OpenDoveDomainNorthbound
Open DOVE Northbound REST APIs for Domains.
Authentication scheme [for now]: HTTP Basic
Authentication realm : opendaylight
Transport : HTTP and HTTPS
HTTPS Authentication is disabled by default. Administrator can enable it in
tomcat-server.xml after adding a proper keystore / SSL certificate from a
trusted authority.
More info :
http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html#Configuration
The following resources are part of this group:
/domains
Mount Point: /controller/nb/v2/opendove/odmc/domains
GET
Lists domains
Response Body
| element: | openDoveDomainRequest |
| media types: | application/json |
List of domains
Example:
Request URL:
http://localhost:8080/controller/nb/v2/opendove/odmc/domains
Response body in JSON:
{
"domains": [ {
"id": "uuid",
"name": "domain_name",
"replication_factor": 2
} ]
}
Status Codes
| code | description |
|---|---|
| 200 | Operation successful |
| 204 | No content |
| 401 | Unauthorized |
| 500 | Internal Error |
/domains/{domainUUID}
Mount Point: /controller/nb/v2/opendove/odmc/domains/{domainUUID}
GET
Returns a particular domain
Parameters
| name | description | type | default |
|---|---|---|---|
| domainUUID | Identifier of the domain | path |
Response Body
| element: | openDoveDomainRequest |
| media types: | application/json |
Data on that domain
Example:
Request URL:
http://localhost:8080/controller/nb/v2/opendove/odmc/domains/uuid
Response body in JSON:
{
"domain": {
"id": "uuid",
"name": "domain_name",
"replication_factor": 2
}
}
Status Codes
| code | description |
|---|---|
| 200 | Operation successful |
| 204 | No content |
| 401 | Unauthorized |
| 404 | Not Found |
| 500 | Internal Error |
/domains/{domainUUID}/odcs-list
Mount Point: /controller/nb/v2/opendove/odmc/domains/{domainUUID}/odcs-list
GET
List service appliances hosting a particular domain
Parameters
| name | description | type | default |
|---|---|---|---|
| domainUUID | Identifier of the network | path |
Response Body
| element: | openDoveDCSList |
| media types: | application/json |
List of service appliances hosting that domain
Example:
Request URL:
http://localhost:8080/controller/nb/v2/opendove/odmc/networks/uuid/domains/uuid/odcs-list
Response body in JSON:
{
"odcs-list": [ {
"ip_family": 4,
"ip": "10.10.10.1",
"uuid": "uuid",
"dcs_rest_service_port": 1888,
"dgw_rest_service_port": 1888,
"dcs_raw_service_port": 932,
"timestamp": "now",
"build_version": "openDSA-1",
"dcs_config_version": 60,
"canBeDCS": true,
"canBeDGW": true,
"isDCS": true,
"isDGW": false
} ]
}
Status Codes
| code | description |
|---|---|
| 200 | Operation successful |
| 204 | No content |
| 401 | Unauthorized |
| 404 | Not Found |
| 500 | Internal Error |