...
{ "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", "createTime":"2016-07-06 15:33:18" }
Get all VNFM
Interface Definition | Description |
---|---|
URI | /onapapi/aai/esr/v1/vnfms |
Operation Type | GET |
...
[ { "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", "createTime":"2016-07-06 15:33:18" } ]
Update VNFM
Interface Definition | Description |
---|---|
URI | /onapapi/aai/esr/v1/vnfms/{vnfmId} |
Operation Type | PUT |
...
Interface Definition | Description |
---|---|
URI | / onapapiapi/aai /esr/v1/vims-cloudInfrastructure/v1/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id} |
Operation Type | PUT |
Request ParametersBody:
Attribute | Qualifier | Cardinality | Content | Description | name
---|---|---|---|---|
cloudOwner | M | 1 | String | VIM nameCloud owner |
cloudOwnercloudRegionId | M | 1 | String | Cloud ownerregion |
cloudRegionauthInfo | M | 1 | StringObj | Cloud regionAuth information of Cloud |
authInfo:
Attribute | Qualifier | Cardinality | Content | Description |
---|---|---|---|---|
url | M | 1 | String | Access url |
userName | M | 1 | String | User name |
password | M | 1 | String | Password |
tenant | M | 1 | String | Tenant name |
domain | O | 0..1 | String | Domain |
vendor | M | 1 | String | VIM vendor |
version | M | 1 | String | VIM version |
type | M | 1 |
String | VIM type |
Request Sample:
/onapapi/aai/esr/v1/vims
{
"namecloud-owner":"vimowner",
"cloud-ownerregion":"ownerregion-one",
"cloud-regionauthInfo":"region-one", {
"url":"http://10.74.151.13:5000/v2.0", "userName":"admin", "password":"admin", "tenant":"admin", "domain":"", "vendor":"ZTE", "version":"v1.0", "descriptiontype":"openstack",
"type":"openstack"} }
Response:
Success Code: 201
...
Interface Definition | Description |
---|---|
URI | / onapapiapi/aai /esr-cloudInfrastructure/v1/ vims?cloud_owner=xxx&cloud_region=xxxcloud-regions/cloud-region/{cloud-owner}/{cloud-region-id} |
Operation Type | GET |
Request Parameters:
Attribute | Qualifier | Cardinality | Content | Description | cloud_owner|
---|---|---|---|---|---|
cloudOwner | M | 1 | String | Cloud owner | |
cloudRegionId | M | 1 | String | VIM identifierCloud region |
Request Sample:
/onapapiapi/aai/esr-cloudInfrastructure/v1/vims?cloud_owner=owner&cloud_region=cloud-regions/cloud-region/owner/region-one
Response Parameters:
Get all VIM
Response Sample:
Success Code: 201
{
"name":"vim",
...
Interface Definition | Description |
---|---|
URI | /api/aai-cloudInfrastructure/v1/cloud-regions |
Operation Type | GET |
Request Parameters:
N/A
Request Sample:
/onapapi/aai/esr/v1/vims
Response Parameters:
List<VIM>
Response Sample:
Success Code: 201
[
{
"cloud-owner":"owner",
"cloud-region":"region-one",
"url":"http://10.74.151.13:5000/v2.0", "userName":"admin", "password":"admin", "tenant":"admin", "vendor":"ZTE", "version":"v1.0", "description":"", "domain":"", "type":"openstack", "createTime":"2016-07-18 12:22:53"} }]
...
Update VIM
Interface Definition | Description |
---|---|
URI | /onapapi/aai/esr/v1/vims?cloudOwner=xxx&cloudRegionId=xxx |
Operation Type | GETPUT |
Request Parameters:
Attribute |
---|
...
Request Sample:
/onapapi/aai/esr/v1/vims
Response Parameters:
List<VIM>
Response Sample:
Success Code: 201
[
{
"name":"vim",
"cloud-owner":"owner",
"cloud-region":"region-one",
...
Qualifier | Cardinality | Content | Description | |
---|---|---|---|---|
cloudOwner | M | 1 | String | Cloud owner |
cloudRegionId | M | 1 | String | Cloud region |
url | O | 0..1 | String | Access url |
userName | O | 0..1 | String | User name |
password | O | 0..1 | String | Password |
tenant | O | 0..1 | String | Tenant name |
domain | O | 0..1 | String | Domain |
vendor | O | 0..1 | String | VIM vendor |
Request Sample:
/onapapi/aai/esr/v1/vims?cloudOwner=owner&cloudRegionId=region-one
{
"passwordcloudOwner":"adminowner",
"tenantcloudRegionId":"adminregion-one",
"vendorurl":"ZTEhttp://10.74.151.13:5000/v2.0", "versionuserName":"v1.0admin", "descriptionpassword":"admin", "domaintenant":"admin", "typedomain":"openstack", "createTimeversion":"2016-07-18 12:22:53" v2.0" } ]
...
Response:
Success Code: 201
Errorcode: 500 Internal Server Error
Delete VIM
Interface Definition | Description |
---|---|
URI | /onapapi/aai/esr/v1/vims?cloud_ownercloudOwner=xxx&cloud_regioncloudRegionId=xxx |
Operation Type | PUTDELETE |
Request Parameters:
Attribute | Qualifier | Cardinality | Content | Description |
---|---|---|---|---|
namevimId | OM | 0..1 | String | VIM name |
cloudOwner | M | 1 | String | Cloud owner |
cloudRegion | M | 1 | String | Cloud region |
url | O | 0..1 | String | Access url |
userName | O | 0..1 | String | User name |
password | O | 0..1 | String | Password |
tenant | O | 0..1 | String | Tenant name |
domainidentifier |
Request Sample:
/onapapi/aai/esr/v1/vims?cloudOwner=owner&cloudRegionId=region-one
Response:
Success Code: 204
Errorcode: 500 Internal Server Error
SDN Controller
SDN Controller registration
Interface Definition | Description |
---|---|
URI | /onapapi/aai/esr/v1/sdncontrollers |
Operation Type | PUT |
Request Parameters:
Attribute | Qualifier | Cardinality | Content | Description |
---|---|---|---|---|
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 | StringDomain | SDNC description |
vendorproductName | O | 0..1 | String | VIM vendor |
...
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:
/onapapi/aai/esr/v1/sdncontrollers
{ "name":"vimsdn", "cloud-ownerurl":"ownerhttp://10.74.151.13:8181", "cloud-regionuserName":"region-oneadmin", "urlpassword":"http://10.74.151.13:5000/v2"admin", "version":"v1.0", "userNamevendor":"adminZTE", "passworddescription":"admin", "tenantprotocol":"adminnetconf", "domainproductName":"", "versiontype":"v2.0WAN" }
Response:
Success Code: 201
Errorcode: 500 Internal Server Error
...
Get SDN Controller by id
Interface Definition | Description |
---|---|
URI | /onapapi/aai/esr/v1/vims?cloud_owner=xxx&cloud_region=xxx/sdncontrollers/{sdnControllerId} |
Operation Type | DELETEGET |
Request Parameters:
Attribute | Qualifier | Cardinality | Content | Description |
---|---|---|---|---|
vimIdsdnControllerId | M | 1 | String | VIM SDN Controller identifier |
Request Sample:
/onapapi/aai/esr/v1/vims?cloud_owner=owner&cloud_region=region-one
Response:
Success Code: 204
Errorcode: 500 Internal Server Errorsdncontrollers/57674786-5b2e-4c92-bb68-578dbd79e2f5
Response Parameters:
SDN Controller
SDN Controller registration
...
Request Parameters:
...
Request Sample:
/onapapi/aai/esr/v1/sdncontrollers
...
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", }
Response:
Success Code: 201
Errorcode: 500 Internal Server Error
...
"createTime":"2016-07-18 12:22:53"
}
Get all SDN Controller
Interface Definition | Description |
---|---|
URI | /onapapi/aai/esr/v1/sdncontrollers/{sdnControllerId} |
Operation Type | GET |
Request Parameters:
...
N/A
Request Sample:
/onapapi/aai/esr/v1/sdncontrollers/57674786-5b2e-4c92-bb68-578dbd79e2f5
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", "createTime":"2016-07-18 12:22:53" }
...
}
]
Update SDN Controller
Interface Definition | Description |
---|---|
URI | /onapapi/aai/esr/v1/sdncontrollers/{sdnControllerId} |
Operation Type | GETPUT |
Request Parameters:
N/A
Request Sample:
/onapapi/aai/esr/v1/sdncontrollers
Response Parameters:
List<SDN Controller>
Response Sample:
Success Code: 201
...
Attribute | Qualifier | Cardinality | Content | Description |
---|---|---|---|---|
sdnControllerId | M | 1 | String | SDN Controller identifier |
name | O | 0..1 | String | SDN Controller name |
url | O | 0..1 | String | Access url |
vendor | O | 0..1 | String | SDNC vendor |
version | O | 0..1 | String | SDNC version |
description | O | 0..1 | String | SDNC description |
productName | O | 0..1 | String | SDNC productName |
protocol | O | 0..1 | Enum{netconf/snmp} | protocol |
userName | O | 0..1 | String | User name |
password | O | 0..1 | String | Password |
Request Sample:
/onapapi/aai/esr/v1/sdncontrollers/57674786-5b2e-4c92-bb68-578dbd79e2f5
{ "descriptionsdnControllerId":"a6c42529-cd6b-4c01-b149-03eb54b20a03", "name":"sdn", "protocolurl":"netconfhttp://10.74.151.13:8181", "productNameuserName":"admin", "password":"admin", "typeversion":"WANv1.0", "createTimevendor":"2016-07-18 12:22:53""ZTE", }"description":"", ]
Update SDN Controller
...
Request Parameters:
...
Request Sample:
/onapapi/aai/esr/v1/sdncontrollers/57674786-5b2e-4c92-bb68-578dbd79e2f5
{ "sdnControllerId":"a6c42529-cd6b-4c01-b149-03eb54b20a03 "protocol":"netconf", "productName":"" }
Response Parameters:
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", "nameproductName":"sdn", "url":"http://10.74.151.13:8181", "userNametype":"adminWAN", "passwordcreateTime":"admin", "version":"v1.0", "vendor":"ZTE",2016-07-18 12:22:53" "description":"", "protocol":"netconf", "productName":"" }
Response Parameters:
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", "createTime":"2016-07-18 12:22:53" }
Delete SDN Controller
...
Request Parameters:
...
Request Sample:
/onapapi/aai/esr/v1/sdncontrollers/57674786-5b2e-4c92-bb68-578dbd79e2f5
Response:
Success Code: 204
Errorcode: 500 Internal Server Error
EMS
EMS registration
...
}
Delete SDN Controller
Interface Definition | Description |
---|---|
URI | /onapapi/aai/esr/v1/sdncontrollers/{sdnControllerId} |
Operation Type | DELETE |
Request Parameters:
Attribute | Qualifier | Cardinality | Content | Description |
---|---|---|---|---|
sdnControllerId | M | 1 | String | SDN Controller identifier |
Request Sample:
/onapapi/aai/esr/v1/sdncontrollers/57674786-5b2e-4c92-bb68-578dbd79e2f5
Response:
Success Code: 204
Errorcode: 500 Internal Server Error
EMS
EMS registration
Interface Definition | Description |
---|---|
URI | /onapapi/aai/esr/v1/emses |
Operation Type | PUT |
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:
Attribute | Qualifier | Cardinality | Content | Description | emsId||
---|---|---|---|---|---|---|
ftptype | M | 1 | String | UUID generated by esr-server | nameEnum{ftp/sftp} | ftp type |
ip | M | 1 | String | EMS name | vendorservice IP of ftp server | |
port | M | 1 | String | vendor | versionservice port of ftp server | |
user | M | 1 | String | versionftp user name | ||
password | OM | 0..1 | String | descriptionftp password | ||
resourceAddrremotepath | M | 1 | ObjString | Address to get resource data | ||
performanceAddr | M | 1 | Obj | Address to get performance data | ||
alarmAddrresource data file path | ||||||
passive | M | 1 | Obj | Address to get alarm data |
...
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 | resource performance data file path |
passive | M | 1 | Boolean | ftp passive mode or not |
performanceAddr:
...
alarmAddr:
...
Request Sample:
/onapapi/aai/esr/v1/emses
...
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:
/onapapi/aai/esr/v1/emses
{
  "emsName": "EMS_TEST",
"version":"v1.0",
"vendor":"ZTE",
"description":"",
"createTime":"2016-07-18 12:22:53"
  "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",
...
  "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"
  }
},
    "user": "root",
    "password": "test"
  }
}
Get EMS by id
Interface Definition | Description |
---|---|
URI | /onapapi/aai/esr/v1/emses/{emsId} |
Operation Type | GET |
Request Parameters:
Attribute | Qualifier | Cardinality | Content | Description |
---|---|---|---|---|
emsId | M | 1 | String | EMS identifier |
Request Sample:
/onapapi/aai/esr/v1/emses/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee
Response Parameters:
EMS
Response Sample:
...
  "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 | /onapapi/aai/esr/v1/emses/{emsId}emss |
