Get Zones
Returns the information about a specific zone. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
Request
URLURL
https://{api_host}/api/vcenter/consumption-domains/zones/{zone}
Path Parameters
Path Parameters
string
zone
Required
Identifier of the zone for which information should be retrieved. The parameter must be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
ConsumptionDomainsZonesInfo
of type application/json
Detailed information about the specified zone.
{
"description": "string"
}
string
description
Required
Description of the zone.
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have all of the privileges described as follows: - The resource com.vmware.vcenter.consumption_domains.Zone referenced by the parameter zone requires System.Read privilege.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetZoneConsumptionDomains -Zone "MyZone"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/consumption-domains/zones/{zone}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 8.0.0.1
