文档首页/ 云桌面 Workspace/ API参考/ 云应用API/ 可用区管理/ 查询可用分区列表
更新时间：2024-09-05 GMT+08:00
查看PDF
分享

查询可用分区列表

功能介绍

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

调试

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

URI

GET /v1/{project_id}/availability-zone

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目唯一标识。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

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

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

availability_zones

Array of AvailabilityZoneInfo objects

云应用支持的可用分区列表。

total_count

Integer

总数。
表4 AvailabilityZoneInfo

参数

参数类型

描述

availability_zone

String

可用分区编码。

display_name

String

可用分区名称。

i18n

Map<String,I18n>

可用分区国际化信息。

sold_out

SoldOutInfo object

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

product_ids

Array of strings

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

visible

Boolean

是否可见。

default_availability_zone

Boolean

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

参数

参数类型

描述

zh_cn

String

可用分区中文名称。

en_us

String

可用分区英语名称。
表6 SoldOutInfo

参数

参数类型

描述

products

Array of strings

售罄产品ID列表。

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

请求示例

GET /v1/29dfe82ada564ac2b927e1ff036d9a9b/availability-zone

响应示例

状态码： 200

成功响应。

{
  "availability_zones" : [ {
    "availability_zone" : "cn-north-7a",
    "display_name" : "cn-north-7a",
    "i18n" : {
      "en_us" : "AZ1",
      "zh_cn" : "可用区1"
    },
    "sold_out" : {
      "products" : [ ]
    },
    "product_ids" : [ ],
    "visible" : true,
    "default_availability_zone" : false
  }, {
    "availability_zone" : "cn-north-7b",
    "display_name" : "cn-north-7b",
    "i18n" : {
      "en_us" : "AZ2",
      "zh_cn" : "可用区2"
    },
    "sold_out" : {
      "products" : [ ]
    },
    "product_ids" : [ ],
    "visible" : true,
    "default_availability_zone" : false
  }, {
    "availability_zone" : "cn-north-7c",
    "display_name" : "cn-north-7c",
    "i18n" : {
      "en_us" : "AZ3",
      "zh_cn" : "可用区3"
    },
    "sold_out" : {
      "products" : [ ]
    },
    "product_ids" : [ ],
    "visible" : true,
    "default_availability_zone" : false
  } ],
  "total_count" : 3
}

状态码

状态码

描述

200

成功响应。

400

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

401

鉴权失败。

403

没有操作权限。

500

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

错误码

请参见错误码。

父主题： 可用区管理

相关文档