文档首页/API网关 APIG/API参考/专享版API（V2）/专享版-实例管理/查询可用区信息 - ListAvailableZonesV2
更新时间：2025-12-26 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询可用区信息 - ListAvailableZonesV2

功能介绍

查询可用区信息

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v2/{project_id}/apigw/available-zones

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见获取项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

available_zones

Array of AvailableZone objects

可用区列表

表4 AvailableZone

参数

参数类型

描述

name

String

可用区名称。

id

String

实例创建失败错误信息

code

String

可用区编码。

port

String

可用区端口号。

local_name

LocalName object

可用区中英文名称。

specs

Map<String,Boolean>

可用区支持的实例规格。

表5 LocalName

参数

参数类型

描述

en_us

String

可用区英文名称。

zh_cn

String

可用区中文名称。

状态码：401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

无

响应示例

状态码：200

OK

{
  "available_zones" : [ {
    "code" : "xx-xxx-4a",
    "id" : "effdcbc7d4d64a02aa1fa26b42f56533",
    "local_name" : {
      "en_us" : "AZ1",
      "zh_cn" : "<Name_of_AZ1>"
    },
    "name" : "<Name_of_AZ1>",
    "port" : "8403",
    "specs" : {
      "BASIC" : true,
      "BASIC_IPV6" : false,
      "ENTERPRISE" : true,
      "ENTERPRISE_IPV6" : false,
      "PLATINUM" : true,
      "PLATINUM_IPV6" : false,
      "PROFESSIONAL" : true,
      "PROFESSIONAL_IPV6" : false,
      "TRIAL" : true,
      "PLATINUM_X2" : false,
      "PLATINUM_X3" : false,
      "PLATINUM_X4" : false,
      "PLATINUM_X5" : false,
      "PLATINUM_X6" : false,
      "PLATINUM_X7" : false,
      "PLATINUM_X8" : false
    }
  }, {
    "code" : "xx-xxx-4b",
    "id" : "a0865121f83b41cbafce65930a22a6e8",
    "local_name" : {
      "en_us" : "AZ2",
      "zh_cn" : "<Name_of_AZ2>"
    },
    "name" : "<Name_of_AZ2>",
    "port" : "8404",
    "specs" : {
      "BASIC" : true,
      "BASIC_IPV6" : true,
      "ENTERPRISE" : true,
      "ENTERPRISE_IPV6" : true,
      "PLATINUM" : true,
      "PLATINUM_IPV6" : false,
      "PROFESSIONAL" : true,
      "PROFESSIONAL_IPV6" : true,
      "TRIAL" : true,
      "PLATINUM_X2" : false,
      "PLATINUM_X3" : false,
      "PLATINUM_X4" : false,
      "PLATINUM_X5" : false,
      "PLATINUM_X6" : false,
      "PLATINUM_X7" : false,
      "PLATINUM_X8" : false
    }
  } ]
}

状态码：401

Unauthorized

{
  "error_code" : "APIC.7102",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码：403

Forbidden

{
  "error_code" : "APIC.7106",
  "error_msg" : "No permissions to request for the method"
}

状态码：500

Internal Server Error

{
  "error_code" : "APIC.9000",
  "error_msg" : "Failed to request internal service"
}

状态码

状态码

描述

200

OK

401

Unauthorized

403

Forbidden

500

Internal Server Error

错误码

请参见错误码。