华为云用户手册

响应示例 状态码：200 查询实例的扩容规格列表成功。 { "total" : 1, "next_offset" : -1, "previous_offset" : -1, "engine" : "rocketmq", "versions" : [ "4.8.0" ], "products" : [ { "type" : "cluster.small", "product_id" : "c6.4u8g.cluster.small", "ecs_flavor_id" : "c6.xlarge.2", "billing_code" : "dms.platinum.c6", "arch_types" : [ "X86" ], "charging_mode" : [ "monthly", "hourly" ], "ios" : [ { "io_spec" : "dms.physical.storage.high.v2", "available_zones" : [ "xxx" ], "type" : "evs", "unavailable_zones" : [ "xxx" ] }, { "io_spec" : "dms.physical.storage.ultra.v2", "available_zones" : [ ], "type" : "evs", "unavailable_zones" : [ "xxx" ] } ], "support_features" : [ ], "properties" : { "max_broker" : "2", "max_topic_per_broker" : "2000", "max_storage_per_node" : "30000", "max_consumer_per_broker" : "2000", "min_broker" : "1", "product_alias" : "rocketmq.4u8g.cluster.small", "engine_versions" : "4.8.0", "min_storage_per_node" : "300" }, "available_zones" : [ "xxx" ], "unavailable_zones" : [ "xxx" ], "qingtian_incompatible" : false }, { "type" : "cluster", "product_id" : "c6.4u8g.cluster", "ecs_flavor_id" : "s6.xlarge.2", "billing_code" : "dms.platinum.c6", "arch_types" : [ "X86" ], "charging_mode" : [ "monthly", "hourly" ], "ios" : [ { "io_spec" : "dms.physical.storage.ultra.v2", "available_zones" : [ ], "type" : "evs", "unavailable_zones" : [ "xxx" ] }, { "io_spec" : "dms.physical.storage.high.v2", "available_zones" : [ "xxx" ], "type" : "evs", "unavailable_zones" : [ "xxx" ] } ], "support_features" : [ ], "properties" : { "max_broker" : "10", "max_topic_per_broker" : "4000", "max_storage_per_node" : "60000", "max_consumer_per_broker" : "4000", "min_broker" : "1", "product_alias" : "rocketmq.4u8g.cluster", "engine_versions" : "4.8.0", "min_storage_per_node" : "300" }, "available_zones" : [ "xxx" ], "unavailable_zones" : [ "xxx" ], "qingtian_incompatible" : false }, { "type" : "cluster", "product_id" : "c6.8u16g.cluster", "ecs_flavor_id" : "c6s.2xlarge.2", "billing_code" : "dms.platinum.c6", "arch_types" : [ "X86" ], "charging_mode" : [ "monthly", "hourly" ], "ios" : [ { "io_spec" : "dms.physical.storage.high.v2", "available_zones" : [ "xxx" ], "type" : "evs", "unavailable_zones" : [ "xxx" ] }, { "io_spec" : "dms.physical.storage.ultra.v2", "available_zones" : [ ], "type" : "evs", "unavailable_zones" : [ "xxx" ] } ], "support_features" : [ ], "properties" : { "max_broker" : "10", "max_topic_per_broker" : "8000", "max_storage_per_node" : "90000", "max_consumer_per_broker" : "8000", "min_broker" : "1", "product_alias" : "rocketmq.8u16g.cluster", "engine_versions" : "4.8.0", "min_storage_per_node" : "300" }, "available_zones" : [ "xxx" ], "unavailable_zones" : [ "xxx" ], "qingtian_incompatible" : false }, { "type" : "cluster", "product_id" : "c6.12u24g.cluster", "ecs_flavor_id" : "c6s.3xlarge.2", "billing_code" : "dms.platinum.c6", "arch_types" : [ "X86" ], "charging_mode" : [ "monthly", "hourly" ], "ios" : [ { "io_spec" : "dms.physical.storage.ultra.v2", "available_zones" : [ ], "type" : "evs", "unavailable_zones" : [ "xxx" ] }, { "io_spec" : "dms.physical.storage.high.v2", "available_zones" : [ "xxx" ], "type" : "evs", "unavailable_zones" : [ "xxx" ] } ], "support_features" : [ ], "properties" : { "max_broker" : "10", "max_topic_per_broker" : "12000", "max_storage_per_node" : "90000", "max_consumer_per_broker" : "12000", "min_broker" : "1", "product_alias" : "rocketmq.12u24g.cluster", "engine_versions" : "4.8.0", "min_storage_per_node" : "300" }, "available_zones" : [ "xxx" ], "unavailable_zones" : [ "xxx" ], "qingtian_incompatible" : false }, { "type" : "cluster", "product_id" : "c6.16u32g.cluster", "ecs_flavor_id" : "c6.4xlarge.2", "billing_code" : "dms.platinum.c6", "arch_types" : [ "X86" ], "charging_mode" : [ "monthly", "hourly" ], "ios" : [ { "io_spec" : "dms.physical.storage.high.v2", "available_zones" : [ "xxx" ], "type" : "evs", "unavailable_zones" : [ "xxx" ] }, { "io_spec" : "dms.physical.storage.ultra.v2", "available_zones" : [ ], "type" : "evs", "unavailable_zones" : [ "xxx" ] } ], "support_features" : [ ], "properties" : { "max_broker" : "10", "max_topic_per_broker" : "16000", "max_storage_per_node" : "90000", "max_consumer_per_broker" : "16000", "min_broker" : "1", "product_alias" : "rocketmq.16u32g.cluster", "engine_versions" : "4.8.0", "min_storage_per_node" : "300" }, "available_zones" : [ "xxx" ], "unavailable_zones" : [ "xxx" ], "qingtian_incompatible" : false } ] }

