文档首页> 云堡垒机 CBH> API参考> API说明> 可用区查询> 获取服务可用区信息
更新时间：2024-06-13 GMT+08:00
在线调试
CLI示例
查看PDF

获取服务可用区信息

功能介绍

获取云堡垒机服务可用区信息。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/cbs/available-zone

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

获取方法详见API参考，附录"获取项目ID"

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

可参考"IAM获取IAM用户Token"获取

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

availability_zone

Array of AvailabilityZones objects

可用区信息
表4 AvailabilityZones

参数

参数类型

描述

region_id

String

可用区ID。

id

String

可用分区ID。

display_name

String

可用分区显示名称。

status

String

可用分区状态。

  • Running：运行中

type

String

可用分区类型。

  • Core：核心可用区

  • Dedicated：专属可用区，只对内部客户开放

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_description

String

请求参数错误。

状态码： 401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_description

String

校验TOKEN失败。

状态码： 403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_description

String

租户无权限操作。

状态码： 404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_description

String

没有找到CBH资源。

请求示例

无

响应示例

状态码： 200

List AvailableZone Info Success

{
  "availability_zone" : [ {
    "region_id" : "cn-north-4",
    "id" : "cn-north-4a",
    "type" : "Core",
    "display_name" : "可用区1",
    "status" : "Running"
  }, {
    "region_id" : "cn-north-4",
    "id" : "cn-north-4b",
    "type" : "Core",
    "display_name" : "可用区2",
    "status" : "Running"
  }, {
    "region_id" : "cn-north-4",
    "id" : "cn-north-4c",
    "type" : "Core",
    "display_name" : "可用区3",
    "status" : "Running"
  } ]
}

状态码

状态码

描述

200

List AvailableZone Info Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。

父主题： 可用区查询