文档首页/ 云堡垒机 CBH/ API参考/ API说明/ 操作管理/ 获取堡垒机实例列表

更新时间：2024-11-12 GMT+08:00

在线调试

CLI示例

查看PDF

获取堡垒机实例列表

功能介绍

获取当前租户下的堡垒机实例列表。

调用方法

请参见如何调用API。

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。获取方法详见API参考，附录"获取项目ID"

表2 Query参数
参数	是否必选	参数类型	描述
instance_id	否	Number	云堡垒机实例ID。（非必传，需要查询单个实例详情时传入）

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。可参考"IAM获取IAM用户Token"获取

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
total	Integer	云堡垒机实例总数。
instance	Array of InstanceDetail objects	云堡垒机实例列表信息。

表5 InstanceDetail
参数	参数类型	描述
name	String	云堡垒机实例名称。
server_id	String	云堡垒机服务器id。
instance_id	String	云堡垒机实例id。
alter_permit	Boolean	云堡垒机实例是否可以扩容。 true：是 false：否
enterprise_project_id	String	项目ID。
period_num	String	云堡垒机实例订购周期数。
start_time	String	云堡垒机实例开始时间，使用时间戳格式表示。
end_time	String	云堡垒机实例结束时间，使用时间戳格式表示。
created_time	String	云堡垒机实例创建时间，使用UTC时间表示。
upgrade_time	Long	云堡垒机实例升级定时时间，使用时间戳格式表示。
update	String	云堡垒机实例是否可以升级。 OLD：当前已是最新版本 NEW：可以升级小版本 CROSS_OS：可以跨版本升级 ROLLBACK：可以回滚枚举值： OLD NEW CROSS_OS ROLLBACK
bastion_version	String	云堡垒机实例当前版本。
az_info	az_info object	可用区信息。
status_info	status_info object	状态信息。
resource_info	resource_info object	资源信息。
network	network object	网络信息。
ha_info	ha_info object	主备信息。

表6 az_info
参数	参数类型	描述
region	String	云堡垒机实例所在可用区ID。
zone	String	云堡垒机实例所在可用分区ID。(实例为主备模式时作为主机实例所在可用分区)
availability_zone_display	String	云堡垒机实例所在可用分区中文名称。(实例为主备模式时作为主机实例所在可用分区中文名称)
slave_zone	String	云堡垒机备机实例所在可用区。
slave_zone_display	String	云堡垒机备机实例所在可用区中文名称。

表7 status_info
参数	参数类型	描述
status	String	云堡垒机实例状态。 SHUTOFF：已关闭 ACTIVE：运行中 DELETING：删除中 BUILD：创建中 DELETED：已删除 ERROR：故障 HAWAIT：等待备机创建成功 FROZEN：已冻结 UPGRADING：升级中 UNPAID：待支付 RESIZE：规格变更中 DILATATION：扩容中 HA：配置HA中
task_status	String	云堡垒机实例当前的任务状态。 powering-on：开启 powering-off：关闭 rebooting：重启 delete_wait：删除 frozen：冻结 NO_TASK：运行 unfrozen：解冻 alter：变更 updating：升级中 configuring-ha：配置HA data-migrating：数据迁移中 rollback：版本回滚中 traffic-switchover：流量切换中
create_instance_status	String	云堡垒机实例在创建实例过程中的状态信息。 Waiting for payment：等待支付 creating-network：创建网络 creating-server：创建服务 tranfering-horizontal-network：网络打通 adding-policy-route：添加路由策略 configing-dns：配置DNS starting-cbs-service：服务运行中 setting-init-conf：初始化 buying-EIP：购买弹性公网IP
instance_status	String	云堡垒机实例状态。 building：创建中 deleting：删除中 deleted：删除了 unpaid：未支付 upgrading：升级中 resizing：扩容中 abnormal：异常 error：故障 ok：正常
instance_description	String	云堡垒机实例信息描述。
fail_reason	String	云堡垒机实例创建实例失败原因。

