All Products
Search
Document Center

Elastic Compute Service:DescribeZones

Last Updated:Sep 29, 2024

Queries the zones in a specific region.

Operation description

When you call this operation, only a list of zones and some resource information of each zone are returned. If you want to query instance types and disk categories that are available for purchase in a specific zone, we recommend that you call the DescribeAvailableResource operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
VerbosebooleanNo

Specifies whether to display detailed information.

  • true: displays detailed information.
  • false: does not display detailed information.

Default value: true.

false
InstanceChargeTypestringNo

The billing method of resources. For more information, see Billing overview. Valid values:

  • PrePaid: subscription
  • PostPaid: pay-as-you-go

Default value: PostPaid.

PostPaid
SpotStrategystringNo

The bidding policy for pay-as-you-go instances. You can specify this parameter when the InstanceChargeType parameter is set to PostPaid. For more information, see Preemptible instances. Valid values:

  • NoSpot: The instances are regular pay-as-you-go instances.
  • SpotWithPriceLimit: The instances are preemptible instances with user-defined maximum hourly prices.
  • SpotAsPriceGo: The instances are preemptible instances for which the market price at the time of purchase is automatically used as the bid price. The market price can be up to the pay-as-you-go price.

Default value: NoSpot.

NoSpot
AcceptLanguagestringNo

The natural language that is used to filter responses. For more information, see RFC 7231. Valid values:

  • zh-CN
  • en-US
  • ja

Default value: zh-CN.

zh-CN

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Zonesarray<object>

Details of the zones and their supported resources.

Zoneobject
ZoneIdstring

The ID of the zone.

cn-hangzhou-g
ZoneTypestring

The type of the zone. Valid values:

  • AvailabilityZone: zone for the Alibaba Cloud public cloud
  • CloudBoxZone: zone for CloudBox
AvailabilityZone
LocalNamestring

The name of the zone in the local language.

Hangzhou Zone G
AvailableResourcesarray<object>

Details about the resources that can be created in the zone.

ResourcesInfoobject
IoOptimizedboolean

Indicates whether the instance is I/O optimized.

true
SystemDiskCategoriesarray

The supported categories of system disks that can be created.

supportedSystemDiskCategorystring

The category of system disks that can be created. Valid values:

  • cloud: basic disk
  • cloud_efficiency: ultra disk
  • cloud_ssd: standard SSD
  • cloud_essd: enhanced SSD (ESSD)
cloud_essd
InstanceGenerationsarray

The supported generations of instance families.

supportedInstanceGenerationstring

The supported generation of instance families.

ecs-6
DataDiskCategoriesarray

The categories of data disks that can be created.

supportedDataDiskCategorystring

The category of data disks that can be created. Valid values:

  • cloud: basic disk
  • cloud_efficiency: ultra disk
  • cloud_ssd: standard SSD
  • cloud_essd: ESSD
  • ephemeral_ssd: local SSD
cloud_essd
InstanceTypesarray

The supported instance types.

supportedInstanceTypestring

The instance type of I/O optimized instances of different network types that can be created in the zone.

ecs.g5.large
InstanceTypeFamiliesarray

The supported instance families.

supportedInstanceTypeFamilystring

The supported instance family.

ecs.r7t
NetworkTypesarray

The supported network types

supportedNetworkCategorystring

The supported network type. Valid values:

  • VPC: Virtual Private Cloud (VPC)
  • Classic: classic network
vpc
AvailableResourceCreationarray

The types of resources that can be created. Valid values:

  • VSwitch: vSwitch
  • IoOptimized: I/O optimized instance
  • Instance: instance
  • DedicatedHost: dedicated host
  • disk: disk
ResourceTypesstring

The type of resources that can be created. Valid values:

  • VSwitch: vSwitch
  • IoOptimized: I/O optimized instance
  • Instance: instance
  • DedicatedHost: dedicated host
  • disk: disk
DedicatedHost
DedicatedHostGenerationsarray

The supported generations of dedicated hosts.

DedicatedHostGenerationstring

The supported generation of dedicated hosts.

ddh-6
AvailableInstanceTypesarray

The supported instance types.

InstanceTypesstring

The supported instance type.

ecs.g6.xlarge
AvailableDiskCategoriesarray

The supported disk categories. Valid values:

  • cloud: basic disk
  • cloud_ssd: standard SSD
  • cloud_efficiency: ultra disk
  • cloud_essd: ESSD
DiskCategoriesstring

The supported disk category. Valid values:

  • cloud: basic disk
  • cloud_ssd: standard SSD
  • cloud_efficiency: ultra disk
  • cloud_essd: ESSD
cloud
AvailableDedicatedHostTypesarray

The supported dedicated host types.

DedicatedHostTypestring

The supported dedicated host type.

ddh.g6
AvailableVolumeCategoriesarray

The supported Shared Block Storage device categories.

VolumeCategoriesstring

The supported Shared Block Storage device category.

san_efficiency

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Zones": {
    "Zone": [
      {
        "ZoneId": "cn-hangzhou-g",
        "ZoneType": "AvailabilityZone",
        "LocalName": "Hangzhou Zone G\n",
        "AvailableResources": {
          "ResourcesInfo": [
            {
              "IoOptimized": true,
              "SystemDiskCategories": {
                "supportedSystemDiskCategory": [
                  "cloud_essd"
                ]
              },
              "InstanceGenerations": {
                "supportedInstanceGeneration": [
                  "ecs-6"
                ]
              },
              "DataDiskCategories": {
                "supportedDataDiskCategory": [
                  "cloud_essd"
                ]
              },
              "InstanceTypes": {
                "supportedInstanceType": [
                  "ecs.g5.large"
                ]
              },
              "InstanceTypeFamilies": {
                "supportedInstanceTypeFamily": [
                  "ecs.r7t"
                ]
              },
              "NetworkTypes": {
                "supportedNetworkCategory": [
                  "vpc"
                ]
              }
            }
          ]
        },
        "AvailableResourceCreation": {
          "ResourceTypes": [
            "DedicatedHost"
          ]
        },
        "DedicatedHostGenerations": {
          "DedicatedHostGeneration": [
            "ddh-6"
          ]
        },
        "AvailableInstanceTypes": {
          "InstanceTypes": [
            "ecs.g6.xlarge"
          ]
        },
        "AvailableDiskCategories": {
          "DiskCategories": [
            "cloud"
          ]
        },
        "AvailableDedicatedHostTypes": {
          "DedicatedHostType": [
            "ddh.g6"
          ]
        },
        "AvailableVolumeCategories": {
          "VolumeCategories": [
            "san_efficiency"
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidSpotStrategyThe specified SpotStrategy is not valid.The specified SpotStrategy parameter is invalid.
404InvalidRegionId.NotFoundThe specified RegionId does not exist.The specified region ID does not exist.
404InvalidRegion.NotFoundThe specified parameter RegionId is not valid.The specified RegionId parameter is invalid.
404InvalidInstanceChargeType.NotFoundThe InstanceChargeType does not exist in our records-
404InvalidAcceptLanguage.NotFoundOnly Chinese (zh-CN), English (en-US), and Japanese (ja) are allowed.Your selected language is invalid. Only Chinese, English, and Japanese are supported.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history