查询所有实例列表

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

engine

否

String

参数解释：

消息引擎类型。

约束限制：

不涉及。

取值范围：

• rocketmq：RocketMQ引擎。

• reliability：RocketMQ引擎别称。

默认取值：

不涉及。

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。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

limit

否

Integer

参数解释：

查询返回实例的个数。

约束限制：

不涉及。

取值范围：

1~50。

默认取值：

10。

offset

否

Integer

参数解释：

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

约束限制：

不涉及。

取值范围：

大于等于0。

默认取值：

不涉及。

instances

Array of InstanceDetail objects

参数解释：

实例列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_num

Integer

参数解释：

实例数量。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

name

String

参数解释：

实例名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

engine

String

参数解释：

消息引擎。

约束限制：

不涉及。

取值范围：

• rocketmq：RocketMQ消息引擎。

• reliability：RocketMQ消息引擎别称。

默认取值：

不涉及。

status

String

参数解释：

状态。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

description

String

参数解释：

消息描述。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

type

String

参数解释：

实例类型。

约束限制：

不涉及。

取值范围：

• single：4.8.0单机。

• cluster：4.8.0集群。

• single.basic：5.x单机基础版。

• cluster.basic：5.x集群基础版。

• single.professional：5.x单机专业版。

• cluster.professional：5.x集群专业版。

默认取值：

不涉及。

specification

String

参数解释：

规格说明。

约束限制：

不涉及。

取值范围：

• 4.8.0版本时，该参数取值由“资源规格”和“代理（个）”组成，如：rocketmq.4u8g.cluster.small * 1 broker。

• 5.x基础版时，该参数取值由“资源规格”和“实例TPS”，如：rocketmq.b2.large.4, 2000 tps。

• 5.x单机专业版时，该参数取值由“资源规格”和“实例TPS”，如：rocketmq.p1.large.1, 500 tps。

• 5.x集群专业版时，该参数取值由“资源规格”、“实例TPS”和“弹性TPS”，如：rocketmq.p2.large.8, 4000 tps, 2000 elastic_tps。

资源规格和其他参数取值请参考产品规格章节中对应版本的实例规格说明表。

默认取值：

不涉及。

engine_version

String

参数解释：

实例版本。

约束限制：

不涉及。

取值范围：

• 4.8.0

• 5.x

默认取值：

不涉及。

instance_id

String

参数解释：

实例ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

arch_type

String

参数解释：

架构类型。

取值范围：

• X86。

charging_mode

Integer

参数解释：

付费模式。

约束限制：

不涉及。

取值范围：

1表示按需计费。

默认取值：

不涉及。

vpc_id

String

参数解释：

私有云ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

vpc_name

String

参数解释：

私有云名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

created_at

String

参数解释：

完成创建时间。

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

product_id

String

参数解释：

RocketMQ实例规格。

约束限制：

不涉及。

取值范围：

• c6.4u8g.cluster.small：单个代理最大Topic数2000，单个代理最大消费组数2000

• c6.4u8g.cluster：单个代理最大Topic数4000，单个代理最大消费组数4000

• c6.8u16g.cluster：单个代理最大Topic数8000，单个代理最大消费组数8000

• c6.12u24g.cluster：单个代理最大Topic数12000，单个代理最大消费组数12000

• c6.16u32g.cluster：单个代理最大Topic数16000，单个代理最大消费组数16000

• rocketmq.b1.large.1：RocketMQ 5.x 基础版单机规格，实例TPS 500

• rocketmq.b2.large.4：RocketMQ 5.x 基础版集群规格，实例TPS 2000

• rocketmq.b2.large.8：RocketMQ 5.x 基础版集群规格，实例TPS 4000

• rocketmq.b2.large.12：RocketMQ 5.x 基础版集群规格，实例TPS 6000

• rocketmq.p1.large.1：RocketMQ 5.x 专业版单机规格，实例TPS 500

• rocketmq.p2.large.8：RocketMQ 5.x 专业版集群规格，实例TPS 4000

• rocketmq.p2.large.12：RocketMQ 5.x 专业版集群规格，实例TPS 6000

• rocketmq.p2.large.20：RocketMQ 5.x 专业版集群规格，实例TPS 10000

• rocketmq.p2.large.40：RocketMQ 5.x 专业版集群规格，实例TPS 20000

• rocketmq.p2.large.100：RocketMQ 5.x 专业版集群规格，实例TPS 50000

• rocketmq.p2.large.150：RocketMQ 5.x 专业版集群规格，实例TPS 75000

• rocketmq.p2.large.200：RocketMQ 5.x 专业版集群规格，实例TPS 100000

• rocketmq.p2.large.300：RocketMQ 5.x 专业版集群规格，实例TPS 150000

默认取值：

不涉及。

security_group_id

String

参数解释：

安全组ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

security_group_name

String

参数解释：

安全组名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

subnet_id

String

参数解释：

子网ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

subnet_cidr

String

参数解释：

子网路由。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

available_zones

Array of strings

参数解释：

可用区ID列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

available_zone_names

Array of strings

参数解释：

可用区名称列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

user_id

String

参数解释：

用户ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

user_name

String

参数解释：

用户名。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

maintain_begin

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

maintain_end

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

enable_log_collection

Boolean

参数解释：

是否开启消息收集功能。

