文档

DescribeRegions - 获取Region列表

更新时间:

调用DescribeRegions接口获取可用地域列表供用户选择。

调试

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

授权信息

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

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

请求参数

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

语言。

zh
UserClientIpstring

用户 Ip。

192.0.2.0
AcceptLanguagestring

支持的语言。包括以下取值:

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

授权资源的所属用户主账号 ID。

111222333
VpcTypestring

VPC 类型:

  • STANDARD:标准 VPC。

  • EDS:无影工作区 VPC。

STANDARD
Scenestring

场景信息。

  • AUTH:内置权威
  • FWD:转发管理
  • RA:流量分析
AUTH

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

AF7D4DCE-0776-47F2-A9B2-6FB85A87AA60
Regionsarray<object>

地域列表。

object
LocalNamestring

地域的展示名,根据当前语言环境转换。

华北2(北京)
RegionNamestring

地域的名称。

华北2(北京)
RegionEndpointstring

Region 服务的 Endpoint 地址。

pvtz.aliyuncs.com
RegionIdstring

地域 ID。

cn-beijing

示例

正常返回示例

JSON格式

{
  "RequestId": "AF7D4DCE-0776-47F2-A9B2-6FB85A87AA60",
  "Regions": {
    "Region": [
      {
        "LocalName": "华北2(北京)",
        "RegionName": "华北2(北京)",
        "RegionEndpoint": "pvtz.aliyuncs.com",
        "RegionId": "cn-beijing"
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史