...

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

...

Request Sample:
/api/aai-esr-server/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"
}
]
}

...

Errorcode: 500 Internal Server Error

Update VIM info

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

Request Body:

Attribute	Qualifier	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-server/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"
}
]
}

...

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

...

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

Response Parameters:

...

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

...

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

Response Parameters:
List<VIM>

...

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

...

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

...

Errorcode: 500 Internal Server Error

VNFM

VNFM registration

...

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

Request Parameters:

O

Attribute	Qualifier	Cardinality	Content	Description	vnfmId
0..1	String	VNFM UUID generated by ESR	name	M	1	String	VNFM name
type	M	1	String	VNFM type
vimId	O	0..1	String	Related VIM
vendor	M	1	String	VNFM vendor
version	M	1	String	VNFM version
description	O	0..1	String	VNFM description
certificateUrl	O	0..1	String	certificate url
url	M	1	String	Access url
userName	O	0..1	String	User name
password	O	0..1	String	Password

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

Body:

       "vnfmIdname":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29eevnfm",

       "nametype":"vnfmTacker",
       "type":"Tacker",
       "vimId"vimId":"",
       "vendor":"ZTE",
       "version":"v1.0",
       "description":"vnfm",
       "url":"http://10.74.44.11",
       "certificateUrl":"",
       "userName":"admin",
       "password":"admin"
   }

Response:

       "vnfmId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",

}

Success Code: 201

Errorcode: 500 Internal Server Error

...

VNFM update

Interface Definition	Description
URI	/api/aai-

vnfm

esr-server/v1/vnfms/

vnfm/

{vnfmId}

Operation Type

GET

POST

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description

vnfmId

name

M

1

String

VNFM

identifier

name

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

Response Parameters:
VNFM

Response Sample:

Success Code: 201

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

Body:

       "name":"vnfm",

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

Get all VNFM

Response:

Success Code: 201

Errorcode: 500 Internal Server Error

Get VNFM

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

Request Parameters:N/A

Attribute	Qualifier	Cardinality	Content	Description
vnfmId	M	1	String	VNFM identifier

Request Sample:
/onapapiapi/aai/-esr-server/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",
       "typevimId":"Tacker",
       "vendor":"ZTE",
       "vimIdversion":"v1.0",
       "description":"vnfm",
       "vendorcertificateUrl":"ZTE",
       "url":"http://10.74.44.11",
       "version":"v1.0",
           "description":"vnfm",
           "certificateUrl":"",
           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: 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-esr-server/v1/vnfms/{vnfmId}
Operation Type	DELETE

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
vnfmId	M	1	String	VNFM identifier

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

Response:

Success Code: 204

Errorcode: 500 Internal Server Error

SDN Controller

SDN Controller registration

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

Request Parameters:

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

Request Sample:
/api/aai-esr-server/v1/sdncontrollers

Body:

{

"name":"sdn",

"url":"http://10.74.

...

151.

...

13:8181",

"userName":"admin",

...

"password":"admin"

...

,

"version":"v1.0",

"vendor":"ZTE",

"description":"",

"protocol":"netconf",

"productName":"",

"type":"WAN"

}

Response:

body:

{

"sdnControllerId":"a6c42529-cd6b-4c01-b149-03eb54b20a03",

}

Success Code: 201

Delete VNFM

...

Request Parameters:

...

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

Response:

Success Code: 204

Errorcode: 500 Internal Server Error

SDN Controller

...

Error

Update SDN Controller info

...

Interface Definition Description
URI /api/aai-
sdncontroller
esr-server/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{
String protocol, such as 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-esr-sdncontrollerserver/v1/sdncontrollers/sdncontroller/{sdnControllerId}
Body:
{
...
a6c42529-cd6b-4c01-b149-03eb54b20a03
...
Body:
{
"name":"sdn",
"url":"http://10.74.151.13:8181",
...
Interface Definition Description
URI /api/aai-sdncontrolleresr-server/v1/sdncontrollers/sdncontroller/{sdnControllerId}
Operation Type GET
...
Attribute Qualifier Cardinality Content Description
sdnControllerId M 1 String SDN Controller identifier
Request Sample:
/api/aai-esr-sdncontrollerserver/v1/sdncontrollers/sdncontroller/57674786-5b2e-4c92-bb68-578dbd79e2f5
...
Interface Definition Description
URI /api/aai-esr-sdncontrollerserver/v1/sdncontrollers
Operation Type GET
Request Parameters:
N/A
Request Sample:
/api/aai-esr-sdncontrollerserver/v1/sdncontrollers
Response Parameters:
List<SDN Controller>
...
Interface Definition Description
URI /api/aai-sdncontrolleresr-server/v1/sdncontrollers/sdncontroller/{sdnControllerId}
Operation Type DELETE
...
Attribute Qualifier Cardinality Content Description
sdnControllerId M 1 String SDN Controller identifier
Request Sample:
/onapapiapi/aai/-esr-server/v1/sdncontrollers/sdncontroller/57674786-5b2e-4c92-bb68-578dbd79e2f5
...

Space shortcuts

Page tree

Versions Compared

Old Version 29

New Version 30

Key

Update VIM info

VNFM

VNFM registration

VNFM update

Get all VNFM

Get VNFM

Get all VNFM

Delete VNFM

SDN Controller

SDN Controller registration

Delete VNFM

SDN Controller

Update SDN Controller info

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

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

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 29

New Version 30

Key

Update VIM info

VNFM

VNFM registration

VNFM update

Get all VNFM

Get VNFM

Get all VNFM

Delete VNFM

SDN Controller

SDN Controller registration

Delete VNFM

SDN Controller

Update SDN Controller info