Table of Contents

VIM

VIM registration

...

Interface Definition	Description
URI	/api/aai-esr-cloudInfrastructureserver/v1/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}	Operation Type	PUT vims
Operation Type	POST

Request Body:

Attribute	Qualifier	CardinalityDefault	Content	Description
cloud-ownercloudOwner	M	1		String	Cloud owner	cloud-regionIdcloud owner name, can be customized, e.g. att-aic
cloudRegionId	M	1		String	Cloud region	auth-infocloud region info based on deployment, e.g. RegionOne
cloudType	M	1	Obj	Auth information of Cloud

authInfo:

...

Request Sample:
/api/aai-cloudInfrastructure/v1/cloud-regions/cloud-region/owner/region-one

Body:

{

"cloud-owner":"owner",

...

	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

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
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-cloudInfrastructureesr-server/v1/cloud-regions/cloud-region/{cloud-ownervims/{cloudOwner}/{cloud-region-idcloudRegionId}
Operation Type	GETPUT

Request ParametersBody:

cloudOwner1

Attribute	Qualifier	CardinalityDefault	Content	Description
cloudType	M			String	Cloud owner
cloudRegionId	M	1	String	Cloud region

Request Sample:
/api/aai-cloudInfrastructure/v1/cloud-regions/cloud-region/owner/region-one

Response Parameters:

VIM

Get all VIM

...

Request Parameters:
N/A

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

Response Parameters:
List<VIM>

Delete VIM

...

Request Parameters:

...

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

Response:

Success Code: 204

Errorcode: 500 Internal Server Error

VNFM

VNFM registration (Update VNFM info)

...

Request Parameters:

...

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

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

Get VIM

Interface Definition	Description
URI	/api/aai-esr-server/v1/vims/{cloudOwner}/{cloudRegionId}
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-vnfmesr-server/v1/vnfmsvims/vnfmZTE/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

region-one

Response Parameters:

VIM

Get all VIM

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

Request Parameters:
N/A

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}/{cloudRegionId}
Operation Type	DELETE

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
vimId	M	1	String	VIM identifier

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

Response:

Success Code: 204

Errorcode: 500 Internal Server Error

VNFM

VNFM registration

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

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

Body:

       "name":"vnfm",

       "type":"Tacker",
       "vimId":"",
       "vendor":"ZTE",
       "version":"v1.0",
       "descriptionurl":"vnfmhttp://10.74.44.11",
       "certificateUrl":"",
       "urluserName":"http://10.74.44.11admin",
       "userNamepassword":"admin",

   }

Response:

       "passwordvnfmId":"admin19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
   }

...

}

Success Code: 200

Errorcode: 500 Internal Server Error

VNFM update

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

Request Parameters:
N/A

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

Response Parameters:
List<VNFM>

Response Sample:

Success Code: 201

...

Attribute	Qualifier	Cardinality	Content	Description
name	M	1	String	VNFM name
type	M	1	String	VNFM type
vimId	O	0..1	String	Related VIM
vendor	M	1	String	VNFM vendor
version	M	1	String	VNFM version
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":"",
   
       "urluserName":"http://10.74.44.11admin",
           "userNamepassword":"admin",
           "password":"admin"
       }
   ]

...

Response:

Success Code: 200

Errorcode: 500 Internal Server Error

Get VNFM

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

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
vnfmId	M	1	String	VNFM identifier

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

Response Parameters:
VNFM

Response Sample:

Success Code: 204

Errorcode: 500 Internal Server Error

SDN Controller

SDN Controller registration (Update SDN Controller info)

...

Request Parameters:

...

sdnControllerId

...

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

...

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

Get all VNFM

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

Request Parameters:
N/A

Request Sample:
/api/aai-esr-server/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",
           "certificateUrl":"",
           "url":"http://10.74.44.11",
           "userName":"admin",
           "password":"admin"
       }
   ]

Delete VNFM

Interface Definition	Description
URI	/api/aai-sdncontrolleresr-server/v1/sdncontrollers/sdncontrollervnfms/{sdnControllerIdvnfmId}
Operation Type	GETDELETE

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
sdnControllerIdvnfmId	M	1	String	SDN Controller VNFM identifier

Request Sample:
/api/aai-sdncontrolleresr-server/v1/sdncontrollersvnfms/sdncontroller/5767478619ecbb3a-5b2e3242-4c924fa3-bb689926-578dbd79e2f58dfb7ddc29ee

Response Parameters::

Success Code: 204

Errorcode: 500 Internal Server Error

SDN Controller

...

Response Sample:

Success Code: 201

...

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

...

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

...

"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

