DescribeRegions - 获取Region列表

调用DescribeRegions接口获取可用地域列表供用户选择,可根据场景信息、vpc类型等进行筛选。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

pvtz:DescribeRegions

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

Lang

string

返回值语言,取值:

  • zh:中文。

  • en:英文。

默认:en

说明

优先级低于 AcceptLanguage。

zh

UserClientIp

string

用户 Ip。

192.0.XX.XX

AcceptLanguage

string

支持的语言。取值:

  • zh-CN:中文

  • en-US:英文

默认:en-US

说明

优先级高于 Lang。

zh-CN

AuthorizedUserId

integer

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

141339776561****

VpcType

string

VPC 类型。取值:

  • STANDARD:标准 VPC。

  • EDS:无影工作区 VPC。

STANDARD

Scene

string

场景信息。取值:

  • AUTH:内置权威

  • FWD:转发管理

  • RA:流量分析

AUTH

返回参数

名称

类型

描述

示例值

object

RequestId

string

唯一请求识别码。

1E0F6898-F854-5133-A4CB-9C094152D05A

Regions

object

Region

array<object>

地域信息列表。

object

地域信息详情。

LocalName

string

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

华东2(上海)

RegionName

string

地域的名称。

华东2(上海)

RegionEndpoint

string

Region 服务的 Endpoint 地址。

pvtz.aliyuncs.com

RegionId

string

地域 ID。

cn-beijing

示例

正常返回示例

JSON格式

{
  "RequestId": "1E0F6898-F854-5133-A4CB-9C094152D05A",
  "Regions": {
    "Region": [
      {
        "LocalName": "华东2(上海)",
        "RegionName": "华东2(上海)",
        "RegionEndpoint": "pvtz.aliyuncs.com",
        "RegionId": "cn-beijing"
      }
    ]
  }
}

异常返回示例

JSON格式

{
    "Message": "The request processing has failed due to some unknown error, exception or failure", 
    "RequestId": "E246E023-F2EB-4034-83F7-B13FCF31459C", 
    "Code": "InternalError"
}

错误码

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

变更历史

更多信息,参考变更详情