Versions Compared

Key

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

...

   {
       "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",
       "createTime":"2016-07-06 15:33:18"
   }

Get all VNFM

Interface DefinitionDescription
URI/onapapi/aai/esr/v1/vnfms
Operation TypeGET

...

 [
       {
           "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",
    
      "createTime":"2016-07-06 15:33:18"        }
   ]

Update VNFM

Interface DefinitionDescription
URI/onapapi/aai/esr/v1/vnfms/{vnfmId}
Operation TypePUT

...

Interface DefinitionDescription
URI

/

onapapi

api/aai

/esr/v1/vims

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

Operation TypePUT

Request ParametersBody:

nameVIM name
AttributeQualifierCardinalityContentDescription
cloudOwnerM1StringCloud owner
cloudOwnercloudRegionIdM1StringCloud ownerregion
cloudRegionauthInfoM1StringObjCloud regionAuth information of Cloud

authInfo:

AttributeQualifierCardinalityContentDescription
urlM1StringAccess url
userNameM1StringUser name
passwordM1StringPassword
tenantM1StringTenant name
domainO0..1StringDomain
vendorM1StringVIM vendor
versionM1StringVIM version
descriptionO0..1StringVIM description
typeM1
Enum{openstack/vmware}
StringVIM type

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

   {
        "namecloud-owner":"vimowner",
       "cloud-ownerregion":"ownerregion-one",
       "cloud-regionauthInfo":"region-one",
 {
       "url":"http://10.74.151.13:5000/v2.0",
       "userName":"admin",
       "password":"admin",
       "tenant":"admin",
       "domain":"",
       "vendor":"ZTE",
       "version":"v1.0",
       "descriptiontype":"openstack",
        "type":"openstack"}
   }

Response:

Success Code: 201

...

Interface DefinitionDescription
URI

/

onapapi

api/aai

/esr

-cloudInfrastructure/v1/

vims?cloud_owner=xxx&cloud_region=xxx

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

Operation TypeGET

Request Parameters:

cloud_ownerVIM identifier
AttributeQualifierCardinalityContentDescription
cloudOwnerM1StringCloud owner
cloudRegionIdM1StringCloud region

Request Sample:
/onapapiapi/aai/esr-cloudInfrastructure/v1/vims?cloud_owner=owner&cloud_region=cloud-regions/cloud-region/owner/region-one

Response Parameters:


Get all VIM

Response Sample:

Success Code: 201 
  {
       "name":"vim",

...

Interface DefinitionDescription
URI/api/aai-cloudInfrastructure/v1/cloud-regions
Operation TypeGET

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",
           "url":"http://10.74.151.13:5000/v2.0",
           "userName":"admin",
           "password":"admin",
           "tenant":"admin",
           "vendor":"ZTE",
           "version":"v1.0",
   
   "description":"",        "domain":"",
           "type":"openstack",
       "createTime":"2016-07-18 12:22:53"}
   }]

...

Update VIM

Interface DefinitionDescription
URI/onapapi/aai/esr/v1/vims?cloudOwner=xxx&cloudRegionId=xxx
Operation TypeGETPUT

Request Parameters:

Attribute

...

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

Response Parameters:
List<VIM>

Response Sample:

