查询可用区列表
功能介绍
该API用于查询可用区列表
调用方法
请参见如何调用API。
URI
GET /api/v2/availabilityZones
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 是 | String | 参数解释: 消息体的类型(格式),默认为application/json,有其他取值时会在具体接口中专门说明。 约束限制: GET方法不做校验 默认取值: 不涉及 |
| X-Auth-Token | 是 | String | 参数解释: 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值,获取方式请参见获取token。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| [数组元素] | Array of GetAvailableZoneResponseBody objects | 参数解释: 可用区列表信息 约束限制: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 可用区ID 取值范围: 不涉及 |
| name | String | 参数解释: 可用区名称 取值范围: 不涉及 |
| displayName | String | 参数解释: 可用区按所在区域显示的名称 取值范围: 不涉及 |
| azGroupIds | Array of strings | 参数解释: 可用区所属的可用区组,一个可用区可能属于多个可用区组 取值范围: 不涉及 |
| PublicBorderGroup | String | 参数解释: EIP所属的组,IES边缘场景为可用区ID,中心区统一为“center” 取值范围: 不涉及 |
| category | String | 参数解释: 可用区分类 取值范围: |
| alias | String | 参数解释: 可用区名称别名 取值范围: 不涉及 |
请求示例
无
响应示例
状态码:200
表示获取可用区列表成功。
[ {
"id" : "cn-north-4a",
"name" : "可用区a",
"displayName" : "可用区a",
"azGroupIds" : [ "cn-north-4-all" ],
"publicBorderGroup" : "center",
"category" : "Default",
"alias" : "可用区a"
} ] 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示获取可用区列表成功。 |
错误码
请参见错误码。