All Products
Search
Document Center

Elastic Compute Service:DescribeRegions

Last Updated:Sep 25, 2024

Queries the details of regions in which Elastic Block Storage (EBS) features (such as async replication, CloudLens for EBS, and Dedicated Block Storage Cluster) are supported.

Debugging

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

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ebs:DescribeRegionsget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceTypestringNo

The type of resource. Valid values:

  • ear: async replication
  • lens: CloudLens for EBS
  • dbsc: Dedicated Block Storage Cluster

Default value: ear.

ear
AcceptLanguagestringNo

The language in which the regions and zones are named. This parameter corresponds to the LocalName response parameter. Valid values:

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

Default value: zh-CN.

zh-CN
RegionIdstringNo

The ID of the region.

cn-beijing

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

17EE62D8-064E-5404-8B0D-72122478****
Regionsarray<object>

Details about the regions.

regionobject
LocalNamestring

The name of the region.

China (Hangzhou)
RegionEndpointstring

The endpoint of the region.

ebs.cn-hangzhou.aliyuncs.com
RegionIdstring

The ID of the region.

cn-hangzhou
Zonesarray<object>

Details about the zones.

zoneobject
LocalNamestring

The name of the zone.

Hangzhou Zone H
ZoneIdstring

The ID of the zone.

cn-hangzhou-h
ResourceTypesarray

The type of resource list.

resourcestring

The type of resource. Valid values:

  • ear: async replication

  • lens: CloudLens for EBS

  • dbsc: Dedicated Block Storage Cluster

ear

Examples

Sample success responses

JSONformat

{
  "RequestId": "17EE62D8-064E-5404-8B0D-72122478****",
  "Regions": [
    {
      "LocalName": "China (Hangzhou)",
      "RegionEndpoint": "ebs.cn-hangzhou.aliyuncs.com",
      "RegionId": "cn-hangzhou",
      "Zones": [
        {
          "LocalName": "Hangzhou Zone H",
          "ZoneId": "cn-hangzhou-h",
          "ResourceTypes": [
            "ear"
          ]
        }
      ]
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
403ForbiddenUser is not authorized to operate.You are not authorized to manage the resource. Check the account permissions or contact the Alibaba Cloud account.
403Forbidden.ActionUser is not authorized to operate this action.You are not authorized to perform this operation. Check the account permissions or contact the Alibaba Cloud account.
404NoSuchResourceThe specified resource does not exist.The specified resource does not exist.
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.An internal error has occurred.
504RequestTimeoutThe request is timeout, please try again later.The request has timed out. Try again later.

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

Change history

Change timeSummary of changesOperation
2024-02-02The internal configuration of the API is changed, but the call is not affectedView Change Details
2023-06-26The internal configuration of the API is changed, but the call is not affectedView Change Details