查询可用区信息 - ListAvailabilityZoneInfosNew
功能介绍
查询可用区信息
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v2/{project_id}/availability-zone
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可通过IAM服务[查询指定IAM用户的项目列表]接口获取。 约束限制: 不涉及 取值范围: 以IAM服务接口返回值为准,字符长度32-64。 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: IAM服务查询用户Token接口为准 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| azs | Array of AzInfo objects | 可用区集合 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| zone_name | String | 可用区名称 |
| zone_number | Integer | 可用区编号 |
| az_type | String | 可用区类型 |
| alias | String | 可用区中文别名 |
| alias_us | String | 可用区英文别名 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| details | Array of DbssErrorDetail objects | PDP5鉴权异常信息 |
| encoded_authorization_message | String | PDP5鉴权异常信息 |
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| details | Array of DbssErrorDetail objects | PDP5鉴权异常信息 |
| encoded_authorization_message | String | PDP5鉴权异常信息 |
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| details | Array of DbssErrorDetail objects | PDP5鉴权异常信息 |
| encoded_authorization_message | String | PDP5鉴权异常信息 |
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
请求示例
/v2/{project_id}/availability-zone 响应示例
状态码:200
成功
{
"azs" : [ {
"zone_name" : "cn-north-7b",
"zone_number" : 2,
"az_type" : "normal",
"alias" : "可用区2",
"alias_us" : "AZ2"
}, {
"zone_name" : "cn-north-7a",
"zone_number" : 1,
"az_type" : "normal",
"alias" : "可用区1",
"alias_us" : "AZ1"
}, {
"zone_name" : "cn-north-7c",
"zone_number" : 3,
"az_type" : "normal",
"alias" : "可用区3",
"alias_us" : "AZ3"
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 成功 |
| 400 | 客户端错误 |
| 403 | 认证失败 |
| 500 | 服务端错误 |
错误码
请参见错误码。