URI GET /v2/{engine}/{project_id}/instances/{instance_id}/extend 表1 路径参数 参数 是否必选 参数类型 描述 engine 是 String 消息引擎的类型。支持的类型为rocketmq。 project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 type 否 String 产品的类型。 advanced：专享版。 limit 否 Integer 查询数量。 offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 topics Array of strings 参数解释： Topic列表（当查询Topic消费“列表”时才显示此参数）。 total Integer 参数解释： Topic总数（当查询Topic消费“列表”时才显示此参数）。 取值范围： 不涉及。 lag Long 参数解释： 消费堆积总数。 取值范围： 不涉及。 max_offset Long 参数解释： 消息总数。 取值范围： 不涉及。 consumer_offset Long 参数解释： 已消费消息数。 取值范围： 不涉及。 brokers Array of Brokers objects 参数解释： Topic关联代理（当查询Topic消费“详情”才显示此参数）。 表4 Brokers 参数 参数类型 描述 broker_name String 参数解释： Topic关联代理名称。 取值范围： 不涉及。 queues Array of Queue objects 参数解释： 关联代理的队列详情。 表5 Queue 参数 参数类型 描述 id Integer 参数解释： 队列ID。 取值范围： 不涉及。 lag Long 参数解释： 队列消费堆积总数。 取值范围： 不涉及。 broker_offset Long 参数解释： 队列消息总数。 取值范围： 不涉及。 consumer_offset Long 参数解释： 已消费消息数。 取值范围： 不涉及。 last_message_time Long 参数解释： 最新消费消息的存储时间，Unix毫秒时间戳格式。 取值范围： 不涉及。

URI GET /v2/{project_id}/instances/{instance_id}/groups/{group}/topics 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 项目ID，获取方式请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id 是 String 参数解释： 实例ID。获取方法如下：登录RocketMQ控制台，在RocketMQ实例详情页面查找实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 group 是 String 参数解释： 消费组名称。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 topic 否 String 参数解释： 待查询的Topic，不指定时查询Topic列表，指定时查询详情。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 limit 否 Integer 参数解释： 当次查询返回Topic的最大个数。 约束限制： 不涉及。 取值范围： 1~50。 默认取值： 10。 offset 否 Integer 参数解释： 偏移量，表示从此偏移量开始查询。 约束限制： 不涉及。 取值范围： 大于等于0。 默认取值： 0。

