Enumerate Regions Async

Get the available regions for specified cloud account

Request

URI

POST

https://vra-interop-222-139.lvn.broadcom.net/iaas/api/cloud-accounts/region-enumeration

COPY

Query Parameters

string

apiVersion

Required

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

Request Body

Region enumeration specification

CloudAccountRegionEnumerationSpecification of type(s) application/json

Required

Show optional properties

{
    "cloudAccountProperties": {}
}

{
    "cloudAccountType": "vsphere, aws, azure, nsxv, nsxt",
    "privateKeyId": "ACDC55DB4MFH6ADG75KK",
    "privateKey": "gfsScK345sGGaVdds222dasdfDDSSasdfdsa34fS",
    "cloudAccountId": "b8b7a918-342e-4a53-a3b0-b935da0fe601",
    "cloudAccountProperties": {
        "supportPublicImages": "true",
        "acceptSelfSignedCertificate": "true"
    },
    "customProperties": {
        "acceptSelfSignedCertificate": "true"
    },
    "certificateInfo": {
        "certificate": "-----BEGIN CERTIFICATE-----\nMIIDHjCCAoegAwIBAgIBATANBgkqhkiG9w0BAQsFADCBpjEUMBIGA1UEChMLVk13\nYXJlIEluYAAc1pw18GT3iAqQRPx0PrjzJhgjIJMla\n/1Kg4byY4FPSacNiRgY/FG2bPCqZk1yRfzmkFYCW/vU+Dg==\n-----END CERTIFICATE-----\n-"
    }
}

string

cloudAccountType

Optional

Cloud account type

string

privateKeyId

Optional

Access key id or username to be used to authenticate with the cloud account. Either provide privateKeyId or provide a cloudAccountId of an existing account.

string

privateKey

Optional

Secret access key or password to be used to authenticate with the cloud account. Either provide privateKey or provide a cloudAccountId of an existing account.

string

cloudAccountId

Optional

Existing cloud account id. Either provide existing cloud account Id, or privateKeyId/privateKey credentials pair.

object

cloudAccountProperties

Required

Cloud Account specific properties supplied in as name value pairs.

object

customProperties

Optional

Additional custom properties that may be used for the cloud account.

object

certificateInfo

Optional

Specification for certificate for a cloud account.

Authentication

This operation uses the following authentication methods.

Authorization

Responses

202

Accepted

Returns RequestTracker of type(s) application/json

"RequestTracker Object"

integer As int32 As int32

progress

Required

Progress of the request as percentage.

string

message

Optional

Status message of the request.

string

status

Required

Status of the request.

Possible values are : FINISHED, INPROGRESS, FAILED,

array of string

resources

Optional

Collection of resources.

string

name

Optional

Name of the operation.

string

Required

ID of this request.

string

selfLink

Required

Self link of this request.

string

deploymentId

Optional

ID of the deployment, this request is connected to.

400

Invalid request - bad data

Returns ServiceErrorResponse of type(s) application/json

"ServiceErrorResponse Object"

string

message

Optional

message

string

messageId

Optional

messageId

array of string

stackTrace

Optional

stackTrace

integer As int32 As int32

statusCode

Optional

statusCode

integer As int32 As int32

errorCode

Optional

errorCode

array of string

details

Optional

details

string

serverErrorId

Optional

serverErrorId

string

documentKind

Optional

documentKind

integer As int32 As int32

internalErrorCode

Optional

internalErrorCode

403

Forbidden

Returns ServiceErrorResponse of type(s) application/json

"ServiceErrorResponse Object"

string

message

Optional

message

string

messageId

Optional

messageId

array of string

stackTrace

Optional

stackTrace

integer As int32 As int32

statusCode

Optional

statusCode

integer As int32 As int32

errorCode

Optional

errorCode

array of string

details

Optional

details

string

serverErrorId

Optional

serverErrorId

string

documentKind

Optional

documentKind

integer As int32 As int32

internalErrorCode

Optional

internalErrorCode

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"cloudAccountProperties:"object"}' https://{api_host}/iaas/api/cloud-accounts/region-enumeration

On This Page

Description

Request

Query Parameters

Request Body

Authentication

Response

202 Response Body

Errors

Cloud Account Operations

POST

Enumerate Private Images