Enumerate Aws Regions

Enumerate Aws Regions

Get the available regions for specified AWS cloud account

Request
URI
POST
https://{api_host}/iaas/api/cloud-accounts-aws/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

CloudAccount specification

CloudAccountAwsSpecification of type(s) application/json
Required
{
    "name": "string",
    "description": "string",
    "accessKeyId": "ACDC55DB4MFH6ADG75KK",
    "secretAccessKey": "gfsScK345sGGaVdds222dasdfDDSSasdfdsa34fS",
    "regionIds": [
        "string"
    ],
    "createDefaultZones": true,
    "tags": [
        {
            "key": "string",
            "value": "string"
        }
    ]
}
string
name
Required

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

string
description
Optional

A human-friendly description.

string
accessKeyId
Required

Aws Access key ID

string
secretAccessKey
Required

Aws Secret Access Key

array of string
regionIds
Required

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

boolean
createDefaultZones
Optional

Create default cloud zones for the enabled regions.

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