文档首页/云桌面 Workspace/API参考/云桌面API/可用分区/查询可用分区列表 - ListAvailabilityZones
更新时间：2026-03-17 GMT+08:00
查看PDF
分享

查询可用分区列表 - ListAvailabilityZones

功能介绍

该接口用于查询云桌面支持的可用分区列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

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

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

URI

GET /v2/{project_id}/availability-zones

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

availability_zones

Array of AvailabilityZoneInfo objects

云桌面支持的可用分区列表。

total_count

Integer

云桌面支持的可用分区列表总数。

表3 AvailabilityZoneInfo

参数

参数类型

描述

availability_zone

String

可用分区编码。

display_name

String

可用分区名称。

i18n

Map<String,String>

可用分区国际化信息。

sold_out

SoldOutInfo object

指定当前分区下售罄的信息。

product_ids

Array of strings

指定当前分区下自定义支持的产品ID列表，如果为空则支持所有套餐。

visible

Boolean

是否可见。

default_availability_zone

Boolean

是否默认可用分区。

表4 SoldOutInfo

参数

参数类型

描述

products

Array of strings

售罄产品ID列表。

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：405

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：503

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

GET /v2/92c84e5bce3d48d7ab5714a44901eb08/availability-zones

响应示例

状态码：200

查询可用分区列表响应。

{
  "availability_zones" : [ {
    "availability_zone" : "string",
    "display_name" : "string",
    "sold_out" : { },
    "product_ids" : [ "string" ],
    "visible" : true,
    "default_availability_zone" : true
  } ],
  "total_count" : 1
}

状态码

状态码

描述

200

查询可用分区列表响应。

400

由于包含语法错误，当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

405

请求中指定的方法不被允许。

500

服务内部错误，具体返回错误码请参见错误码说明。

503

服务不可用。

错误码

请参见错误码。

父主题：可用分区