查询所有实例列表 - ListInstances

project_id

是

String

参数解释：

项目ID，获取方式请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

engine

是

String

参数解释：

引擎类型：rabbitmq。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

name

否

String

参数解释：

实例名称。获取方式：调用查询所有实例列表接口，从响应体中获取实例名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

否

String

参数解释：

实例ID。获取方法如下：调用查询所有实例列表接口，从响应体中获取实例ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

status

否

String

参数解释：

实例状态，详细状态说明请参考实例状态说明。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

include_failure

否

String

参数解释：

是否返回创建失败的实例数。

约束限制：

不涉及。

取值范围：

• true：返回创建失败的实例数。

• false：不返回创建失败的实例数。

默认取值：

不涉及。

exact_match_name

否

String

参数解释：

是否按照实例名称进行精确匹配查询。

约束限制：

不涉及。

取值范围：

• true：按照实例名称进行精确匹配查询。

• false：按照模糊匹配实例名称查询。

默认取值：

false

enterprise_project_id

否

String

参数解释：

企业项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

offset

否

String

参数解释：

偏移量，表示从此偏移量开始查询。

约束限制：

不涉及。

取值范围：

大于等于0

默认取值：

不涉及。

limit

否

String

参数解释：

当次查询返回的最大实例个数。

约束限制：

不涉及。

取值范围：

1~50

默认取值：

10

instances

Array of ShowInstanceResp objects

参数解释：

实例列表。

instance_num

Integer

参数解释：

实例个数。

取值范围：

不涉及。

access_user

String

参数解释：

认证用户名。

取值范围：

不涉及。

broker_num

Integer

参数解释：

代理个数。

取值范围：

• 1

• 3

• 5

• 7

name

String

参数解释：

实例名称。

取值范围：

不涉及。

engine

String

参数解释：

消息引擎类型。

取值范围：

rabbitmq：RabbitMQ引擎。

engine_version

String

参数解释：

消息引擎版本。

取值范围：

• 3.8.35

• AMQP-0-9-1

specification

String

参数解释：

实例规格。

取值范围：

• 单机实例：返回vm规格。

• 集群实例：返回vm规格和节点数。

storage_space

Integer

参数解释：

消息存储空间，单位：GB。

取值范围：

不涉及。

used_storage_space

Integer

参数解释：

已使用的消息存储空间，单位：GB。

取值范围：

不涉及。

dns_enable

Boolean

参数解释：

实例是否开启域名访问功能。

取值范围：

• true：开启

• false：未开启

connect_address

String

参数解释：

实例内网连接IP地址。

取值范围：

不涉及。

connect_domain_name

String

参数解释：

实例内网连接域名。

取值范围：

不涉及。

public_connect_address

String

参数解释：

实例公网连接IP地址。

取值范围：

不涉及。

public_connect_domain_name

String

参数解释：

实例公网连接域名。

取值范围：

不涉及。

port

Integer

参数解释：

实例连接端口。

取值范围：

不涉及。

status

String

参数解释：

实例状态。

取值范围：

详细状态说明请参考实例状态说明。

description

String

参数解释：

实例描述。

取值范围：

不涉及。

instance_id

String

参数解释：

实例ID。

取值范围：

不涉及。

resource_spec_code

String

参数解释：

资源规格标识。

取值范围：

• dms.instance.rabbitmq.single.c3.2u4g：RabbitMQ单机，vm规格2u4g

• dms.instance.rabbitmq.single.c3.4u8g：RabbitMQ单机，vm规格4u8g

• dms.instance.rabbitmq.single.c3.8u16g：RabbitMQ单机，vm规格8u16g

• dms.instance.rabbitmq.single.c3.16u32g：RabbitMQ单机，vm规格16u32g

• dms.instance.rabbitmq.cluster.c3.4u8g.3：RabbitMQ集群，vm规格4u8g，3个节点

• dms.instance.rabbitmq.cluster.c3.4u8g.5：RabbitMQ集群，vm规格4u8g，5个节点

• dms.instance.rabbitmq.cluster.c3.4u8g.7：RabbitMQ集群，vm规格4u8g，7个节点

• dms.instance.rabbitmq.cluster.c3.8u16g.3：RabbitMQ集群，vm规格8u16g，3个节点

• dms.instance.rabbitmq.cluster.c3.8u16g.5：RabbitMQ集群，vm规格8u16g，5个节点

• dms.instance.rabbitmq.cluster.c3.8u16g.7：RabbitMQ集群，vm规格8u16g，7个节点

• dms.instance.rabbitmq.cluster.c3.16u32g.3：RabbitMQ集群，vm规格16u32g，3个节点

• dms.instance.rabbitmq.cluster.c3.16u32g.5：RabbitMQ集群，vm规格16u32g，5个节点

• dms.instance.rabbitmq.cluster.c3.16u32g.7：RabbitMQ集群，vm规格16u32g，7个节点

