...
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:
/onapapi/aai/esr/v1/vnfms
{
"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 Parameters:
Success Code: 201
Errorcode: 500 Internal Server Error
Get VNFM
...
Response Sample:
...
by id
Interface Definition | Description |
---|---|
URI | /onapapi/aai/esr/v1/vnfms/{vnfmId} |
Operation Type | GET |
Request Parameters:
Attribute | Qualifier | Cardinality | Content | Description |
---|---|---|---|---|
vnfmId | 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
{ "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", "certificateUrluserName":"admin", "userNamepassword":"admin", "passwordcreateTime":"admin", "createTime":"2016-07-06 15:33:18" }
Get all VNFM
...
Interface Definition | Description |
---|---|
URI | /onapapi/aai/esr/v1/vnfms/{vnfmId} |
Operation Type | GET |
Request Parameters:
...
N/A
Request Sample:
/onapapi/aai/esr/v1/vnfms/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":"", "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 | GETPUT |
Request Parameters:
N/A
Request Sample:
/onapapi/aai/esr/v1/vnfms
Response Parameters:
List<VNFM>
Response Sample:
...
Attribute | Qualifier | Cardinality | Content | Description |
---|---|---|---|---|
vnfmId | M | 1 | String | VNFM identifier |
name | O | 0..1 | String | VNFM name |
vendor | O | 0..1 | String | VNFM vendor |
url | O | 0..1 | String | Access url |
userName | O | 0..1 | String | User name |
password | O | 0..1 | String | Password |
Request Sample:
/onapapi/aai/esr/v1/vnfms/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee
{ "vnfmId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee", "name":"vnfm", "type":"Tacker", "vimId":"", "vendor":"ZTE", "versionurl":"v1.0http://10.74.44.11", "descriptionuserName":"vnfmadmin", "certificateUrlpassword":"admin", "url":"http://10.74.44.11", "userName":"admin", "password":"admin", "createTime":"2016-07-06 15:33:18" } ]
...
}
Response Parameters:
Success Code: 201
Errorcode: 500 Internal Server Error
Delete VNFM
Interface Definition | Description |
---|---|
URI | /onapapi/aai/esr/v1/vnfms/{vnfmId} |
Operation Type | PUTDELETE |
Request Parameters:
Attribute | Qualifier | Cardinality | Content | Description |
---|---|---|---|---|
vnfmId | M | 1 | String | VNFM identifier |
name | O | 0..1 | String | VNFM name |
vendor | O | 0..1 | String | VNFM vendor |
url | O | 0..1 | String | Access url |
userName | O | 0..1 | String | User name |
password | O | 0..1 | String | Password |
Request Sample:
/onapapi/aai/esr/v1/vnfms/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee
{ "vnfmId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee", "name":"vnfm", "vendor":"ZTE", "url":"http://10.74.44.11", "userName":"admin", "password":"admin" }
Response Parameters:
VNFM
Response Sample:
{ "vnfmId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee", "name":"vnfm", "type":"Tacker", "vimId":"", "vendor":"ZTE", "version":"v1.0", "description":"vnfm", "url":"http://10.74.44.11", "userName":"admin", "password":"admin", "createTime":"2016-07-06 15:33:18" }
Delete VNFM
...
Request Parameters:
...
Request Sample:
/onapapi/aai/esr/v1/vnfms/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee
Response Parameters:
N/A
Response Sample:
N/A
VIM
VIM registration
...
Request Parameters:
...
Request Sample:
/onapapi/aai/esr/v1/vims
{
"name":"vim",
"cloud-owner":"owner",
"cloud-region":"region-one", "url":"http://10.74.151.13:5000/v2.0", "userName":"admin", "password":"admin", "tenant":"admin", "domain":"", "vendor":"ZTE", "version":"v1.0", "description":"", "type":"openstack" }
Response Parameters:
VIM
Response Sample:
Response:
Success Code: 204
Errorcode: 500 Internal Server Error
VIM
VIM registration
Interface Definition | Description |
---|---|
URI | /onapapi/aai/esr/v1/vims |
Operation Type | PUT |
Request Parameters:
Attribute | Qualifier | Cardinality | Content | Description |
---|---|---|---|---|
name | M | 1 | String | VIM name |
cloudOwner | M | 1 | String | Cloud owner |
cloudRegion | M | 1 | String | Cloud region |
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 |
description | O | 0..1 | String | VIM description |
type | M | 1 | Enum{openstack/vmware} | VIM type |
Request Sample:
/onapapi/aai/esr/v1/vims
{ "name":"vim",
"cloud-owner":"owner",
"cloud-region":"region-one", "url":"http://10.74.151.13:5000/v2.0", "userName":"admin", "password":"admin", "tenant":"admin", "vendordomain":"ZTE", "versionvendor":"v1.0ZTE", "descriptionversion":"v1.0", "domaindescription":"", "type":"openstack", "createTime":"2016-07-18 12:22:53" } }
Response:
Success Code: 201
Errorcode: 500 Internal Server Error
Get VIM by conditions
Interface Definition | Description |
---|---|
URI | /onapapi/aai/esr/v1/vims?cloud_owner=xxx&cloud_region=xxx |
Operation Type | GET |
...
Response Parameters:
VIM
Response Sample:
Success Code: 201
{ "name":"vim",
"cloud-owner":"owner",
...
Response Parameters:
List<VIM>
Response Sample:
[
{
"name":"vim",
"cloud-owner":"owner",
"cloud-region":"region-one",
...
Sample:
Success Code: 201
[ "userName":"admin",{ "passwordname":"adminvim",
"tenantcloud-owner":"adminowner",
"vendorcloud-region":"ZTEregion-one",
"versionurl":"v1http://10.74.151.13:5000/v2.0", "descriptionuserName":"admin", "domainpassword":"admin", "typetenant":"openstackadmin", "createTime":"2016-07-18 12:22:53" "vendor":"ZTE", } ]
Update VIM
...
Request Parameters:
...
"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?cloud_owner= |
...
xxx&cloud_region= |
...
{
"name":"vim",
"cloud-owner":"owner",
"cloud-region":"region-one",
"url":"http://10.74.151.13:5000/v2.0", "userName":"admin", "password":"admin", "tenant":"admin", "domain":"", "version":"v2.0" }
Response Parameters:
VIM
Response Sample:
{
"name":"vim",
"cloud-owner":"owner",
"cloud-region":"region-one",
...
xxx | |
Operation Type | PUT |
Request Parameters:
Attribute | Qualifier | Cardinality | Content | Description |
---|---|---|---|---|
name | O | 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 |
domain | O | 0..1 | String | Domain |
vendor | O | 0..1 | String | VIM vendor |
Request Sample:
/onapapi/aai/esr/v1/vims?cloud_owner=owner&cloud_region=region-one
{
"name":"vim",
"cloud-owner":"owner",
"tenantcloud-region":"adminregion-one",
"vendorurl":"ZTEhttp://10.74.151.13:5000/v2.0", "versionuserName":"v2.0admin", "descriptionpassword":"admin", "domaintenant":"admin", "typedomain":"openstack", "createTimeversion":"2016-07-18 12:22:53v2.0" }
Response:
Success Code: 201
Errorcode: 500 Internal Server Error
Delete VIM
Interface Definition | Description |
---|---|
URI | /onapapi/aai/esr/v1/vims?cloud_owner=xxx&cloud_region=xxx |
Operation Type | DELETE |
...
Request Sample:
/onapapi/aai/esr/v1/vims?cloud_owner=owner&cloud_region=region-one
Response Parameters:N/AResponse Sample:
N/A
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 | String | SDNC description |
productName | O | 0..1 | String | SDNC productName |
protocol | M | 1 | Enum{netconf/snmp} | protocol |
userName | ||||
Operation Type | PUT |
Request Parameters:
Attribute | Qualifier | Cardinality | Content | Description | |
---|---|---|---|---|---|
name | M | 1 | String | User SDN Controller namepassword | |
location | MO | 1 | String | Password | typefit for DC type |
url | M | 1 | Enum{WAN/DC} | SDN Controller type |
Request Sample:
/onapapi/aai/esr/v1/sdncontrollers
{ "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 Parameters:
SDN Controller
Response Sample:
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:
/onapapi/aai/esr/v1/sdncontrollers
{ "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:53WAN" }
Response:
Success Code: 201
Errorcode: 500 Internal Server Error
Get SDN Controller by id
Interface Definition | Description |
---|---|
URI | /onapapi/aai/esr/v1/sdncontrollers/{sdnControllerId} |
Operation Type | GET |
...
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" }
...
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" } ]
...
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.13:8181", "vendoruserName":"ZTEadmin", "descriptionpassword":"admin", "protocolversion":"netconfv1.0", "productNamevendor":"ZTE", "typedescription":"WAN", "createTimeprotocol":"2016-07-18 12:22:53""netconf", }
Delete SDN Controller
...
Request Parameters:
...
Request Sample:
/onapapi/aai/esr/v1/sdncontrollers/57674786-5b2e-4c92-bb68-578dbd79e2f5
Response Parameters:
N/A
Response Sample:
N/A
EMS
EMS registration
...
Request Parameters:
...
"productName":"",
"type":"WAN",
"createTime":"2016-07-18 12:22:53"
}
Delete SDN Controller
Interface Definition | Description |
---|---|
URI | /onapapi/aai/esr/v1/sdncontrollers/{sdnControllerId} |
Operation Type | DELETE |
Request Parameters:
Attribute | Qualifier | Cardinality | Content | Description |
---|---|---|---|---|
ftptypesdnControllerId | M | 1Enum{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 |
...
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 | ftptype|||
---|---|---|---|---|---|---|---|
emsId | M | 1 | String | UUID generated by esr-server | |||
name | M | 1 | Enum{ftp/sftp} | ftp type | ipString | EMS name | |
vendor | M | 1 | String | service IP of ftp server | portvendor | ||
version | M | 1 | String | service port of ftp server | user | M | version |
description | O | 0..1 | String | ftp user namedescription | |||
passwordresourceAddr | M | 1 | String | ftp password | remotepathObj | Address to get resource data | |
performanceAddr | M | 1 | StringObj | Address to get performance data file path | |||
passivealarmAddr | M | 1 | Boolean | ftp passive mode or not |
...
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 |
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:
...
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:
/onapapi/aai/esr/v1/emses
{
"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"
}
}
Get EMS by id
...
Request Parameters:
...
Request Sample:
/onapapi/aai/esr/v1/emses/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee,
"user": "root",
"password": "test"
}
}
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
...
EMS by id
Interface Definition | Description |
---|---|
URI | /onapapi/aai/esr/v1/emssemses/{emsId} |
Operation Type | GET |
Request Parameters:N/A
Attribute | Qualifier | Cardinality | Content | Description |
---|---|---|---|---|
emsId | M | 1 | String | EMS identifier |
Request Sample:
/onapapi/aai/esr/v1/emss/emses/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee
Response Parameters:
List<EMS>
Response Sample:
[
{
"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"
}
}
]
...
Get all EMS
Interface Definition | Description |
---|---|
URI | /onapapi/aai/esr/v1/emses/{emsId}emss |
Operation Type | PUTGET |
Request Parameters:
...
resourceAddr:
...
performanceAddrN/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
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 | ip||
---|---|---|---|---|---|---|
ftptype | O | 0..1 | String | service IP of ftp server | portEnum{ftp/sftp} | ftp type |
ip | O | 0..1 | String | service port IP of ftp server | ||
user | O | 0..1 | String | ftp user name | ||
password | O | 0..1 | String | ftp 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 Parameters:
EMS
Response Sample:
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 |
---|---|---|---|---|
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 |
Request Sample:
/onapapi/aai/esr/v1/emses/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee
{
"emsId": "19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
...
"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 Sample:
/onapapi/aai/esr/v1/emses/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee
Response Parameters:N/AResponse Sample:
N/A
Success Code: 204
Errorcode: 500 Internal Server Error
Other
Get basic info by id
...