This API is only exposed to esr portal.
Table of Contents |
---|
VIM
VIM registration
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 | |
authInfoItemsvimAuthInfos | M | 1 | [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 |
sslCacert | O | String | ca file content if enabled ssl on auth-url |
sslInsecure | O | Boolean | Whether to verify VIM's certificate |
Request Sample:
/api/aai-esr-server/v1/vims
Body:
{
"
...
cloudOwner": "ZTE",
"
...
cloudRegionId":
...
"region-
...
one",
"
...
cloudType": "openstack",
"
...
cloudRegionVersion": "v1.0",
"
...
ownerDefinedType": "owner-defined-type",
"
...
cloudZone": "cloud zone",
"
...
complexName": "complex name",
"cloudExtraInfo": "cloud-extra-info"
...
,
"
...
vimAuthInfos":
[
...
{
"
...
userName": "admin",
"password": "admin",
"
...
authUrl": "http://10.74.151.13:5000/v2.0",
"
...
sslCacert": "ssl-cacert",
"
...
sslInsecure":
...
true
...
,
"
...
cloudDomain": "cloud-domain"
}
...
]
}
Response:
Success Code: 201: 200
body:
{
"cloudOwner": "ZTE",
"cloudRegionId": "region-one"
}
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 |
vimAuthInfos | 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 |
sslCacert | O | String | ca file content if enabled ssl on auth-url |
sslInsecure | O | Boolean | Whether to verify VIM's certificate |
Request Sample:
/api/aai-esr-server/v1/vims/ZTE/region-one
{
"statuscloudOwner": "activeZTE",
"cloud-typecloudRegionId": "region-one",
"cloudType": "openstack",
"cloud-region-versioncloudRegionVersion": "v1.0",
"owner-defined-typeownerDefinedType": "owner-defined-type",
"cloud-zonecloudZone": "cloud zone",
"complex-namecomplexName": "complex name",
"cloud-extra-infocloudExtraInfo": "cloud-extra-info",
"auth-info-itemsvimAuthInfos":
[
{
"usernameuserName": "admin",
"password": "admin",
"auth-urlauthUrl": "http://10.74.151.13:5000/v2.0",
"ssl-cacertsslCacert": "ssl-cacert",
"ssl-insecuresslInsecure": "ssl-insecure"true,
"cloud-domaincloudDomain": "cloud-domain"
}
]
}
Get VIM
Interface Definition | Description |
---|---|
URI | /api/aai-esr-server/v1/vims/{cloud-ownercloudOwner}/{cloud-region-idcloudRegionId} |
Operation Type | GET |
Request Parameters:
...
Request Sample:
/api/aai-esr-server/v1/vims/ZTE/region-one
Response Parameters:
Get all VIM
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>
Delete VIM
Interface Definition | Description |
---|---|
URI | /api/aai-esr-server/v1/vims?cloudOwner=xxx&cloudRegionId=xxx/{cloudOwner}/{cloudRegionId} |
Operation Type | DELETE |
Request Parameters:
...
Request Sample:
/api/aai-esr-server/v1/vims?cloudOwner=owner&cloudRegionId=/owner/region-one
Response:
Success Code: 204
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..1 | String | 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-vnfmesr-server/v1/vnfms/vnfm/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee
BodyBody:
{
"vnfmId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee", "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: 201200
Errorcode: 500 Internal Server Error
...
VNFM update
Interface Definition | Description |
---|---|
URI | /api/aai-vnfmesr-server/v1/vnfms/vnfm/{vnfmId} |
Operation Type | GETPUT |
Request Parameters:
Attribute | Qualifier | Cardinality | Content | Description |
---|---|---|---|---|
vnfmIdname | M | 1 | String | VNFM identifier |
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 |
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", "descriptionurl":"vnfmhttp://10.74.44.11", "certificateUrl":"", "url":"http://10.74.44.11", "userName":"admin", "password":"admin", }
Response:
Success Code: 200
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:
/api/aai-esr-server/v1/vnfms/19ecbb3a-3242-4fa3-9926-8dfb7ddc29eeRequest Sample:
/onapapi/aai/esr/v1/vnfms
Response Parameters:
List<VNFM>
Response Sample:
Success
...
Code:
...
200
[ { "vnfmId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee", "name":"vnfm", "type":"Tacker", "vimId":"", "vendor":"ZTE", "version":"v1.0", "descriptioncertificateUrl":"vnfm", "certificateUrlurl":"", "url":"http:http://10.74.44.11", "userName":"admin", "password":"admin", } ]
...
Get all VNFM
Interface Definition | Description |
---|---|
URI | /api/aai-vnfmesr-server/v1/vnfms/vnfm/{vnfmId} |
Operation Type | DELETEGET |
Request Parameters:
...
N/A
Request Sample:
/api/aai-vnfmesr-server/v1/vnfms/vnfm/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee
Response Parameters:
List<VNFM>
Response SampleResponse:
Success Code:
...
200
[ { "vnfmId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee", "name":"vnfm", "type":"Tacker", "vimId":"", "vendor":"ZTE", "version":"v1.0", "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 |
Errorcode: 500 Internal Server Error
SDN Controller
SDN Controller registration (Update SDN Controller info)
...
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 | Enum{netconf/snmp} | protocol |
userName | M | 1 | String | User name |
password | M | 1 | String | Password |
type | M | 1 | Enum{WAN/DC} | SDN Controller type |
Request Sample:
/api/aai-sdncontrolleresr-server/v1/sdncontrollers/sdncontroller/{sdnControllerId}
Body:
{
"sdnControllerId":"a6c42529-cd6b-4c01-b149-03eb54b20a03",
"name":"sdn",
"url":"http://10.74.151.13:8181",
"userName":"admin",
"password":"admin",
"version":"v1.0",
"vendor":"ZTE",
"description":"",
"protocol":"netconf",
"productName":"",
"type":"WAN"
}
Response:
Success Code: 201
Errorcode: 500 Internal Server Error
Get SDN Controller
...
Request Parameters:
...
Request Sample:
/api/aai-sdncontroller/v1/sdncontrollers/sdncontroller/57674786-5b2e-4c92-bb68-578dbd79e2f5
Response Parameters:
SDN Controller
Response Sample:
Success Code: 201
...
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.151.13:8181",
"userName":"admin",
"password":"admin",
"version":"v1.0",
"vendor":"ZTE",
...
"description":"",
...
"protocol":"netconf",
...
"productName":"",
"type":"WAN"
}
Response:
body:
{
"sdnControllerId":"a6c42529-cd6b-4c01-b149-03eb54b20a03",
}
Success Code: 200
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-server/v1/sdncontrollers/a6c42529-cd6b-4c01-b149-03eb54b20a03
Body:
{
"name":"sdn",
"url":"http://10.74.151.13:8181",
"userName":"admin",
"password":"admin",
"version":"v1.0",
"vendor":"ZTE",
"description":"",
"protocol":"netconf",
"productName":"",
"type":"WAN"
}
Response:
Success Code: 200
Errorcode: 500 Internal Server Error
Get SDN Controller
Interface Definition | Description |
---|---|
URI | /api/aai-esr-server/v1/sdncontrollers/{sdnControllerId} |
Operation Type | GET |
Request Parameters:
Attribute | Qualifier | Cardinality | Content | Description |
---|---|---|---|---|
sdnControllerId | M | 1 | String | SDN Controller identifier |
Request Sample:
/api/aai-esr-server/v1/sdncontrollers/57674786-5b2e-4c92-bb68-578dbd79e2f5
Response Parameters:
SDN Controller
Response Sample:
Success Code: 200
{ "sdnControllerId":"a6c42529-cd6b-4c01-b149-03eb54b20a03", "name":"sdn", "url":"http://10.74.151.13:8181", "userName":"admin", "password":"admin", "version":"v1.0", "vendor":"ZTE", "description":"", "protocol":"netconf", "productName":"", "type":"WAN" }
Get all SDN Controller
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>
Response Sample:
Success Code: 200
[ { "sdnControllerId":"a6c42529-cd6b-4c01-b149-03eb54b20a03", "name":"sdn", "url":"http://10.74.151.13:8181", "userName":"admin", "password":"admin", "version":"v1.0", "vendor":"ZTE", "description":"", "protocol":"netconf", "productName":"", "type":"WAN" } ]
Delete SDN Controller
Interface Definition | Description |
---|---|
URI | /api/aai-esr-server/v1/sdncontrollers/{sdnControllerId} |
Operation Type | DELETE |
Request Parameters:
Attribute | Qualifier | Cardinality | Content | Description |
---|---|---|---|---|
sdnControllerId | M | 1 | String | SDN Controller identifier |
Request Sample:
/api/aai-esr-server/v1/sdncontrollers/57674786-5b2e-4c92-bb68-578dbd79e2f5
Response:
Success Code: 204
Errorcode: 500 Internal Server Error
EMS
EMS registration
Interface Definition | Description |
---|---|
URI | /api/aai-esr-server/v1/emses |
Operation Type | POST |
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",
"vendor":"ZTE",
"description":"",
"resouceAddr": {
"ftptype": "ftp",
"ip": "10.44.55.145",
"port": "2000",
"user": "root",
"password": "test",
"remotepath": "/opt/res/data/",
"passive": true
},
"performanceAddr": {
"ftptype": "ftp",
"ip": "10.44.55.145",
"port": "2000",
"user": "root",
"password": "test",
"remotepath": "/opt/Gcp/data/",
"passive": true
},
"alarmAddr": {
"ip": "10.44.55.145",
"port": 2000,
"user": "root",
"password": "test"
}
}
Response Sample:
body:
{
"emsId": "19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
}
Success Code: 200
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",
"vendor":"ZTE",
"description":"",
"resouceAddr": {
"ftptype": "ftp",
"ip": "10.44.55.145",
"port": "2000",
"user": "root",
"password": "test",
"remotepath": "/opt/res/data/",
"passive": true
},
"performanceAddr": {
"ftptype": "ftp",
"ip": "10.44.55.145",
"port": "2000",
"user": "root",
"password": "test",
"remotepath": "/opt/Gcp/data/",
"passive": true
},
"alarmAddr": {
"ip": "10.44.55.145",
"port": 2000,
"user": "root",
"password": "test"
}
}
Get EMS by id
Get all SDN Controller
...
Request Parameters:
N/A
Request Sample:
/api/aai-sdncontroller/v1/sdncontrollers
Response Parameters:
List<SDN Controller>
Response Sample:
Success Code: 201
[ { "sdnControllerId":"a6c42529-cd6b-4c01-b149-03eb54b20a03", "name":"sdn", "url":"http://10.74.151.13:8181", "userName":"admin", "password":"admin", "version":"v1.0", "vendor":"ZTE", "description":"", "protocol":"netconf", "productName":"", "type":"WAN" } ]
Delete SDN Controller
...
Request Parameters:
...
Request Sample:
/onapapi/aai/esr/v1/sdncontrollers/sdncontroller/57674786-5b2e-4c92-bb68-578dbd79e2f5
Response:
Success Code: 204
Errorcode: 500 Internal Server Error
EMS
...
Interface Definition | Description |
---|---|
URI | /api/aai-emsesr-server/v1/emses/ems/{emsId} |
Operation Type | PUTGET |
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 |
resourceAddr:
...
performanceAddr:
...
alarmAddr:
...
Request Sample:
/api/aai-ems/v1/emses/ems/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee
Body:
{
"emsId": "19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
"emsName": "EMS_TEST",
"version":"v1.0",
"vendor":"ZTE",
"description":"",
"resouceAddr": {
"ftptype": "ftp",
"ip": "10.44.55.145",
"port": "2000",
"user": "root",
"password": "test",
"remotepath": "/opt/res/data/",
"passive": true
},
"performanceAddr": {
"ftptype": "ftp",
"ip": "10.44.55.145",
"port": "2000",
"user": "root",
"password": "test",
"remotepath": "/opt/Gcp/data/",
"passive": true
},
"alarmAddr": {
"ip": "10.44.55.145",
"port": 2000,
"user": "root",
"password": "test"
}
}
Response Parameters:
EMS
Response Sample:
{
"emsId": "19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
"emsName": "EMS_TEST",
"version":"v1.0",
"vendor":"ZTE",
"description":"",
"resouceAddr": {
"ftptype": "ftp",
"ip": "10.44.55.145",
"port": "2000",
"user": "root",
"password": "test",
"remotepath": "/opt/res/data/",
"passive": true
},
"performanceAddr": {
"ftptype": "ftp",
"ip": "10.44.55.145",
"port": "2000",
"user": "root",
"password": "test",
"remotepath": "/opt/Gcp/data/",
"passive": true
},
"alarmAddr": {
"ip": "10.44.55.145",
"port": 2000,
"user": "root",
"password": "test"
}
}
...
EMS identifier |
Request Sample:
/api/aai-esr-server/v1/emses/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee
Response Parameters:
EMS
Response Sample:
{
"emsId": "19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
"emsName": "EMS_TEST",
"version":"v1.0",
"vendor":"ZTE",
"description":"",
"resouceAddr": {
"ftptype": "ftp",
"ip": "10.44.55.145",
"port": "2000",
"user": "root",
"password": "test",
"remotepath": "/opt/res/data/",
"passive": true
},
"performanceAddr": {
"ftptype": "ftp",
"ip": "10.44.55.145",
"port": "2000",
"user": "root",
"password": "test",
"remotepath": "/opt/Gcp/data/",
"passive": true
},
"alarmAddr": {
"ip": "10.44.55.145",
"port": 2000,
"user": "root",
"password": "test"
}
}
Get all EMS
Interface Definition | Description |
---|---|
URI | /api/aai-esr-server/v1/emses |
Operation Type | GET |
Request Parameters:
N/A
Request Sample:
/api/aai-esr-server/v1/emses
Response Parameters:
List<EMS>
Response Sample:
Success Code: 200
[
{
"emsId": "19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
"emsName": "EMS_TEST",
"version":"v1.0",
"vendor":"ZTE",
"description":"",
"resouceAddr": {
"ftptype": "ftp",
"ip": "10.44.55.145",
"port": "2000",
"user": "root",
"password": "test",
"remotepath": "/opt/res/data/",
"passive": true
},
"performanceAddr": {
"ftptype": "ftp",
"ip": "10.44.55.145",
"port": "2000",
"user": "root",
"password": "test",
"remotepath": "/opt/Gcp/data/",
"passive": true
},
"alarmAddr": {
"ip": "10.44.55.145",
"port": 2000,
"user": "root",
"password": "test"
}
}
]
Delete EMS
Interface Definition | Description |
---|---|
URI | /api/aai-esr-server/v1/emses/{emsId} |
Operation Type | DELETE |
Request Parameters:
Attribute | Qualifier | Cardinality | Content | Description |
---|---|---|---|---|
emsId | M | 1 | String | EMS identifier |
Request Sample:
/api/aai-esr-server/v1/emses/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee
Response:
Success Code: 204
Errorcode: 500 Internal Server Error
PNF
PNF registration
Interface Definition | Description |
---|---|
URI | /api/aai-esr-server/v1/pnfs |
Operation Type | POST |
Request Parameters:
Attribute | Qualifier | Cardinality | Content | Description |
---|---|---|---|---|
pnfId | M | 1 | String | unique ID of PNF |
userLabel | M | 1 | String | PNF system name |
subnetId | M | 1 | String | subnet ID of DU network element |
neId | M | 1 | String | network element ID |
managementType | O | 1 | String | |
vendor | O | 1 | String | |
pnfdId | M | 1 | String | |
emsId | M | 1 | String | |
lattitude | O | 1 | String | |
longitude | O | 1 | String |
Request Sample:
/api/aai-esr-server/v1/pnfs
Body:
{
"pnfId":"dafdaf3213dfa",
"userLabel":"pnf1", "subnetId":"15da65fa1f", "neId":"4f6asd8ff4asd", "managementType":"test", "vendor":"zte", "pnfdId":"8f7adfa8fa9", "emsId":"fdsa5f4afd4a", "lattitude":"156.446", "longitude":"121.154" }
Response:
Success Code: 200
Errorcode: 500 Internal Server Error
Update PNF info
Interface Definition | Description |
---|---|
URI | /api/aai-esr-emsserver/v1/emsespnfs/ems/{emsIdpnfId} |
Operation Type | GETPUT |
Request Parameters:
Attribute | Qualifier | Cardinality | Content | Description |
---|
pnfId | M | 1 | String | unique ID of PNF |
userLabel | M | 1 | String | PNF system name |
subnetId | M | 1 | String | subnet ID of DU network element |
neId | M | 1 | String |
Request Sample:
/api/aai-ems/v1/emses/ems/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee
Response Parameters:
EMS
Response Sample:
{
"emsId": "19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
"emsName": "EMS_TEST",
"version":"v1.0",
"vendor":"ZTE",
"description":"",
"resouceAddr": {
"ftptype": "ftp",
"ip": "10.44.55.145",
"port": "2000",
"user": "root",
"password": "test",
"remotepath": "/opt/res/data/",
"passive": true
},
"performanceAddr": {
"ftptype": "ftp",
"ip": "10.44.55.145",
"port": "2000",
"user": "root",
"password": "test",
"remotepath": "/opt/Gcp/data/",
"passive": true
},
"alarmAddr": {
"ip": "10.44.55.145",
"port": 2000,
"user": "root",
"password": "test"
}
}
...
network element ID | ||||
managementType | O | 1 | String | |
vendor | O | 1 | String | |
pnfdId | M | 1 | String | |
emsId | M | 1 | String | |
lattitude | O | 1 | String | |
longitude | O | 1 | String |
Body:Request Sample:
/api/aai-esr-server/v1/pnfs/dafdaf3213dfa
{
"pnfId":"dafdaf3213dfa",
"userLabel":"pnf1",
"subnetId":"15da65fa1f",
"neId":"4f6asd8ff4asd",
"managementType":"test",
"vendor":"zte",
"pnfdId":"8f7adfa8fa9",
"emsId":"fdsa5f4afd4a",
"lattitude":"156.446",
"longitude":"121.154"
}
Response:
Success Code: 200
Errorcode: 500 Internal Server Error
Get PNF by ID
Interface Definition | Description |
---|---|
URI | /api/aai-esr-emsserver/v1/pnfs/emses{pnfId} |
Operation Type | GET |
Request Parameters:N/A
Attribute | Qualifier | Cardinality | Content | Description |
---|---|---|---|---|
pnfId | M | 1 | String | PNF identifier |
Request Sample:
/api/aai-esr-emsserver/v1/pnfs/emsesdafdaf3213dfa
Response Parameters:
List<EMS>PNF
Response Sample:
Success Code: 201
[
{
"emsId": "19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
"emsName": "EMS_TEST",
"version":"v1.0",
"vendor":"ZTE",
"description":"",
"resouceAddr": {
"ftptype": "ftp",
"ip": "10.44.55.145",
"port": "2000",
"user": "root",
"password": "test",
"remotepath": "/opt/res/data/",
"passive": true
},
"performanceAddr": {
"ftptype": "ftp",
"ip": "10.44.55.145",
"port": "2000",
"user": "root",
"password": "test",
"remotepath": "/opt/Gcp/data/",
"passive": true
},
"alarmAddr": {
"ip": "10.44.55.145",
"port": 2000,
"user": "root",
"password": "test"
}
}
]
...
Code: 200
{
"pnfId":"dafdaf3213dfa",
"userLabel":"pnf1",
"subnetId":"15da65fa1f",
"neId":"4f6asd8ff4asd",
"managementType":"test",
"vendor":"zte",
"pnfdId":"8f7adfa8fa9",
"emsId":"fdsa5f4afd4a",
"lattitude":"156.446",
"longitude":"121.154"
}
Get all PNF
Interface Definition | Description |
---|---|
URI | /api/aai-esr-server/v1/pnfs |
Operation Type | GET |
Request Parameters:
N/A
Request Sample:
/api/aai-esr-server/v1/pnfs
Response Parameters:
List<PNF>
Response Sample:
Success Code: 200
[
{
"pnfId":"dafdaf3213dfa",
"userLabel":"pnf1",
"subnetId":"15da65fa1f",
"neId":"4f6asd8ff4asd",
"managementType":"test",
"vendor":"zte",
"pnfdId":"8f7adfa8fa9",
"emsId":"fdsa5f4afd4a",
"lattitude":"156.446",
"longitude":"121.154"
}
]
Delete PNF
Interface Definition | Description |
---|---|
URI | /onapapiapi/aai/-esr-server/v1/emsespnfs/{emsIdpnfId} |
Operation Type | DELETE |
Request Parameters:
Attribute | Qualifier | Cardinality | Content | Description |
---|---|---|---|---|
emsIdpnfId | M | 1 | String | EMS PNF identifier |
Request Sample:
/onapapiapi/aai/-esr-server/v1/emses/19ecbb3a-3242-4fa3-9926-8dfb7ddc29eepnfs/dafdaf3213dfa
Response:
Success Code: 204
Errorcode: 500 Internal Server Error
Information elements
VNFM
Attribute | Qualifier | Cardinality | Content | Description | |||||
---|---|---|---|---|---|---|---|---|---|
vnfmId | O | 0..1 | String | 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 | |||||
name | |||||||||
type | M | userName | O | 0..1 | StringUser | nameVNFM type | |||
passwordvimId | O | 0..1 | String | Password | Related VIM | ||||
Attribute | Qualifier | Cardinality | Content | Description | |||||
vendor | cloud-owner | M | 1 | String | Cloud owner | cloud-region-idVNFM vendor | |||
version | M | 1 | String | Cloud region | VNFM version | ||||
certificateUrl | cloud-extra-infoO | 0.. | .1 | String | Extra information of Cloud | cloud-type | O | 0...certificate url | |
url | M | 1 | String | Type of the cloud (e.g., openstack) | Access url | ||||
userName | owner-defined-typeO | 0.. | .1 | String | Cloud-owner defined type indicator | cloud-region-versionUser name | |||
password | 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 |
...
Password |
VIM
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 | |
vimAuthInfos | M | 1 | [Obj] | Auth information of Cloud |
vimAuthInfo:
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 | |
defaultTenant | O | String | ||
sslCacert | O | String | ca file content if enabled ssl on auth-url | |
sslInsecure | O | Boolean | Whether to verify VIM's certificate |
SDN Controller
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 | |||||||
Attribute | Qualifier | Cardinality | Content | Description | |||
---|---|---|---|---|---|---|---|
O | 0..1 | String | SDNC productName | ||||
protocol | sdnControllerIdM | 1 | Enum{netconf/snmp} | protocol | |||
userName | String | UUID of sdncontroller | name | M | 1 | String | SDN Controller User name |
password | OM | 1 | String | fit for DC type | |||
url | M | 1 | String | Access url | |||
Password | |||||||
type | M | 1 | Enum{WAN/DC} | SDN Controller type |
EMS
Attribute | Qualifier | Cardinality | Content | Description |
---|---|---|---|---|
emsIdvendor | M | 1 | StringSDNC | vendorEMS identifier |
versionname | MO | 0..1 | StringSDNC | versionEMS name |
descriptionvendor | O | 0..1 | String | SDNC descriptionVendor |
productNameversion | O | 0..1 | String | SDNC productNameversion |
protocoldescription | MO | 0..1 | Enum{netconf/snmp} | protocol |
userName | M | 1 | String | User name |
password | M | 1 | String | Password |
type | M | 1 | Enum{WAN/DC} | SDN Controller type |
...
String | description | |||
resourceAddr | O | 0..1 | Obj | Address to get resource data |
performanceAddr | O | 0..1 | Obj | Address to get performance data |
alarmAddr | O | 0..1 | Obj | Address to get alarm data |
resourceAddr
Attribute | Qualifier | Cardinality | Content | Description | |||
---|---|---|---|---|---|---|---|
emsId | M | 1 | String | EMS identifier | |||
ftptype | name | O | 0..1 | String | EMS name | Enum{ftp/sftp} | ftp type |
ip | vendorO | 0..1 | String | Vendor | service IP of ftp server | ||
port | versionO | 0..1 | String | version | service port of ftp server | ||
user | descriptionO | 0..1 | String | descriptionftp user name | |||
password | O | 0..1 | Obj | Address to get resource data | String | ftp password | |
remotepath | performanceAddrO | 0..1 | Obj | Address to get performance data | String | resource data file path | |
passive | alarmAddrO | 0..1 | Obj | Address to get alarm data |
...
Boolean | ftp passive mode or not |
performanceAddr
Attribute | Qualifier | Cardinality | Content | Description |
---|---|---|---|---|
ftptype | O | 0..1 | Enum{ftp/sftp} | ftp type |
ip | O | 0..1 | String | service IP of ftp server |
port | O | 0..1 | String | service port of ftp server |
user | O | 0..1 | String | ftp user name |
password | O | 0..1 | String | ftp password |
remotepath | O | 0..1 | String |
performance data file path | ||||
passive | O | 0..1 | Boolean | ftp passive mode or not |
...
alarmAddr
Attribute | Qualifier | Cardinality | Content | Description |
---|
ip | O | 0..1 |
String | service IP of ftp server |
port |
O | 0..1 | String | service |
port of ftp server |
user | O | 0..1 | String |
ftp |
user name |
password | O | 0..1 | String | ftp |
alarmAddr
password |
PNF
Attribute | Qualifier | Cardinality | Content | Description |
---|---|---|---|---|
pnfId | M | 1 | String | unique ID of PNF |
userLabel | M | 1 | String | PNF system name |
subnetId | M | 1 | String | subnet ID of DU network element |
neId | M | 1 | String | network element ID |
managementType | O | 1 | String | |
vendor | O | 1 | String | |
pnfdId | M | 1 | String | |
emsId | M | 1 | String | |
lattitude | O | 1 | String | |
longitude | O | 1 | String |