华为云用户手册

响应示例 状态码： 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 }

响应示例 状态码：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 }

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 表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 查询数量。

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 total Integer 元数据迁移任务总数。 task Array of MetadataTask objects 元数据迁移任务列表。 表4 MetadataTask 参数 参数类型 描述 id String 元数据迁移任务ID。 name String 元数据迁移任务名称。 start_date String 元数据迁移任务开始时间。 status String 元数据迁移任务状态。 type 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 查询成功。 { "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。

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。

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 total Number 总数。 next_offset Integer 下个分页的offset。 previous_offset Integer 上个分页的offset。 trace Array of trace objects 消息轨迹列表。 表4 trace 参数 参数类型 描述 success Boolean 是否成功。 trace_type String 轨迹类型 timestamp Number 时间。 group_name String 生产组或消费组。 cost_time Number 耗时。 request_id String 请求ID。 consume_status Number 消费状态： 0-消费成功 1-消费超时 2-消费发生异常 3-消费返回NULL 5-消费失败 topic String 主题名称。 msg_id String 消息ID。 offset_msg_id String offset消息ID。 tags String 消息的标签。 keys String 消息的keys。 store_host String 存储消息的主机IP。 client_host String 产生消息的主机IP。 retry_times Integer 重试次数。 body_length Number 消息体长度。 msg_type String 消息类型。 transaction_state String 事务状态。 transaction_id String 事务ID。 from_transaction_check Boolean 是否为事务回查的响应。

响应示例 状态码：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 } ]

