This API is only exposed to esr portal.

VIM

VIM registration

Interface Definition	Description
URI	/api/aai-esr/v1/vims
Operation Type	POST

Request Body:

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

authInfoItem:

Attribute	Qualifier	Content	Description
cloudDomain	M	String	domain info for keystone v3
userName	M	String	User name
password	M	String	Password
authUrl	M	String	authentication url of the cloud, e.g. keystone url
ssl-cacert	O	String	ca file content if enabled ssl on auth-url
ssl-insecure	O	Boolean	Whether to verify VIM's certificate

Request Sample:
/api/aai-esr/v1/vims

Body:

{
"cloud-owner": "ZTE",
"status": "active",
"cloud-region-id": "region-one",
"cloud-type": "openstack",
"cloud-region-version": "v1.0",
"owner-defined-type": "owner-defined-type",
"cloud-zone": "cloud zone",
"complex-name": "complex name",
"cloud-extra-info": "cloud-extra-info",
"auth-info-items": [
{
"username": "admin",
"password": "admin",
"auth-url": "http://10.74.151.13:5000/v2.0",
"ssl-cacert": "ssl-cacert",
"ssl-insecure": "true",
"cloud-domain": "cloud-domain"
}
]
}

Response:

Success Code: 201

Errorcode: 500 Internal Server Error

Update VIM info

Interface Definition	Description
URI	/api/aai-esr/v1/vims/{cloudOwner}/{cloudRegionId}
Operation Type	PUT

Request Body:

Attribute	Qualifier	Content	Description
cloudType	M	String	type of the cloud, decides which multicloud plugin to use, openstack or vio
cloudRegionVersion	M	String	cloud version, ocata, mitaka or other
ownerDefinedType	O	String	Cloud-owner defined type indicator (e.g., dcp, lcp)
cloudZone	O	String	Zone where the cloud is homed.
complexName	O	String	complex name for cloud-region instance.
cloudExtraInfo	O	String	extra info for Cloud
authInfoItems	M	[Obj]	Auth information of Cloud

authInfoItem:

Attribute	Qualifier	Content	Description
cloudDomain	M	String	domain info for keystone v3
userName	M	String	User name
password	M	String	Password
authUrl	M	String	authentication url of the cloud, e.g. keystone url
ssl-cacert	O	String	ca file content if enabled ssl on auth-url
ssl-insecure	O	Boolean	Whether to verify VIM's certificate

Request Sample:
/api/aai-esr/v1/vims/ZTE/region-one

{
"status": "active",
"cloud-type": "openstack",
"cloud-region-version": "v1.0",
"owner-defined-type": "owner-defined-type",
"cloud-zone": "cloud zone",
"complex-name": "complex name",
"cloud-extra-info": "cloud-extra-info",
"auth-info-items": [
{
"username": "admin",
"password": "admin",
"auth-url": "http://10.74.151.13:5000/v2.0",
"ssl-cacert": "ssl-cacert",
"ssl-insecure": "ssl-insecure",
"cloud-domain": "cloud-domain"
}
]
}

Get VIM

Interface Definition	Description
URI	/api/aai-esr/v1/vims/{cloud-owner}/{cloud-region-id}
Operation Type	GET

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
cloudOwner	M	1	String	Cloud owner
cloudRegionId	M	1	String	Cloud region

Request Sample:
/api/aai-esr/v1/vims/ZTE/region-one

Response Parameters:

VIM

Get all VIM

Interface Definition	Description
URI	/api/aai-esr/v1/vims
Operation Type	GET

Request Parameters:
N/A

Request Sample:
/api/aai-esr/v1/vims/

Response Parameters:
List<VIM>

Delete VIM

Interface Definition	Description
URI	/api/aai-esr/v1/vims?cloudOwner=xxx&cloudRegionId=xxx
Operation Type	DELETE

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
vimId	M	1	String	VIM identifier

Request Sample:
/api/aai-esr/v1/vims?cloudOwner=owner&cloudRegionId=region-one

Response:

Success Code: 204

Errorcode: 500 Internal Server Error

VNFM

VNFM registration (Update VNFM info)

