All Products
Search
Document Center

Elastic Compute Service:DescribeRegions

Last Updated:Dec 03, 2024

Queries available Alibaba Cloud regions.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceChargeTypestringNo

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

  • PrePaid: subscription. If you set this parameter to PrePaid, make sure that you have sufficient balance or credits in your account. Otherwise, the InvalidPayMethod error code is returned.
  • PostPaid: pay-as-you-go.
  • SpotWithPriceLimit: preemptible instance for which a maximum hourly price is specified.
  • SpotAsPriceGo: preemptible instance 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: PostPaid.

PrePaid
ResourceTypestringNo

The type of resource. Valid values:

  • instance: Elastic Compute Service (ECS) instance
  • disk: disk
  • reservedinstance: reserved instance
  • scu: storage capacity unit (SCU)

Default value: instance.

instance
AcceptLanguagestringNo

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

  • zh-CN: Chinese
  • en-US: English
  • ja: Japanese

Default value: zh-CN.

zh-CN

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

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

The information of the regions.

Regionobject
Statusstring

Indicates whether clusters are sold out. Valid values:

  • available
  • soldOut
available
RegionEndpointstring

The endpoint of the region.

ecs.aliyuncs.com
LocalNamestring

The name of the region.

China (Qingdao)
RegionIdstring

The ID of the region.

cn-qingdao-et2-bo1

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Regions": {
    "Region": [
      {
        "Status": "available",
        "RegionEndpoint": "ecs.aliyuncs.com",
        "LocalName": "China (Qingdao)",
        "RegionId": "cn-qingdao-et2-bo1"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
403Unauthorized.EmptyRegionThe specified account has no access authority to any region.You do not have permissions to access any regions. Apply for the permissions and try again.
403Invalid.InstanceChargeTypeThe specified instanceChargeType is not valid.The specified InstanceChargeType parameter is invalid.
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.
404InvalidResourceType.NotFoundThe ResourceType provided does not exist in our records.The specified resource type does not exist.

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

Change history

Change timeSummary of changesOperation
No change history