约束限制：

不涉及。

取值范围：

• true：开启。

• false：不开启。

默认取值：

不涉及。

storage_space

Integer

参数解释：

存储空间，单位：GB。

约束限制：

不涉及。

取值范围：

不同的实例规格支持不同的存储配置。

默认取值：

不涉及。

used_storage_space

Integer

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

enable_publicip

Boolean

参数解释：

是否开启公网。

约束限制：

不涉及。

取值范围：

• true：开启。

• false：不开启。

默认取值：

不涉及。

publicip_id

String

参数解释：

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

以英文逗号隔开多个弹性IP地址的ID。

如果开启了公网访问功能（即enable_publicip为true），该字段为必选。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

publicip_address

String

参数解释：

公网IP地址。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

ssl_enable

Boolean

参数解释：

是否开启SSL。

取值范围：

• true：开启。

• false：未开启。

cross_vpc_info

String

参数解释：

跨VPC访问信息。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

storage_resource_id

String

参数解释：

存储资源ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

storage_spec_code

String

参数解释：

存储规格代码。

约束限制：

不涉及。

取值范围：

• dms.physical.storage.high.v2：高IO类型磁盘。RocketMQ 5.x专业版不支持该取值。

• dms.physical.storage.ultra.v2：超高IO类型磁盘。

默认取值：

不涉及。

service_type

String

参数解释：

服务类型。

约束限制：

不涉及。

取值范围：

• advanced：服务类型。

默认取值：

不涉及。

storage_type

String

参数解释：

存储类型。

约束限制：

不涉及。

取值范围：

• hec：存储类型。

默认取值：

不涉及。

extend_times

Long

参数解释：

扩展时间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

ipv6_enable

Boolean

参数解释：

是否开启IPv6。

约束限制：

不涉及。

取值范围：

• true：开启。

• false：未开启。

默认取值：

不涉及。

support_features

String

参数解释：

实例支持的特性功能。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

disk_encrypted

Boolean

参数解释：

是否开启磁盘加密。

取值范围：

• true：开启。

• false：不开启。

ces_version

String

参数解释：

云监控版本。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

node_num

Integer

参数解释：

节点数。（仅RocketMQ 4.8.0版本会显示此字段）

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

new_spec_billing_enable

Boolean

参数解释：

是否启用新规格计费。

约束限制：

不涉及。

取值范围：

• true：开启。

• false：未开启。

默认取值：

不涉及。

enable_acl

Boolean

参数解释：

是否开启访问控制列表。

约束限制：

不涉及。

取值范围：

• true：开启。

• false：未开启。

默认取值：

不涉及。

broker_num

Integer

参数解释：

Broker节点数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

dns_enable

Boolean

参数解释：

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

约束限制：

不涉及。

取值范围：

• true：开启。

• false：未开启。

默认取值：

不涉及。

namesrv_address

String

参数解释：

元数据地址。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

namesrv_domain_name

String

参数解释：

元数据域名。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

broker_address

String

参数解释：

业务数据地址。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

public_namesrv_address

String

参数解释：

公网元数据地址。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

public_namesrv_domain_name

String

参数解释：

公网元数据域名。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

public_broker_address

String

参数解释：

公网业务数据地址。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

grpc_address

String

参数解释：

grpc连接地址（仅RocketMQ 5.x版本会显示此字段）。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

grpc_domain_name

String

参数解释：

grpc连接域名（仅RocketMQ 5.x版本会显示此字段）。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

public_grpc_address

String

参数解释：

公网grpc连接地址（仅RocketMQ 5.x版本会显示此字段）。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

public_grpc_domain_name

String

参数解释：

公网grpc连接域名（仅RocketMQ 5.x版本会显示此字段）。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

enterprise_project_id

String

参数解释：

企业项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

tags

Array of TagEntity objects

参数解释：

标签列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

total_storage_space

Integer

参数解释：

总存储空间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

resource_spec_code

String

参数解释：

资源规格。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

produce_portion

Integer

参数解释：

生产TPS占比。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

consume_portion

Integer

参数解释：

消费TPS占比。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

dr_enable

Boolean

参数解释：

是否为容灾实例。

约束限制：

不涉及。

取值范围：

• true：容灾实例。

• false：非容灾实例。

默认取值：

不涉及。

quota_address

String

参数解释：

流控地址。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

max_msg_process_tps

Integer

参数解释：

最大消息TPS。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

config_ssl_need_restart_process

Boolean

参数解释：

配置SSL是否需要重启。

约束限制：

不涉及。

取值范围：

• true：需要重启。

• false：不需要重启。

默认取值：

不涉及。

tls_mode

String

参数解释：

实例使用的安全协议。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

enable_elastic_tps

Boolean

参数解释：

弹性TPS开关状态。

约束限制：

不涉及。

取值范围：

• true：开启弹性TPS。

• false：不开启弹性TPS。

默认取值：

不涉及。

key

String

参数解释：

标签键。

约束限制：

• 不能为空。

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

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

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

• 首尾字符不能为空格。

取值范围：

不涉及。

默认取值：

不涉及。

value

String

参数解释：

标签值。

约束限制：

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

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

• 首尾字符不能为空格。

取值范围：

不涉及。

默认取值：

不涉及。

200

查询所有实例列表成功。