文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 可用分区/ 查询可用分区列表概要
更新时间：2024-12-27 GMT+08:00
查看PDF
分享

查询可用分区列表概要

功能介绍

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

调试

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

URI

GET /v2/{project_id}/availability-zones/summary

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目id。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。

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

Content-Type

是

String

发送的实体的MIME类型，如：application/json。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

support_type

Array of strings

支持类型。

default_type

String

默认类型。

azs

Map<String,Array<AzInfo>>

可用区。
表4 AzInfo

参数

参数类型

描述

availability_zone

String

可用区名称。

i18n

I18n object

国际化。

default_availability_zone

Boolean

是否为默认可用分区。
表5 I18n

参数

参数类型

描述

zh_cn

String

可用分区中文名称。

en_us

String

可用分区英语名称。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

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

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

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

状态码： 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

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

状态码： 404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

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

状态码： 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

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

请求示例

GET /v2/92c84e5bce3d48d7ab5714a44901eb08/availability-zones/summary

响应示例

状态码： 200

查询可用分区列表响应。

{
  "support_type" : [ "string" ],
  "default_type" : "string",
  "azs" : {
    "additionalProp1" : [ {
      "availability_zone" : "string",
      "i18n" : {
        "zh_cn" : "string",
        "en_us" : "string"
      },
      "default_availability_zone" : true
    } ],
    "additionalProp2" : [ {
      "availability_zone" : "string",
      "i18n" : {
        "zh_cn" : "string",
        "en_us" : "string"
      },
      "default_availability_zone" : true
    } ],
    "additionalProp3" : [ {
      "availability_zone" : "string",
      "i18n" : {
        "zh_cn" : "string",
        "en_us" : "string"
      },
      "default_availability_zone" : true
    } ]
  }
}

状态码

状态码

描述

200

查询可用分区列表响应。

400

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

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

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

错误码

请参见错误码。

父主题： 可用分区

相关文档