Success Code: 201  
 [
       {
           "name":"vim",
           "cloud-owner":"owner",
           "cloud-region":"region-one",

...

QualifierCardinalityContentDescription
cloudOwnerM1StringCloud owner
cloudRegionIdM1StringCloud region
urlO0..1StringAccess url
userNameO0..1StringUser name
passwordO0..1StringPassword
tenantO0..1StringTenant name
domainO0..1StringDomain
vendorO0..1StringVIM vendor

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

   {
        "passwordcloudOwner":"adminowner",
    
       "tenantcloudRegionId":"adminregion-one",
            "vendorurl":"ZTEhttp://10.74.151.13:5000/v2.0",
           "versionuserName":"v1.0admin",
  
        "descriptionpassword":"admin",
   
       "domaintenant":"admin",
   
       "typedomain":"openstack",
  
        "createTimeversion":"2016-07-18 12:22:53"
   v2.0"
   }
   ]

...

Response:

Success Code: 201

Errorcode: 500 Internal Server Error

Delete VIM

Interface DefinitionDescription
URI/onapapi/aai/esr/v1/vims?cloud_ownercloudOwner=xxx&cloud_regioncloudRegionId=xxx
Operation TypePUTDELETE

Request Parameters:

AttributeQualifierCardinalityContentDescription
namevimIdOM0..1StringVIM name
cloudOwnerM1StringCloud owner
cloudRegionM1StringCloud region
urlO0..1StringAccess url
userNameO0..1StringUser name
passwordO0..1StringPassword
tenantO0..1StringTenant name
domainidentifier

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

Interface DefinitionDescription
URI/onapapi/aai/esr/v1/sdncontrollers
Operation TypePUT

Request Parameters:

AttributeQualifierCardinalityContentDescription
nameM1StringSDN Controller name
locationO1Stringfit for DC type
urlM1StringAccess url
vendorM1StringSDNC vendor
versionM1StringSDNC version
descriptionO0..1StringDomainSDNC description
vendorproductNameO0..1StringVIM vendor

...

SDNC productName
protocolM1Enum{netconf/snmp}protocol
userNameM1StringUser name
passwordM1StringPassword
typeM1Enum{WAN/DC}SDN Controller type

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

   {
       "name":"vimsdn",
       "cloud-ownerurl":"ownerhttp://10.74.151.13:8181",
       "cloud-regionuserName":"region-oneadmin",
       "urlpassword":"http://10.74.151.13:5000/v2"admin",
       "version":"v1.0",
       "userNamevendor":"adminZTE",
       "passworddescription":"admin",
       "tenantprotocol":"adminnetconf",
       "domainproductName":"",
       "versiontype":"v2.0WAN"
   }

Response:

Success Code: 201

Errorcode: 500 Internal Server Error

...

Get SDN Controller by id

Interface DefinitionDescription
URI/onapapi/aai/esr/v1/vims?cloud_owner=xxx&cloud_region=xxx/sdncontrollers/{sdnControllerId}
Operation TypeDELETEGET

Request Parameters:

AttributeQualifierCardinalityContentDescription
vimIdsdnControllerIdM1StringVIM SDN Controller identifier

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

Response:

Success Code: 204

Errorcode: 500 Internal Server Errorsdncontrollers/57674786-5b2e-4c92-bb68-578dbd79e2f5

Response Parameters:
SDN Controller

SDN Controller registration

...

Request Parameters:

...

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

...

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

Response:

Success Code: 201

Errorcode: 500 Internal Server Error

...

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

Get all SDN Controller

Interface DefinitionDescription
URI/onapapi/aai/esr/v1/sdncontrollers/{sdnControllerId}
Operation TypeGET

Request Parameters:

...

N/A

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

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

Interface DefinitionDescription
URI/onapapi/aai/esr/v1/sdncontrollers/{sdnControllerId}
Operation TypeGETPUT

Request Parameters:
N/A

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

Response Parameters:
List<SDN Controller>

Response Sample:

Success Code: 201  

...

AttributeQualifierCardinalityContentDescription
sdnControllerIdM1StringSDN Controller identifier
nameO0..1StringSDN Controller name
urlO0..1StringAccess url
vendorO0..1StringSDNC vendor
versionO0..1StringSDNC version
descriptionO0..1StringSDNC description
productNameO0..1StringSDNC productName
protocolO0..1Enum{netconf/snmp}protocol
userNameO0..1StringUser name
passwordO0..1StringPassword

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

   {
        "descriptionsdnControllerId":"a6c42529-cd6b-4c01-b149-03eb54b20a03",
       "name":"sdn",
       "protocolurl":"netconfhttp://10.74.151.13:8181",
   
       "productNameuserName":"admin",
       "password":"admin",
       "typeversion":"WANv1.0",
   
       "createTimevendor":"2016-07-18 12:22:53""ZTE",
        }"description":"",
     ]

Update SDN Controller

...

Request Parameters:

...

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

   {
       "sdnControllerId":"a6c42529-cd6b-4c01-b149-03eb54b20a03  "protocol":"netconf",
       "productName":""
   }

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",
       "nameproductName":"sdn",
       "url":"http://10.74.151.13:8181",
       "userNametype":"adminWAN",
       "passwordcreateTime":"admin",
       "version":"v1.0",
       "vendor":"ZTE",2016-07-18 12:22:53"
       "description":"",
       "protocol":"netconf",
       "productName":""
   }

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

