文档首页/ 云堡垒机 CBH/ API参考/ API说明/ 配额管理/ 获取创建堡垒机实例所需ECS资源配额
更新时间:2024-11-12 GMT+08:00

获取创建堡垒机实例所需ECS资源配额

功能介绍

获取当前租户所选择的可用分区里的堡垒机ECS规格是否可用。

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/cbs/instance/ecs-quota

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

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

表2 Query参数

参数

是否必选

参数类型

描述

availability_zone

String

可用分区名称。

可参考接口"获取服务可用区"获取

resource_spec_code

String

待创建云堡垒机规格ID,例如:

  • cbh.basic.10 10资产标准版
  • cbh.enhance.10 10资产专业版

可参考接口"查询云堡垒机规格信息"获取

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

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

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

status_v6

String

支持IPv6云堡垒机实例规格资源状态。

  • sellout:售罄
  • normal:正常商用

status

String

云堡垒机实例规格资源状态。

  • sellout:售罄
  • normal:正常商用

状态码: 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

Get Ecs Quota Success

{
  "status_v6" : "sellout",
  "status" : "normal"
}

状态码

状态码

描述

200

Get Ecs Quota Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码