{ "name": "trocket", "display_name": "消息队列 RocketMQ 版", "description": "介绍如何使用云 API 对消息队列 RocketMQ进行操作，包括消息回溯，修改主题，创建订阅关系等。", "domain": "other", "api_version": "2023-03-08", "endpoint": "trocket.tencentcloudapi.com", "actions": [ { "name": "ChangeMigratingTopicToNextStage", "description": "修改迁移中的Topic状态进入下一步", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务ID，可在[DescribeSmoothMigrationTaskList](https://cloud.tencent.com/document/api/1493/119997)接口返回的[SmoothMigrationTaskItem](https://cloud.tencent.com/document/api/1493/96031#SmoothMigrationTaskItem)或控制台中获得。", "example": "02f6c31a-9707-4244-8dd3-35ad868ef92a" }, { "name": "TopicNameList", "type": "array", "required": true, "description": "主题名称列表，主题名称可在[DescribeMigratingTopicList](https://cloud.tencent.com/document/api/1493/118007)接口返回的[MigratingTopic](https://cloud.tencent.com/document/api/1493/96031#MigratingTopic)数据结构中获得。", "example": "[\"Topic-A\"]", "item_type": "string" }, { "name": "NamespaceList", "type": "array", "required": false, "description": "命名空间列表，仅4.x集群有效，与TopicNameList一一对应，可在[DescribeMigratingTopicList](https://cloud.tencent.com/document/api/1493/118007)接口返回的[MigratingTopic](https://cloud.tencent.com/document/api/1493/96031#MigratingTopic)数据结构中获得。", "example": "[\"tdmq-default\"]", "item_type": "string" } ], "required": [ "TaskId", "TopicNameList" ] }, { "name": "CreateConsumerGroup", "description": "创建消费组。 当前 API 适用集群：5.x 集群。4.x 集群的创建消费组接口文档见 [CreateRocketMQGroup](https://cloud.tencent.com/document/api/1179/63428)。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。", "example": "rmq-72mo3a9o" }, { "name": "MaxRetryTimes", "type": "integer", "required": true, "description": "最大重试次数，取值范围0～1000", "example": "16" }, { "name": "ConsumeEnable", "type": "boolean", "required": true, "description": "是否开启消费", "example": "true" }, { "name": "ConsumeMessageOrderly", "type": "boolean", "required": true, "description": "顺序投递：true 并发投递：false", "example": "true" }, { "name": "ConsumerGroup", "type": "string", "required": false, "description": "消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。", "example": "test_group" }, { "name": "Remark", "type": "string", "required": false, "description": "备注信息，最多 128 个字符", "example": "test remark info." }, { "name": "TagList", "type": "array", "required": false, "description": "标签列表", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_value" } ] } ], "required": [ "InstanceId", "MaxRetryTimes", "ConsumeEnable", "ConsumeMessageOrderly" ] }, { "name": "CreateInstance", "description": "创建 RocketMQ 5.x 集群。 当前 API 适用集群：5.x 集群。创建 4.x 专享/通用集群的接口文档见 [CreateRocketMQVipInstance](https://cloud.tencent.com/document/product/1179/95721)。", "status": "online", "parameters": [ { "name": "InstanceType", "type": "string", "required": true, "description": "实例类型，枚举值如下： - EXPERIMENT：体验版 - BASIC：基础版 - PRO：专业版 - PLATINUM：铂金版", "example": "BASIC" }, { "name": "Name", "type": "string", "required": true, "description": "集群名称，不能为空， 3-64个字符，只能包含数字、字母、“-”和“_”", "example": "test_name" }, { "name": "SkuCode", "type": "string", "required": true, "description": "商品规格，从 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/96031#ProductSKU) 出参获得。", "example": "basic_1k" }, { "name": "VpcList", "type": "array", "required": true, "description": "集群绑定的VPC信息", "example": "无", "item_type": "object", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "VPC ID", "example": "vpc-xxxx" }, { "name": "SubnetId", "type": "string", "required": true, "description": "子网ID", "example": "subnet-xxxx" } ] }, { "name": "Remark", "type": "string", "required": false, "description": "备注信息", "example": "测试集群" }, { "name": "TagList", "type": "array", "required": false, "description": "标签列表", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_value" } ] }, { "name": "EnablePublic", "type": "boolean", "required": false, "description": "是否开启公网，默认值为false表示不开启", "example": "true" }, { "name": "BillingFlow", "type": "boolean", "required": false, "description": "公网是否按流量计费，默认值为false表示不按流量计费", "example": "false" }, { "name": "Bandwidth", "type": "integer", "required": false, "description": "公网带宽（单位：兆），默认值为0。如果开启公网，该字段必须为大于0的正整数", "example": "2" }, { "name": "IpRules", "type": "array", "required": false, "description": "公网访问白名单，不填表示拒绝所有 IP 访问", "example": "无", "item_type": "object", "children": [ { "name": "Ip", "type": "string", "required": true, "description": "IP地址", "example": "0.0.0.0" }, { "name": "Allow", "type": "boolean", "required": true, "description": "是否允许放行，默认为false表示拒绝", "example": "true" }, { "name": "Remark", "type": "string", "required": true, "description": "备注信息", "example": "remark1" } ] }, { "name": "MessageRetention", "type": "integer", "required": false, "description": "消息保留时长（单位：小时），取值范围参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/96031#ProductSKU) 出参： - 默认值：DefaultRetention 参数 - 最小值：RetentionLowerLimit 参数 - 最大值：RetentionUpperLimit 参数", "example": "72" }, { "name": "PayMode", "type": "integer", "required": false, "description": "付费模式（0: 后付费；1: 预付费），默认值为0", "example": "0" }, { "name": "RenewFlag", "type": "integer", "required": false, "description": "预付费集群是否自动续费（0: 不自动续费；1: 自动续费），默认值为0", "example": "1" }, { "name": "TimeSpan", "type": "integer", "required": false, "description": "预付费集群的购买时长（单位：月），取值范围为1～60，默认值为1", "example": "1" }, { "name": "MaxTopicNum", "type": "integer", "required": false, "description": "最大可创建主题数，从 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/96031#ProductSKU) 出参： - 默认值和最小值：TopicNumLimit 参数 - 最大值：TopicNumUpperLimit 参数", "example": "50" }, { "name": "ZoneIds", "type": "array", "required": false, "description": "部署可用区列表，从 [DescribeZones](https://cloud.tencent.com/document/product/1596/77929) 接口返回中的 [ZoneInfo](https://cloud.tencent.com/document/api/1596/77932#ZoneInfo) 数据结构中获得。", "example": "[10001,10002]", "item_type": "integer" } ], "required": [ "InstanceType", "Name", "SkuCode", "VpcList" ] }, { "name": "CreateRole", "description": "添加角色。 当前 API 适用集群：5.x 集群。4.x 集群的创建角色接口文档见 [CreateRocketMQRole](https://cloud.tencent.com/document/product/1179/107538)，给角色授权接口文档见 [CreateRocketMQEnvironmentRole](https://cloud.tencent.com/document/product/1179/107539)。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。", "example": "rmq-72mo3a9o" }, { "name": "Role", "type": "string", "required": true, "description": "角色名称，不能为空，只支持数字 大小写字母 分隔符(\"_\",\"-\")，不能超过 32 个字符", "example": "test_role_name" }, { "name": "PermWrite", "type": "boolean", "required": true, "description": "是否开启生产权限", "example": "true" }, { "name": "PermRead", "type": "boolean", "required": true, "description": "是否开启消费权限", "example": "false" }, { "name": "Remark", "type": "string", "required": true, "description": "备注", "example": "测试角色" }, { "name": "PermType", "type": "string", "required": false, "description": "权限类型，默认按集群授权（Cluster：集群级别；TopicAndGroup：主题\u0026消费组级别）", "example": "Cluster" }, { "name": "DetailedPerms", "type": "array", "required": false, "description": "Topic\u0026Group维度权限配置，权限类型为 TopicAndGroup 时必填", "example": "无", "item_type": "object", "children": [ { "name": "Resource", "type": "string", "required": true, "description": "权限对应的资源 可以是主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。 可以是消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。", "example": "test_topic" }, { "name": "PermWrite", "type": "boolean", "required": true, "description": "是否开启生产权限", "example": "true" }, { "name": "PermRead", "type": "boolean", "required": true, "description": "是否开启消费权限", "example": "true" }, { "name": "ResourceType", "type": "string", "required": true, "description": "授权资源类型（Topic:主题; Group:消费组）", "example": "Topic" }, { "name": "Remark", "type": "string", "required": false, "description": "资源备注", "example": "test_remark" } ] } ], "required": [ "InstanceId", "Role", "PermWrite", "PermRead", "Remark" ] }, { "name": "CreateTopic", "description": "创建 RocketMQ 主题。 当前 API 适用集群：5.x 集群。4.x 集群的创建主题接口文档见 [CreateRocketMQTopic](https://cloud.tencent.com/document/api/1179/63426)", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。", "example": "rmq-72mo3a9o" }, { "name": "Topic", "type": "string", "required": true, "description": "主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。", "example": "test_topic" }, { "name": "TopicType", "type": "string", "required": true, "description": "主题类型，枚举值如下： - NORMAL: 普通消息 - FIFO: 顺序消息 - DELAY: 延时消息 - TRANSACTION: 事务消息", "example": "NORMAL" }, { "name": "QueueNum", "type": "integer", "required": true, "description": "队列数量，取值范围3～16", "example": "3" }, { "name": "Remark", "type": "string", "required": false, "description": "备注信息，最多 128 个字符", "example": "测试主题" }, { "name": "MsgTTL", "type": "integer", "required": false, "description": "消息保留时长（单位：小时）", "example": "72" }, { "name": "TagList", "type": "array", "required": false, "description": "标签列表", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_value" } ] } ], "required": [ "InstanceId", "Topic", "TopicType", "QueueNum" ] }, { "name": "DeleteConsumerGroup", "description": "删除消费组。消费者组删除后，消费者组的所有配置和相关数据都会被清空，且无法找回。删除后，在线的消费者客户端会出现报错，建议您提前下线客户端。 当前 API 适用集群：5.x 集群。4.x 集群的删除消费组接口文档见 [DeleteRocketMQGroup](https://cloud.tencent.com/document/api/1179/63424)。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。", "example": "rmq-72mo3a9o" }, { "name": "ConsumerGroup", "type": "string", "required": false, "description": "消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。", "example": "test_group" } ], "required": [ "InstanceId" ] }, { "name": "DeleteInstance", "description": "删除 RocketMQ 5.x 集群，删除前请先删除正在使用的主题、消费组和角色信息。 当前 API 适用集群：5.x 集群。删除 4.x 集群接口文档见 [DeleteRocketMQVipInstance](https://cloud.tencent.com/document/product/1179/95802)。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。", "example": "rmq-72mo3a9o" } ], "required": [ "InstanceId" ] }, { "name": "DeleteRole", "description": "删除角色。请确保该角色相关信息不在当前代码中被使用。删除角色后，原先使用该角色进行生产或消费消息的密钥（AccessKey 和 SecretKey）将立即失效。 当前 API 适用集群：5.x 集群。4.x 集群的删除角色接口文档见 [DeleteRocketMQRoles](https://cloud.tencent.com/document/product/1179/107536)，删除角色授权接口文档见 [DeleteRocketMQEnvironmentRoles](https://cloud.tencent.com/document/product/1179/107537)。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。", "example": "rmq-72mo3a9o" }, { "name": "Role", "type": "string", "required": true, "description": "角色名称，从 [DescribeRoleList](https://cloud.tencent.com/document/api/1493/98862) 接口响应中的 [RoleItem](https://cloud.tencent.com/document/api/1493/96031#RoleItem) 或控制台获得。", "example": "test_role_name" } ], "required": [ "InstanceId", "Role" ] }, { "name": "DeleteSmoothMigrationTask", "description": "删除平滑迁移任务，只有被取消的任务才可删除", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务ID，可在[DescribeSmoothMigrationTaskList](https://cloud.tencent.com/document/api/1493/119997)接口返回的[SmoothMigrationTaskItem](https://cloud.tencent.com/document/api/1493/96031#SmoothMigrationTaskItem)或控制台中获得。", "example": "02f6c31a-9707-4244-8dd3-35ad868ef92a" } ], "required": [ "TaskId" ] }, { "name": "DeleteTopic", "description": "删除主题。主题删除后，主题的所有配置和相关数据都会被清空，且无法找回。 当前 API 适用集群：5.x 集群。4.x 集群的删除主题接口文档见 [DeleteRocketMQTopic](https://cloud.tencent.com/document/api/1179/63423)。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。", "example": "rmq-72mo3a9o" }, { "name": "Topic", "type": "string", "required": true, "description": "主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。", "example": "test_topic" } ], "required": [ "InstanceId", "Topic" ] }, { "name": "DescribeConsumerClient", "description": "查询消费者客户端详情。 当前 API 适用集群：5.x 集群。4.x 集群的查询消费者客户端详情接口文档见 [DescribeRocketMQConsumerConnectionDetail](https://cloud.tencent.com/document/product/1179/102490)。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。", "example": "rmq-72mo3a9o" }, { "name": "ClientId", "type": "string", "required": true, "description": "客户端ID，从 [DescribeConsumerClientList](https://cloud.tencent.com/document/api/1493/120140) 接口中的 [ConsumerClient](https://cloud.tencent.com/document/api/1493/96031#ConsumerClient) 出参中获得。", "example": "11.139.244.247@75043#6734858812769343" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤查询条件列表，请在引用此参数的API说明中了解使用方法。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤条件参数名", "example": "fliter_key" }, { "name": "Values", "type": "array", "required": true, "description": "过滤条件的值", "example": "filter_value", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "查询起始位置，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询结果限制数量，默认20。", "example": "20" }, { "name": "ConsumerGroup", "type": "string", "required": false, "description": "消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。", "example": "test_group" } ], "required": [ "InstanceId", "ClientId" ] }, { "name": "DescribeConsumerClientList", "description": "查询消费组下的客户端连接列表。 当前 API 适用集群：5.x 集群。4.x 集群的查询消费组下的客户端列表接口文档见 [DescribeRocketMQConsumerConnections](https://cloud.tencent.com/document/product/1179/100460)。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。", "example": "rmq-72mo3a9o" }, { "name": "ConsumerGroup", "type": "string", "required": false, "description": "消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。", "example": "test_group" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤查询条件列表，请在引用此参数的API说明中了解使用方法。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤条件参数名", "example": "fliter_key" }, { "name": "Values", "type": "array", "required": true, "description": "过滤条件的值", "example": "filter_value", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "查询起始位置，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询结果限制数量，默认20。", "example": "20" } ], "required": [ "InstanceId" ] }, { "name": "DescribeConsumerGroup", "description": "查询消费组详情。 当前 API 适用集群：5.x 集群。4.x 集群的查询消费组详情接口文档见 [DescribeRocketMQConsumerConnections](https://cloud.tencent.com/document/product/1179/100460)。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。", "example": "rmq-72mo3a9o" }, { "name": "ConsumerGroup", "type": "string", "required": false, "description": "消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。", "example": "test_group" } ], "required": [ "InstanceId" ] }, { "name": "DescribeConsumerGroupList", "description": "获取消费组列表，Filter参数使用说明如下： - ConsumerGroupName 消费组名称，支持模糊查询，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。 - ConsumeMessageOrderly，投递顺序性，枚举值如下： - true 顺序投递 - false 并发投递 Filters示例： [{ \"Name\": \"ConsumeMessageOrderly\", \"Values\": [\"true\"...", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。", "example": "rmq-72mo3a9o" }, { "name": "TagFilters", "type": "array", "required": false, "description": "标签过滤器", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键名称", "example": "test_key" }, { "name": "TagValues", "type": "array", "required": true, "description": "标签值列表", "example": "test_value", "item_type": "string" } ] }, { "name": "Filters", "type": "array", "required": false, "description": "过滤查询条件列表，请在引用此参数的API说明中了解使用方法。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤条件参数名", "example": "fliter_key" }, { "name": "Values", "type": "array", "required": true, "description": "过滤条件的值", "example": "filter_value", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "查询起始位置，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询结果限制数量，默认20。", "example": "20" }, { "name": "FromTopic", "type": "string", "required": false, "description": "查询指定主题下的消费组", "example": "test_topic" }, { "name": "SortedBy", "type": "string", "required": false, "description": "按照指定字段排序，枚举值如下： - subscribeNum：订阅 Topic 个数", "example": "subscribeNum" }, { "name": "SortOrder", "type": "string", "required": false, "description": "按升序或降序排列，枚举值如下： - asc：升序 - desc：降序", "example": "asc" } ], "required": [ "InstanceId" ] }, { "name": "DescribeConsumerLag", "description": "查询指定消费组堆积数。 当前 API 适用集群：4.x 集群和 5.x 集群。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。", "example": "rmq-72mo3a9o" }, { "name": "ConsumerGroup", "type": "string", "required": false, "description": "消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。", "example": "test_group" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间，4.x集群必填，从 [DescribeRocketMQNamespaces](https://cloud.tencent.com/document/api/1179/63419) 接口返回的 [RocketMQNamespace](https://cloud.tencent.com/document/api/1179/46089#RocketMQNamespace) 或控制台获得。", "example": "namespace_test" }, { "name": "SubscribeTopic", "type": "string", "required": false, "description": "订阅主题，不为空则查询订阅了该主题的消费组的堆积，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。", "example": "topic_test" } ], "required": [ "InstanceId" ] }, { "name": "DescribeFusionInstanceList", "description": "查询集群列表，支持 4.x 和 5.x 集群，其中 Filters 参数使用说明如下： - InstanceName 集群名称，支持模糊查询，从本接口返回值或控制台获得 - InstanceId 集群ID，精确查询，从当前接口或控制台获得 - InstanceType 集群类型，可参考 [InstanceItem](https://cloud.tencent.com/document/api/1493/96031#InstanceItem) 数据结构，支持多选 - Version 集群版本，枚举值如下： - 4 RocketMQ 4.x 集群 - 5 RocketMQ 5.x 集群 Filte...", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "查询起始位置，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询结果限制数量，默认20。", "example": "20" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤查询条件列表，请在引用此参数的API说明中了解使用方法。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤条件参数名", "example": "fliter_key" }, { "name": "Values", "type": "array", "required": true, "description": "过滤条件的值", "example": "filter_value", "item_type": "string" } ] }, { "name": "TagFilters", "type": "array", "required": false, "description": "标签过滤器", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键名称", "example": "test_key" }, { "name": "TagValues", "type": "array", "required": true, "description": "标签值列表", "example": "test_value", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeInstance", "description": "查询 RocketMQ 5.x 集群信息。 当前 API 适用集群：5.x 集群。查询 4.x 专享/通用集群信息的接口文档见 [DescribeRocketMQVipInstanceDetail](https://cloud.tencent.com/document/product/1179/86725)。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。", "example": "rmq-72mo3a9o" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstanceList", "description": "查询集群列表，仅支持 5.x 集群。Filters参数使用说明如下： - InstanceName 集群名称，支持模糊搜索 - InstanceId 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得 - InstanceType 集群类型，可参考 [InstanceItem](https://cloud.tencent.com/document/api/1493/96031#InstanceItem) 数据结构，支持多选 - InstanceStatus 集群状态，可参考 [InstanceItem](https://cloud....", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤查询条件列表，请在引用此参数的API说明中了解使用方法。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤条件参数名", "example": "fliter_key" }, { "name": "Values", "type": "array", "required": true, "description": "过滤条件的值", "example": "filter_value", "item_type": "string" } ] }, { "name": "TagFilters", "type": "array", "required": false, "description": "标签过滤器", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键名称", "example": "test_key" }, { "name": "TagValues", "type": "array", "required": true, "description": "标签值列表", "example": "test_value", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "查询起始位置，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询结果限制数量，默认20。", "example": "20" } ], "required": [] }, { "name": "DescribeMessage", "description": "查询消息详情。 当前 API 适用集群：5.x 集群。4.x 集群的查询消息详情接口文档见 [DescribeRocketMQMsg](https://cloud.tencent.com/document/product/1179/91055)。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。", "example": "rmq-72mo3a9o" }, { "name": "Topic", "type": "string", "required": true, "description": "主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。", "example": "test_topic" }, { "name": "MsgId", "type": "string", "required": true, "description": "消息 ID，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。", "example": "01963F0B14BAF09F27077D244F00000000" }, { "name": "Offset", "type": "integer", "required": false, "description": "查询起始位置，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询结果限制数量，默认20。", "example": "20" }, { "name": "QueryDeadLetterMessage", "type": "boolean", "required": false, "description": "是否是死信消息，默认为false", "example": "false" }, { "name": "QueryDelayMessage", "type": "boolean", "required": false, "description": "是否是延时消息，默认为false", "example": "false" } ], "required": [ "InstanceId", "Topic", "MsgId" ] }, { "name": "DescribeMessageList", "description": "查询消息列表。如果查询死信消息，请设置ConsumerGroup参数。 当前 API 适用集群：5.x 集群。4.x 集群的查询消息列表接口文档见 [DescribeRocketMQTopicMsgs](https://cloud.tencent.com/document/product/1179/97761)。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。", "example": "rmq-72mo3a9o" }, { "name": "Topic", "type": "string", "required": true, "description": "主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。", "example": "test_topic" }, { "name": "StartTime", "type": "integer", "required": true, "description": "要查询消息的开始时间，**Unix时间戳（毫秒）**", "example": "1672502400000" }, { "name": "EndTime", "type": "integer", "required": true, "description": "要查询消息的结束时间，**Unix时间戳（毫秒）**", "example": "1672504200000" }, { "name": "TaskRequestId", "type": "string", "required": true, "description": "一次查询标识。第一次查询可传空字符串，当查询结果涉及分页，请求下一页数据时该入参的值取上一次请求响应中的出参TaskRequestId 值即可。", "example": "901a6956-1ab9-7fb7-3bf5-9f02b7aa2a7d" }, { "name": "Offset", "type": "integer", "required": false, "description": "查询起始位置，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询结果限制数量，默认20。", "example": "20" }, { "name": "ConsumerGroup", "type": "string", "required": false, "description": "消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。", "example": "test_group" }, { "name": "MsgId", "type": "string", "required": false, "description": "消息 ID，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口返回的 [MessageItem](https://cloud.tencent.com/document/api/1493/96031#MessageItem) 或业务日志中获得。", "example": "01963F0B14BAF09F27077D244F00000000" }, { "name": "MsgKey", "type": "string", "required": false, "description": "消息 Key，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口返回的 [MessageItem](https://cloud.tencent.com/document/api/1493/96031#MessageItem) 或业务日志中获得。", "example": "test_key" }, { "name": "RecentMessageNum", "type": "integer", "required": false, "description": "查询最近N条消息 最大不超过1024，默认-1为其他查询条件", "example": "100" }, { "name": "QueryDeadLetterMessage", "type": "boolean", "required": false, "description": "是否查询死信消息，默认为false", "example": "false" }, { "name": "Tag", "type": "string", "required": false, "description": "消息 Tag，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口返回的 [MessageItem](https://cloud.tencent.com/document/api/1493/96031#MessageItem) 或业务日志中获得。", "example": "test_tag" } ], "required": [ "InstanceId", "Topic", "StartTime", "EndTime", "TaskRequestId" ] }, { "name": "DescribeMessageTrace", "description": "根据消息 ID 查询消息轨迹。 当前 API 适用集群：5.x 集群。4.x 集群查询消息轨迹接口文档见 [DescribeRocketMQMsgTrace](https://cloud.tencent.com/document/product/1179/97760)。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。", "example": "rmq-72mo3a9o" }, { "name": "Topic", "type": "string", "required": true, "description": "主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。", "example": "test_topic" }, { "name": "MsgId", "type": "string", "required": true, "description": "消息 ID，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口返回的 [MessageItem](https://cloud.tencent.com/document/api/1493/96031#MessageItem) 或业务日志中获得。", "example": "1EAE3915000721B8D17C2C5BB31638D1" }, { "name": "QueryDeadLetterMessage", "type": "boolean", "required": false, "description": "是否是死信消息，默认为false", "example": "false" }, { "name": "QueryDelayMessage", "type": "boolean", "required": false, "description": "是否是延时消息，默认为false", "example": "false" } ], "required": [ "InstanceId", "Topic", "MsgId" ] }, { "name": "DescribeMigratingGroupStats", "description": "查看迁移消费组的实时信息", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务ID，可在[DescribeSmoothMigrationTaskList](https://cloud.tencent.com/document/api/1493/119997)接口返回的[SmoothMigrationTaskItem](https://cloud.tencent.com/document/api/1493/96031#SmoothMigrationTaskItem)或控制台中获得。", "example": "02f6c31a-9707-4244-8dd3-35ad868ef92a" }, { "name": "GroupName", "type": "string", "required": true, "description": "消费组名称，可在[DescribeSourceClusterGroupList](https://cloud.tencent.com/document/api/1493/118006)接口返回的[SourceClusterGroupConfig](https://cloud.tencent.com/document/api/1493/96031#SourceClusterGroupConfig)或控制台中获取。", "example": "group-a" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间，仅迁移至4.x集群有效，可在[DescribeSourceClusterGroupList](https://cloud.tencent.com/document/api/1493/118006)接口返回的[SourceClusterGroupConfig](https://cloud.tencent.com/document/api/1493/96031#SourceClusterGroupConfig)或控制台中获取。", "example": "tdmq-default" } ], "required": [ "TaskId", "GroupName" ] }, { "name": "DescribeMigratingTopicList", "description": "查询Topic迁移状态列表。 Filters字段为查询过滤器，支持以下条件： * TopicName 主题名称，支持模糊查询 * MigrationStatus 迁移状态，可参考[MigratingTopic](https://cloud.tencent.com/document/api/1493/96031#MigratingTopic)数据结构 * Namespace 命名空间，仅4.x集群有效 Filters示例： [{ \"Name\": \"TopicName\", \"Values\": [\"topic-a\"] }]", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务ID，可在[DescribeSmoothMigrationTaskList](https://cloud.tencent.com/document/api/1493/119997)接口返回的[SmoothMigrationTaskItem](https://cloud.tencent.com/document/api/1493/96031#SmoothMigrationTaskItem)或控制台中获得。", "example": "02f6c31a-9707-4244-8dd3-35ad868ef92a" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询结果限制数量，默认20。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "查询起始位置，默认为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤查询条件列表，请在引用此参数的API说明中了解使用方法。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤条件参数名", "example": "fliter_key" }, { "name": "Values", "type": "array", "required": true, "description": "过滤条件的值", "example": "filter_value", "item_type": "string" } ] } ], "required": [ "TaskId" ] }, { "name": "DescribeMigratingTopicStats", "description": "用于查询迁移主题的实时数据", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务ID，可在[DescribeSmoothMigrationTaskList](https://cloud.tencent.com/document/api/1493/119997)接口返回的[SmoothMigrationTaskItem](https://cloud.tencent.com/document/api/1493/96031#SmoothMigrationTaskItem)或控制台中获得。", "example": "4f9864ae-26ac-4662-9ede-1942b20d7a04" }, { "name": "TopicName", "type": "string", "required": true, "description": "主题名称，可在[DescribeMigratingTopicList](https://cloud.tencent.com/document/api/1493/118007)接口返回的[MigratingTopic](https://cloud.tencent.com/document/api/1493/96031#MigratingTopic)数据结构中获得。", "example": "topic-a" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间，仅迁移至4.x集群有效，可在[DescribeMigratingTopicList](https://cloud.tencent.com/document/api/1493/118007)接口返回的[MigratingTopic](https://cloud.tencent.com/document/api/1493/96031#MigratingTopic)数据结构中获得。", "example": "tdmq-default" } ], "required": [ "TaskId", "TopicName" ] }, { "name": "DescribeMigrationTaskList", "description": "获取数据迁移任务列表，Filter参数使用说明如下： TaskId，根据任务ID精确查找 InstanceId，根据实例ID精确查找 Type，根据任务类型精确查找", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤查询条件列表，请在引用此参数的API说明中了解使用方法。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤条件参数名", "example": "fliter_key" }, { "name": "Values", "type": "array", "required": true, "description": "过滤条件的值", "example": "filter_value", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "查询起始位置，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询结果限制数量，默认20。", "example": "20" } ], "required": [] }, { "name": "DescribeProducerList", "description": "查询主题关联的生产者列表信息，Filters支持以下筛选条件： - ClientIP，客户端IP - ClientID，客户端ID 当前 API 适用集群：5.x 集群。4.x 集群的查询生产者客户端列表接口文档见 [DescribeRocketMQProducers](https://cloud.tencent.com/document/api/1179/122749)。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。", "example": "rmq-72mo3a9o" }, { "name": "Topic", "type": "string", "required": true, "description": "主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。", "example": "test_topic" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤查询条件列表，请在引用此参数的API说明中了解使用方法。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤条件参数名", "example": "fliter_key" }, { "name": "Values", "type": "array", "required": true, "description": "过滤条件的值", "example": "filter_value", "item_type": "string" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "查询结果限制数量，默认20。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "查询起始位置，默认为0。", "example": "0" } ], "required": [ "InstanceId", "Topic" ] }, { "name": "DescribeProductSKUs", "description": "查询产品售卖规格，针对 RocketMQ 5.x 集群。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeRoleList", "description": "查询角色列表，Filter参数使用说明如下： - RoleName 角色名称，支持模糊搜索，从本接口返回值或控制台获得 - AccessKey AccessKey，支持模糊搜索，从本接口返回值或控制台获得 Filters示例： [{ \"Name\": \"RoleName\", \"Values\": [\"test_role\"] }] 当前 API 适用集群：5.x 集群。4.x 集群的查询角色列表接口文档见 [DescribeRocketMQRoles](https://cloud.tencent.com/document/product/1179/107534)，查询角色授权列表接口文档\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。", "example": "rmq-72mo3a9o" }, { "name": "Offset", "type": "integer", "required": false, "description": "查询起始位置，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询结果限制数量，默认20。", "example": "20" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤查询条件列表，请在引用此参数的API说明中了解使用方法。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤条件参数名", "example": "fliter_key" }, { "name": "Values", "type": "array", "required": true, "description": "过滤条件的值", "example": "filter_value", "item_type": "string" } ] } ], "required": [ "InstanceId" ] }, { "name": "DescribeSmoothMigrationTaskList", "description": "用于查询平滑迁移任务列表。 查询参数Filters， 支持的字段如下： * TaskStatus, 任务状态，支持多选 * ConnectionType，网络连接类型，支持多选，参考[SmoothMigrationTaskItem](https://cloud.tencent.com/document/api/1493/96031#SmoothMigrationTaskItem)的说明 * InstanceId，实例ID，精确搜索 * TaskName，任务名称，支持模糊搜索 Filters示例： [{ \"Name\": \"InstanceId\", \"Values\": [\"rmq-1gzecldfg\"] }]", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "查询结果限制数量，默认20。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "查询起始位置，默认为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤查询条件列表，请在引用此参数的API说明中了解使用方法。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤条件参数名", "example": "fliter_key" }, { "name": "Values", "type": "array", "required": true, "description": "过滤条件的值", "example": "filter_value", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeSourceClusterGroupList", "description": "平滑迁移过程获取源集群group列表接口。 Filters字段为查询过滤器，支持以下字段： * GroupName，消费组名称，支持模糊搜索 * Imported，是否已导入 * ImportStatus，导入状态，参考[SourceClusterGroupConfig](https://cloud.tencent.com/document/api/1493/96031#SourceClusterGroupConfig)的说明 * Namespace，命名空间，仅4.x集群有效 Filters示例： [{ \"Name\": \"GroupName\", \"Values\": [\"group-a\"] }]", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务ID，可在[DescribeSmoothMigrationTaskList](https://cloud.tencent.com/document/api/1493/119997)接口返回的[SmoothMigrationTaskItem](https://cloud.tencent.com/document/api/1493/96031#SmoothMigrationTaskItem)或控制台上获得。", "example": "02f6c31a-9707-4244-8dd3-35ad868ef92a" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询结果限制数量，默认20。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "查询起始位置，默认为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤查询条件列表，请在引用此参数的API说明中了解使用方法。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤条件参数名", "example": "fliter_key" }, { "name": "Values", "type": "array", "required": true, "description": "过滤条件的值", "example": "filter_value", "item_type": "string" } ] } ], "required": [ "TaskId" ] }, { "name": "DescribeTopic", "description": "查询主题详情，Offset和Limit参数是指订阅该主题的消费组查询分页参数，Filter参数使用说明如下： - ConsumerGroup 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。 Filters示例： [{ \"Name\": \"ConsumerGroup\", \"Values\": [\"test_group\"] }]", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。", "example": "rmq-72mo3a9o" }, { "name": "Topic", "type": "string", "required": true, "description": "主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。", "example": "test_topic" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤查询条件列表，请在引用此参数的API说明中了解使用方法。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤条件参数名", "example": "fliter_key" }, { "name": "Values", "type": "array", "required": true, "description": "过滤条件的值", "example": "filter_value", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "查询起始位置，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询结果限制数量，默认20。", "example": "20" } ], "required": [ "InstanceId", "Topic" ] }, { "name": "DescribeTopicList", "description": "获取主题列表，Filter参数使用说明如下： - TopicName 主题名称，支持模糊搜索，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得 - TopicType 主题类型查询，支持多选，参考 [DescribeTopic](https://cloud.tencent.com/document/api/1493/97945) 接口 TopicType 字段 Filters示例： [{ \"Name\": \"TopicName\", \"Values\": [\"test_topic\"] }]...", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。", "example": "rmq-72mo3a9o" }, { "name": "TagFilters", "type": "array", "required": false, "description": "标签过滤器", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键名称", "example": "test_key" }, { "name": "TagValues", "type": "array", "required": true, "description": "标签值列表", "example": "test_value", "item_type": "string" } ] }, { "name": "Filters", "type": "array", "required": false, "description": "过滤查询条件列表，请在引用此参数的API说明中了解使用方法。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤条件参数名", "example": "fliter_key" }, { "name": "Values", "type": "array", "required": true, "description": "过滤条件的值", "example": "filter_value", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "查询起始位置，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询结果限制数量，默认20。", "example": "20" }, { "name": "FromGroup", "type": "string", "required": false, "description": "按照消费组查询订阅的主题", "example": "test_group" } ], "required": [ "InstanceId" ] }, { "name": "DescribeTopicListByGroup", "description": "查询消费组订阅的主题列表，Filter参数使用说明如下： - TopicName 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。 Filters示例： [{ \"Name\": \"TopicName\", \"Values\": [\"test_topic\"] }] 当前 API 适用集群：5.x 集群。4.x 集群的查询消费组订阅的主题列表接口文档见 [DescribeRocketMQTopicsByGroup](https://c...", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。", "example": "rmq-72mo3a9o" }, { "name": "Offset", "type": "integer", "required": false, "description": "查询起始位置，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询结果限制数量，默认20。", "example": "20" }, { "name": "ConsumerGroup", "type": "string", "required": false, "description": "消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。", "example": "test_group" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤查询条件列表，请在引用此参数的API说明中了解使用方法。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤条件参数名", "example": "fliter_key" }, { "name": "Values", "type": "array", "required": true, "description": "过滤条件的值", "example": "filter_value", "item_type": "string" } ] } ], "required": [ "InstanceId" ] }, { "name": "DoHealthCheckOnMigratingTopic", "description": "检查迁移中的主题是否处于正常状态，只有处于正常状态的主题，才可以进入下一个迁移阶段", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务ID，可在[DescribeSmoothMigrationTaskList](https://cloud.tencent.com/document/api/1493/119997)接口返回的[SmoothMigrationTaskItem](https://cloud.tencent.com/document/api/1493/96031#SmoothMigrationTaskItem)或控制台中获得。", "example": "02f6c31a-9707-4244-8dd3-35ad868ef92a" }, { "name": "TopicName", "type": "string", "required": true, "description": "主题名称，可在[DescribeMigratingTopicList](https://cloud.tencent.com/document/api/1493/118007)接口返回的[MigratingTopic](https://cloud.tencent.com/document/api/1493/96031#MigratingTopic)数据结构中获得。", "example": "topic-a" }, { "name": "IgnoreCheck", "type": "boolean", "required": false, "description": "是否忽略当前检查", "example": "true" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间，仅迁移至4.x集群有效，可在[DescribeMigratingTopicList](https://cloud.tencent.com/document/api/1493/118007)接口返回的[MigratingTopic](https://cloud.tencent.com/document/api/1493/96031#MigratingTopic)数据结构中获得。", "example": "ns1" } ], "required": [ "TaskId", "TopicName" ] }, { "name": "ImportSourceClusterConsumerGroups", "description": "导入消费者组列表", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务ID，可在[DescribeSmoothMigrationTaskList](https://cloud.tencent.com/document/api/1493/119997)接口返回的[SmoothMigrationTaskItem](https://cloud.tencent.com/document/api/1493/96031#SmoothMigrationTaskItem)或控制台中获得。", "example": "n4zk7nv4-d596886f" }, { "name": "GroupList", "type": "array", "required": true, "description": "待导入的消费组列表", "example": "[\"GroupName\": \"group-a\", \"Remark\": \"备注\"]", "item_type": "object", "children": [ { "name": "GroupName", "type": "string", "required": true, "description": "消费组名称，可在[DescribeSourceClusterGroupList](https://cloud.tencent.com/document/api/1493/118006)接口返回的[SourceClusterGroupConfig](https://cloud.tencent.com/document/api/1493/96031#SourceClusterGroupConfig)数据中获取。 注意：此字段可能返回 null，表示取不到有效值。", "example": "group1" }, { "name": "Remark", "type": "string", "required": false, "description": "备注信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "remark1" }, { "name": "Imported", "type": "boolean", "required": false, "description": "是否已导入，作为入参时无效 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间，仅4.x集群有效 注意：此字段可能返回 null，表示取不到有效值。", "example": "namespace1" }, { "name": "ImportStatus", "type": "string", "required": false, "description": "导入状态 Unknown 未知 Success 成功 Failure 失败 AlreadyExists 已存在 仅作为出参时使用 注意：此字段可能返回 null，表示取不到有效值。", "example": "Success" }, { "name": "NamespaceV4", "type": "string", "required": false, "description": "4.x的命名空间，出参使用 注意：此字段可能返回 null，表示取不到有效值。", "example": "namespace1" }, { "name": "GroupNameV4", "type": "string", "required": false, "description": "4.x的消费组名，出参使用 注意：此字段可能返回 null，表示取不到有效值。", "example": "group1" }, { "name": "FullNamespaceV4", "type": "string", "required": false, "description": "4.x的完整命名空间，出参使用 注意：此字段可能返回 null，表示取不到有效值。", "example": "namespace1" }, { "name": "ConsumeMessageOrderly", "type": "boolean", "required": false, "description": "是否为顺序投递，5.0有效 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" } ] } ], "required": [ "TaskId", "GroupList" ] }, { "name": "ImportSourceClusterTopics", "description": "导入topic列表", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务ID，可在[DescribeSmoothMigrationTaskList](https://cloud.tencent.com/document/api/1493/119997)接口返回的[SmoothMigrationTaskItem](https://cloud.tencent.com/document/api/1493/96031#SmoothMigrationTaskItem)或控制台中获得。", "example": "fe391925-2ed6-43ea-8a53-8a9c1d04a319" }, { "name": "TopicList", "type": "array", "required": true, "description": "待导入的主题列表", "example": "[ { \"TopicName\": \"Test\", \"TopicType\": \"Normal\", \"QueueNum\": 10, \"Remark\": \"abc\", \"Namespace\": \"\" } ]", "item_type": "object", "children": [ { "name": "TopicName", "type": "string", "required": true, "description": "主题名称，可在[DescribeMigratingTopicList](https://cloud.tencent.com/document/api/1493/118007)接口返回的[MigratingTopic](https://cloud.tencent.com/document/api/1493/96031#MigratingTopic)数据结构中获得。", "example": "topic1" }, { "name": "TopicType", "type": "string", "required": true, "description": "主题类型， 5.x版本 UNSPECIFIED 未指定 NORMAL 普通消息 FIFO 顺序消息 DELAY 延迟消息 TRANSACTION 事务消息 4.x版本 Normal 普通消息 PartitionedOrder 分区顺序消息 Transaction 事务消息 DelayScheduled 延时消息", "example": "FIFO" }, { "name": "QueueNum", "type": "integer", "required": true, "description": "队列数", "example": "3" }, { "name": "Remark", "type": "string", "required": false, "description": "备注信息", "example": "remark" }, { "name": "Imported", "type": "boolean", "required": false, "description": "是否已导入，作为入参时无效", "example": "true" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间，仅4.x集群有效", "example": "namespace1" }, { "name": "ImportStatus", "type": "string", "required": false, "description": "导入状态， Unknown 未知， AlreadyExists 已存在， Success 成功， Failure 失败 仅作为出参可用", "example": "Unknown" }, { "name": "NamespaceV4", "type": "string", "required": false, "description": "4.x的命名空间，出参使用", "example": "namespace1" }, { "name": "TopicNameV4", "type": "string", "required": false, "description": "4.x的主题名，出参使用", "example": "topic1" }, { "name": "FullNamespaceV4", "type": "string", "required": false, "description": "4.x的完整命名空间，出参使用", "example": "namespace1" } ] } ], "required": [ "TaskId", "TopicList" ] }, { "name": "ModifyConsumerGroup", "description": "修改消费组属性。 当前 API 适用集群：5.x 集群。4.x 集群的修改消费组属性接口文档见 [ModifyRocketMQGroup](https://cloud.tencent.com/document/api/1179/63416)。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。", "example": "rmq-72mo3a9o" }, { "name": "ConsumeEnable", "type": "boolean", "required": true, "description": "是否开启消费", "example": "true" }, { "name": "ConsumeMessageOrderly", "type": "boolean", "required": true, "description": "顺序投递：true 并发投递：false", "example": "true" }, { "name": "ConsumerGroup", "type": "string", "required": false, "description": "消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。", "example": "test_group" }, { "name": "MaxRetryTimes", "type": "integer", "required": false, "description": "最大重试次数，取值范围0～1000", "example": "3" }, { "name": "Remark", "type": "string", "required": false, "description": "备注信息，最多 128 个字符", "example": "测试修改" } ], "required": [ "InstanceId", "ConsumeEnable", "ConsumeMessageOrderly" ] }, { "name": "ModifyInstance", "description": "修改 RocketMQ 5.x 集群属性，仅支持修改运行中的集群。 当前 API 适用集群：5.x 集群。修改 4.x 集群属性的接口文档见 [ModifyRocketMQInstance](https://cloud.tencent.com/document/product/1179/108862)。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。", "example": "rmq-72mo3a9o" }, { "name": "Name", "type": "string", "required": false, "description": "实例名称，不能为空, 3-64个字符，只能包含数字、字母、“-”和“_”", "example": "instance1" }, { "name": "Remark", "type": "string", "required": false, "description": "备注信息，最多 128 个字符", "example": "测试修改" }, { "name": "SendReceiveRatio", "type": "float", "required": false, "description": "消息发送和接收的比例", "example": "1.0" }, { "name": "SkuCode", "type": "string", "required": false, "description": "商品规格，从 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/96031#ProductSKU) 出参获得。", "example": "basic_1k" }, { "name": "MessageRetention", "type": "integer", "required": false, "description": "消息保留时长（单位：小时），取值范围参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/96031#ProductSKU) 出参： - 默认值：DefaultRetention 参数 - 最小值：RetentionLowerLimit 参数 - 最大值：RetentionUpperLimit 参数", "example": "72" }, { "name": "ScaledTpsEnabled", "type": "boolean", "required": false, "description": "是否开启弹性TPS", "example": "false" }, { "name": "AclEnabled", "type": "boolean", "required": false, "description": "是否开启ACL", "example": "false" }, { "name": "MaxTopicNum", "type": "integer", "required": false, "description": "最大可创建主题数，取值范围参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/96031#ProductSKU) 出参： - 最小值和默认值：TopicNumLimit 参数 - 最大值：TopicNumUpperLimit 参数", "example": "100" }, { "name": "ExtraTopicNum", "type": "string", "required": false, "description": "免费额度之外的主题个数，免费额度参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/96031#ProductSKU) 出参中的 TopicNumLimit 参数。", "example": "50" }, { "name": "EnableDeletionProtection", "type": "boolean", "required": false, "description": "是否开启删除保护", "example": "false" } ], "required": [ "InstanceId" ] }, { "name": "ModifyInstanceEndpoint", "description": "修改 RocketMQ 5.x 集群接入点，操作前请先确认接入点已存在。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。", "example": "rmq-72mo3a9o" }, { "name": "Type", "type": "string", "required": true, "description": "接入点类型， PUBLIC 公网", "example": "PUBLIC" }, { "name": "Bandwidth", "type": "integer", "required": false, "description": "公网带宽，Mbps为单位", "example": "2" }, { "name": "IpRules", "type": "array", "required": false, "description": "公网安全组信息", "example": "无", "item_type": "object", "children": [ { "name": "Ip", "type": "string", "required": true, "description": "IP地址", "example": "0.0.0.0" }, { "name": "Allow", "type": "boolean", "required": true, "description": "是否允许放行，默认为false表示拒绝", "example": "true" }, { "name": "Remark", "type": "string", "required": true, "description": "备注信息", "example": "remark1" } ] }, { "name": "BillingFlow", "type": "boolean", "required": false, "description": "公网是否按流量计费", "example": "false" } ], "required": [ "InstanceId", "Type" ] }, { "name": "ModifyRole", "description": "修改角色。 当前 API 适用集群：5.x 集群。4.x 集群的修改角色接口文档见 [ModifyRocketMQRole](https://cloud.tencent.com/document/product/1179/107532)，修改角色的授权接口文档见 [ModifyRocketMQEnvironmentRole](https://cloud.tencent.com/document/product/1179/107533)。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。", "example": "rmq-72mo3a9o" }, { "name": "Role", "type": "string", "required": true, "description": "角色名称，从 [DescribeRoleList](https://cloud.tencent.com/document/api/1493/98862) 接口中返回的 [RoleItem](https://cloud.tencent.com/document/api/1493/96031#RoleItem) 或控制台获得。", "example": "test_role_name" }, { "name": "PermRead", "type": "boolean", "required": true, "description": "是否开启消费", "example": "false" }, { "name": "PermWrite", "type": "boolean", "required": true, "description": "是否开启生产", "example": "false" }, { "name": "PermType", "type": "string", "required": false, "description": "权限类型，默认按集群授权（Cluster：集群维度；TopicAndGroup：主题和消费组维度）", "example": "Cluster" }, { "name": "Remark", "type": "string", "required": false, "description": "备注", "example": "remark info" }, { "name": "DetailedPerms", "type": "array", "required": false, "description": "Topic\u0026Group维度权限配置，权限类型为 TopicAndGroup 时必填", "example": "无", "item_type": "object", "children": [ { "name": "Resource", "type": "string", "required": true, "description": "权限对应的资源 可以是主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。 可以是消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。", "example": "test_topic" }, { "name": "PermWrite", "type": "boolean", "required": true, "description": "是否开启生产权限", "example": "true" }, { "name": "PermRead", "type": "boolean", "required": true, "description": "是否开启消费权限", "example": "true" }, { "name": "ResourceType", "type": "string", "required": true, "description": "授权资源类型（Topic:主题; Group:消费组）", "example": "Topic" }, { "name": "Remark", "type": "string", "required": false, "description": "资源备注", "example": "test_remark" } ] } ], "required": [ "InstanceId", "Role", "PermRead", "PermWrite" ] }, { "name": "ModifyTopic", "description": "修改主题属性。 当前 API 适用集群：5.x 集群。4.x 集群的修改主题属性接口文档见 [ModifyRocketMQTopic](https://cloud.tencent.com/document/api/1179/63414)。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。", "example": "rmq-72mo3a9o" }, { "name": "Topic", "type": "string", "required": true, "description": "主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。", "example": "test_topic" }, { "name": "QueueNum", "type": "integer", "required": false, "description": "队列数量，取值范围3～16", "example": "6" }, { "name": "Remark", "type": "string", "required": false, "description": "备注信息，最多 128 个字符", "example": "测试修改" }, { "name": "MsgTTL", "type": "integer", "required": false, "description": "消息保留时长（单位：小时）", "example": "72" } ], "required": [ "InstanceId", "Topic" ] }, { "name": "RemoveMigratingTopic", "description": "从迁移列表中移除主题，仅当主题处于初始状态时有效", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务ID，可在[DescribeSmoothMigrationTaskList](https://cloud.tencent.com/document/api/1493/119997)接口返回的[SmoothMigrationTaskItem](https://cloud.tencent.com/document/api/1493/96031#SmoothMigrationTaskItem)或控制台中获得。", "example": "02f6c31a-9707-4244-8dd3-35ad868ef92a" }, { "name": "TopicName", "type": "string", "required": true, "description": "主题名称，可在[DescribeMigratingTopicList](https://cloud.tencent.com/document/api/1493/118007)接口返回的[MigratingTopic](https://cloud.tencent.com/document/api/1493/96031#MigratingTopic)数据结构中获得。", "example": "topic-a" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间，仅迁移至4.x集群有效，可在[DescribeMigratingTopicList](https://cloud.tencent.com/document/api/1493/118007)接口返回的[MigratingTopic](https://cloud.tencent.com/document/api/1493/96031#MigratingTopic)数据结构中获得。", "example": "tdmq-default" } ], "required": [ "TaskId", "TopicName" ] }, { "name": "ResendDeadLetterMessage", "description": "重新发送死信消息。 当前 API 适用集群：5.x集群。4.x 集群的重发死信消息接口文档见 [RetryRocketMQDlqMessage](https://cloud.tencent.com/document/api/1179/114595)。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。", "example": "rmq-72mo3a9o" }, { "name": "MessageIds", "type": "array", "required": true, "description": "死信消息ID列表", "example": "[\"01963F0B14BAF09F27077D244F00000000\"]", "item_type": "string" }, { "name": "ConsumerGroup", "type": "string", "required": false, "description": "消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。", "example": "test_group" } ], "required": [ "InstanceId", "MessageIds" ] }, { "name": "ResetConsumerGroupOffset", "description": "重置消费位点。 当前 API 适用集群：5.x 集群。4.x 集群的重置消费位点接口文档见 [ResetRocketMQConsumerOffSet](https://cloud.tencent.com/document/api/1179/71662)。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。", "example": "rmq-72mo3a9o" }, { "name": "Topic", "type": "string", "required": true, "description": "主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。", "example": "test_topic" }, { "name": "ResetTimestamp", "type": "integer", "required": true, "description": "重置位点的时间戳（单位：毫秒），指定为 -1 时表示重置到最新位点", "example": "-1" }, { "name": "ConsumerGroup", "type": "string", "required": false, "description": "消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。", "example": "test_group" } ], "required": [ "InstanceId", "Topic", "ResetTimestamp" ] }, { "name": "RollbackMigratingTopicStage", "description": "回滚正在迁移的主题至前一个阶段", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务ID，可在[DescribeSmoothMigrationTaskList](https://cloud.tencent.com/document/api/1493/119997)接口返回的[SmoothMigrationTaskItem](https://cloud.tencent.com/document/api/1493/96031#SmoothMigrationTaskItem)或控制台中获得。", "example": "02f6c31a-9707-4244-8dd3-35ad868ef92a" }, { "name": "TopicName", "type": "string", "required": true, "description": "主题名称，可在[DescribeMigratingTopicList](https://cloud.tencent.com/document/api/1493/118007)接口返回的[MigratingTopic](https://cloud.tencent.com/document/api/1493/96031#MigratingTopic)数据结构中获得。", "example": "topic-a" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间，仅迁移至4.x集群有效，可在[DescribeMigratingTopicList](https://cloud.tencent.com/document/api/1493/118007)接口返回的[MigratingTopic](https://cloud.tencent.com/document/api/1493/96031#MigratingTopic)数据结构中获得。", "example": "tdmq-default" } ], "required": [ "TaskId", "TopicName" ] }, { "name": "SendMessage", "description": "发送 RocketMQ 消息，该接口仅用于控制台发送少量测试消息，不保证 SLA，且云 API 存在限流，在真实业务场景下，请使用 RocketMQ SDK 发送消息。 当前 API 适用集群：5.x 集群。4.x 集群的发送消息接口文档见 [SendRocketMQMessage](https://cloud.tencent.com/document/api/1179/94179)。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。", "example": "rmq-72mo3a9o" }, { "name": "Topic", "type": "string", "required": true, "description": "主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。", "example": "test_topic" }, { "name": "MsgBody", "type": "string", "required": true, "description": "消息内容", "example": "This is a normal message for Apache RocketMQ." }, { "name": "MsgKey", "type": "string", "required": false, "description": "消息Key", "example": "test_key" }, { "name": "MsgTag", "type": "string", "required": false, "description": "消息Tag", "example": "test_tag" } ], "required": [ "InstanceId", "Topic", "MsgBody" ] }, { "name": "VerifyMessageConsumption", "description": "消息消费验证。 当前 API 适用集群：5.x 集群。4.x 集群的消息消费验证接口文档见 [VerifyRocketMQConsume](https://cloud.tencent.com/document/api/1179/101061)。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。", "example": "rmq-72mo3a9o" }, { "name": "Topic", "type": "string", "required": true, "description": "主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。", "example": "test_topic" }, { "name": "ClientId", "type": "string", "required": true, "description": "客户端ID", "example": "10.185.22.31@7#782332544" }, { "name": "MsgId", "type": "string", "required": true, "description": "消息ID", "example": "1464F14500017DAF6ECC79CA6CAA0288" }, { "name": "ConsumerGroup", "type": "string", "required": false, "description": "消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。", "example": "test_group" } ], "required": [ "InstanceId", "Topic", "ClientId", "MsgId" ] } ] }