文档首页> 云堡垒机 CBH> API参考> API说明> 规格管理> 查询云堡垒机规格信息
更新时间：2024-06-13 GMT+08:00
在线调试
CLI示例
查看PDF

查询云堡垒机规格信息

功能介绍

查询云堡垒机规格信息。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/cbs/instance/specification

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

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

参数

是否必选

参数类型

描述

action

是

String

查询云堡垒机规格当前动作。

  • create：查询可创建云堡垒机规格信息

  • update：查询可变更云堡垒机规格信息

spec_code

否

String

云堡垒机规格信息，当action为update时此字段必填。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

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

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of CbsGetSpecInfo objects

Search Spec Info Successs
表5 CbsGetSpecInfo

参数

参数类型

描述

resource_spec_code

String

云堡垒机规格名称。

ecs_system_data_size

Integer

云堡垒机系统盘磁盘大小，单位GB。

cpu

Integer

云堡垒机CPU核心数。

ram

Integer

云堡垒机内存大小，单位GB。

asset

Integer

云堡垒机资产数量。

connection

Integer

云堡垒机最大连接数。

type

String

云堡垒机规格类型。

  • basic：标准版

  • enhance：专业版

data_disk_size

Number

云堡垒机数据盘大小，单位TB。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_description

String

请求参数错误。

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_description

String

校验TOKEN失败。

状态码： 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_description

String

租户无权限操作。

状态码： 404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_description

String

没有找到CBH资源。

请求示例

无

响应示例

状态码： 200

Search Spec Info Successs

[ {
  "data_disk_size" : 1,
  "ecs_system_data_size" : 10,
  "cpu" : 4,
  "connection" : 10,
  "resource_spec_code" : "cbh.basic.xxx",
  "asset" : 10,
  "type" : "basic",
  "ram" : 8
} ]

状态码

状态码

描述

200

Search Spec Info Successs

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。

父主题： 规格管理