查询可用分区详情
功能介绍
该接口用于查询云桌面支持的可用分区列表。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/availability-zones/detail
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
availability_zone_id |
是 |
String |
可用分区ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
|
Content-Type |
是 |
String |
发送的实体的MIME类型,如:application/json。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
对应CMDB的region数据中的'zoneCode'字段。 |
|
region_id |
String |
对应CMDB的region数据中的'regionCode'字段。 |
|
type |
String |
当前AZ的类型:
|
|
display_name |
String |
英文名。 |
|
status |
String |
状态。 |
|
sold_out |
SoldOutInfo object |
指定当前分区下售罄的信息。 |
|
product_ids |
Array of strings |
参品Id集。 |
|
mode |
String |
计费模式,专属 / 共享。 |
|
alias |
String |
az的别名(中文、数字、字母、下划线、中划线,最大128字节)。 |
|
public_border_group |
String |
EIP所属的group。 |
|
category |
Integer |
分类的Id:
|
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
请求示例
GET /v2/92c84e5bce3d48d7ab5714a44901eb08/availability-zones/detail?availability_zone_id=br-iaas-odin1raa
响应示例
状态码:200
查询可用分区列表响应。
{
"id" : "string",
"region_id" : "string",
"type" : "string",
"display_name" : "string",
"status" : "string",
"sold_out" : {
"products" : [ "string" ]
},
"product_ids" : [ "string" ],
"mode" : "string",
"alias" : "string",
"public_border_group" : "string",
"category" : 0
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询可用分区列表响应。 |
|
400 |
由于包含语法错误,当前请求无法被服务器理解。 |
|
401 |
鉴权失败。 |
|
403 |
没有操作权限。 |
|
404 |
找不到资源。 |
|
500 |
服务内部错误,具体返回错误码请参见错误码说明。 |
错误码
请参见错误码。