Operation Type | GET |
Request Parameters:
...
N/A
Request Sample:
/onapapi/aai/esr/v1/emses/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee/emss
Response Parameters:
List<EMS>
Response Sample:
Success Code: 201
[
{
  "emsId": "19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
  "emsName": "EMS_TEST",
"version":"v1.0",
"vendor":"ZTE",
"description":"",
"createTime":"2016-07-18 12:22:53"
  "
...
resouce": {
    "ftptype": "ftp",
    "ip": "10.44.55.145",
    "port": "2000",
    "user": "root",
    "password": "test",
    "remotepath": "/opt/res/data/",
    "passive": true
  },
  "
...
performance": {
    "ftptype": "ftp",
    "ip": "10.44.55.145",
    "port": "2000",
    "user": "root",
    "password": "test",
    "remotepath": "/opt/Gcp/data/",
    "passive": true
  },
  "
...
alarm": {
    "ip": "10.44.55.145",
    "port": 2000,
    "user": "root",
    "password": "test"
  }
}
...
Get all EMS
...
Request Parameters:
N/A
Request Sample:
/onapapi/aai/esr/v1/emss
Response Parameters:
List<EMS>
Response Sample:
Success Code: 201
[
{
  "emsId": "19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
  "emsName": "EMS_TEST",
"version":"v1.0",
"vendor":"ZTE",
"description":"",
"createTime":"2016-07-18 12:22:53"
  "resouce": {
    "ftptype": "ftp",
    "ip": "10.44.55.145",
    "port": "2000",
    "user": "root",
    "password": "test",
    "remotepath": "/opt/res/data/",
    "passive": true
  },
  "performance": {
    "ftptype": "ftp",
    "ip": "10.44.55.145",
    "port": "2000",
    "user": "root",
    "password": "test",
    "remotepath": "/opt/Gcp/data/",
    "passive": true
  },
  "alarm": {
    "ip": "10.44.55.145",
    "port": 2000,
    "user": "root",
    "password": "test"
  }
}
]
Update EMS
...
]
Update EMS
Interface Definition | Description |
---|---|
URI | /onapapi/aai/esr/v1/emses/{emsId} |
Operation Type | PUT |
Request Parameters:
Attribute | Qualifier | Cardinality | Content | Description |
---|---|---|---|---|
emsId | M | 1 | String | EMS identifier |
name | O | 0..1 | String | EMS name |
vendor | O | 0..1 | String | Vendor |
version | O | 0..1 | String | version |
description | O | 0..1 | 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 |
---|---|---|---|---|
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 | resource data file path |
passive | O | 0..1 | 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 | emsId||
---|---|---|---|---|---|---|
ip | MO | 0..1 | String | EMS identifier | nameservice 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 | EMS name | ||
vendor | O | 0..1 | String | Vendor | ||
version | O | 0..1 | String | version | ||
description | O | 0..1 | 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:
...
performanceAddr:
...
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 passwordftp password |
Request Sample:
/onapapi/aai/esr/v1/emses/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee
{
  "emsId": "19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
  "emsName": "EMS_TEST",
"version":"v1.0",
"vendor":"ZTE",
"description":"",
"createTime":"2016-07-18 12:22:53"
  "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:
Success Code: 201
Errorcode: 500 Internal Server Error
Delete EMS
Interface Definition | Description |
---|---|
URI | /onapapi/aai/esr/v1/emses/{emsId} |
Operation Type | DELETE |
Request Parameters:
Attribute | Qualifier | Cardinality | Content | Description |
---|---|---|---|---|
emsId | M | 1 | String | EMS identifier |
Request Sample:
/onapapi/aai/esr/v1/emses/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee
Response:
Success Code: 204
Errorcode: 500 Internal Server Error
Other
Get basic info by id
Interface Definition | Description |
---|---|
URI | /onapapi/aai/esr/v1/common/{instanceId} |
Operation Type | GET |
Request Parameters:
Attribute | Qualifier | Cardinality | Content | Description |
---|---|---|---|---|
instanceId | M | 1 | String | External system identifier |
Request Sample:
/onapapi/aai/esr/v1/emsescommon/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee
Response Parameters:
Attribute | Content | Description |
---|---|---|
instanceId | String | External system identifier(UUID) |
category | Enum{ |
...
  "emsName": "EMS_TEST",
"version":"v1.0",
"vendor":"ZTE",
"description":"",
"createTime":"2016-07-18 12:22:53"
  "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:
Success Code: 201
Errorcode: 500 Internal Server Error
Delete EMS
...
VIM/VNFM/SDNC/EMS} | External system category | |
name | String | External system name |
description | String | External system description |
version | String | External system version |
vendor | String | External system vendor |
type | String | External system type |
createTime | String | Create time |
Response Sample:
{
"instanceId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
"category":"VNFM",
"name":"vnfm",
"description":"",
"version":"v1.0",
"vendor":"ZTE",
"type":"Tacker",
"createTime":"2016-07-18 12:22:53"
}
Information elements
VNFM
Attribute | Content | Description |
---|---|---|
vnfmId | String | VNFM identifier(UUID) |
name | String | VNFM name |
description | String | VNFM description |
version | String | VNFM version |
vendor | String | VNFM vendor |
type | String | VNFM type |
url | String | Access url |
userName | String | User name |
password | String | Password |
createTime | String | Create time |
vimId | String | Related VIM |
certificateUrl | String | VNFM certificate url |
VIM
Attribute | Qualifier | Cardinality | Content | Description |
---|
cloudOwner | M | 1 | String |
Request Sample:
/onapapi/aai/esr/v1/emses/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee
Response:
Success Code: 204
Errorcode: 500 Internal Server Error
Other
Get basic info by id
Interface Definition | Description |
---|---|
URI | /onapapi/aai/esr/v1/common/{instanceId} |
Operation Type | GET |
Request Parameters:
Attribute | Qualifier | Cardinality | Content | Description |
---|---|---|---|---|
instanceId | M | 1 | String | External system identifier |
Request Sample:
/onapapi/aai/esr/v1/common/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee
Response Parameters:
Attribute | Content | Description |
---|---|---|
instanceId | String | External system identifier(UUID) |
category | Enum{VIM/VNFM/SDNC/EMS} | External system category |
name | String | External system name |
description | String | External system description |
version | String | External system version |
vendor | String | External system vendor |
type | String | External system type |
createTime | String | Create time |
Response Sample:
{
"instanceId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
"category":"VNFM",
"name":"vnfm",
"description":"",
"version":"v1.0",
"vendor":"ZTE",
"type":"Tacker",
"createTime":"2016-07-18 12:22:53"
}
Information elements
VNFM
...
VIM
Cloud owner | ||||
cloudRegionId | M | 1 | String | Cloud region |
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[] | |
tenants | O | 0...1 | object[] | |
flavors | O | 0...1 | object[] | |
group-assignments | O | 0...1 | object[] | |
snapshots | O | 0...1 | object[] | |
images | O | 0...1 | object[] | |
availability-zones | O | 0...1 | object[] | |
relationship-list | O | 0...1 | object[] | |
authInfo | M | 1 | Obj | Auth information of Cloud |
volume-group
Attribute | Qualifier | Cardinality | Content | Description |
---|---|---|---|---|
volume-group-id | M | 1 | String | Unique ID of volume-group. |
volume-group-name | M | 1 | String | Name of the volume group. |
heat-stack-id | O | 0...1 | String | Heat stack id corresponding to this volume-group |
vnf-type | M | 1 | String | String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
orchestration-status | O | 0...1 | String | Orchestration status of this volume-group |
resource-version | O | 0...1 | String | Used for optimistic concurrency. Must be empty on create, valid on update and delete. |
relationship-list | O | 0...1 | object[] |
authInfo:
Attribute | Qualifier | Cardinality | Content | Description |
---|---|---|---|---|
url | M | 1 | String | Access url |
userName | M | 1 | String | User name |
password | M | 1 | String | Password |
tenant | M | 1 | String | Tenant name |
domain | O | 0..1 | String | Domain |
vendor | M | 1 | String | VIM vendor |
version | M | 1 | String | VIM version |
type | M | 1 | String | VIM type |
SDN Controller
Attribute | Content | Description |
---|---|---|
sdnControllerId(UUID) | String | SDN Controller identifier |
name | String | SDN Controller name |
description | String | description |
version | String | version |
vendor | String | vendor |
type | Enum{WAN/DC} | SDN Controller type |
url | String | Access url |
userName | String | User name |
password | String | Password |
createTime | String | Create time |
protocol | Enum{netconf/snmp} | protocol |
productName | String | productName |
location | String | only fit for DC type |
...