Table of Contents

VNFM

VNFM registration (Update VNFM)

Interface Definition	Description
URI	/onapapiapi/aai/esr-vnfm/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:
/onapapiapi/aai-vnfm/esr/v1/vnfms/vnfm/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee

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

...

Errorcode: 500 Internal Server Error

Get VNFM

...

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

Request Parameters:

...

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

Request Parameters:
N/A

...

 [
       {
           "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	/onapapiapi/aai-vnfm/esr/v1/vnfms/vnfm/{vnfmId}
Operation Type	PUTDELETE

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

VIM

VIM registration(Update VIM)

Interface Definition	Description
URI	/api/aai-cloudInfrastructure/v1/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}
Operation Type	PUT

Request Body:

Attribute	Qualifier	Cardinality	Content	Description
cloud-owner	M	1	String	Cloud owner
cloud-regionId	M	1	String	Cloud region
auth-info	M	1	Obj	Auth information of Cloud

authInfo:

Attribute	Qualifier	Cardinality	Content	Description
url	M	1	String	Access url
userName	M	1
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	OM	0..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:
/api/aai-cloudInfrastructure/v1/cloud-regions/cloud-region/owner/region-oneRequest Sample:
/onapapi/aai/esr/v1/vnfms/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee

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

       "namecloud-region":"vnfmregion-one",


       "vendorauthInfo": {

"ZTE",
       "url":"http://10.74.44.11.151.13:5000/v2.0",
       "userName":"admin",
       "password":"admin",
   }

Response Parameters:

Success Code: 201

Errorcode: 500 Internal Server Error

...

    "tenant":"admin",
       "domain":"",
       "vendor":"ZTE",
       "version":"v1.0",
       "type":"openstack"

       }
   }

Response:

Success Code: 201

Errorcode: 500 Internal Server Error

Get VIM

Interface Definition

Description

URI

/

onapapi

api/aai

/esr/v1/vnfms/{vnfmId

-cloudInfrastructure/v1/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}

Operation Type

DELETEGET

Request Parameters:

vnfmIdVNFM identifier

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

Request Sample:
/onapapiapi/aai-cloudInfrastructure/esr/v1/vnfmscloud-regions/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee

Response:

Success Code: 204

Errorcode: 500 Internal Server Error

VIM

...

cloud-region/owner/region-one

Response Parameters:

VIM

Get all VIM

Interface Definition	Description
URI	/api/aai-cloudInfrastructure/v1/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}
Operation Type	PUTGET

Request BodyParameters:

...

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

       "authInfo": {

       "url":"http://10.74.151.13:5000/v2.0",
       "userName":"admin",
       "password":"admin",
       "tenant":"admin",
       "domain":"",
       "vendor":"ZTE",
       "version":"v1.0",

authInfo:

...

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

       "cloud-owner":"owner",

       "cloud-regiontype":"region-oneopenstack",

       "authInfo": {}

       "url":"http://10.74.151.13:5000/v2.0",}
       "userName":"admin",
       "password":"admin",
       "tenant":"admin",
       "domain":"",
       "vendor":"ZTE",
       "version":"v1.0",
       "type":"openstack"

       }
   }

Response:

Success Code: 201

Errorcode: 500 Internal Server Error

...

Delete VIM

Interface Definition	Description
URI	/onapapi/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:
/onapapi/aai/esr/v1/vims?cloudOwner=owner&cloudRegionId=region-one

Response:

Success Code: 204

Errorcode: 500 Internal Server Error

SDN Controller

SDN Controller registration (Update SDN Controller)

Interface Definition	Description
URI	/api/aai-cloudInfrastructuresdncontroller/v1/cloud-regions/cloud-regionsdncontrollers/sdncontroller/{cloud-owner}/{cloud-region-id}sdnControllerId}
Operation Type	PUT	Operation Type	GET

Request Parameters:

cloudOwnercloudRegionId

Attribute	Qualifier	Cardinality	Content	Description
sdnControllerId	M	1	String	Cloud owner	UUID of sdncontroller
name		M	1	String	Cloud region

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

Response Parameters:

VIM

Get all VIM

...

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}

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

       "authInfo": {

       "url":"http://10.74.151.13:5000/v2.0",
       "userName":"admin",
       "passwordsdnControllerId":"admina6c42529-cd6b-4c01-b149-03eb54b20a03",


       "tenantname":"adminsdn",
       "domainurl":"",
http://10.74.151.13:8181",
       "vendoruserName":"ZTEadmin",
       "versionpassword":"v1.0admin",
       "typeversion":"openstack"v1.0",
       }

       }
   ]

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

SDN Controller

SDN Controller registration

