# 导出RocketMQ元数据 - ExportRocketmqMetadata #### 功能介绍 导出RocketMQ元数据。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-hrm/api-call-process.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-hrm/api-grant-policy.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v2/{project_id}/rocketmq/instances/{instance_id}/metadata-export 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID，获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-hrm/hrm-api-0011.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释**： 实例ID。获取方法如下：调用"查询所有实例列表"接口，从响应体中获取实例ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表2响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | export_time | Integer | **参数解释**： 导出时间戳。 **取值范围**： 不涉及。 | | topic_config_table | Map\ | **参数解释**： Topic元数据，键为Topic名称，值为Topic配置。 | | subscription_group_table | Map\ | **参数解释**： 消费组元数据，键为消费组名称，值为消费组配置。 | 表3MetadataTopicConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | order | Boolean | **参数解释**： 是否有序消息。 **取值范围**： - true：是有序消息。 - false：不是有序消息。 | | perm | Integer | **参数解释**： Topic权限。 **取值范围**： - 2：订阅权限。 - 4：发布权限。 - 6：发布订阅权限。 | | attributes | [attributes] object | **参数解释**： 扩展属性。 | | read_queue_nums | Integer | **参数解释**： 读队列个数。 **取值范围**： 不涉及。 | | topic_name | String | **参数解释**： Topic名称。 **取值范围**： 不涉及。 | | topic_filter_type | String | **参数解释**： Topic过滤类型。 **取值范围**： - SINGLE_TAG：单标签。 - MULTI_TAG：多标签。 | | topic_sys_flag | Integer | **参数解释**： Topic系统标志位。 **取值范围**： 不涉及。 | | write_queue_nums | Integer | **参数解释**： 写队列个数。 **取值范围**： 不涉及。 | 表4attributes | 参数 | 参数类型 | 描述 | |:---|:---|:---| | message.type | String | **参数解释**： 消息类型。 **取值范围**： - NORMAL：普通。 - DELAY：定时。 - FIFO：顺序。 - TRANSACTION：事务。 | 表5MetadataSubscriptionGroup | 参数 | 参数类型 | 描述 | |:---|:---|:---| | broker_id | Integer | **参数解释**： 关联代理的ID。 **取值范围**： 不涉及。 | | consume_broadcast_enable | Boolean | **参数解释**： 是否允许以广播模式消费。 **取值范围**： - true：允许以广播模式消费。 - false：不允许以广播模式消费。 | | consume_enable | Boolean | **参数解释**： 是否允许消费。 **取值范围**： - true：允许消费。 - false：不允许消费。 | | consume_from_min_enable | Boolean | **参数解释**： 是否从最小偏移量开始消费。 **取值范围**： - true：是。 - false：不是。 | | group_name | String | **参数解释**： 消费组名称。 **取值范围**： 不涉及。 | | notify_consumer_ids_changed_enable | Boolean | **参数解释**： 消费者ID变化时是否通知。 **取值范围**： - true：是。 - false：不是。 | | retry_max_times | Integer | **参数解释**： 最大重试次数。 **取值范围**： 1-16。 | | retry_queue_nums | Integer | **参数解释**： 重试队列数量。 **取值范围**： 不涉及。 | | which_broker_when_consume_slow | Integer | **参数解释**： 慢消费时选择的broker节点ID。 **取值范围**： 不涉及。 | | consume_message_orderly | Boolean | **参数解释**： 是否顺序消费消息。 **取值范围**： - true：是。 - false：不是。 | | attributes | Map\ | **参数解释**： 扩展属性键值对。 | #### 请求示例 导出RocketMQ元数据。 ``` GET https://{endpoint}/v2/{project_id}/rocketmq/instances/{instance_id}/metadata-export ``` #### 响应示例 **状态码：200** ``` { "export_time" : 1780299372600, "topic_config_table" : { "topic-443036272" : { "order" : false, "perm" : 6, "attributes" : { "message.type" : "DELAY" }, "read_queue_nums" : 4, "topic_filter_type" : "SINGLE_TAG", "topic_name" : "topic-443036272", "topic_sys_flag" : 0, "write_queue_nums" : 4 } }, "subscription_group_table" : { "test" : { "broker_id" : 0, "consume_broadcast_enable" : true, "consume_enable" : true, "consume_from_min_enable" : true, "group_name" : "test", "notify_consumer_ids_changed_enable" : true, "retry_max_times" : 16, "retry_queue_nums" : 1, "which_broker_when_consume_slow" : 1, "consume_message_orderly" : false, "attributes" : { } } } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-hrm/ErrorCode.html)。