Enumerate V Sphere Regions

Enumerate V Sphere Regions

Get the available regions for specified vSphere cloud account

Request
URI
POST
https://{api_host}/iaas/api/cloud-accounts-vsphere/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
CloudAccountVsphereSpecification of type(s) application/json
Optional
{
    "hostName": "vc.mycompany.com",
    "acceptSelfSignedCertificate": false,
    "associatedCloudAccountIds": [
        "string"
    ],
    "password": "cndhjslacd90ascdbasyoucbdh",
    "createDefaultZones": true,
    "dcid": "23959a1e-18bc-4f0c-ac49-b5aeb4b6eef4",
    "name": "string",
    "description": "string",
    "regionIds": [
        "string"
    ],
    "username": "[email protected]",
    "tags": [
        {
            "value": "string",
            "key": "string"
        }
    ]
}
string
hostName
Required

Host name for the vSphere endpoint

boolean
acceptSelfSignedCertificate
Optional

Accept self signed certificate when connecting to vSphere

array of string
associatedCloudAccountIds
Optional

Cloud accounts to associate with this cloud account

string
password
Required

Password for the user used to authenticate with the cloud Account

boolean
createDefaultZones
Optional

Create default cloud zones for the enabled regions.

string
dcid
Optional

Identifier of a data collector vm deployed in the on premise infrastructure. Refer to the data-collector API to create or list data collectors

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 datacenter managed object reference identifiers (MoRef) to enable provisioning on. Refer to /iaas/cloud-accounts-vsphere/region-enumeration.

string
username
Required

Username 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