文档首页/ 云硬盘 EVS/ API参考/ Cinder API/ 可用区查询/ 查询所有的可用分区信息
更新时间：2024-02-27 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询所有的可用分区信息

功能介绍

查询所有的可用分区信息。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/os-availability-zone

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

获取方法请参见"获取项目ID"。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

availabilityZoneInfo

Array of AzInfo objects

查询请求返回的可用分区列表。
表4 AzInfo

参数

参数类型

描述

zoneName

String

可用分区的名字。

zoneState

ZoneState object

可用分区的状态。
表5 ZoneState

参数

参数类型

描述

available

Boolean

可用分区是否可用。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error

Error object

出现错误时，返回的错误信息。
表7 Error

参数

参数类型

描述

code

String

出现错误时，返回的错误码。

错误码和其对应的含义请参考错误码说明。

message

String

出现错误时，返回的错误消息。

请求示例

GET https://{endpoint}/v2/{project_id}/os-availability-zone

响应示例

状态码： 200

可用分区的信息。

{
  "availabilityZoneInfo" : [ {
    "zoneState" : {
      "available" : true
    },
    "zoneName" : "az-dc-1"
  } ]
}

状态码： 400

Bad Request

{
  "error" : {
    "message" : "XXXX",
    "code" : "XXX"
  }
}

状态码

状态码

描述

200

可用分区的信息。

400

Bad Request

错误码

请参见错误码。

父主题： 可用区查询