Get Zone

Get Zone

Retrieves a Zone.

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

zoneUrn

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns Zone of type(s) application/json;version=40.0 
{
    "id": "string",
    "name": "string",
    "region": {
        "name": "string",
        "id": "string"
    },
    "memoryReservationUsedMiB": 0,
    "memoryReservationMiB": 0,
    "memoryUsedMiB": 0,
    "memoryLimitMiB": 0,
    "cpuReservationUsedMHz": 0,
    "cpuReservationMHz": 0,
    "cpuUsedMHz": 0,
    "cpuLimitMHz": 0
}
string
id
Optional

Identifier for this zone. This is immutable.

string
name
Optional

The name of this zone.

object
region
Optional

Entity reference used to describe VCD entities

integer As int64 As int64
memoryReservationUsedMiB
Optional

The amount of reserved memory resources used in MiB. For Tenants, this value represents the total given to all of a Tenant's Namespaces. For Providers, this value represents the total given to all Tenants.

integer As int64 As int64
memoryReservationMiB
Optional

The amount of reserved memory resources reserved in MiB.

integer As int64 As int64
memoryUsedMiB
Optional

The total amount of reserved and unreserved memory resources used in MiB. For Tenants, this value represents the total given to all of a Tenant's Namespaces. For Providers, this value represents the total given to all Tenants.

integer As int64 As int64
memoryLimitMiB
Optional

The total amount of reserved and unreserved memory resources allocated in MiB.

integer As int64 As int64
cpuReservationUsedMHz
Optional

The amount of CPU resources used in MHz. For Tenants, this value represents the total given to all of a Tenant's Namespaces. For Providers, this value represents the total given to all Tenants.

integer As int64 As int64
cpuReservationMHz
Optional

The total amount of CPU resources reserved in MHz.

integer As int64 As int64
cpuUsedMHz
Optional

The amount of reserved and unreserved CPU resources used in MHz. For Tenants, this value represents the total given to all of a Tenant's Namespaces. For Providers, this value represents the total given to all Tenants.

integer As int64 As int64
cpuLimitMHz
Optional

The total amount of reserved and unreserved CPU resources allocated in MHz.


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/zones/{zoneUrn}
Availability
Added in 40.0
On This Page
Zones Operations
GET
Query Zones
GET
Get Zone