获取堡垒机实例列表 - ListInstances

project_id

是

String

参数解释：

项目ID，用于唯一标识用户项目。获取方法请参见获取项目ID。

约束限制：

不涉及

取值范围：

只能由字母和数字组成，长度为32个字符。

默认取值：

不涉及

instance_id

否

Long

参数解释：

云堡垒机实例ID。需要查询单个实例详情时传入。如果不传，默认查询租户下所有的堡垒机列表。

约束限制：

不涉及

取值范围：

整数，取值范围为0~9223372036854775807。

默认取值：

不涉及

limit

否

Integer

参数解释：

查询返回的记录数量上限。

约束限制：

不涉及

取值范围：

整数字符串，取值范围为1~1000。

默认取值：

1000

offset

否

Integer

参数解释：

查询的起始偏移量（索引位置）。

约束限制：

不涉及

取值范围：

整数字符串，取值范围为大于等于0的整数。

默认取值：

0

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

字符串，长度为1~28000个字符。

默认取值：

不涉及

total

Integer

参数解释：

云堡垒机实例总数。

取值范围：

整数，取值范围为0~1000。

instance

Array of InstanceDetail objects

参数解释：

云堡垒机实例列表信息。

取值范围：

数组，最多512个InstanceDetail对象。

name

String

参数解释：

云堡垒机实例名称。

取值范围：

字符串，长度为1~65个字符。

server_id

String

参数解释：

云堡垒机服务器ID。

取值范围：

字符串，长度为1~64个字符。

instance_id

String

参数解释：

云堡垒机实例ID。

取值范围：

字符串，长度为1~36个字符。

alter_permit

Boolean

参数解释：

云堡垒机实例是否可以扩容。

取值范围：

• true：是

• false：否

enterprise_project_id

String

参数解释：

企业项目ID。

取值范围：

字符串，长度为1~36个字符。

period_num

String

参数解释：

云堡垒机实例订购周期数。

取值范围：

字符串，长度为1~36个字符。

start_time

String

参数解释：

云堡垒机实例开始时间（已废弃）。

取值范围：

时间戳字符串，长度为1~12个字符。

end_time

String

参数解释：

云堡垒机实例结束时间（已废弃）。

取值范围：

时间戳字符串，长度为1~12个字符。

created_time

String

参数解释：

云堡垒机实例创建时间。

取值范围：

UTC格式字符串，长度为1~25个字符。

upgrade_time

Long

参数解释：

预约的升级时间。

取值范围：

实际时间对应的毫秒时间戳。

update

String

参数解释：

云堡垒机实例是否可以升级。

取值范围：

• OLD：当前已是最新版本，无需升级

• NEW：可以升级小版本

• CROSS_OS：可以跨版本升级

• ROLLBACK：可以回滚

bastion_version

String

参数解释：

云堡垒机实例当前版本。

取值范围：

字符串，长度为1~36个字符。

az_info

az_info object

参数解释：

可用区信息。

取值范围：

不涉及

status_info

status_info object

参数解释：

状态信息。

取值范围：

不涉及

resource_info

resource_info object

参数解释：

资源信息。

取值范围：

不涉及

network

network object

参数解释：

网络信息。

取值范围：

不涉及

ha_info

ha_info object

参数解释：

主备信息。

取值范围：

不涉及

region

String

参数解释：

云堡垒机实例所在可用区ID。

取值范围：

字符串，长度为1~36个字符。

zone

String

参数解释：

云堡垒机实例所在可用区ID（若为主备类型的实例，则此参数为主机实例的可用区ID）。

取值范围：

字符串，长度为1~36个字符。

availability_zone_display

String

参数解释：

云堡垒机实例所在可用区名称（若为主备类型的实例，则此参数为主机实例的可用区名称）。

取值范围：

字符串，长度为1~36个字符。

slave_zone

String

参数解释：

云堡垒机备机实例所在可用区。

取值范围：

字符串，长度为1~36个字符。

slave_zone_display

String

参数解释：

云堡垒机备机实例所在可用区名称。

取值范围：

字符串，长度为1~36个字符。

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

参数解释：

云堡垒机实例信息描述。

取值范围：

字符串，长度为1~36个字符。

fail_reason

String

参数解释：

云堡垒机实例创建实例失败原因。

取值范围：

字符串，长度为1~36个字符。

specification

String

参数解释：

云堡垒机实例规格。

取值范围：

字符串，长度为1~36个字符。

order_id

String

参数解释：

订单ID。

取值范围：

字符串，长度为1~64个字符。

resource_id

String

参数解释：

云堡垒机实例的资源ID，UUID格式显示。

取值范围：

字符串，长度为1~36个字符。

data_disk_size

Number

参数解释：

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

取值范围：

数字，取值范围为0~300。

disk_resource_id

Array of strings

参数解释：

云堡垒机实例数据盘资源ID。

取值范围：

字符串数组，最多21个元素，每个字符串长度为1~64个字符。

vip

String

参数解释：

云堡垒机实例浮动IP。(实例为主备模式时返回对应的值)

取值范围：

字符串，长度为1~36个字符。

web_port

String

参数解释：

云堡垒机实例WEB界面访问的端口号。

取值范围：

字符串，长度为1~36个字符。

public_ip

String

参数解释：

云堡垒机实例弹性公网IP。

取值范围：

字符串，长度为1~15个字符。

public_id

String

参数解释：

云堡垒机实例已绑定的弹性公网IP的ID，UUID格式表示。

取值范围：

字符串，长度为1~36个字符。

private_ip

String

参数解释：

云堡垒机实例私有IP。

取值范围：

字符串，长度为1~15个字符。

vpc_id

String

参数解释：

云堡垒机实例所在虚拟私有云ID。

取值范围：

字符串，长度为1~36个字符。

subnet_id

String

参数解释：

云堡垒机实例所在子网ID。

取值范围：

字符串，长度为1~36个字符。

security_group_id

String

参数解释：

云堡垒机实例所属的安全组ID。

取值范围：

字符串，长度为1~36个字符。

ha_id

String

参数解释：

主备ID。

取值范围：

字符串，长度为1~36个字符。

instance_type

String

参数解释：

实例类型。

取值范围：

• master：主

• slave：备

error_code

String

错误码。

error_description

String

请求参数错误。

error_code

String

错误码。

error_description

String

校验Token失败。

error_code

String

错误码。

error_description

String

租户无权限操作。

error_code

String

错误码。

error_description

String

没有找到CBH资源。

200

Cbh List Instance Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found