全部产品
Search
文档中心

云服务器 ECS:DescribeRegions - 查询地域信息

更新时间:Nov 22, 2024

查询块存储EBS相关功能异步复制、数据洞察、专属块存储集群支持的地域信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ebs:DescribeRegionsget
*全部资源
*

请求参数

名称类型必填描述示例值
ResourceTypestring

资源类型。取值范围:

  • ear:异步复制。

  • lens:数据洞察。

  • dbsc: 专属块存储集群。

未指定资源类型时,将会返回所有资源类型支持的地域信息。

ear
AcceptLanguagestring

地域和可用区名称的语言类型。对应返回参数中LocalName的返回值。取值范围:

  • zh-CN:中文。
  • en-US:英文。
  • ja:日文。

默认值:zh-CN。

zh-CN
RegionIdstring

用户访问端的地域 ID。

cn-beijing

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

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

地域和可用区信息合集。

regionobject
LocalNamestring

地域名称。

华东1(杭州)
RegionEndpointstring

地域对应的接入地址(Endpoint)。

ebs.cn-hangzhou.aliyuncs.com
RegionIdstring

地域 ID。

cn-hangzhou
Zonesarray<object>

可用区信息合集。

zoneobject
LocalNamestring

可用区名称。

杭州 可用区H
ZoneIdstring

可用区 ID。

cn-hangzhou-h
ResourceTypesarray

资源类型列表。

resourcestring

资源类型。可能值:

  • ear:异步复制。

  • lens:数据洞察。

  • dbsc: 专属块存储集群。

ear

示例

正常返回示例

JSON格式

{
  "RequestId": "17EE62D8-064E-5404-8B0D-72122478****",
  "Regions": [
    {
      "LocalName": "华东1(杭州)",
      "RegionEndpoint": "ebs.cn-hangzhou.aliyuncs.com",
      "RegionId": "cn-hangzhou",
      "Zones": [
        {
          "LocalName": "杭州 可用区H",
          "ZoneId": "cn-hangzhou-h",
          "ResourceTypes": [
            "ear"
          ]
        }
      ]
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
403ForbiddenUser is not authorized to operate.当前用户无权限对当前资源执行任何操作。请检查您的账号权限或者咨询您的主账号管理员。
403Forbidden.ActionUser is not authorized to operate this action.当前用户无权限执行该操作。请检查您的账号权限或者咨询您的主账号管理员。
404NoSuchResourceThe specified resource does not exist.指定的资源不存在。
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.内部错误。
504RequestTimeoutThe request is timeout, please try again later.该请求超时,请稍后再重试。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-02-02API 内部配置变更,不影响调用查看变更详情
2023-06-26API 内部配置变更,不影响调用查看变更详情