Interface Definition	Description
URI	/api/aai-esr-sdncontrollerserver/v1/sdncontrollersemses/sdncontroller/{sdnControllerIdemsId}
Operation Type	DELETEGET

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
sdnControllerIdemsId	M	1	String	SDN Controller EMS identifier

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

Response:

Success Code: 204

Errorcode: 500 Internal Server Error

EMS

EMS registration (Update EMS info)

...

Request Parameters:

...

resourceAddr:

...

performanceAddr:

...

alarmAddr:

...

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-emsesr-server/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"

}

...

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

emsId


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

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"

}

...

	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/emsespnfs/{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/emsespnfs/dafdaf3213dfa

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"

}

]

...

: 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

Stringcloud-ownercloud-region-idextra-info.0...owner-defined-type.cloud-region-version.

Attribute	Qualifier	Cardinality	Content	Description
vnfmId	O	0..1	String	VNFM UUID generated by ESR	name	M	1
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..name
type	M	1	StringUser	nameVNFM type
passwordvimId	O	0..1	String	Password	Related VIM
Attribute	Qualifier	Cardinality	Content	Description
vendor	M	1	String	Cloud owner	VNFM vendor
version	M	1	String	Cloud region	VNFM version
certificateUrl	O	0..	1	String	Extra information of Cloud	cloud-type	O	certificate url
url	M	1	String	Type of the cloud (e.g., openstack)	Access url
userName	O	0	..1	String	Cloud-owner defined type indicator	User 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
authInfo	M	1	Obj	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	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

urluserNameMtenant

Attribute	Qualifier	Cardinality	Content	Description
sdnControllerId	M	1	String	Access url	UUID of sdncontroller
name	M	1	String	User SDN Controller namepassword
location	O	1	String	Password	fit for DC type
url	M	1	String	Tenant name
domain	O	0..1	String	Domain
Access url
vendor	M	1	String	VIM SDNC vendor
version	M	1	String	VIM SDNC version
typedescription	MO	0..1	String	VIM type

SDN Controller

locationO

Attribute	Qualifier	Cardinality	Content	Description
sdnControllerId	SDNC description
productName	O	0..1	String	SDNC productName
protocol	M	1	String	UUID of sdncontroller	nameEnum{netconf/snmp}	protocol
userName	M	1	String	SDN Controller User name
password	M	1	String	fit for DC type
url	M	1	String	Access url
vendor	Password
type	M	1	Enum{WAN/DC}	SDN Controller type

EMS

Attribute	Qualifier	Cardinality	Content	Description
emsId	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

versiondescriptiondescriptionresourceAddrperformanceAddralarmAddr

Attribute	Qualifier	Cardinality	Content	Description
emsId	M	1	String	EMS identifier
name	ftptype	O	0..1	String	EMS name	vendorEnum{ftp/sftp}	ftp type
ip	O	0..1	String	Vendor	service IP of ftp server
port	O	0..1	String	version	service port of ftp server
user	O	0..1	String	ftp user name
password	O	0..1	Obj	Address to get resource data	String	ftp password
remotepath	O	0..1	Obj	Address to get performance data	String	resource data file path
passive	O	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

resource

performance data file path
passive	O	0..1	Boolean	ftp passive mode or not

...

alarmAddr

Attribute	Qualifier	Cardinality	Content	Description

ftptypeip

ip

O

0..1

Enum{ftp/sftp}ftp type

String	service IP of ftp server
port	O	0..1	String	service

IP

port of ftp server

port

user

O

0..1

String

service port of

ftp

server

user name

user

password

O

0..1

String

ftp

user namepasswordO0..1Stringftp passwordremotepathO0..1Stringperformance data file pathpassiveO0..1Booleanftp 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 passwordpassword

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

Page Comparison

Versions Compared

Old Version 26

New Version Current

Key

VIM

VIM registration

Update VIM info

Get all VIM

Delete VIM

VNFM

VNFM registration (Update VNFM info)

Get VIM

Get all VIM

Delete VIM

VNFM

VNFM registration

VNFM update

Get VNFM

SDN Controller

SDN Controller registration (Update SDN Controller info)

Get all VNFM

Delete VNFM

SDN Controller

SDN Controller

registration

Get all SDN Controller

Update SDN Controller info

Get SDN Controller

Get all SDN Controller

Delete SDN Controller

EMS

EMS registration

Update EMS info

Get EMS by id

EMS

EMS registration (Update EMS info)

Get all EMS

Delete EMS

PNF

PNF registration

Update PNF info

Get PNF by ID

Get all PNF

Delete PNF

Information elements

VNFM

VIM

SDN Controller

SDN Controller

EMS

resourceAddr

performanceAddr

alarmAddr

alarmAddr

PNF