Enumerate Gcp Regions

Enumerate Gcp Regions

Get the available regions for specified GCP cloud account

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

CloudAccountGcpSpecification of type(s) application/json
Required
{
    "name": "string",
    "description": "string",
    "projectId": "example-gcp-project",
    "privateKeyId": "027f73d50a19452eedf5775a9b42c5083678abdf",
    "privateKey": "-----BEGIN PRIVATE KEY-----\nMIICXgIHAASBgSDHikastc8+I81zCg/qWW8dMr8mqvXQ3qbPAmu0RjxoZVI47tvs\nkYlFAXOf0sPrhO2nUuooJngnHV0639iTTEYG1vckNaW2R6U5QTdQ5Rq5u+uV3pMk\n7w7Vs4n3urQ4jnqt7rTXbC1DNa/PFeAZatbf7ffBBy0IGO0zc128IshYcwIDAQAB\nAoGBALTNl2JxTvq4SDW/3VH0fZkQXWH1MM10oeMbB2qO5beWb11FGaOO77nGKfWc\nbYgfp5Ogrql2yhBvLAXnxH8bcqqwORtFhlyV68U1y4R+8WxDNh0aevxH8hRS/1X5\n963DJm1JlU0E+vStiktN0tC3ebH5hE+1OxbIHSZ+WOWLYX7JAkEA5uigRgKp8ScG\nauUijvdOLZIhHWq9y5Wz+nOHUuDw8P7wOTKU34QJAoWEe771p9Pf/GTA/kr0BQnP\nQvWUDxGzJwJBAN05C6krwPeryFKrKtjOGJIbiIoY72wRnoNcdEEs3HDRhf48YWFo\nriRbZylzzzNFy/gmzT6XJQTfktGqq+FZD9UCQGIJaGrxHJgfmpDuAhMzGsUsYtTr\niRox0D1Iqa7dhE693t5aBG010OF6MLqdZA1CXrn5SRtuVVaCSLZEL/2J5UcCQQDA\nd3MXucNnN4NPuS/L9HMYJWD7lPoosaORcgyK77bSSNgk+u9WSjbH1uYIAIPSffUZ\nbti+jc2dUg5wb+aeZlgJAkEAurrpmpqj5vg087ZngKfFGR5rozDiTsK5DceTV97K\na1Y+Nzl+XWTxDBWk4YPh2ZlKv402hZEfWBYxUDn5ZkH/bw==\n-----END PRIVATE KEY-----\n",
    "clientEmail": "[email protected]",
    "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
projectId
Required

GCP Project ID

string
privateKeyId
Required

GCP Private key ID

string
privateKey
Required

GCP Private key

string
clientEmail
Required

GCP Client email

array of string
regionIds
Required

A set of Region names to enable provisioning on. Refer to /iaas/cloud-accounts-gcp/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