Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

Body:

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

...

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

Body:

{

"cloud-owner":"owner",

"cloud-region":"region-one",

...

Request Sample:
/api/aai-sdncontroller/v1/sdncontrollers/sdncontroller/{sdnControllerId}

Body:

{

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

...

/api/aai-ems/v1/emses/ems/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee

Body:

{

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

...

"alarmAddr": {
        "ip": "10.44.55.145",
        "port": 2000,
        "user": "root",
        "password": "test"

}

}

]

...

Delete EMS

Interface DefinitionDescription
URI/onapapi/aai/esr/v1/emses/{emsId}
Operation TypePUTDELETE

Request Parameters:

version
AttributeQualifierCardinalityContentDescription
emsIdM1StringEMS identifier
nameO0..1StringEMS name
vendorO0..1StringVendor

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

Response:

Success Code: 204

Errorcode: 500 Internal Server Error


Information elements

VNFM

descriptionO0..
AttributeQualifierCardinalityContentDescription
vnfmIdO0..1String
version
VNFM UUID generated by ESR
nameM
1String
description
VNFM name
resourceAddr
type
O
M
0..
1
ObjAddress to get resource dataperformanceAddr
StringVNFM type
vimIdO0..1
ObjAddress to get performance dataalarmAddrO0..1ObjAddress to get alarm data

resourceAddr:

StringRelated VIM
vendorM1StringVNFM vendor
versionM1StringVNFM version
description
AttributeQualifierCardinalityContentDescriptionftptype
O0..1
Enum{ftp/sftp}ftp typeip0..
StringVNFM description
certificateUrlO0..1String
service IP of ftp serverportO
certificate url
urlM
1String
service port of ftp serveruser
Access url
userNameO0..1String
ftp user

Response Sample:

   {
       "instanceId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
       "category":"VNFM",
       "name":"vnfm",
       "description":"",
       "version":"v1.0",
       "vendor":"ZTE",
       "type":"Tacker",
       "createTime":"2016-07-18 12:22:53"
   }

Information elements

VNFM

AttributeContentDescriptionvnfmIdStringVNFM identifier(UUID)nameStringVNFM namedescriptionStringVNFM descriptionversionStringVNFM versionvendorStringVNFM vendortypeStringVNFM typeurlStringAccess urluserNameStringUser namepasswordStringPasswordcreateTimeStringCreate timevimIdStringRelated VIMcertificateUrlStringVNFM certificate url
User name
passwordO0..1String
ftp passwordremotepathO0..1Stringresource data file pathpassiveO0..1Booleanftp passive mode or not

performanceAddr:

...

alarmAddr:

...

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:

Success Code: 201

Errorcode: 500 Internal Server Error

Delete EMS

...

Request Parameters:

AttributeQualifierCardinalityContentDescription
emsIdM1StringEMS identifier

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

Response:

Success Code: 204

Errorcode: 500 Internal Server Error

Other

Get basic info by id

Interface DefinitionDescription
URI/onapapi/aai/esr/v1/common/{instanceId}
Operation TypeGET

Request Parameters:

AttributeQualifierCardinalityContentDescription
instanceIdM1StringExternal system identifier

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

Response Parameters:

...

Password

VIM

AttributeQualifierCardinalityContentDescription
cloudOwnerM1StringCloud owner
cloudRegionIdM1StringCloud region
cloud-typeO0...1StringType of the cloud (e.g., openstack)
owner-defined-typeO0...1StringCloud-owner defined type indicator
cloud-region-versionO0...1StringSoftware version employed at the site
identity-urlO0...1StringURL of the keystone identity service
cloud-zoneO0...1StringZone where the cloud is homed
complex-nameO0...1Stringcomplex name for cloud-region instance
resource-versionO0...1StringUsed for optimistic concurrency. Must be empty on create, valid on update and delete.
volume-groupsO0...1object[]definition detail see AAI API
tenantsO0...1object[]definition detail see AAI API
flavorsO0...1object[]definition detail see AAI API
group-assignmentsO0...1object[]definition detail see AAI API
snapshotsO0...1object[]definition detail see AAI API
imagesO0...1object[]definition detail see AAI API
availability-zonesO0...1object[]definition detail see AAI API
relationship-listO0...1object[]definition detail see AAI API
authInfoM1ObjAuth information of Cloud

...