Page History

...

Request Sample:
/onapapi/aai/esr/v1/vims/57674786-5b2e-4c92-bb68-578dbd79e2f5?cloud_owner=owner&cloud_region=region-one

Response Parameters:
VIM

Response Sample:

...

Request Sample:
/onapapi/aai/esr/v1/vims/57674786-5b2e-4c92-bb68-578dbd79e2f5?cloud_owner=owner&cloud_region=region-one

   {
       "name":"vim",

       "cloud-owner":"owner",

...

Response Parameters:
VIM

Response Sample:

   {
       "vimIdname":"57674786-5b2e-4c92-bb68-578dbd79e2f5",
"vim",

       "cloud-owner":"owner",

       "namecloud-region":"vimregion-one",


       "url":"http://10.74.151.13:5000/v2.0",
       "userName":"admin",
       "password":"admin",
       "tenant":"admin",
       "vendor":"ZTE",
       "version":"v2.0",
       "description":"",
       "domain":"",
       "type":"openstack",
       "createTime":"2016-07-18 12:22:53"
   }

...

Interface Definition	Description
URI	/onapapi/aai/esr/v1/vims/{vimId}?cloud_owner=xxx&cloud_region=xxx
Operation Type	Operation Type	DELETE

Request Parameters:

...

Request Sample:
/onapapi/aai/esr/v1/vims/57674786-5b2e-4c92-bb68-578dbd79e2f5?cloud_owner=owner&cloud_region=region-one

Response Parameters:
N/A

Response Sample:
N/A

...

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	M	1	String	User name
password	M	1	String	Password
type	M	1	Enum{ODLWAN/ONOSDC}	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":"ODLWAN"
   }

Response Parameters:
SDN Controller

...

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

...

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

...

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

...

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

...

O0..urluserName

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	descriptionproductName
resourceAddr	M	1	String	productName	Obj	Address to get resource data
performanceAddr		M	1	String	Access url	Obj	Address to get performance data
alarmAddr		M	1	String	User name
password	M	1	String	Password

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

   {
       "name":"ems",
       "vendor":"ZTE",
       "version":"v1.0",
       "description":"",
       "productName":"",
       "url":"http://10.74.44.11",
       "userName":"admin",
       "password":"admin"
   }

Response Parameters:
EMS

Response Sample:

   {
       "emsId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
       "name":"ems",
       "vendor":"ZTE",
       "version":"v1.0",
       "description":"",
       "productName":"",
       "url":"http://10.74.44.11",
       "userName":"admin",
       "password":"admin",
       "createTime":"2016-07-18 12:22:53"
   }

Get EMS by id

Interface Definition	Description
URI	/onapapi/aai/esr/v1/emses/{emsId}
Operation Type	GET

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 Parameters:
EMS

Response Sample:

   {
       "emsId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
       "name":"ems",
       "version":"v1.0",
       "vendor":"ZTE",
       "description":"",
       "productName":"",
       "url":"http://10.74.44.11",
       "userName":"admin",
       "password":"admin",
       "createTime":"2016-07-18 12:22:53"
   }

Get all EMS

Interface Definition	Description
URI	/onapapi/aai/esr/v1/emss
Operation Type	GET

Request Parameters:
N/A

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

Response Parameters:
List<EMS>

Response Sample:

   [
       {
           "emsId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
           "name":"ems",
           "version":"v1.0",
           "vendor":"ZTE",
           "description":"",
           "productName":"",
           "url":"http://10.74.44.11",
           "userName":"admin",
           "password":"admin",
           "createTime":"2016-07-18 12:22:53"
       }
   ]

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
productName	O	0..1	String	productName
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/emses/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee

...

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:

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

{
"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	/onapapi/aai/esr/v1/emses/{emsId}
Operation Type	GET

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 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	/onapapi/aai/esr/v1/emss
Operation Type	GET

Request Parameters:
N/A

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

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"

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

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:

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

"emsName": "EMS_TEST",

  "version":"v1.0",
  "vendor":"ZTE
       "name":"ems",
  "description":"",

     "vendor"createTime":"2016-07-18 12:22:53"

"resouceAddr": {
"ftptype": "

...

ftp",

...

"ip": "

...

10.44.55.145",
"port": "2000",

...

"user": "root",

...

Response Parameters:
EMS

Response Sample:

...

"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

...

Attribute	Content	Description
emsId	String	EMS identifier(UUID)
name	String	EMS name
description	String	description
version	String	version
vendor	String	Vendor
createTime	String	Create time
productName	String	product name
resource	resourceInfo	resource data access address
performance	performanceInfo	performance data access address
alarm	alarmInfo	alarm data access address

resouceInforesourceAddr:

Attribute	Content	Description

ftpType

ftptype	Enum{ftp/sftp}	ftp type
ip	String	service IP of ftp server
port	String	service port of ftp server
user	String	ftp user name
password	String	ftp password

remotePath

remotepath	String	resource data file path
passive	Boolean	ftp passive mode or not

performanceAddrperformanceInfo:

Attribute	Content	Description

ftpType

ftptype	Enum{ftp/sftp}	ftp type
ip	String	service IP of ftp server
port	String	service port of ftp server
user	String	ftp user name
password	String

remotePath

ftp password
remotepath	String	performance data file path
passive	Boolean	ftp passive mode or not

alarmAddralarmInfo:

Attribute	Content	Description
ip	String	service IP of ftp server
port	String	service port of ftp server
user	String	ftp user name
password	String	ftp password

Space shortcuts

Page tree

Versions Compared

Old Version 7

New Version 8

Key

Get EMS by id

Get all EMS

Update EMS

Get EMS by id

Get all EMS

Update EMS

Delete EMS