响应示例 状态码：200 查询消费列表或详情成功。 查询消费组的Topic列表成功。 { "topics" : [ "topic-test" ], "total" : 1 } 查询消费组详情成功。 { "lag" : 0, "max_offset" : 1, "consumer_offset" : 1, "brokers" : [ { "broker_name" : "broker-0", "queues" : [ { "id" : 0, "lag" : 0, "broker_offset" : 0, "consumer_offset" : 0, "last_message_time" : 0 }, { "id" : 1, "lag" : 0, "broker_offset" : 1, "consumer_offset" : 1, "last_message_time" : 1679398537088 }, { "id" : 0, "lag" : 0, "broker_offset" : 0, "consumer_offset" : 0, "last_message_time" : 0 } ] } ] }

响应示例 状态码：200 查询消费者订阅详情成功。 { "group_name" : "test", "online" : true, "subscription_consistency" : true, "total" : 1, "next_offset" : -1, "previous_offset" : -1, "clients" : [ { "client_id" : "192.168.0.1@consumer1", "language" : "JAVA", "version" : "V4_8_0", "client_addr" : "192.168.0.1:65233", "subscriptions" : [ { "topic" : "topicA", "type" : "TAG", "expression" : "tagA" } ] } ] }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 group_name String 消费组名称。 online Boolean 消费组是否在线。 subscription_consistency Boolean 订阅关系是否一致。 total Integer 消费者总数。 next_offset Integer 下个分页的offset。 previous_offset Integer 上个分页的offset。 clients Array of ClientData objects 消费者订阅详情列表。 表4 ClientData 参数 参数类型 描述 language String 客户端语言。 version String 客户端版本。 client_id String 客户端ID。 client_addr String 客户端地址。 subscriptions Array of Subscription objects 订阅关系列表。 表5 Subscription 参数 参数类型 描述 topic String 订阅的Topic名称。 type String 订阅类型，取值如下：TAG和SQL92。 expression String 订阅tag字符。

URI GET /v2/rocketmq/{project_id}/instances/{instance_id}/groups/{group}/clients 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID。 group 是 String 消费组名称。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 查询数量，取值范围为1~50。 offset 否 Integer 偏移量，表示从此偏移量开始查询， offset大于等于0。 is_detail 否 Boolean 是否查询消费者详细列表，参数为“true”则表示查询详细列表，否则表示查询简易列表。

响应示例 状态码： 200 查询成功。 { "dimensions" : [ { "name" : "kafka_instance_id", "metrics" : [ "current_partitions", "current_topics", "group_messages" ], "key_name" : [ "instance_ids" ], "dim_router" : [ "kafka_instance_id" ] }, { "name" : "kafka_broker", "metrics" : [ "broker_data_size", "broker_messages_in_rate", "broker_bytes_out_rate", "broker_bytes_in_rate", "broker_produce_mean", "broker_fetch_mean" ], "key_name" : [ "nodes" ], "dim_router" : [ "kafka_instance_id", "kafka_broker" ] }, { "name" : "kafka_rest", "metrics" : [ "rest_produce_success", "rest_produce_failed", "rest_produce_latency", "rest_produce_msg_num", "rest_produce_flow", "rest_consume_success", "rest_consume_failed", "rest_consume_latency", "rest_consume_msg_num", "rest_consume_flow", "rest_commit_success", "rest_commit_failed", "rest_commit_latency", "rest_commit_msg_num", "rest_commit_flow" ], "key_name" : [ "nodes" ], "dim_router" : [ "kafka_instance_id", "kafka_rest" ] }, { "name" : "kafka_topics", "metrics" : [ "topic_data_size", "topic_messages_in_rate", "topic_bytes_out_rate", "topic_bytes_in_rate", "topic_messages" ], "key_name" : [ "queues" ], "dim_router" : [ "kafka_instance_id", "kafka_topics" ], "children" : [ { "name" : "kafka_partitions", "metrics" : [ "produced_messages", "partition_messages" ], "key_name" : [ "queues", "partitions" ], "dim_router" : [ "kafka_instance_id", "kafka_topics", "kafka_partitions" ] } ] }, { "name" : "kafka_groups_partitions", "metrics" : [ "messages_consumed", "messages_remained" ], "key_name" : [ "groups", "queues", "partitions" ], "dim_router" : [ "kafka_instance_id", "kafka_groups", "kafka_groups_topics", "kafka_groups_partitions" ] } ], "instance_ids" : [ { "name" : "68f3f6a0-3741-453b-bda9-a6ff6b5bb6f7" } ], "nodes" : [ { "name" : "broker-0" }, { "name" : "broker-1" }, { "name" : "broker-2" } ], "queues" : [ { "name" : "aaaa", "partitions" : [ { "name" : "0" } ] }, { "name" : "mytest", "partitions" : [ { "name" : "0" }, { "name" : "1" }, { "name" : "2" } ] }, { "name" : "topic-84234378", "partitions" : [ { "name" : "0" }, { "name" : "1" }, { "name" : "2" } ] } ], "groups" : [ { "name" : "test-consumer-group", "queues" : [ { "name" : "mytest", "partitions" : [ { "name" : "0" }, { "name" : "1" }, { "name" : "2" } ] } ] } ] }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 dimensions Object 监控维度。 instance_ids Array of instance_ids objects 实例信息。 nodes Array of nodes objects 节点信息。 queues Array of queues objects 队列信息。 groups Array of groups objects 消费组信息。 表3 instance_ids 参数 参数类型 描述 name String 实例ID。 表4 nodes 参数 参数类型 描述 name String 节点名称。 表5 queues 参数 参数类型 描述 name String topic名称。 partitions Array of partitions objects 分区列表。 表6 partitions 参数 参数类型 描述 name String 分区名称。 表7 groups 参数 参数类型 描述 name String 消费组名称。 queues Array of queues objects topic信息。 表8 queues 参数 参数类型 描述 name String topic名称。 partitions Array of partitions objects 分区信息。 表9 partitions 参数 参数类型 描述 name String 分区名称。