Delete SDN Controller

...

Request Parameters:

...

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

Response:

Success Code: 204

Errorcode: 500 Internal Server Error

EMS

EMS registration

...

}

Delete SDN Controller

Interface DefinitionDescription
URI/onapapi/aai/esr/v1/sdncontrollers/{sdnControllerId}
Operation TypeDELETE

Request Parameters:

AttributeQualifierCardinalityContentDescription
sdnControllerIdM1StringSDN Controller identifier

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

Response:

Success Code: 204

Errorcode: 500 Internal Server Error


EMS

EMS registration

Interface DefinitionDescription
URI/onapapi/aai/esr/v1/emses
Operation TypePUT

Request Parameters:

AttributeQualifierCardinalityContentDescription
emsIdM1StringUUID generated by esr-server
nameM1StringEMS name
vendorM1Stringvendor
versionM1Stringversion
descriptionO0..1Stringdescription
resourceAddrM1ObjAddress to get resource data
performanceAddrM1ObjAddress to get performance data
alarmAddrM1ObjAddress to get alarm data

resourceAddr:

emsIdvendorversionversiondescriptionO0..description
AttributeQualifierCardinalityContentDescription
ftptypeM1StringUUID generated by esr-servernameEnum{ftp/sftp}ftp type
ipM1StringEMS nameservice IP of ftp server
portM1Stringvendorservice port of ftp server
userM1Stringftp user name
passwordM1Stringftp password
resourceAddrremotepathM1ObjStringAddress to get resource data
performanceAddrM1ObjAddress to get performance data
alarmAddrresource data file path
passiveM1ObjAddress to get alarm data

...

Booleanftp passive mode or not

performanceAddr:

AttributeQualifierCardinalityContentDescription
ftptypeM1Enum{ftp/sftp}ftp type
ipM1Stringservice IP of ftp server
portM1Stringservice port of ftp server
userM1Stringftp user name
passwordM1Stringftp password
remotepathM1Stringresource performance data file path
passiveM1Booleanftp passive mode or not

performanceAddr:

...

alarmAddr:

...

Request Sample:

/onapapi/aai/esr/v1/emses

...

alarmAddr:

AttributeQualifierCardinalityContentDescription
ipM1Stringservice IP of ftp server
portM1Stringservice port of ftp server
userM1Stringftp user name
passwordM1Stringftp 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",

...

    "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"
    }
},
        "user": "root",
        "password": "test"
    }
}


Get EMS by id

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

Request Parameters:

AttributeQualifierCardinalityContentDescription
emsIdM1StringEMS identifier

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

Response Parameters:
EMS

Response Sample:

...

    "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 DefinitionDescription
URI/onapapi/aai/esr/v1/emses/{emsId}emss
Operation TypeGET

Request Parameters:

...

N/A

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

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"

    "

...

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

...

Get all EMS

...

Request Parameters:
N/A

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

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"

    "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

...

   ]


Update EMS

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

Request Parameters:

AttributeQualifierCardinalityContentDescription
emsIdM1StringEMS identifier
nameO0..1StringEMS name
vendorO0..1StringVendor
versionO0..1Stringversion
descriptionO0..1Stringdescription
resourceAddrO0..1ObjAddress to get resource data
performanceAddrO0..1ObjAddress to get performance data
alarmAddrO0..1ObjAddress to get alarm data

resourceAddr:

AttributeQualifierCardinalityContentDescription
ftptypeO0..1Enum{ftp/sftp}ftp type
ipO0..1Stringservice IP of ftp server
portO0..1Stringservice port of ftp server
userO0..1Stringftp user name
passwordO0..1Stringftp password
remotepathO0..1Stringresource data file path
passiveO0..1Booleanftp passive mode or not

performanceAddr:

AttributeQualifierCardinalityContentDescription
ftptypeO0..1Enum{ftp/sftp}ftp type
ipO0..1Stringservice IP of ftp server
portO0..1Stringservice port of ftp server
userO0..1Stringftp user name
passwordO0..1Stringftp password
remotepathO0..1Stringperformance data file path
passiveO0..1Booleanftp passive mode or not

