更新时间:2026-04-03 GMT+08:00

查询指定实例

功能介绍

查询指定实例的详细信息。

URI

GET /v2/{project_id}/instances/{instance_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID,获取方式请参见获取项目ID

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

instance_id

String

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

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。

取值范围

不涉及。

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_name

String

参数解释

子网名称。

取值范围

不涉及。

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),该字段为必选。

取值范围

  • true:开启。

  • false:不开启。

publicip_address

String

参数解释

公网IP地址。

取值范围

不涉及。

ssl_enable

Boolean

参数解释

是否开启SSL。

取值范围

  • true:开启。

  • false:未开启。

cross_vpc_info

String

参数解释

跨VPC访问信息。

取值范围

  • true:开启。

  • false:未开启。

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

参数解释

实例使用的安全协议。

取值范围

不涉及。

arch_type

String

参数解释

架构类型。

取值范围

  • X86。

enable_elastic_tps

Boolean

参数解释

弹性TPS开关状态。

取值范围

  • true:开启弹性TPS。

  • false:不开启弹性TPS。

表3 TagEntity

参数

参数类型

描述

key

String

参数解释

标签键。

约束限制

  • 不能为空。

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

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

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

  • 首尾字符不能为空格。

取值范围

不涉及。

默认取值

不涉及。

value

String

参数解释

标签值。

约束限制

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

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

  • 首尾字符不能为空格。

取值范围

不涉及。

默认取值

不涉及。

请求示例

查询指定实例的详细信息。

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}

响应示例

状态码:200

查询实例成功。

{
  "name" : "reliability-test",
  "engine" : "reliability",
  "status" : "RUNNING",
  "description" : "",
  "type" : "single.basic",
  "specification" : "rocketmq.b1.large.1, 500 tps",
  "engine_version" : "5.x",
  "instance_id" : "68fdc9a8-805e-439d-8dd9-25adc1c58bf6",
  "resource_spec_code" : "",
  "charging_mode" : 1,
  "vpc_id" : "3db8490c-4d6d-4d8f-8d3f-047b0de4c5cf",
  "vpc_name" : "vpc-1101840",
  "created_at" : "1636699753874",
  "product_id" : "rocketmq.b1.large.1",
  "security_group_id" : "23c5977f-ff33-4b95-a73e-08d8a0bc4e6c",
  "security_group_name" : "security_group_test",
  "subnet_id" : "0a0f1fcb-f019-458d-b9e5-301867394d50",
  "subnet_name" : "subnet-test",
  "subnet_cidr" : "192.168.64.0/18",
  "available_zones" : [ "9f1c5806706d4c1fb0eb72f0a9b18c77" ],
  "available_zone_names" : [ "AZ3" ],
  "user_id" : "0b01fbb53600d4671fa8c00673c71260",
  "user_name" : "user_test",
  "maintain_begin" : "02:00:00",
  "maintain_end" : "06:00:00",
  "enable_log_collection" : false,
  "storage_space" : 558,
  "total_storage_space" : 600,
  "used_storage_space" : 28,
  "enable_publicip" : true,
  "publicip_id" : "83924171-7014-48f0-a6b2-c714e7a090dd",
  "publicip_address" : "***",
  "ssl_enable" : false,
  "cross_vpc_info" : "{\"192.168.93.114\":{\"advertised_ip\":\"192.168.93.114\",\"broker_port\":\"10100\",\"port_id\":\"b3de3981-1f73-4e6f-b35a-78833b783364\",\"namesrv_port\":\"8300\"}}",
  "storage_resource_id" : "164bdaef-2e67-4fd5-be8b-a18f91d455a2",
  "storage_spec_code" : "dms.physical.storage.ultra.v2",
  "service_type" : "advanced",
  "storage_type" : "hec",
  "enterprise_project_id" : "0",
  "extend_times" : 0,
  "ipv6_enable" : false,
  "support_features" : "features.log.collection",
  "disk_encrypted" : false,
  "ces_version" : "linux,v1,v2,v3,v4",
  "new_spec_billing_enable" : true,
  "dns_enable" : false,
  "dr_enable" : false,
  "config_ssl_need_restart_process" : false,
  "enable_acl" : false,
  "namesrv_address" : "192.168.93.114:8100",
  "broker_address" : "192.168.64.0/18:10100",
  "public_namesrv_address" : "100.85.116.211:8200",
  "public_broker_address" : "100.85.116.211:10101",
  "grpc_address" : "192.168.93.114:8080",
  "public_grpc_address" : "100.85.116.211:8081"
}

状态码

状态码

描述

200

查询实例成功。

错误码

请参见错误码