响应示例 状态码：200 操作成功。 { "instance_id" : "68fdc9a8-805e-439d-8dd9-25adc1c58bf6", "nodes" : [ { "name" : "broker-0" }, { "name" : "broker-1" }, { "name" : "broker-2" } ], "result" : "success" }

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 oper_type 是 String 变更类型 取值范围： storage：存储空间扩容，代理数量不变。 horizontal：代理数量扩容，每个broker的存储空间不变。 vertical：垂直扩容，broker的底层虚机规格变更，代理数量和存储空间不变。 new_storage_space 否 Integer 当oper_type类型是storage或horizontal时，该参数有效且必填，实例存储空间 = 代理数量 * 每个broker的存储空间。 当oper_type类型是storage时，代理数量不变，每个broker存储空间最少扩容100GB。 当oper_type类型是horizontal时，每个broker的存储空间不变。 new_product_id 否 String 当oper_type类型是vertical时，该参数才有效且必填。 new_broker_num 否 Integer 代理数量 当oper_type参数为horizontal时，该参数必填。 publicip_id 否 String 实例绑定的弹性IP地址的ID。 以英文逗号隔开多个弹性IP地址的ID。 当oper_type参数为horizontal且开启了公网访问时，此参数必填。

URI POST /v2/{engine}/{project_id}/instances/{instance_id}/groups/{group_id}/reset-message-offset 表1 路径参数 参数 是否必选 参数类型 描述 engine 是 String 引擎类型：reliability。 project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID。 group_id 是 String 消费组名称。

请求示例 重置topic_01主题的消费进度到指定时间点。 POST https://{endpoint}/v2/{engine}/{project_id}/instances/{instance_id}/groups/{group_id}/reset-message-offset { "topic" : "topic_01", "timestamp" : 1662652800000 }

URI GET /v2/{project_id}/instances/{instance_id}/users 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 String 偏移量，表示从此偏移量开始查询， offset大于等于0。 limit 否 String 查询数量。

响应示例 状态码：200 查询结果。 { "users" : [ { "access_key" : "test_01", "admin" : false, "default_group_perm" : "DENY", "default_topic_perm" : "SUB", "group_perms" : [ ], "secret_key" : "**************", "topic_perms" : [ ], "white_remote_address" : "" } ], "total" : 1 }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 policies Array of policies objects 用户列表。 total Number 总用户个数。 name String 主题或消费组名称。 表4 policies 参数 参数类型 描述 access_key String 用户名。 secret_key String 密钥。 white_remote_address String IP白名单。 admin Boolean 是否为管理员。 perm String 权限。

