云堡垒机 CBH-获取堡垒机实例列表:响应参数

时间:2025-02-13 15:51:41

响应参数

状态码: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:可以回滚

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资源。

support.huaweicloud.com/api-cbh/ListInstances.html