alarmAddr:

emsIdMname
AttributeQualifierCardinalityContentDescription
ipO0..1StringEMS identifierservice IP of ftp server
portO0..1Stringservice port of ftp server
userO0..1Stringftp user name
passwordO0..1StringEMS name
vendorO0..1StringVendor
versionO0..1Stringversion
descriptionO0..1Stringdescription
resourceAddrO0..1ObjAddress to get resource data
performanceAddrO0..1ObjAddress to get performance data
alarmAddrO0..1ObjAddress to get alarm data

resourceAddr:

...

performanceAddr:

...

alarmAddr:

AttributeQualifierCardinalityContentDescription
ipO0..1Stringservice IP of ftp server
portO0..1Stringservice port of ftp server
userO0..1Stringftp user name
passwordO0..1Stringftp passwordftp 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:

Success Code: 201

Errorcode: 500 Internal Server Error

Delete EMS

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

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/emsescommon/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee

Response Parameters:

AttributeContentDescription
instanceIdStringExternal system identifier(UUID)
categoryEnum{

...

    "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

...

VIM/VNFM/SDNC/EMS}External system category
nameStringExternal system name
descriptionStringExternal system description
versionStringExternal system version
vendorStringExternal system vendor
typeStringExternal system type
createTimeStringCreate time

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

AttributeContentDescription
vnfmIdStringVNFM identifier(UUID)
nameStringVNFM name
descriptionStringVNFM description
versionStringVNFM version
vendorStringVNFM vendor
typeStringVNFM type
urlStringAccess url
userNameStringUser name
passwordStringPassword
createTimeStringCreate time
vimIdStringRelated VIM
certificateUrlStringVNFM certificate url

VIM

AttributeQualifierCardinalityContentDescription
emsId
cloudOwnerM1String
EMS 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:

AttributeContentDescription
instanceIdStringExternal system identifier(UUID)
categoryEnum{VIM/VNFM/SDNC/EMS}External system category
nameStringExternal system name
descriptionStringExternal system description
versionStringExternal system version
vendorStringExternal system vendor
typeStringExternal system type
createTimeStringCreate time

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

...

VIM

AttributeContentDescriptionvimIdStringVIM identifier(UUID)nameStringVIM namedescriptionStringVIM descriptionversionStringVIM versionvendorStringVIM vendortypeEnum{openstack/vmware}VIM typeurlStringAccess urluserNameStringUser namepasswordStringPasswordcreateTimeStringCreate timetenantStringTenant namedomainStringVIM domain
Cloud 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[]
tenantsO0...1object[]
flavorsO0...1object[]
group-assignmentsO0...1object[]
snapshotsO0...1object[]
imagesO0...1object[]
availability-zonesO0...1object[]
relationship-listO0...1object[]
authInfoM1ObjAuth information of Cloud

volume-group

AttributeQualifierCardinalityContentDescription
volume-group-idM1StringUnique ID of volume-group.
volume-group-nameM1StringName of the volume group.
heat-stack-idO0...1StringHeat stack id corresponding to this volume-group
vnf-typeM1StringString capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
orchestration-statusO0...1StringOrchestration status of this volume-group
resource-versionO0...1StringUsed for optimistic concurrency. Must be empty on create, valid on update and delete.
relationship-listO0...1object[]

authInfo:

AttributeQualifierCardinalityContentDescription
urlM1StringAccess url
userNameM1StringUser name
passwordM1StringPassword
tenantM1StringTenant name
domainO0..1StringDomain
vendorM1StringVIM vendor
versionM1StringVIM version
typeM1StringVIM type


SDN Controller

AttributeContentDescription
sdnControllerId(UUID)StringSDN Controller identifier
nameStringSDN Controller name
descriptionStringdescription
versionStringversion
vendorStringvendor
typeEnum{WAN/DC}SDN Controller type
urlStringAccess url
userNameStringUser name
passwordStringPassword
createTimeStringCreate time
protocolEnum{netconf/snmp}protocol
productNameStringproductName
locationStringonly fit for DC type

...