URI GET /v2/{project_id}/instances/{instance_id}/topics/{topic}/accesspolicy 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID。 topic 是 String 主题名称。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 String 偏移量，表示从此偏移量开始查询， offset大于等于0。 limit 否 String 查询数量。

URI GET /v2/{project_id}/instances/{instance_id}/metadata 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 id 否 String 任务ID。 type 否 String 查询类型。 offset 否 String 当前页，从1开始。 limit 否 String 当前页大小。 name 否 String 查询vhost列表时，该字段可为空。 查询exchange列表时，该字段为exchange所属vhost名称。 查询queue列表时，该字段为queue所属vhost-所属exchange，例vhost1-exchange1。

响应示例 状态码：200 返回状态码。 { "total" : 1, "task" : [ { "id" : "6cf4dcd3-8471-4139-8b5b-8a3a71f704c7", "name" : "task-932331847", "start_date" : "2023-03-13 19:43:32.12", "status" : "finished", "type" : "rabbitToRocket" } ] }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 total Integer 元数据迁移任务总数。 task Array of MetadataTask objects 元数据迁移任务列表。 表4 MetadataTask 参数 参数类型 描述 id String 元数据迁移任务ID。 name String 元数据迁移任务名称。 start_date String 元数据迁移任务开始时间。 status String 元数据迁移任务状态。 type String 元数据迁移类型。

响应示例 状态码：200 查询成功。 { "total" : "3,", "max" : "2000,", "remaining" : "1997,", "next_offset" : "-1,", "previous_offset" : "-1,", "topics" : [ { "name" : "topic-1", "total_read_queue_num" : 3, "total_write_queue_num" : 3, "permission" : "all", "brokers" : [ { "broker_name" : "broker-0", "read_queue_num" : 3, "write_queue_num" : 3 } ], "message_type" : "NORMAL" }, { "name" : "topic-2", "total_read_queue_num" : 3, "total_write_queue_num" : 3, "permission" : "all", "brokers" : [ { "broker_name" : "broker-0", "read_queue_num" : 3, "write_queue_num" : 3 } ], "message_type" : "NORMAL" }, { "name" : "topic-3", "total_read_queue_num" : 3, "total_write_queue_num" : 3, "permission" : "all", "brokers" : [ { "broker_name" : "broker-0", "read_queue_num" : 3, "write_queue_num" : 3 } ], "message_type" : "NORMAL" } ] }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 total Integer 参数解释： Topic总数。 取值范围： 不涉及。 max Integer 参数解释： 最大可创建Topic数量。 取值范围： 不涉及。 remaining Integer 参数解释： 剩余可创建Topic数量。 取值范围： 不涉及。 next_offset Integer 参数解释： 下个分页的offset。 取值范围： 不涉及。 previous_offset Integer 参数解释： 上个分页的offset。 取值范围： 不涉及。 topics Array of Topic objects 参数解释： 剩余可创建Topic数量。 表4 Topic 参数 参数类型 描述 name String 参数解释： Topic名称。 取值范围： 不涉及。 total_read_queue_num Number 参数解释： 总读队列个数。 取值范围： 不涉及。 total_write_queue_num Number 参数解释： 总写队列个数。 取值范围： 不涉及。 permission String 参数解释： 权限。 取值范围： sub：拥有订阅权限。 pub：拥有发布权限。 all：拥有发布、订阅权限。 brokers Array of brokers objects 关联的代理。 message_type String 参数解释： 消息类型（RocketMQ实例5.x版本才包含此参数）。 取值范围： NORMAL：普通消息。 FIFO：顺序消息。 DELAY：定时消息。 TRANSACTION：事务消息。 表5 brokers 参数 参数类型 描述 broker_name String 参数解释： 代理名称。 取值范围： 不涉及。 read_queue_num Number 参数解释： 读队列个数。 取值范围： 不涉及。 write_queue_num Number 参数解释： 写队列个数。 取值范围： 不涉及。

