Enumerate Regions

Enumerate Regions

Get the available regions for specified cloud account

Request
URI
POST
https://{api_host}/iaas/api/cloud-accounts/region-enumeration
COPY
Query Parameters
string
apiVersion
Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /iaas/api/about


Request Body
CloudAccountSpecification of type(s) application/json
Optional
{
    "privateKey": "gfsScK345sGGaVdds222dasdfDDSSasdfdsa34fS",
    "associatedCloudAccountIds": [
        "string"
    ],
    "createDefaultZones": true,
    "cloudAccountType": "vsphere, aws, azure, nsxv, nsxt",
    "name": "string",
    "description": "string",
    "regionIds": [
        "string"
    ],
    "privateKeyId": "ACDC55DB4MFH6ADG75KK",
    "tags": [
        {
            "value": "string",
            "key": "string"
        }
    ]
}
object
cloudAccountProperties
Required

Cloud Account specific properties supplied in as name value pairs

string
privateKey
Required

Secret access key or password to be used to authenticate with the cloud account

array of string
associatedCloudAccountIds
Optional

Cloud account to link with this cloud account

boolean
createDefaultZones
Optional

Create default cloud zones for the enabled regions.

object
customProperties
Optional

Additional custom properties that may be used to extend the Cloud Account.

string
cloudAccountType
Required

Cloud account type

string
name
Required

A human-friendly name used as an identifier in APIs that support this option.

string
description
Optional

A human-friendly description.

array of string
regionIds
Required

A set of Region names to enable provisioning on.Refer to /iaas/cloud-accounts/region-enumeration.

string
privateKeyId
Required

Access key id or username to be used to authenticate with the cloud account

array of Tag
tags
Optional

A set of tag keys and optional values to set on the Cloud Account

Responses
200

successful operation

Returns CloudAccountRegions of type(s) application/json
{
    "externalRegionIds": [
        "string"
    ]
}
array of string
externalRegionIds
Required

A set of region ids for the cloud account.


400

Invalid Request - bad data

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure