文档首页> 云堡垒机 CBH> API参考> API说明> 获取CBH实例列表
更新时间:2021-12-27 GMT+08:00
分享

获取CBH实例列表

功能介绍

获取CBH实例列表

调试

您可以在API Explorer中调试该接口。

URI

GET /v1/{project_id}/cbs/instance/list

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

Tenant Project Id

请求参数

响应参数

状态码: 200

表2 响应Body参数

参数

参数类型

描述

total

Integer

实例总数

quota_detail

QuotaDetail object

当前租户CBH的配额信息

instance

Array of InstanceDetail objects

实例列表

表3 QuotaDetail

参数

参数类型

描述

zh_cn

String

中文配额描述

en_us

String

英文配额描述

remaining

Integer

租户剩余配额数量

表4 InstanceDetail

参数

参数类型

描述

publicip

String

弹性ip

exp_time

String

过期时间

start_time

String

开始时间

end_time

String

结束时间

release_time

String

释放时间

name

String

实例名称

instance_id

String

实例的server id

private_ip

String

实例私有ip

task_status

String

实例当前的任务状态

status

String

实例状态

created

String

实例创建时间

region

String

实例所在region

zone

String

实例所在可用区id

availability_zone_display

String

实例所在可用区名称

vpc_id

String

实例所在vpc的id

subnet_id

String

实例所在子网的id

security_group_id

String

实例所属的安全组的id

specification

String

实例规格

update

String

实例镜像是否可以升级

createinstance_status

String

在创建实例过程中的过程状态信息

fail_reason

String

创建实例失败原因

instance_key

String

实例ID

order_id

String

订单id

period_num

String

租户购买的时长

resource_id

String

实例的资源id

bastion_type

String

堡垒机类型

public_id

String

实例绑定的弹性IP的id

alter_permit

String

前端是否显示扩容按钮

bastion_version

String

实例镜像当前版本号

new_bastion_version

String

实例镜像最新版本号

instance_status

String

实例状态

instance_description

String

实例描述

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_description

String

错误描述

状态码: 401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_description

String

错误描述

状态码: 403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_description

String

错误描述

状态码: 404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_description

String

错误描述

请求示例

响应示例

状态码

状态码

描述

200

Cbh List Instance Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码

分享:

    相关文档

    相关产品

close