This API is only exposed to esr portal.
...
| Attribute | Qualifier | Default | Content | Description |
|---|---|---|---|---|
| cloudOwner | M | String | cloud owner name, can be customized, e.g. att-aic | |
| cloudRegionId | M | String | cloud region info based on deployment, e.g. RegionOne | |
| cloudType | M | String | type of the cloud, decides which multicloud plugin to use, openstack or vio | |
| cloudRegionVersion | M | String | cloud version, ocata, mitaka or other | |
| ownerDefinedType | O | String | Cloud-owner defined type indicator (e.g., dcp, lcp) | |
| cloudZone | O | String | Zone where the cloud is homed. | |
| complexName | O | String | complex name for cloud-region instance. | |
| cloudExtraInfo | O | String | extra info for Cloud | |
| authInfoItemsvimAuthInfo | M | 1 | [Obj] | Auth information of Cloud |
...
| Attribute | Qualifier | Default | Content | Description |
|---|---|---|---|---|
| cloudDomain | M | String | domain info for keystone v3 | |
| userName | M | String | User name | |
| password | M | String | Password | |
| authUrl | M | String | authentication url of the cloud, e.g. keystone url | |
| ssl-cacertsslCacert | O | String | ca file content if enabled ssl on auth-urlssl-insecure | |
| sslInsecure | O | Boolean | Whether 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: 201: 201
body:
{
"cloudOwner": "ZTE",
"cloudRegionId": "region-one"
}
Errorcode: 500 Internal Server Error
...
| Attribute | Qualifier | Default | Content | Description |
|---|---|---|---|---|
| cloudType | M | String | type of the cloud, decides which multicloud plugin to use, openstack or vio | |
| cloudRegionVersion | M | String | cloud version, ocata, mitaka or other | |
| ownerDefinedType | O | String | Cloud-owner defined type indicator (e.g., dcp, lcp) | |
| cloudZone | O | String | Zone where the cloud is homed. | |
| complexName | O | String | complex name for cloud-region instance. | |
| cloudExtraInfo | O | String | extra info for Cloud | |
authInfoItemsvimAuthInfo | M | [Obj] | Auth information of Cloud |
...
| Attribute | Qualifier | Default | Content | Description |
|---|---|---|---|---|
| cloudDomain | M | String | domain info for keystone v3 | |
| userName | M | String | User name | |
| password | M | String | Password | |
| authUrl | M | String | authentication url of the cloud, e.g. keystone url | |
ssl-cacertsslCacert | O | String | ca file content if enabled ssl on auth-urlssl-insecure | |
| sslInsecure | O | Boolean | Whether 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 Definition | Description |
|---|---|
| URI | /api/aai-esr-server/v1/vims/{cloudOwner}/{cloudRegionId} |
| Operation Type | GET |
...
Request Sample:
/api/aai-esr-server/v1/vims/
Response Parameters:
List<VIM>
...
| Attribute | Qualifier | Default | Content | Description |
|---|---|---|---|---|
| cloudOwner | M | String | cloud owner name, can be customized, e.g. att-aic | |
| cloudRegionId | M | String | cloud region info based on deployment, e.g. RegionOne | |
| cloudType | M | String | type of the cloud, decides which multicloud plugin to use, openstack or vio | |
| cloudRegionVersion | M | String | cloud version, ocata, mitaka or other | |
| ownerDefinedType | O | String | Cloud-owner defined type indicator (e.g., dcp, lcp) | |
| cloudZone | O | String | Zone where the cloud is homed. | |
| complexName | O | String | complex name for cloud-region instance. | |
| cloudExtraInfo | O | String | extra info for Cloud | |
| authInfoItems | M | 1 | [Obj] | Auth information of Cloud |
...