URI GET /v2/{project_id}/instances/{instance_id}/topics 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 项目ID，获取方式请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id 是 String 参数解释： 实例ID。获取方法如下：登录RocketMQ控制台，在RocketMQ实例详情页面查找实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 参数解释： 查询数量。 约束限制： 不涉及。 取值范围： 1~50。 默认取值： 不涉及。 offset 否 Integer 参数解释： 偏移量，表示从此偏移量开始查询。 约束限制： 不涉及。 取值范围： 大于等于0。 默认取值： 不涉及。

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 engine String 引擎类型。 versions Array of strings 支持的版本。 products Array of ProductEntity objects 产品详情列表。 表3 ProductEntity 参数 参数类型 描述 type String 产品类型，single或者cluster。 product_id String 产品ID。 ecs_flavor_id String E CS 的flavor id。 billing_code String CBC的规格码。 arch_types Array of strings 架构类型。 charging_mode Object 计费模式。 ios Object 支持的io类型。 support_features Object 支持的特性。 properties Object 产品特性。 available_zones Array of strings 可用分区。 unavailable_zones Array of strings 不可用分区。 qingtian_incompatible Boolean 是否为擎天实例。

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 messages Array of Message objects 消息列表。 total Number 消息总数。 表4 Message 参数 参数类型 描述 msg_id String 消息ID。 instance_id String 实例ID。 topic String 主题名称。 store_timestamp Number 存储消息的时间。 born_timestamp Number 产生消息的时间。 reconsume_times Integer 重试次数。 body String 消息体。 body_crc Number 消息体校验和。 store_size Number 存储大小。 property_list Array of property_list objects 消息属性列表。 born_host String 产生消息的主机IP。 store_host String 存储消息的主机IP。 queue_id Integer 队列ID。 queue_offset Integer 在队列中的偏移量。 表5 property_list 参数 参数类型 描述 name String 属性名称。 value String 属性值。

响应示例 状态码：200 查询消息成功。 { "messages" : [ { "msg_id" : "C0A807C9000027740000000000000030", "instance_id" : "11c45539-xxxx-xxxx-xxxx-812c41f61f30", "topic" : "topic-test", "store_timestamp" : 1648888166319, "born_timestamp" : 1648888166275, "reconsume_times" : 0, "body" : "xxxx", "body_crc" : 1932557065, "store_size" : 175, "property_list" : [ { "name" : "KEYS", "value" : "" }, { "name" : "UNIQ_KEY", "value" : "7F00000123DC6E0BE85808B037820000" }, { "name" : "CLUSTER", "value" : "DmsCluster" }, { "name" : "TAGS", "value" : "" } ], "born_host" : "192.168.0.66:50098", "store_host" : "192.168.7.201:10100", "queue_id" : 2, "queue_offset" : 0 } ], "total" : 1 }

URI GET /v2/{engine}/{project_id}/instances/{instance_id}/messages 表1 路径参数 参数 是否必选 参数类型 描述 engine 是 String 消息引擎。 project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 topic 是 String 主题名称。 limit 否 String 查询数量。 offset 否 String 偏移量，表示从此偏移量开始查询， offset大于等于0。 key 否 String 消息的key。 start_time 否 String 开始时间（不通过msg_id精确查询消息时，此参数必填）。 end_time 否 String 结束时间（不通过msg_id精确查询消息时，此参数必填）。 msg_id 否 String 消息ID。

响应示例 状态码：200 查询成功。 示例 1 1 示例 2 -1 示例 3 -1 示例 4 [ { "success" : true, "trace_type" : "Pub", "timestamp" : 1634822858013, "group_name" : "ProducerGroupName", "cost_time" : 47, "request_id" : "644F0069C829287CBBF26B9A54390000", "consume_status" : 0, "topic" : "aaaaa", "msg_id" : "7F000001561018B4AAC26B9A0D1D0004", "offset_msg_id" : "C0A8011700002774000000000000BE12", "tags" : "TagA", "keys" : "OrderID188", "store_host" : "192.168.0.1:10101", "client_host" : "127.0.0.1", "retry_times" : 0, "body_length" : 11, "msg_type" : "Normal_Msg", "transaction_state" : null, "transaction_id" : null, "from_transaction_check" : false } ]

URI GET /v2/{engine}/{project_id}/instances/{instance_id}/trace 表1 路径参数 参数 是否必选 参数类型 描述 engine 是 String 消息引擎。 project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 msg_id 是 String 消息ID。 limit 否 Integer 查询数量。 offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。