响应示例 状态码： 200 查询成功。 { "instances" : [ { "name" : "reliability-ztest", "engine" : "reliability", "status" : "RUNNING", "description" : "", "type" : "cluster", "specification" : "c6.4u8g.cluster * 1 broker", "engine_version" : "4.8.0", "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" : "c6.4u8g.cluster", "security_group_id" : "23c5977f-ff33-4b95-a73e-08d8a0bc4e6c", "security_group_name" : "Sys-default", "subnet_id" : "0a0f1fcb-f019-458d-b9e5-301867394d50", "available_zones" : [ "9f1c5806706d4c1fb0eb72f0a9b18c77" ], "available_zone_names" : [ "AZ3" ], "user_id" : "0b01fbb53600d4671fa8c00673c71260", "user_name" : "", "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" : false, "ssl_enable" : false, "cross_vpc_info" : "{\"192.168.1.21\":{\"advertised_ip\":\"192.168.1.21\",\"broker_port\":\"-\",\"port_id\":\"fa020857-d899-497c-a5f8-8dd90ed67ff7\",\"namesrv_port\":\"8301\"},\"192.168.1.246\":{\"advertised_ip\":\"192.168.1.246\",\"broker_port\":\"10100\",\"port_id\":\"c0f0586f-a4ee-41b5-a7f1-b4e554bbf12d\",\"namesrv_port\":\"-\"},\"192.168.1.77\":{\"advertised_ip\":\"192.168.1.77\",\"broker_port\":\"10101\",\"port_id\":\"8eb1d144-4315-402f-8498-37c9a10b630c\",\"namesrv_port\":\"-\"},\"192.168.1.159\":{\"advertised_ip\":\"192.168.1.159\",\"broker_port\":\"-\",\"port_id\":\"d35b22af-a202-4329-bda4-26e1bdf2aa8e\",\"namesrv_port\":\"8300\"},\"192.168.1.14\":{\"advertised_ip\":\"192.168.1.14\",\"broker_port\":\"10102\",\"port_id\":\"5fcb50fd-3af5-4123-a455-a67f1b926026\",\"namesrv_port\":\"-\"}}", "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" : "kafka.crossvpc.domain.enable,feature.physerver.kafka.topic.accesspolicy,rabbitmq.plugin.management,rocketmq.acl,roma_app_enable,auto_topic_switch,feature.physerver.kafka.user.manager,enable.new.authinfo,route,kafka.config.dynamic.modify.enable,kafka.new.pod.port,feature.physerver.kafka.topic.modify,message_trace_enable,features.pod.token.access,kafka.ssl.cert.modify.enable,roma.user.manage.no.support,feature.physerver.kafka.pulbic.dynamic,features.log.collection,kafka.config.static.modify.enable", "disk_encrypted" : false, "ces_version" : "linux,v1,v2", "node_num" : 5, "new_spec_billing_enable" : true, "broker_num" : 1, "namesrv_address" : "***", "broker_address" : "***", "public_namesrv_address" : "***", "public_broker_address" : "***", "grpc_address" : "***", "public_grpc_address" : "***" } ], "instance_num" : 1 }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 instances Array of ShowInstanceResp objects 实例列表。 instance_num Integer 实例数量。 表3 ShowInstanceResp 参数 参数类型 描述 name String 实例名称。 engine String 引擎。 status String 状态。 description String 消息描述。 type String 实例类型：集群，cluster。 specification String 实例规格。 engine_version String 版本。 instance_id String 实例ID。 charging_mode Integer 付费模式，1表示按需计费，0表示包年/包月计费。 vpc_id String 私有云ID。 vpc_name String 私有云名称。 created_at String 完成创建时间。 格式为时间戳，指从格林威治时间1970年01月01日00时00分00秒起至指定时间的偏差总毫秒数。 product_id String 产品标识。 security_group_id String 安全组ID。 security_group_name String 租户安全组名称。 subnet_id String 子网ID。 subnet_name String 子网名称。 subnet_cidr String 子网路由（仅RocketMQ 5.x版本会显示此字段）。 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 是否开启消息收集功能。 storage_space Integer 存储空间，单位：GB。 used_storage_space Integer 已用消息存储空间，单位：GB。 enable_publicip Boolean 是否开启公网。 publicip_id String 实例绑定的弹性IP地址的ID。以英文逗号隔开多个弹性IP地址的ID。如果开启了公网访问功能（即enable_publicip为true），该字段为必选。 publicip_address String 公网IP地址。 ssl_enable Boolean 是否开启SSL。 cross_vpc_info String 跨VPC访问信息。 storage_resource_id String 存储资源ID。 storage_spec_code String 存储规格代码。 service_type String 服务类型。 storage_type String 存储类型。 extend_times Long 扩展时间。 ipv6_enable Boolean 是否开启IPv6。 support_features String 实例支持的特性功能。 disk_encrypted Boolean 是否开启磁盘加密。 ces_version String 云监控 版本。 node_num Integer 节点数。 new_spec_billing_enable Boolean 是否启用新规格计费。 enable_acl Boolean 是否开启访问控制列表。 broker_num Integer 节点数（仅RocketMQ 4.8.0版本会显示此字段）。 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 资源规格。 表4 TagEntity 参数 参数类型 描述 key String 标签键。 不能为空。 对于同一个实例，Key值唯一。 长度为1~128个字符（中文也可以输入128个字符）。 由任意语种字母、数字、空格和字符组成，字符仅支持_ . : = + - @ 首尾字符不能为空格。 value String 标签值。 长度为0~255个字符（中文也可以输入255个字符）。 由任意语种字母、数字、空格和字符组成，字符仅支持_ . : = + - @ 首尾字符不能为空格。

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 instances Array of InstanceDetail objects 参数解释： 实例列表。 取值范围： 不涉及。 instance_num Integer 参数解释： 实例数量。 取值范围： 不涉及。 表4 InstanceDetail 参数 参数类型 描述 name String 参数解释： 实例名称。 取值范围： 不涉及。 engine String 参数解释： 消息引擎。 取值范围： 不涉及。 status String 参数解释： 状态。 取值范围： 不涉及。 description String 参数解释： 消息描述。 取值范围： 不涉及。 type String 参数解释： 实例类型。 取值范围： single：单机。 cluster：集群。 specification String 参数解释： 实例规格。 取值范围： 不涉及。 engine_version String 参数解释： 实例版本。 取值范围： 不涉及。 instance_id String 参数解释： 实例ID。 取值范围： 不涉及。 charging_mode Integer 参数解释： 付费模式。 取值范围： 1表示按需计费，0表示包年/包月计费。 vpc_id String 参数解释： 私有云ID。 取值范围： 不涉及。 vpc_name String 参数解释： 私有云名称。 取值范围： 不涉及。 created_at String 参数解释： 完成创建时间。 格式为时间戳，指从格林威治时间1970年01月01日00时00分00秒起至指定时间的偏差总毫秒数。 取值范围： 不涉及。 product_id String 参数解释： 产品标识。 取值范围： 不涉及。 security_group_id String 参数解释： 安全组ID。 取值范围： 不涉及。 security_group_name String 参数解释： 安全组名称。 取值范围： 不涉及。 subnet_id String 参数解释： 子网ID。 取值范围： 不涉及。 subnet_cidr String 参数解释： 子网路由（仅RocketMQ 5.x版本会显示此字段）。 取值范围： 不涉及。 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 参数解释： 存储规格代码。 取值范围： 不涉及。 service_type String 参数解释： 服务类型。 取值范围： 不涉及。 storage_type String 参数解释： 存储类型。 取值范围： 不涉及。 extend_times Long 参数解释： 扩展时间。 取值范围： 不涉及。 ipv6_enable Boolean 参数解释： 是否开启IPv6。 取值范围： true：开启。 false：未开启。 support_features String 参数解释： 实例支持的特性功能。 取值范围： 不涉及。 disk_encrypted Boolean 参数解释： 是否开启磁盘加密。 取值范围： true：开启。 false：不开启。 ces_version String 参数解释： 云监控版本。 取值范围： 不涉及。 node_num Integer 参数解释： 节点数。 取值范围： 不涉及。 new_spec_billing_enable Boolean 参数解释： 是否启用新规格计费。 取值范围： true：开启。 false：未开启。 enable_acl Boolean 参数解释： 是否开启访问控制列表。 取值范围： true：开启。 false：未开启。 broker_num Integer 参数解释： Broker节点数（仅RocketMQ 4.8.0版本会显示此字段）。 取值范围： 不涉及。 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 参数解释： 是否为容灾实例。 取值范围： 不涉及。 config_ssl_need_restart_process Boolean 参数解释： 配置ssl是否需要重启。 取值范围： 不涉及。 tls_mode String 参数解释： 实例使用的安全协议。 取值范围： 不涉及。 表5 TagEntity 参数 参数类型 描述 key String 标签键。 不能为空。 对于同一个实例，Key值唯一。 长度为1~128个字符（中文也可以输入128个字符）。 由任意语种字母、数字、空格和字符组成，字符仅支持_ . : = + - @ 首尾字符不能为空格。 value String 标签值。 长度为0~255个字符（中文也可以输入255个字符）。 由任意语种字母、数字、空格和字符组成，字符仅支持_ . : = + - @ 首尾字符不能为空格。