Interface Definition	Description
URI	/api/aai-esr/v1/vnfms/vnfm/{vnfmId}
Operation Type	PUT

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-vnfm/v1/vnfms/vnfm/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee

Body:

       "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:

Success Code: 201

Errorcode: 500 Internal Server Error

Get VNFM

Interface Definition	Description
URI	/api/aai-vnfm/v1/vnfms/vnfm/{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",
       "userName":"admin",
       "password":"admin",
   }

Get all VNFM

Interface Definition	Description
URI	/api/aai-vnfm/v1/vnfms
Operation Type	GET

Request Parameters:
N/A

Request Sample:
/onapapi/aai/esr/v1/vnfms

Response Parameters:
List<VNFM>

Response Sample:

Success Code: 201

 [
       {
           "vnfmId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
           "name":"vnfm",
           "type":"Tacker",
           "vimId":"",
           "vendor":"ZTE",
           "version":"v1.0",
           "description":"vnfm",
           "certificateUrl":"",
           "url":"http://10.74.44.11",
           "userName":"admin",
           "password":"admin"
       }
   ]

Delete VNFM

Interface Definition	Description
URI	/api/aai-vnfm/v1/vnfms/vnfm/{vnfmId}
Operation Type	DELETE

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
vnfmId	M	1	String	VNFM identifier

Request Sample:
/api/aai-vnfm/v1/vnfms/vnfm/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee

Response:

Success Code: 204

Errorcode: 500 Internal Server Error

SDN Controller

SDN Controller registration (Update SDN Controller info)

Interface Definition	Description
URI	/api/aai-sdncontroller/v1/sdncontrollers/sdncontroller/{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	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-sdncontroller/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

Interface Definition	Description
URI	/api/aai-sdncontroller/v1/sdncontrollers/sdncontroller/{sdnControllerId}
Operation Type	GET

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
sdnControllerId	M	1	String	SDN Controller identifier

Request Sample:
/api/aai-sdncontroller/v1/sdncontrollers/sdncontroller/57674786-5b2e-4c92-bb68-578dbd79e2f5

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"
   }

Get all SDN Controller

Interface Definition	Description
URI	/api/aai-sdncontroller/v1/sdncontrollers
Operation Type	GET

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

Interface Definition	Description
URI	/api/aai-sdncontroller/v1/sdncontrollers/sdncontroller/{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/sdncontroller/57674786-5b2e-4c92-bb68-578dbd79e2f5

Response:

Success Code: 204

Errorcode: 500 Internal Server Error

EMS

EMS registration (Update EMS info)

Interface Definition	Description
URI	/api/aai-ems/v1/emses/ems/{emsId}
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
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-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"

}

Get EMS by id

Interface Definition	Description
URI	/api/aai-ems/v1/emses/ems/{emsId}
Operation Type	GET

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
emsId	M	1	String	EMS identifier

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"

}

Get all EMS

Interface Definition	Description
URI	/api/aai-ems/v1/emses
Operation Type	GET

Request Parameters:
N/A

Request Sample:
/api/aai-ems/v1/emses

Response Parameters:
List<EMS>

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"

}

]

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

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
userName	O	0..1	String	User name
password	O	0..1	String	Password

VIM

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

auth-info-items

Attribute	Qualifier	Cardinality	Content	Description
auth-url	M	1	String	Access url
username	M	1	String	User name
password	M	1	String	Password
default-tenant	M	1	String	Tenant name
cloud-domain	O	0..1	String	Domain

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	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

EMS

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
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

A&AI: External System Operation API Definition

VIM

VIM registration

Update VIM info

Get VIM

Get all VIM

Delete VIM

VNFM

VNFM registration (Update VNFM info)

Get VNFM

Get all VNFM

Delete VNFM

SDN Controller

SDN Controller registration (Update SDN Controller info)

Get SDN Controller

Get all SDN Controller

Delete SDN Controller

EMS

EMS registration (Update EMS info)

Get EMS by id

Get all EMS

Delete EMS

Information elements

VNFM

VIM

auth-info-items

SDN Controller

EMS

resourceAddr

performanceAddr

alarmAddr