Get Region

Get Region

Retrieves a region with the given ID.

Request
URI
GET
https://{api_host}/cloudapi/vcf/regions/{regionUrn}
COPY
Path Parameters
string
regionUrn
Required

regionUrn

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns Region of type(s) application/json;version=40.0 
{
    "id": "string",
    "name": "string",
    "description": "string",
    "nsxManager": {
        "name": "string",
        "id": "string"
    },
    "supervisors": [
        {
            "name": "string",
            "id": "string"
        }
    ],
    "storagePolicies": [
        "string"
    ],
    "status": "string",
    "loadBalancerType": "string",
    "memoryCapacityMiB": 0,
    "memoryReservationCapacityMiB": 0,
    "cpuCapacityMHz": 0,
    "cpuReservationCapacityMHz": 0
}
string
id
Optional

The identifier of the region in URN format.

string
name
Required
Constraints: maxLength: 63

The name of the region. It must follow RFC 1123 Label Names to conform with Kubernetes standards.

string
description
Optional

The description of the region.

object
nsxManager
Required

Entity reference used to describe VCD entities

array of object
supervisors
Required
Constraints: minItems: 1 maxItems: 128

A list of supervisors in a region

array of string
storagePolicies
Required
Constraints: minItems: 1 maxItems: 128

A list of distinct vCenter storage policy names from the vCenters taking part in this region. A storage policy with the given name must exist in all the vCenters of this region otherwise it will not be accepted. Only the storage policies added to a region can be published to the tenant Virtual Datacenters.

string
status
Optional

The creation status of the Region. Possible values are READY, NOT_READY, ERROR, FAILED, DELETING. A Region needs to be ready and enabled to be usable.

string
loadBalancerType
Optional

The load balancer type of the supervisors in a Region

integer As int64 As int64
memoryCapacityMiB
Optional

Total memory resources (in mebibytes) available to this Region.

integer As int64 As int64
memoryReservationCapacityMiB
Optional

Total memory reservation resources (in mebibytes) available to this Region.

integer As int64 As int64
cpuCapacityMHz
Optional

Total CPU resources in MHz available to this Region.

integer As int64 As int64
cpuReservationCapacityMHz
Optional

Total CPU reservation resources in MHz available to this Region.


Vendor Extension

This operation contains the following vendor extensions defined in the spec:

                    [object Object]
Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/vcf/regions/{regionUrn}
Availability
Added in 40.0
On This Page
Regions Operations
GET
Query Regions
GET
Get Region