...

Request Parameters:

...

"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

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:

Success Code: 201

Errorcode: 500 Internal Server Error

Get SDN Controller by id

...

Request Parameters:

...

Request Sample:
/onapapi/aai/esr/v1/sdncontrollers/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",
       "createTime":"2016-07-18 12:22:53"
   }

Get all SDN Controller

...

Request Parameters:
N/A

Request Sample:
/onapapi/aai/esr/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",
           "createTime":"2016-07-18 12:22:53"
       }
   ]

Update SDN Controller

...

Request Parameters:

...

Request Sample:
/onapapi/aai/esr/v1/sdncontrollers/57674786-5b2e-4c92-bb68-578dbd79e2f5578dbd79e2f5

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

   }

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",
           "createTime":"2016-07-18 12:22:53"
       }
   ]

Delete SDN Controller

Interface Definition	Description
URI	/onapapiapi/aai/esr-sdncontroller/v1/sdncontrollers/sdncontroller/{sdnControllerId}
Operation Type	DELETE

...

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

...

Interface Definition	Description
URI	/onapapiapi/aai-ems/esr/v1/emses/ems/{emsId}
Operation Type	PUT

Request Parameters:

...

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:

/onapapiapi/aai/esr-ems/v1/emses/ems/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:

{

"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 EMS by id

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

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
emsId	M	1	String	EMS identifier

Request Sample:
/onapapiapi/aai/esr-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":"",

...

"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	/onapapiapi/aai-ems/esr/v1/emssemses
Operation Type	GET

Request Parameters:
N/A

Request Sample:
/onapapiapi/aai/esr-ems/v1/emssemses

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"

"resouceresouceAddr": {

"ftptype": "ftp",
"ip": "10.44.55.145",
"port": "2000",
"user": "root",
"password": "test",
"remotepath": "/opt/res/data/",
"passive": true
},

"performanceperformanceAddr": {
"ftptype": "ftp",
"ip": "10.44.55.145",
"port": "2000",
"user": "root",
"password": "test",
"remotepath": "/opt/Gcp/data/",
"passive": true

},

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

...

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	Qualifier	Cardinality	Content	Description
sdnControllerId	M	1	String	UUID of sdncontroller
name	M	1	String

Domain

SDN Controller name

vendor

location

M

O

1

String

VIM vendor

fit for DC type

url

version

M

1

String

VIM version

Access url

type

vendor

M

1

String

VIM type

...

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

AttributeContentDescriptionsdnControllerId(UUID)StringSDN Controller identifiernameStringSDN Controller namedescriptionStringdescriptionversionStringversionvendorStringvendortypeEnum{WAN/DC}SDN Controller typeurlStringAccess urluserName

	String	User name
password	M	1	String	Password

createTime

type

StringCreate time

M

1

protocol

Enum{

netconf

WAN/

snmp

DC}

protocolproductNameStringproductNamelocationStringonly fit for DC

SDN Controller type

EMS

Attribute	Qualifier	Cardinality	Content	Description
emsId	M	1	String	EMS identifier

(UUID)


name	O	0..1	String	EMS name

description


vendor	O	0..1	String

description

Vendor
version	O	0..1	String	version

vendor

description

StringVendorcreateTimeStringCreate timeproductNameStringproduct nameresourceresourceInforesource data access addressperformanceperformanceInfoperformance data access addressalarmalarmInfo

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

alarm data access address

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

Space shortcuts

Page tree

Versions Compared

Old Version 15

New Version 16

Key

VNFM

VNFM registration (Update VNFM)

Get VNFM

Delete VNFM

VIM

VIM registration(Update VIM)

Get VIM

VIM

Get all VIM

Delete VIM

SDN Controller

SDN Controller registration (Update SDN Controller)

Get all VIM

Delete VIM

SDN Controller

SDN Controller registration

Get SDN Controller

Get SDN Controller by id

Get all SDN Controller

Update SDN Controller

Get all SDN Controller

Delete SDN Controller

Get EMS by id

Get all EMS

Update EMS

SDN Controller

EMS

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 15

New Version 16

Key

VNFM

VNFM registration (Update VNFM)

Get VNFM

Delete VNFM

VIM

VIM registration(Update VIM)

Get VIM

VIM

Get all VIM

Delete VIM

SDN Controller

SDN Controller registration (Update SDN Controller)

Get all VIM

Delete VIM

SDN Controller

SDN Controller registration

Get SDN Controller

Get SDN Controller by id

Get all SDN Controller

Update SDN Controller

Get all SDN Controller

Delete SDN Controller

Get EMS by id

Get all EMS

Update EMS

SDN Controller

EMS