响应示例 状态码：200 查询所有实例列表成功。 { "instances" : [ { "name" : "reliability-ztest", "engine" : "reliability", "status" : "RUNNING", "description" : "", "type" : "cluster", "specification" : "c6.4u8g.cluster * 1 broker", "engine_version" : "4.8.0", "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" : "c6.4u8g.cluster", "security_group_id" : "23c5977f-ff33-4b95-a73e-08d8a0bc4e6c", "security_group_name" : "Sys-default", "subnet_id" : "0a0f1fcb-f019-458d-b9e5-301867394d50", "available_zones" : [ "9f1c5806706d4c1fb0eb72f0a9b18c77" ], "available_zone_names" : [ "AZ3" ], "user_id" : "0b01fbb53600d4671fa8c00673c71260", "user_name" : "", "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" : false, "ssl_enable" : false, "cross_vpc_info" : "{\"192.168.1.21\":{\"advertised_ip\":\"192.168.1.21\",\"broker_port\":\"-\",\"port_id\":\"fa020857-d899-497c-a5f8-8dd90ed67ff7\",\"namesrv_port\":\"8301\"},\"192.168.1.246\":{\"advertised_ip\":\"192.168.1.246\",\"broker_port\":\"10100\",\"port_id\":\"c0f0586f-a4ee-41b5-a7f1-b4e554bbf12d\",\"namesrv_port\":\"-\"},\"192.168.1.77\":{\"advertised_ip\":\"192.168.1.77\",\"broker_port\":\"10101\",\"port_id\":\"8eb1d144-4315-402f-8498-37c9a10b630c\",\"namesrv_port\":\"-\"},\"192.168.1.159\":{\"advertised_ip\":\"192.168.1.159\",\"broker_port\":\"-\",\"port_id\":\"d35b22af-a202-4329-bda4-26e1bdf2aa8e\",\"namesrv_port\":\"8300\"},\"192.168.1.14\":{\"advertised_ip\":\"192.168.1.14\",\"broker_port\":\"10102\",\"port_id\":\"5fcb50fd-3af5-4123-a455-a67f1b926026\",\"namesrv_port\":\"-\"}}", "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" : "kafka.crossvpc.domain.enable,feature.physerver.kafka.topic.accesspolicy,rabbitmq.plugin.management,rocketmq.acl,roma_app_enable,auto_topic_switch,feature.physerver.kafka.user.manager,enable.new.authinfo,route,kafka.config.dynamic.modify.enable,kafka.new.pod.port,feature.physerver.kafka.topic.modify,message_trace_enable,features.pod.token.access,kafka.ssl.cert.modify.enable,roma.user.manage.no.support,feature.physerver.kafka.pulbic.dynamic,features.log.collection,kafka.config.static.modify.enable", "disk_encrypted" : false, "ces_version" : "linux,v1,v2", "node_num" : 5, "new_spec_billing_enable" : true, "broker_num" : 1, "namesrv_address" : "***", "broker_address" : "***", "public_namesrv_address" : "***", "public_broker_address" : "***", "grpc_address" : "***", "public_grpc_address" : "***" } ], "instance_num" : 1 }

