Versions Compared

Key

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

...

AttributeQualifierDefaultContentDescription
cloudOwnerM
Stringcloud owner name, can be customized, e.g. att-aic
cloudRegionIdM
Stringcloud region info based on deployment, e.g. RegionOne
cloudTypeM
Stringtype of the cloud, decides which multicloud plugin to use, openstack or vio
cloudRegionVersionM
Stringcloud version, ocata, mitaka or other
ownerDefinedTypeO
StringCloud-owner defined type indicator (e.g., dcp, lcp)
cloudZoneO
StringZone where the cloud is homed.
complexNameO
Stringcomplex name for cloud-region instance.
cloudExtraInfoO
Stringextra info for Cloud
authInfoItemsvimAuthInfoM1[Obj]Auth information of Cloud

...

AttributeQualifierDefaultContentDescription
cloudDomainM
Stringdomain info for keystone v3
userNameM
StringUser name
passwordM
StringPassword
authUrlM
Stringauthentication url of the cloud, e.g. keystone url
ssl-cacertsslCacertO
Stringca file content if enabled ssl on auth-urlssl-insecure
sslInsecureO
BooleanWhether to verify VIM's certificate

Request Sample:
/api/aai-esr-server/v1/vims

Body:

{
"

...

cloudOwner": "ZTE",
"

...

cloudRegionId":

...

 "region-

...

one",
"

...

cloudType": "openstack",
"

...

cloudRegionVersion": "v1.0",
"

...

ownerDefinedType": "owner-defined-type",
"

...

cloudZone": "cloud zone",
"

...

complexName": "complex name",
"

...

cloudExtraInfo": "cloud-extra-info",
"

...

vimAuthInfo":

...

 
{
"

...

userName": "admin",
"password": "admin",
"

...

authUrl": "http://10.74.151.13:5000/v2.0",
"

...

sslCacert": "ssl-cacert",
"

...

sslInsecure":

...

 true

...

,
"

...

cloudDomain": "cloud-domain"
}

...

}


Response:

Success Code: 201201

body:

{
"cloudOwner": "ZTE",
"cloudRegionId": "region-one"
}

Errorcode: 500 Internal Server Error

...

AttributeQualifierDefaultContentDescription
cloudTypeM
Stringtype of the cloud, decides which multicloud plugin to use, openstack or vio
cloudRegionVersionM
Stringcloud version, ocata, mitaka or other
ownerDefinedTypeO
StringCloud-owner defined type indicator (e.g., dcp, lcp)
cloudZoneO
StringZone where the cloud is homed.
complexNameO
Stringcomplex name for cloud-region instance.
cloudExtraInfoO
Stringextra info for Cloud
authInfoItems
vimAuthInfo
M
[Obj]Auth information of Cloud

...

AttributeQualifierDefaultContentDescription
cloudDomainM
Stringdomain info for keystone v3
userNameM
StringUser name
passwordM
StringPassword
authUrlM
Stringauthentication url of the cloud, e.g. keystone url
ssl-cacert
sslCacert
O
Stringca file content if enabled ssl on auth-urlssl-insecure
sslInsecureO
BooleanWhether to verify VIM's certificate


Request Sample:
/api/aai-esr-server/v1/vims/ZTE/region-one

{
"statuscloudOwner": "activeZTE",
"cloud-typecloudRegionId": "region-one",
"cloudType": "openstack",
"cloud-region-versioncloudRegionVersion": "v1.0",
"owner-defined-typeownerDefinedType": "owner-defined-type",
"cloud-zonecloudZone": "cloud zone",
"complex-namecomplexName": "complex name",
"cloud-extra-infocloudExtraInfo": "cloud-extra-info",
"auth-info-itemsvimAuthInfo": [
{
"usernameuserName": "admin",
"password": "admin",
"auth-urlauthUrl": "http://10.74.151.13:5000/v2.0",
"ssl-cacertsslCacert": "ssl-cacert",
"ssl-insecuresslInsecure": "ssl-insecure"true,
"cloud-domaincloudDomain": "cloud-domain"
}
]
}

Get VIM

Interface DefinitionDescription
URI

/api/aai-esr-server/v1/vims/{cloudOwner}/{cloudRegionId}

Operation TypeGET

...

Request Sample:
/api/aai-esr-server/v1/vims/

Response Parameters:
List<VIM>

...