表8 resource_info
参数	参数类型	描述
specification	String	云堡垒机实例规格。
order_id	String	订单id。
resource_id	String	云堡垒机实例的资源id，UUID格式显示。
data_disk_size	Number	云堡垒机实例数据盘大小，单位TB。
disk_resource_id	Array of strings	云堡垒机实例数据盘资源ID。

表9 network
参数	参数类型	描述
vip	String	云堡垒机实例浮动ip。(实例为主备模式时返回对应的值)
web_port	String	云堡垒机实例WEB界面访问的端口号。
public_ip	String	云堡垒机实例弹性公网IP。
public_id	String	云堡垒机实例绑定公网的弹性IP的ID，UUID格式表示。
private_ip	String	云堡垒机实例私有ip。
vpc_id	String	云堡垒机实例所在虚拟私有云ID。
subnet_id	String	云堡垒机实例所在子网ID。
security_group_id	String	云堡垒机实例所属的安全组ID。

**表10** ha_info
参数	参数类型	描述
ha_id	String	主备ID。
instance_type	String	实例类型。 master：主 slave：备

状态码： 400

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_description	String	请求参数错误。

状态码： 401

**表12** 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_description	String	校验TOKEN失败。

状态码： 403

**表13** 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_description	String	租户无权限操作。

状态码： 404

**表14** 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_description	String	没有找到CBH资源。

请求示例

无

响应示例

状态码： 200

Cbh List Instance Success

{
  "total" : 1,
  "instance" : [ {
    "name" : "CBH-e2b4",
    "server_id" : "760aeee4-9916-436a-8854-837a9ae94b2b",
    "instance_id" : "5473",
    "alter_permit" : false,
    "enterprise_project_id" : "0",
    "period_num" : "1,2",
    "start_time" : 1692245215000,
    "end_time" : 1694966399000,
    "created_time" : "2023-08-17 12:05:02.0",
    "update" : false,
    "bastion_version" : "3.3.49.0",
    "az_info" : {
      "region" : "cn-north-7",
      "zone" : "cn-north-7a",
      "availability_zone_display" : "可用区1",
      "slave_zone" : "cn-north-7b",
      "slave_zone_display" : "可用区2"
    },
    "status_info" : {
      "status" : "ACTIVE",
      "task_status" : "NO_TASK",
      "create_instance_status" : "NO_TASK",
      "fail_reason" : "No FailReason Now",
      "instance_status" : "ok",
      "instance_description" : ",2023-08-21 15:19:07,{\"d_usage\":\"0.30\",\"m_usage\":\"43.66\",\"c_usage\":\"1.00\",\"session_count\":\"0\""
    },
    "resource_info" : {
      "specification" : "cbh.basic.5",
      "order_id" : "CS2308171141G8C14",
      "resource_id" : "c7a07a7f-e5ee-49cf-8355-aee46c5a4fcf",
      "data_disk_size" : 200,
      "disk_resource_id" : [ ]
    },
    "network" : {
      "vip" : "192.168.0.228",
      "web_port" : "443",
      "public_ip" : "100.xx.xx.1",
      "public_id" : "56220ed7-0f75-4d42-85c4-013d5414c81c",
      "private_ip" : "192.168.0.190",
      "vpc_id" : "03211ecf-697e-4306-a7a0-6e939bf948de",
      "subnet_id" : "dd08a6a9-ced7-484b-ace6-1b821854a772",
      "security_group_id" : "02dcf62d-b84d-4a14-aad3-c310f2ceea55"
    },
    "ha_info" : {
      "ha_id" : "332",
      "instance_type" : "master"
    }
  } ]
}

状态码

状态码	描述
200	Cbh List Instance Success
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found

错误码

请参见错误码。

父主题： 操作管理

上一篇：操作管理

下一篇：获取堡垒机实例状态信息

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

获取堡垒机实例列表

功能介绍

调用方法

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线