This API is only exposed to esr portal.
...
| 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 |
...
| 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 |
...
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 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
...
Request Sample:
/api/aai-esr-server/v1/sdncontrollers
Body:
{
"name":"sdn",
"url":"http://10.74.151.13:8181",
...
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-server/v1/sdncontrollers/a6c42529-cd6b-4c01-b149-03eb54b20a03
...
| Interface Definition | Description |
|---|---|
| URI | /api/aai-esr-server/v1/sdncontrollers |
| Operation Type | GET |
Request Parameters:
N/A
Request Sample:
/api/aai-esr-server/v1/sdncontrollers
Response Parameters:
List<SDN Controller>
...
Errorcode: 500 Internal Server Error
EMS
EMS
...
registration
| Interface Definition | Description |
|---|---|
| URI | /api/aai-emsesr-server/v1/emses/ems/{emsId} |
| Operation Type | PUTPOST |
Request Parameters:
| Attribute | Qualifier | Cardinality | Content | Description | emsId | M||
|---|---|---|---|---|---|---|---|
| 1 | String | UUID generated by esr-server | name | M | 1 | String | EMS name |
| vendor | M | 1 | String | vendor | |||
| version | M | 1 | String | version | |||
| description | O | 0..1 | String | description | |||
| resourceAddr | M | 1 | Obj | Address to get resource data | |||
| performanceAddr | M | 1 | Obj | Address to get performance data | |||
| alarmAddr | M | 1 | Obj | Address to get alarm data |
...
| Attribute | Qualifier | Cardinality | Content | Description |
|---|---|---|---|---|
| ip | M | 1 | String | service IP of ftp server |
| port | M | 1 | String | service port of ftp server |
| user | M | 1 | String | ftp user name |
| password | M | 1 | String | ftp password |
Request Sample:
/api/aai-emsesr-server/v1/emses/ems/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee
Body:
{
...
"emsName": "EMS_TEST",
"version":"v1.0",
...
"alarmAddr": {
"ip": "10.44.55.145",
"port": 2000,
"user": "root",
"password": "test"
}
}
Response ParametersSample:EMS
Response Sample:
{
...
body:
{
"emsId": "19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
}
Success Code: 201
Errorcode: 500 Internal Server Error
Update EMS info
| Interface Definition | Description |
|---|---|
| URI | /api/aai-esr-server/v1/emses/{emsId} |
| Operation Type | PUT |
Request Parameters:
| Attribute | Qualifier | Cardinality | Content | Description |
|---|---|---|---|---|
| name | M | 1 | String | EMS name |
| vendor | M | 1 | String | vendor |
| version | M | 1 | String | version |
| description | O | 0..1 | String | description |
| resourceAddr | M | 1 | Obj | Address to get resource data |
| performanceAddr | M | 1 | Obj | Address to get performance data |
| alarmAddr | M | 1 | Obj | Address to get alarm data |
resourceAddr:
| Attribute | Qualifier | Cardinality | Content | Description |
|---|---|---|---|---|
| ftptype | M | 1 | Enum{ftp/sftp} | ftp type |
| ip | M | 1 | String | service IP of ftp server |
| port | M | 1 | String | service port of ftp server |
| user | M | 1 | String | ftp user name |
| password | M | 1 | String | ftp password |
| remotepath | M | 1 | String | resource data file path |
| passive | M | 1 | Boolean | ftp passive mode or not |
performanceAddr:
| Attribute | Qualifier | Cardinality | Content | Description |
|---|---|---|---|---|
| ftptype | M | 1 | Enum{ftp/sftp} | ftp type |
| ip | M | 1 | String | service IP of ftp server |
| port | M | 1 | String | service port of ftp server |
| user | M | 1 | String | ftp user name |
| password | M | 1 | String | ftp password |
| remotepath | M | 1 | String | performance data file path |
| passive | M | 1 | Boolean | ftp passive mode or not |
alarmAddr:
| Attribute | Qualifier | Cardinality | Content | Description |
|---|---|---|---|---|
| ip | M | 1 | String | service IP of ftp server |
| port | M | 1 | String | service port of ftp server |
| user | M | 1 | String | ftp user name |
| password | M | 1 | String | ftp password |
Request Sample:
/api/aai-esr-server/v1/emses
Body:
{
"emsName": "EMS_TEST",
"version":"v1.0",
...
| Interface Definition | Description |
|---|---|
| URI | /api/aai-esr-emsserver/v1/emses/ems/{emsId} |
| Operation Type | GET |
Request Parameters:
| Attribute | Qualifier | Cardinality | Content | Description |
|---|---|---|---|---|
| emsId | M | 1 | String | EMS identifier |
Request Sample:
/api/aai-emsesr-server/v1/emses/ems/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee
...
| Interface Definition | Description |
|---|---|
| URI | /api/aai-esr-emsserver/v1/emses |
| Operation Type | GET |
Request Parameters:
N/A
Request Sample:
/api/aai-emsesr-server/v1/emses
Response Parameters:
List<EMS>
...
| Interface Definition | Description |
|---|---|
| URI | /onapapiapi/aai/-esr-server/v1/emses/{emsId} |
| Operation Type | DELETE |
...
| Attribute | Qualifier | Cardinality | Content | Description |
|---|---|---|---|---|
| emsId | M | 1 | String | EMS identifier |
Request Sample:
/onapapiapi/aai/-esr-server/v1/emses/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee
...
| 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 |
...