DescribeRegions

更新时间:
复制 MD 格式

Queries Alibaba Cloud regions. When you call this operation, you can specify parameters, such as InstanceChargeType and ResourceType, in the request.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

InstanceChargeType

string

No

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: spot instance for which a maximum hourly price is specified.

  • SpotAsPriceGo: spot 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

ResourceType

string

No

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

AcceptLanguage

string

No

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

  • zh-CN: Simplified Chinese

  • zh_TW: Traditional Chinese

  • en-US: English

  • ja: Japanese

  • fr: French

  • de: German

  • ko: Korean

Default value: zh-CN.

Valid values:

  • de :

    German

  • en-US :

    English

  • ko :

    Korean

  • zh-TW :

    Traditional Chinese

  • ja :

    Japanese

  • fr :

    French

  • zh-CN :

    Simplified Chinese

zh-CN

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Regions

object

Region

array<object>

The information of the regions.

object

Status

string

Indicates whether clusters are sold out. Valid values:

  • available

  • soldOut

available

RegionEndpoint

string

The endpoint of the region.

ecs.cn-qingdao.aliyuncs.com

LocalName

string

The name of the region.

华北1(青岛)

RegionId

string

The ID of the region.

cn-qingdao

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Regions": {
    "Region": [
      {
        "Status": "available",
        "RegionEndpoint": "ecs.cn-qingdao.aliyuncs.com",
        "LocalName": "华北1(青岛)",
        "RegionId": "cn-qingdao"
      }
    ]
  }
}

Error codes

HTTP status code

Error code

Error message

Description

403 Unauthorized.EmptyRegion The specified account has no access authority to any region.
403 Invalid.InstanceChargeType The specified instanceChargeType is not valid.
404 InvalidAcceptLanguage.NotFound Only Chinese (zh-CN), English (en-US), and Japanese (ja) are allowed. Your selected language is invalid. Only Chinese, English, and Japanese are supported.
404 InvalidResourceType.NotFound The ResourceType provided does not exist in our records. The specified resource type does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.