URI GET /v2/{project_id}/instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 项目ID，获取方式请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 engine 是 String 参数解释： 消息引擎。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 name 否 String 参数解释： 实例名称。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id 否 String 参数解释： 实例ID。获取方法如下：登录RocketMQ控制台，在RocketMQ实例详情页面查找实例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。 默认取值： 不涉及。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 total Number 消费组总数。 groups Array of ConsumerGroup objects 消费组列表。 max Integer 最大可创建消费组数量。 remaining Integer 剩余可创建消费组数量。 next_offset Integer 下个分页的offset。 previous_offset Integer 上个分页的offset。 表4 ConsumerGroup 参数 参数类型 描述 enabled Boolean 是否可以消费。 broadcast Boolean 是否广播。 brokers Array of strings 关联的代理列表。 name String 消费组名称，只能由英文字母、数字、百分号、竖线、中划线、下划线组成，长度3~64个字符。 group_desc String 消费组描述，长度0~200个字符。 retry_max_time Integer 最大重试次数，取值范围为1~16。 createdAt Long 创建时间戳。 permissions Array of strings 权限集。 consume_orderly Boolean 是否按顺序消费。

响应示例 状态码： 200 查询成功。 { "total" : 1, "groups" : [ { "name" : "group-1", "enabled" : true, "broadcast" : false, "brokers" : [ "broker-0" ], "createdAt" : 1709087952686, "permissions" : [ ], "retry_max_time" : 16, "consume_orderly" : false } ], "max" : 4000, "remaining" : 3999, "next_offset" : -1, "previous_offset" : -1 }