charging_mode

Integer

参数解释：

付费模式。

取值范围：

• 0表示包年/包月计费。

• 1表示按需计费。

vpc_id

String

参数解释：

VPC ID。

取值范围：

不涉及。

vpc_name

String

参数解释：

VPC的名称。

取值范围：

不涉及。

created_at

String

参数解释：

完成创建时间。格式为时间戳，指从格林威治时间 1970年01月01日00时00分00秒起至指定时间的偏差总毫秒数。

取值范围：

不涉及。

user_id

String

参数解释：

用户ID。

取值范围：

不涉及。

user_name

String

参数解释：

用户名。

取值范围：

不涉及。

order_id

String

参数解释：

订单ID，只有在包周期计费时才会有order_id值，其他计费方式order_id值为空。

取值范围：

不涉及。

maintain_begin

String

参数解释：

维护时间窗开始时间，格式为HH:mm:ss。

取值范围：

不涉及。

maintain_end

String

参数解释：

维护时间窗结束时间，格式为HH:mm:ss。

取值范围：

不涉及。

enable_publicip

Boolean

参数解释：

RabbitMQ实例是否开启公网访问功能。

取值范围：

• true：开启

• false：未开启

publicip_address

String

参数解释：

RabbitMQ实例绑定的弹性IP地址。

如果未开启公网访问功能，该字段值为null。

取值范围：

• true：开启

• false：未开启

publicip_id

String

参数解释：

RabbitMQ实例绑定的弹性IP地址的ID。

如果未开启公网访问功能，该字段值为null。

取值范围：

不涉及。

management_connect_address

String

参数解释：

RabbitMQ实例的管理地址。

取值范围：

不涉及。

management_connect_domain_name

String

参数解释：

RabbitMQ实例的管理域名。

取值范围：

不涉及。

public_management_connect_address

String

参数解释：

RabbitMQ实例的公网管理地址。

取值范围：

不涉及。

public_management_connect_domain_name

String

参数解释：

RabbitMQ实例的公网管理域名。

取值范围：

不涉及。

ssl_enable

Boolean

参数解释：

是否开启安全认证。

取值范围：

• true：开启

• false：未开启

enterprise_project_id

String

参数解释：

企业项目ID。

取值范围：

不涉及。

is_logical_volume

Boolean

参数解释：

实例扩容时用于区分老实例与新实例。

取值范围：

• true：新创建的实例，允许磁盘动态扩容不需要重启。

• false：特别老的实例不支持磁盘扩容。

extend_times

Integer

参数解释：

实例扩容磁盘次数。

取值范围：

不涉及。

type

String

参数解释：

实例类型。

取值范围：

• single：单机。

• cluster：集群。

product_id

String

参数解释：

产品标识。

取值范围：

不涉及。

security_group_id

String

参数解释：

安全组ID。

取值范围：

不涉及。

security_group_name

String

参数解释：

租户安全组名称。

取值范围：

不涉及。

subnet_id

String

参数解释：

子网ID。

取值范围：

不涉及。

available_zones

Array of strings

参数解释：

实例节点所在的可用区ID。

available_zone_names

Array of strings

参数解释：

实例节点所在的可用区名称。

total_storage_space

Integer

参数解释：

总共消息存储空间，单位：GB。

取值范围：

不涉及。

storage_resource_id

String

参数解释：

存储资源ID。

取值范围：

不涉及。

storage_spec_code

String

参数解释：

IO规格。

取值范围：

不涉及。

ipv6_enable

Boolean

参数解释：

是否开启IPv6。

取值范围：

• true：开启。

• false：不开启。

ipv6_connect_addresses

Array of strings

参数解释：

IPv6的连接地址。

tags

Array of TagEntity objects

参数解释：

标签列表。

service_type

String

参数解释：

服务类型。

取值范围：

advanced：服务类型。

storage_type

String

参数解释：

存储类型。

取值范围：

hec：存储类型。

disk_encrypted

Boolean

参数解释：

是否开启磁盘加密。

取值范围：

• true：开启

• false：不开启

disk_encrypted_key

String

参数解释：

磁盘加密key，未开启磁盘加密时为空。

取值范围：

不涉及。

key

String

参数解释：

标签键。

约束限制：

• 不能为空。

• 对于同一个实例，Key值唯一。

• 长度为1~128个字符（中文也可以输入128个字符）。

• 由任意语种字母、数字、空格和字符组成，字符仅支持_ . : = + - @

• 不能以_sys_开头。

• 首尾字符不能为空格。

取值范围：

不涉及。

默认取值：

不涉及。

value

String

参数解释：

标签值。

约束限制：

• 长度为0~255个字符（中文也可以输入255个字符）。

• 由任意语种字母、数字、空格和字符组成，字符仅支持_ . : = + - @

取值范围：

不涉及。

默认取值：

不涉及。

200

查询所有实例列表成功。