Versions Compared

Key

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

...

Errorcode: 500 Internal Server Error

VIM

VIM registration(Update VIM)

Interface DefinitionDescription
URI

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

Operation TypePUT

...

AttributeQualifierCardinalityContentDescription
cloudOwnercloud-ownerM1StringCloud ownercloudRegionId
cloud-regionIdM1StringCloud regionauthInfo
auth-infoM1ObjAuth information of Cloud

authInfo:

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

Request Sample:
/onapapiapi/aai/esr/v1/vims-cloudInfrastructure/v1/cloud-regions/cloud-region/owner/region-one

   {
       "cloud-owner":"owner",
       "cloud-region":"region-one",

...

Errorcode: 500 Internal Server Error

Get VIM

...

Interface DefinitionDescription
URI

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

Operation TypeGET

...

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

Response Parameters:

VIM

Get all VIM

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

...

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",
           "vendordomain":"ZTE",
   
       "version":"v1.0",
           "domain":"",
           "type":"openstack"
       }
   ]

Update VIM

...

Request Parameters:

...

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

   {
       "cloudOwner":"owner",
       "cloudRegionId":"region-one",
       "url":"http://10.74.151.13:5000/v2.0",
       "userName":"admin",
       "password":"adminvendor":"ZTE",
       "tenantversion":"adminv1.0",
       "domaintype":"openstack",
       }
   "version":"v2.0"    }

Response:

Success Code: 201

...


   ]

Delete VIM

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

...

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

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

...