This API is only exposed to esr portal.
...
| Interface Definition | Description |
|---|---|
| URI | /api/aai-esr-server/v1/vims |
| Operation Type | POST |
...
| Attribute | Qualifier | Default | Content | Description |
|---|---|---|---|---|
| cloudOwner | M | String | cloud owner name, can be customized, e.g. att-aic | |
| cloudRegionId | M | String | cloud region info based on deployment, e.g. RegionOne | |
| cloudType | M | String | type of the cloud, decides which multicloud plugin to use, openstack or vio | |
| cloudRegionVersion | M | String | cloud version, ocata, mitaka or other | |
| ownerDefinedType | O | String | Cloud-owner defined type indicator (e.g., dcp, lcp) | |
| cloudZone | O | String | Zone where the cloud is homed. | |
| complexName | O | String | complex name for cloud-region instance. | |
| cloudExtraInfo | O | String | extra info for Cloud | |
| authInfoItems | M | 1 | [Obj] | Auth information of Cloud |
...
Request Sample:
/api/aai-esr-server/v1/vims
Body:
{
"cloud-owner": "ZTE",
"status": "active",
"cloud-region-id": "region-one",
"cloud-type": "openstack",
"cloud-region-version": "v1.0",
"owner-defined-type": "owner-defined-type",
"cloud-zone": "cloud zone",
"complex-name": "complex name",
"cloud-extra-info": "cloud-extra-info",
"auth-info-items": [
{
"username": "admin",
"password": "admin",
"auth-url": "http://10.74.151.13:5000/v2.0",
"ssl-cacert": "ssl-cacert",
"ssl-insecure": "true",
"cloud-domain": "cloud-domain"
}
]
}
...
Errorcode: 500 Internal Server Error
Update VIM info
Interface Definition | Description |
|---|---|
| URI | /api/aai-esr-server/v1/vims/{cloudOwner}/{cloudRegionId} |
| Operation Type | PUT |
Request Body:
| Attribute | Qualifier | Default | Content | Description |
|---|---|---|---|---|
| cloudType | M | String | type of the cloud, decides which multicloud plugin to use, openstack or vio | |
| cloudRegionVersion | M | String | cloud version, ocata, mitaka or other | |
| ownerDefinedType | O | String | Cloud-owner defined type indicator (e.g., dcp, lcp) | |
| cloudZone | O | String | Zone where the cloud is homed. | |
| complexName | O | String | complex name for cloud-region instance. | |
| cloudExtraInfo | O | String | extra info for Cloud | |
| authInfoItems | M | [Obj] | Auth information of Cloud |
authInfoItem:
| Attribute | Qualifier | Default | Content | Description |
|---|---|---|---|---|
| cloudDomain | M | String | domain info for keystone v3 | |
| userName | M | String | User name | |
| password | M | String | Password | |
| authUrl | M | String | authentication url of the cloud, e.g. keystone url | |
| ssl-cacert | O | String | ca file content if enabled ssl on auth-url | |
| ssl-insecure | O | Boolean | Whether to verify VIM's certificate |
Request Sample:
/api/aai-esr-server/v1/vims/ZTE/region-one
{
"status": "active",
"cloud-type": "openstack",
"cloud-region-version": "v1.0",
"owner-defined-type": "owner-defined-type",
"cloud-zone": "cloud zone",
"complex-name": "complex name",
"cloud-extra-info": "cloud-extra-info",
"auth-info-items": [
{
"username": "admin",
"password": "admin",
"auth-url": "http://10.74.151.13:5000/v2.0",
"ssl-cacert": "ssl-cacert",
"ssl-insecure": "ssl-insecure",
"cloud-domain": "cloud-domain"
}
]
}
...
| Interface Definition | Description |
|---|---|
| URI | /api/aai-esr-server/v1/vims/{cloud-owner}/{cloud-region-id} |
| Operation Type | GET |
...
Request Sample:
/api/aai-esr-server/v1/vims/ZTE/region-one
Response Parameters:
...
| Interface Definition | Description |
|---|---|
| URI | /api/aai-esr-server/v1/vims |
| Operation Type | GET |
...
Request Sample:
/api/aai-esr-server/v1/vims/
Response Parameters:
List<VIM>
...
| Interface Definition | Description |
|---|---|
| URI | /api/aai-esr-server/v1/vims?cloudOwner=xxx&cloudRegionId=xxx |
| Operation Type | DELETE |
...
Request Sample:
/api/aai-esr-server/v1/vims?cloudOwner=owner&cloudRegionId=region-one
...
Errorcode: 500 Internal Server Error
VNFM
VNFM registration
...
| Interface Definition | Description |
|---|---|
| URI | /api/aai-esr-server/v1/vnfms/vnfm/{vnfmId} |
| Operation Type | PUTPOST |
Request Parameters:
| Attribute | Qualifier | Cardinality | Content | Description | vnfmId | O | 0..1String | |
|---|---|---|---|---|---|---|---|---|
| VNFM UUID generated by ESR | name | M | 1 | String | VNFM name | |||
| type | M | 1 | String | VNFM type | ||||
| vimId | O | 0..1 | String | Related VIM | ||||
| vendor | M | 1 | String | VNFM vendor | ||||
| version | M | 1 | String | VNFM version | ||||
| description | O | 0..1 | String | VNFM description | ||||
| certificateUrl | O | 0..1 | String | certificate url | ||||
| url | M | 1 | String | Access url | ||||
| userName | O | 0..1 | String | User name | ||||
| password | O | 0..1 | String | Password |
Request Sample:
/api/aai-esr-vnfmserver/v1/vnfms/vnfm/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee
Body:
{"vnfmIdname":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29eevnfm",
"name":"vnfm", "type":"Tacker", "vimId":"", "vendor":"ZTE", "version":"v1.0", "description":"vnfm", "url":"http://10.74.44.11", "certificateUrl":"", "userName":"admin", "password":"admin" }
Response:
{ "vnfmId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",}
Success Code: 201
Errorcode: 500 Internal Server Error
...
VNFM update
| Interface Definition | Description |
|---|---|
| URI | /api/aai-esr- |
| server/v1/vnfms/ |
| {vnfmId} |
| Operation Type |
| POST |
Request Parameters:
| Attribute | Qualifier | Cardinality | Content | Description |
|---|
| name | M | 1 | String | VNFM |
Request Sample:
/onapapi/aai/esr/v1/vnfms/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee
Response Parameters:
VNFM
Response Sample:
Success Code: 201
...
| name | ||||
| type | M | 1 | String | VNFM type |
| vimId | O | 0..1 | String | Related VIM |
| vendor | M | 1 | String | VNFM vendor |
| version | M | 1 | String | VNFM version |
| description | O | 0..1 | String | VNFM description |
| certificateUrl | O | 0..1 | String | certificate url |
| url | M | 1 | String | Access url |
| userName | O | 0..1 | String | User name |
| password | O | 0..1 | String | Password |
Request Sample:
/api/aai-esr-server/v1/vnfms/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee
...
Body:
{"name":"vnfm",
"type":"Tacker", "vimId":"", "vendor":"ZTE", "version":"v1.0", "description":"vnfm", "certificateUrlurl":"http://10.74.44.11", "urlcertificateUrl":"http://10.74.44.11", "userName":"admin", "password":"admin", }
...
Response:
Success Code: 201
Errorcode: 500 Internal Server Error
Get VNFM
| Interface Definition | Description |
|---|---|
| URI | /api/aai-esr-vnfmserver/v1/vnfms/{vnfmId} |
| Operation Type | GET |
Request Parameters:
N/A
| Attribute | Qualifier | Cardinality | Content | Description |
|---|---|---|---|---|
| vnfmId | M | 1 | String | VNFM identifier |
Request Sample:
/onapapiapi/aai/-esr-server/v1/vnfmsResponse Parameters/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee
Response Parameters:
List<VNFM>
Response Sample:
Success
...
Code:
...
201
...
[ { "vnfmId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee", "name":"vnfm", "type":"Tacker", "vimId":"", "vimIdvendor":"ZTE", "version":"v1.0", "vendordescription":"ZTEvnfm", "certificateUrl":"", "version":"v1.0", "description":"vnfm", "certificateUrl":"", "url":"http://10.74.44.11", "userName":"admin", "password":"admin", }
Get all VNFM
| Interface Definition | Description |
|---|---|
| URI | /api/aai-esr-server/v1/vnfms |
| Operation Type | GET |
Request Parameters:
N/A
Request Sample:
/api/aai-esr-server/v1/vnfms
Response Parameters:
List<VNFM>
Response Sample:
Success Code: 201 [ { "vnfmId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee", "name":"vnfm", "type":"Tacker", "vimId":"", "vendor":"ZTE", "version":"v1.0", "description":"vnfm", "certificateUrl":"", "url":"http://10.74.44.11", "userName":"admin", "password":"admin" } ]
Delete VNFM
| Interface Definition | Description |
|---|---|
| URI | /api/aai-esr-server/v1/vnfms/{vnfmId} |
| Operation Type | DELETE |
Request Parameters:
| Attribute | Qualifier | Cardinality | Content | Description |
|---|---|---|---|---|
| vnfmId | M | 1 | String | VNFM identifier |
Request Sample:
/api/aai-vnfm/v1/vnfms/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee
Response:
Success Code: 204
Errorcode: 500 Internal Server Error
SDN Controller
SDN Controller registration
| Interface Definition | Description |
|---|---|
| URI | /api/aai-esr-server/v1/sdncontrollers |
| Operation Type | POST |
Request Parameters:
| Attribute | Qualifier | Cardinality | Content | Description |
|---|---|---|---|---|
sdnControllerId | M | 1 | String | UUID of sdncontroller |
| name | M | 1 | String | SDN Controller name |
| location | O | 1 | String | fit for DC type |
| url | M | 1 | String | Access url |
| vendor | M | 1 | String | SDNC vendor |
| version | M | 1 | String | SDNC version |
| description | O | 0..1 | String | SDNC description |
| productName | O | 0..1 | String | SDNC productName |
| protocol | M | 1 | String | protocol, such as netconf/snmp |
| userName | M | 1 | String | User name |
| password | M | 1 | String | Password |
| type | M | 1 | Enum{WAN/DC} | SDN Controller type |
Request Sample:
/api/aai-esr-server/v1/sdncontrollers
Body:
{
"name":"sdn",
"url":"http://10.74.
...
"userName":"admin",
...
"password":"admin"
...
Delete VNFM
...
Request Parameters:
...
Request Sample:
/api/aai-vnfm/v1/vnfms/vnfm/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee
Response:
...
,
"version":"v1.0",
"vendor":"ZTE",
"description":"",
"protocol":"netconf",
"productName":"",
"type":"WAN"
}
Response:
body:
{
"sdnControllerId":"a6c42529-cd6b-4c01-b149-03eb54b20a03",
}
Success Code: 201
Errorcode: 500 Internal Server Error
...
...
Update SDN Controller info
...
| Interface Definition | Description |
|---|---|
| URI | /api/aai- |
| esr-server/v1/sdncontrollers |
| /{sdnControllerId} | |
| Operation Type | PUT |
Request Parameters:
| Attribute | Qualifier | Cardinality | Content | Description |
|---|---|---|---|---|
sdnControllerId | M | 1 | String | UUID of sdncontroller |
| name | M | 1 | String | SDN Controller name |
| location | O | 1 | String | fit for DC type |
| url | M | 1 | String | Access url |
| vendor | M | 1 | String | SDNC vendor |
| version | M | 1 | String | SDNC version |
| description | O | 0..1 | String | SDNC description |
| productName | O | 0..1 | String | SDNC productName |
| protocol | M | 1 |
| String | protocol, such as netconf/snmp |
| userName | M | 1 | String | User name |
| password | M | 1 | String | Password |
| type | M | 1 | Enum{WAN/DC} | SDN Controller type |
Request Sample:
/api/aai-esr-sdncontrollerserver/v1/sdncontrollers/sdncontroller/{sdnControllerId}
Body:
{
...
a6c42529-cd6b-4c01-b149-03eb54b20a03
...
Body:
{
"name":"sdn",
"url":"http://10.74.151.13:8181",
...
| Interface Definition | Description |
|---|---|
| URI | /api/aai-esr-sdncontrollerserver/v1/sdncontrollers/sdncontroller/{sdnControllerId} |
| Operation Type | GET |
...
| Attribute | Qualifier | Cardinality | Content | Description |
|---|---|---|---|---|
| sdnControllerId | M | 1 | String | SDN Controller identifier |
Request Sample:
/api/aai-sdncontrolleresr-server/v1/sdncontrollers/sdncontroller/57674786-5b2e-4c92-bb68-578dbd79e2f5
...
| Interface Definition | Description |
|---|---|
| URI | /api/aai-sdncontrolleresr-server/v1/sdncontrollers |
| Operation Type | GET |
Request Parameters:
N/A
Request Sample:
/api/aai-esr-sdncontrollerserver/v1/sdncontrollers
Response Parameters:
List<SDN Controller>
...
| Interface Definition | Description |
|---|---|
| URI | /api/aai-sdncontrolleresr-server/v1/sdncontrollers/sdncontroller/{sdnControllerId} |
| Operation Type | DELETE |
...
| Attribute | Qualifier | Cardinality | Content | Description |
|---|---|---|---|---|
| sdnControllerId | M | 1 | String | SDN Controller identifier |
Request Sample:
/onapapiapi/aai/-esr-server/v1/sdncontrollers/sdncontroller/57674786-5b2e-4c92-bb68-578dbd79e2f5
...
| Attribute | Qualifier | Cardinality | Content | Description |
|---|---|---|---|---|
| cloud-owner | M | 1 | String | Cloud owner |
| cloud-region-id | M | 1 | String | Cloud region |
| cloud-extra-info | O | 0...1 | String | Extra information of Cloud |
| cloud-type | O | 0...1 | String | Type of the cloud (e.g., openstack) |
| owner-defined-type | O | 0...1 | String | Cloud-owner defined type indicator |
| cloud-region-version | O | 0...1 | String | Software version employed at the site |
| identity-url | O | 0...1 | String | URL of the keystone identity service |
| cloud-zone | O | 0...1 | String | Zone where the cloud is homed |
| complex-name | O | 0...1 | String | complex name for cloud-region instance |
| resource-version | O | 0...1 | String | Used for optimistic concurrency. Must be empty on create, valid on update and delete. |
| volume-groups | O | 0...1 | object[] | definition detail see AAI API |
| tenants | O | 0...1 | object[] | definition detail see AAI API |
| flavors | O | 0...1 | object[] | definition detail see AAI API |
| group-assignments | O | 0...1 | object[] | definition detail see AAI API |
| snapshots | O | 0...1 | object[] | definition detail see AAI API |
| images | O | 0...1 | object[] | definition detail see AAI API |
| availability-zones | O | 0...1 | object[] | definition detail see AAI API |
| relationship-list | O | 0...1 | object[] | definition detail see AAI API |
| authInfoItems | M | 1 | object[] | Auth information of Cloud |
...