{ "name": "tdmq", "display_name": "消息队列 TDMQ", "description": "介绍如何使用API对消息队列 TDMQ进行操作，包括消息回溯，修改主题，创建订阅关系等。", "domain": "database", "api_version": "2020-02-17", "endpoint": "tdmq.tencentcloudapi.com", "actions": [ { "name": "AcknowledgeMessage", "description": "根据提供的 MessageID 确认指定 topic 中的消息", "status": "online", "parameters": [ { "name": "MessageId", "type": "string", "required": true, "description": "用作标识消息的唯一的ID（可从 receiveMessage 的返回值中获得）", "example": "5:7:-1" }, { "name": "AckTopic", "type": "string", "required": true, "description": "Topic 名字（可从 receiveMessage 的返回值中获得）这里尽量需要使用topic的全路径，即：tenant/namespace/topic。如果不指定，默认使用的是：public/default", "example": "persistent://tenant/namespace/my-topic" }, { "name": "SubName", "type": "string", "required": true, "description": "订阅者的名字，可以从receiveMessage的返回值中获取到。这里尽量与receiveMessage中的订阅者保持一致，否则没办法正确ack 接收回来的消息。", "example": "my-sub" } ], "required": [ "MessageId", "AckTopic", "SubName" ] }, { "name": "ClearCmqQueue", "description": "清空cmq消息队列中的消息", "status": "online", "parameters": [ { "name": "QueueName", "type": "string", "required": true, "description": "队列名字，在单个地域同一账号下唯一。队列名称是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)。", "example": "test-queue" } ], "required": [ "QueueName" ] }, { "name": "ClearCmqSubscriptionFilterTags", "description": "清空订阅者消息标签", "status": "online", "parameters": [ { "name": "TopicName", "type": "string", "required": true, "description": "主题名字，在单个地域同一账号下唯一。主题名称是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线（-）。", "example": "test-topic" }, { "name": "SubscriptionName", "type": "string", "required": true, "description": "订阅名字，在单个地域同一账号的同一主题下唯一。订阅名称是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)。", "example": "test-queue" } ], "required": [ "TopicName", "SubscriptionName" ] }, { "name": "CreateCmqQueue", "description": "创建cmq队列接口", "status": "online", "parameters": [ { "name": "QueueName", "type": "string", "required": true, "description": "队列名字，在单个地域同一账号下唯一。队列名称以字母起始，只能包含字母、数字、“-”及“_”，最大64字符，不区分大小写。", "example": "testQueue" }, { "name": "MaxMsgHeapNum", "type": "integer", "required": false, "description": "最大堆积消息数。取值范围在公测期间为 1,000,000 - 10,000,000，正式上线后范围可达到 1000,000-1000,000,000。默认取值在公测期间为 10,000,000，正式上线后为 100,000,000。", "example": "1000000" }, { "name": "PollingWaitSeconds", "type": "integer", "required": false, "description": "消息接收长轮询等待时间。取值范围 0-30 秒，默认值 0。", "example": "3" }, { "name": "VisibilityTimeout", "type": "integer", "required": false, "description": "消息可见性超时。取值范围 1-43200 秒（即12小时内），默认值 30。", "example": "30" }, { "name": "MaxMsgSize", "type": "integer", "required": false, "description": "消息最大长度。取值范围 1024-1048576 Byte（即1-1024K），默认值 1048576。", "example": "1048576" }, { "name": "MsgRetentionSeconds", "type": "integer", "required": false, "description": "消息最长未确认时间。取值范围 30-43200 秒（30秒~12小时），默认值 3600 (1 小时)。", "example": "3600" }, { "name": "RewindSeconds", "type": "integer", "required": false, "description": "队列是否开启回溯消息能力，该参数取值范围0-1296000，0表示不开启。", "example": "0" }, { "name": "Transaction", "type": "integer", "required": false, "description": "1 表示事务队列，0 表示普通队列", "example": "0" }, { "name": "FirstQueryInterval", "type": "integer", "required": false, "description": "第一次回查间隔", "example": "0" }, { "name": "MaxQueryCount", "type": "integer", "required": false, "description": "最大回查次数", "example": "0" }, { "name": "DeadLetterQueueName", "type": "string", "required": false, "description": "死信队列名称", "example": "test1" }, { "name": "Policy", "type": "integer", "required": false, "description": "死信策略。0为消息被多次消费未删除，1为Time-To-Live过期", "example": "0" }, { "name": "MaxReceiveCount", "type": "integer", "required": false, "description": "最大接收次数 1-1000", "example": "1" }, { "name": "MaxTimeToLive", "type": "integer", "required": false, "description": "policy为1时必选。最大未消费过期时间。范围300-43200，单位秒，需要小于消息最大保留时间msgRetentionSeconds", "example": "300" }, { "name": "Trace", "type": "boolean", "required": false, "description": "是否开启消息轨迹追踪，当不设置字段时，默认为不开启，该字段为true表示开启，为false表示不开启", "example": "false" }, { "name": "Tags", "type": "array", "required": false, "description": "标签数组", "example": "[{\"TagKey\":\"aa\",\"TagValue\":\"bb\"}]", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签的key的值 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_tag_key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签的Value的值 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_tag_value1" } ] }, { "name": "RetentionSizeInMB", "type": "integer", "required": false, "description": "队列可回溯存储空间：若开启消息回溯，取值范围：10240MB - 512000MB，若不开启消息回溯，取值：0", "example": "0" } ], "required": [ "QueueName" ] }, { "name": "CreateCmqSubscribe", "description": "创建cmq订阅接口", "status": "online", "parameters": [ { "name": "TopicName", "type": "string", "required": true, "description": "主题名字，在单个地域同一账号下唯一。主题名称是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线（-）。", "example": "ConnTopic" }, { "name": "SubscriptionName", "type": "string", "required": true, "description": "订阅名字，在单个地域同一账号的同一主题下唯一。订阅名称以字母起始，只能包含字母、数字、“-”及“_”，最大64字符，创建后不能修改。", "example": "ConnSubQueue" }, { "name": "Protocol", "type": "string", "required": true, "description": "订阅的协议，目前支持两种协议：http、queue。使用http协议，用户需自己搭建接受消息的web server。使用queue，消息会自动推送到CMQ queue，用户可以并发地拉取消息。", "example": "queue" }, { "name": "Endpoint", "type": "string", "required": true, "description": "接收通知的Endpoint，根据协议Protocol区分：对于http，Endpoint必须以“`http://`”开头，host可以是域名或IP；对于Queue，则填QueueName。 请注意，目前推送服务不能推送到私有网络中，因此Endpoint填写为私有网络域名或地址将接收不到推送的消息，目前支持推送到公网和基础网络。", "example": "queue_sub" }, { "name": "NotifyStrategy", "type": "string", "required": false, "description": "向Endpoint推送消息出现错误时，CMQ推送服务器的重试策略。取值有：1）BACKOFF_RETRY，退避重试。每隔一定时间重试一次，重试够一定次数后，就把该消息丢弃，继续推送下一条消息；2）EXPONENTIAL_DECAY_RETRY，指数衰退重试。每次重试的间隔是指数递增的，例如开始1s，后面是2s，4s，8s...由于Topic消息的周期是一天，所以最多重试一天就把消息丢弃。默认值是EXPONENTIAL_DECAY_RETRY。", "example": "EXPONENTIAL_DECAY_RETRY" }, { "name": "FilterTag", "type": "array", "required": false, "description": "消息正文。消息标签（用于消息过滤)。标签数量不能超过5个，每个标签不超过16个字符。与(Batch)PublishMessage的MsgTag参数配合使用，规则：1）如果FilterTag没有设置，则无论MsgTag是否有设置，订阅接收所有发布到Topic的消息；2）如果FilterTag数组有值，则只有数组中至少有一个值在MsgTag数组中也存在时（即FilterTag和MsgTag有交集），订阅才接收该发布到Topic的消息；3）如果FilterTag数组...", "example": "[\"aa\"]", "item_type": "string" }, { "name": "BindingKey", "type": "array", "required": false, "description": "BindingKey数量不超过5个， 每个BindingKey长度不超过64字节，该字段表示订阅接收消息的过滤策略，每个BindingKey最多含有15个“.”， 即最多16个词组。", "example": "[\"new\"]", "item_type": "string" }, { "name": "NotifyContentFormat", "type": "string", "required": false, "description": "推送内容的格式。取值：1）JSON；2）SIMPLIFIED，即raw格式。如果Protocol是queue，则取值必须为SIMPLIFIED。如果Protocol是http，两个值均可以，默认值是JSON。", "example": "SIMPLIFIED" } ], "required": [ "TopicName", "SubscriptionName", "Protocol", "Endpoint" ] }, { "name": "CreateCmqTopic", "description": "创建cmq主题", "status": "online", "parameters": [ { "name": "TopicName", "type": "string", "required": true, "description": "主题名字，在单个地域同一账号下唯一。主题名称只能包含字母、数字、“-”及“_”，最大64字符，创建后不能修改，不区分大小写。", "example": "test-topic" }, { "name": "MaxMsgSize", "type": "integer", "required": false, "description": "消息最大长度。取值范围 1024-65536 Byte（即1-64K），默认值 65536。", "example": "65536" }, { "name": "FilterType", "type": "integer", "required": false, "description": "用于指定主题的消息匹配策略。1：表示标签匹配策略；2：表示路由匹配策略，默认值为标签匹配策略。", "example": "1" }, { "name": "MsgRetentionSeconds", "type": "integer", "required": false, "description": "消息保存时间。取值范围60 - 86400 s（即1分钟 - 1天），默认值86400。", "example": "86400" }, { "name": "Trace", "type": "boolean", "required": false, "description": "是否开启消息轨迹标识，true表示开启，false表示不开启，不填表示不开启。", "example": "false" }, { "name": "Tags", "type": "array", "required": false, "description": "标签数组", "example": "[{\"TagKey\":\"aa\",\"TagValue\":\"bb\"}]", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签的key的值 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_tag_key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签的Value的值 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_tag_value1" } ] } ], "required": [ "TopicName" ] }, { "name": "CreateEnvironment", "description": "用于在用户账户下创建消息队列 Tdmq 命名空间", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境（命名空间）名称，不支持中字以及除了短线和下划线外的特殊字符且不超过16个字符。", "example": "devNamespace" }, { "name": "MsgTTL", "type": "integer", "required": true, "description": "未消费消息过期时间，单位：秒，取值范围：60秒~15天。", "example": "60" }, { "name": "ClusterId", "type": "string", "required": true, "description": "Pulsar 集群的ID", "example": "pulsar-ge3n43v3wj" }, { "name": "Remark", "type": "string", "required": false, "description": "说明，128个字符以内。", "example": "demo" }, { "name": "RetentionPolicy", "type": "object", "required": false, "description": "消息保留策略", "example": "无", "children": [ { "name": "TimeInMinutes", "type": "integer", "required": true, "description": "消息保留时长", "example": "0" }, { "name": "SizeInMB", "type": "integer", "required": true, "description": "消息保留大小", "example": "0" } ] }, { "name": "AutoSubscriptionCreation", "type": "boolean", "required": false, "description": "是否开启自动创建订阅", "example": "true" }, { "name": "SubscriptionExpirationTime", "type": "integer", "required": false, "description": "离线订阅过期自动清理时间", "example": "1440" }, { "name": "SubscriptionExpirationTimeEnable", "type": "boolean", "required": false, "description": "离线订阅过期自动清理时间开关", "example": "false" }, { "name": "Tags", "type": "array", "required": false, "description": "命名空间标签", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签的key的值 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_tag_key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签的Value的值 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_tag_value1" } ] } ], "required": [ "EnvironmentId", "MsgTTL", "ClusterId" ] }, { "name": "CreateEnvironmentRole", "description": "创建环境角色授权", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境（命名空间）名称。", "example": "devDemo" }, { "name": "RoleName", "type": "string", "required": true, "description": "角色名称。", "example": "test_role_1" }, { "name": "Permissions", "type": "array", "required": true, "description": "授权项，最多只能包含produce、consume两项的非空字符串数组。", "example": "[\"produce\"]", "item_type": "string" }, { "name": "ClusterId", "type": "string", "required": true, "description": "必填字段，集群的ID", "example": "pulsar-xk3ne8k2qkp8" } ], "required": [ "EnvironmentId", "RoleName", "Permissions", "ClusterId" ] }, { "name": "CreateProCluster", "description": "创建专业集群——预付费，仅通过api调用", "status": "online", "parameters": [ { "name": "ZoneIds", "type": "array", "required": true, "description": "多可用区部署选择三个可用区，示例[200002,200003,200004] 单可用区部署选择一个可用区，示例[200002]", "example": "[200002,200003,200004]", "item_type": "integer" }, { "name": "ProductName", "type": "string", "required": true, "description": "集群规格代号 参考 [专业集群规格](https://cloud.tencent.com/document/product/1179/83705)", "example": "PULSAR.P1.MINI2" }, { "name": "AutoRenewFlag", "type": "integer", "required": true, "description": "1: true，开启自动按月续费 0: false，关闭自动按月续费", "example": "1" }, { "name": "TimeSpan", "type": "integer", "required": true, "description": "购买时长，取值范围：1～50", "example": "3" }, { "name": "ClusterName", "type": "string", "required": true, "description": "集群名称，不支持中字以及除了短线和下划线外的特殊字符且不超过64个字符。", "example": "default" }, { "name": "AutoVoucher", "type": "integer", "required": true, "description": "是否自动选择代金券 1是 0否 默认为0", "example": "1" }, { "name": "StorageSize", "type": "integer", "required": false, "description": "存储规格 参考 [专业集群规格](https://cloud.tencent.com/document/product/1179/83705)", "example": "200" }, { "name": "Vpc", "type": "object", "required": false, "description": "vpc网络标签", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "vpc信息", "example": "vpc-9dlrd5h1" }, { "name": "SubnetId", "type": "string", "required": true, "description": "子网信息", "example": "subnet-jadmas" } ] }, { "name": "Tags", "type": "array", "required": false, "description": "集群的标签列表(已废弃)", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签的key的值 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_tag_key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签的Value的值 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_tag_value1" } ] } ], "required": [ "ZoneIds", "ProductName", "AutoRenewFlag", "TimeSpan", "ClusterName", "AutoVoucher" ] }, { "name": "CreateRabbitMQBinding", "description": "创建RabbitMQ路由关系", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如 amqp-xxxxxxxx。有效的 InstanceId 可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询。", "example": "amqp-2ppxx4rq" }, { "name": "VirtualHost", "type": "string", "required": true, "description": "VirtualHost 名称，形如 testvhost。有效的 VirtualHost 名称可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询，在左侧导航栏点击 Vhost，并在 Vhost 列表中找到Vhost名称。", "example": "testVhost" }, { "name": "Source", "type": "string", "required": true, "description": "源exchange", "example": "prod.exchange" }, { "name": "DestinationType", "type": "string", "required": true, "description": "目标类型,取值queue或exchange", "example": "queue" }, { "name": "Destination", "type": "string", "required": true, "description": "目标", "example": "prod.queue" }, { "name": "RoutingKey", "type": "string", "required": false, "description": "路由键", "example": "permission.created" } ], "required": [ "InstanceId", "VirtualHost", "Source", "DestinationType", "Destination" ] }, { "name": "CreateRabbitMQUser", "description": "创建RabbitMQ的用户", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如 amqp-xxxxxxxx。有效的 InstanceId 可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询。", "example": "amqp-2ppxx4rq" }, { "name": "User", "type": "string", "required": true, "description": "用户名，登录时使用", "example": "test_user" }, { "name": "Password", "type": "string", "required": true, "description": "密码，登录时使用。规范：不能为空，8-64个字符，至少要包含小写字母、大写字母、数字、特殊字符【()`~!@#$%^\u0026*_=|{}[]:;',.?/】中的两项", "example": "abc123._" }, { "name": "Description", "type": "string", "required": false, "description": "描述", "example": "hello" }, { "name": "Tags", "type": "array", "required": false, "description": "用户标签，用于决定改用户访问RabbitMQ Management的权限范围 management：普通控制台用户，monitoring：管理型控制台用户，其他值：非控制台用户", "example": "monitoring", "item_type": "string" }, { "name": "MaxConnections", "type": "integer", "required": false, "description": "该用户的最大连接数，不填写则不限制", "example": "1000" }, { "name": "MaxChannels", "type": "integer", "required": false, "description": "该用户的最大channel数，不填写则不限制", "example": "2000" } ], "required": [ "InstanceId", "User", "Password" ] }, { "name": "CreateRabbitMQVipInstance", "description": "创建 RabbitMQ 托管版实例", "status": "online", "parameters": [ { "name": "ZoneIds", "type": "array", "required": true, "description": "可用区", "example": "[100003,100004]", "item_type": "integer" }, { "name": "VpcId", "type": "string", "required": true, "description": "私有网络ID，形如 vpc-xxx。有效的 VpcId 可通过登录[私有网络](https://console.cloud.tencent.com/vpc/vpc?rid=1)控制台查询；也可以调用接口 [DescribeVpcEx](https://cloud.tencent.com/document/api/215/1372)，从接口返回中的 unVpcId 字段获取。若在创建子机时 VpcId 与 SubnetId 同时传入 DEFAULT，则强制使用默认 vpc 网络。", "example": "vpc-5ghsr4p9" }, { "name": "SubnetId", "type": "string", "required": true, "description": "私有网络子网 ID，形如 subnet-xxx。有效的私有网络子网 ID 可通过登录[子网控制台](https://console.cloud.tencent.com/vpc/subnet?rid=1)查询；也可以调用接口 [DescribeSubnets](https://cloud.tencent.com/document/api/215/15784)，从接口返回中的 unSubnetId 字段获取。若在创建子机时 SubnetId 与 VpcId 同时传入 DEFAULT，则强制使用默认 vpc 网络。", "example": "subnet-67y9wil4" }, { "name": "ClusterName", "type": "string", "required": true, "description": "集群名称", "example": "prod_rabbitmq" }, { "name": "NodeSpec", "type": "string", "required": false, "description": "集群的节点规格，需要输入对应的规格标识： 2C8G：rabbit-vip-profession-2c8g 4C16G：rabbit-vip-profession-4c16g 8C32G：rabbit-vip-profession-8c32g 16C32G：rabbit-vip-basic-4 16C64G：rabbit-vip-profession-16c64g 2C4G：rabbit-vip-basic-5 4C8G：rabbit-vip-basic-1 8C16G（已售罄）：rabbit-vip-basic-2 不传默认为 4C8G：rabbit-vip-basic-1", "example": "rabbit-vip-basic-1" }, { "name": "NodeNum", "type": "integer", "required": false, "description": "节点数量,多可用区最少为3节点。不传默认单可用区为1,多可用区为3", "example": "1" }, { "name": "StorageSize", "type": "integer", "required": false, "description": "单节点存储规格,不传默认为200G", "example": "200" }, { "name": "EnableCreateDefaultHaMirrorQueue", "type": "boolean", "required": false, "description": "是否开启默认镜像队列，true 表示为开启，false 表示为不开启。不传默认为 false", "example": "false" }, { "name": "AutoRenewFlag", "type": "boolean", "required": false, "description": "仅预付费集群（PayMode 参数为 1 时）使用该参数，表示是否自动续费，true 表示打开自动续费。不传默认为 true", "example": "true" }, { "name": "TimeSpan", "type": "integer", "required": false, "description": "购买时长,不传默认为1(月)", "example": "1" }, { "name": "PayMode", "type": "integer", "required": false, "description": "付费方式，0 为后付费，即按量计费；1 为预付费，即包年包月。默认包年包月", "example": "1" }, { "name": "ClusterVersion", "type": "string", "required": false, "description": "集群版本，不传默认为 3.8.30，可选值为 3.8.30、3.11.8和3.13.7", "example": "3.8.30" }, { "name": "IsIntl", "type": "boolean", "required": false, "description": "是否国际站请求，默认 false", "example": "false" }, { "name": "ResourceTags", "type": "array", "required": false, "description": "资源标签列表", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签的key的值 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_tag_key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签的Value的值 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_tag_value1" } ] }, { "name": "Bandwidth", "type": "integer", "required": false, "description": "公网带宽大小，单位 Mbps", "example": "5" }, { "name": "EnablePublicAccess", "type": "boolean", "required": false, "description": "是否打开公网接入，不传默认为false", "example": "false" }, { "name": "EnableDeletionProtection", "type": "boolean", "required": false, "description": "是否打开集群删除保护，不传默认为 false", "example": "false" } ], "required": [ "ZoneIds", "VpcId", "SubnetId", "ClusterName" ] }, { "name": "CreateRabbitMQVirtualHost", "description": "创建RabbitMQ的vhost", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如amqp-xxxxxxxx。有效的 InstanceId 可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询。", "example": "amqp-2ppxx4rq" }, { "name": "VirtualHost", "type": "string", "required": true, "description": "vhost名", "example": "testVhost" }, { "name": "Description", "type": "string", "required": false, "description": "描述", "example": "hello" }, { "name": "TraceFlag", "type": "boolean", "required": false, "description": "消息轨迹开关,true打开,false关闭,默认关闭", "example": "true" }, { "name": "MirrorQueuePolicyFlag", "type": "boolean", "required": false, "description": "是否创建镜像队列策略，默认值 true", "example": "true" } ], "required": [ "InstanceId", "VirtualHost" ] }, { "name": "CreateRocketMQCluster", "description": "创建 RocketMQ 集群。 当前 API 适用集群：4.x 虚拟集群。创建 4.x 专享或通用集群的接口文档见 [CreateRocketMQVipInstance](https://cloud.tencent.com/document/api/1179/95721)，创建 5.x 集群接口文档见 [CreateInstance](https://cloud.tencent.com/document/api/1493/97868)。", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "集群名称，3-64个字符，只能包含字母、数字、“-”及“_”", "example": "test_name" }, { "name": "Remark", "type": "string", "required": false, "description": "集群描述，128个字符以内", "example": "remark info" }, { "name": "TagList", "type": "array", "required": false, "description": "标签列表", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签的key的值 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_tag_key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签的Value的值 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_tag_value1" } ] } ], "required": [ "Name" ] }, { "name": "CreateRocketMQEnvironmentRole", "description": "创建角色授权。 当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群的创建角色接口文档见 [CreateRole](https://cloud.tencent.com/document/api/1493/98864)。", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "命名空间，4.x 通用集群命名空间固定为: tdmq_default", "example": "test_namespace" }, { "name": "RoleName", "type": "string", "required": true, "description": "角色名称。", "example": "test_role_name" }, { "name": "Permissions", "type": "array", "required": true, "description": "授权项，最多只能包含produce、consume两项的非空字符串数组。", "example": "[\"produce\"]", "item_type": "string" }, { "name": "ClusterId", "type": "string", "required": true, "description": "必填字段，集群的ID", "example": "rocketmq-2p9vx3ax9jxg" }, { "name": "DetailedPerms", "type": "array", "required": false, "description": "Topic\u0026Group维度权限配置", "example": "无", "item_type": "object", "children": [ { "name": "Resource", "type": "string", "required": true, "description": "权限对应的资源", "example": "test_topic" }, { "name": "PermWrite", "type": "boolean", "required": true, "description": "是否开启生产权限", "example": "true" }, { "name": "PermRead", "type": "boolean", "required": true, "description": "是否开启消费权限", "example": "false" }, { "name": "ResourceType", "type": "string", "required": true, "description": "授权资源类型，枚举值如下： - Topic：主题维度 - Group：消费组维度 - Cluster：集群维度（默认值）", "example": "Topic" }, { "name": "Remark", "type": "string", "required": false, "description": "资源备注", "example": "test remark info." } ] } ], "required": [ "EnvironmentId", "RoleName", "Permissions", "ClusterId" ] }, { "name": "CreateRocketMQGroup", "description": "创建 RocketMQ 消费组。 当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。创建 5.x 集群消费组的接口文档见 [CreateConsumerGroup](https://cloud.tencent.com/document/api/1493/97943)。", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "Group名称，8~64个字符", "example": "test_group" }, { "name": "Namespaces", "type": "array", "required": true, "description": "消费组所在的命名空间，4.x 通用集群命名空间固定为: tdmq_default", "example": "[\"test_namespace\"]", "item_type": "string" }, { "name": "ReadEnable", "type": "boolean", "required": true, "description": "是否开启消费", "example": "true" }, { "name": "BroadcastEnable", "type": "boolean", "required": true, "description": "是否开启广播消费", "example": "true" }, { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "rocketmq-4k4orqgq" }, { "name": "Remark", "type": "string", "required": false, "description": "说明信息，最长128个字符", "example": "测试创建" }, { "name": "GroupType", "type": "string", "required": false, "description": "Group类型（TCP/HTTP）", "example": "TCP" }, { "name": "RetryMaxTimes", "type": "integer", "required": false, "description": "Group最大重试次数", "example": "16" } ], "required": [ "GroupId", "Namespaces", "ReadEnable", "BroadcastEnable", "ClusterId" ] }, { "name": "CreateRocketMQGroupV2", "description": "创建 RocketMQ 消费组。 当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。创建 5.x 集群消费组的接口文档见 [CreateConsumerGroup](https://cloud.tencent.com/document/api/1493/97943)。", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "消费组名称", "example": "test_group" }, { "name": "Namespace", "type": "string", "required": true, "description": "消费组所在的命名空间，4.x 通用集群命名空间固定为: tdmq_default", "example": "test_ns" }, { "name": "ReadEnable", "type": "boolean", "required": true, "description": "是否开启消费", "example": "true" }, { "name": "BroadcastEnable", "type": "boolean", "required": true, "description": "是否开启广播消费", "example": "true" }, { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "rocketmq-4k4orqgq" }, { "name": "Remark", "type": "string", "required": false, "description": "备注", "example": "test remark info." }, { "name": "GroupType", "type": "string", "required": false, "description": "Group类型（TCP/HTTP）", "example": "TCP" }, { "name": "RetryMaxTimes", "type": "integer", "required": false, "description": "Group最大重试次数", "example": "16" }, { "name": "TagList", "type": "array", "required": false, "description": "标签列表", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签的key的值 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_tag_key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签的Value的值 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_tag_value1" } ] } ], "required": [ "GroupId", "Namespace", "ReadEnable", "BroadcastEnable", "ClusterId" ] }, { "name": "CreateRocketMQNamespace", "description": "创建 RocketMQ 命名空间。 当前 API 适用集群：4.x 虚拟集群和 4.x 专享集群，其他集群类型均不支持该功能。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "rocketmq-4k4orqgq" }, { "name": "NamespaceId", "type": "string", "required": true, "description": "命名空间名称，3-64个字符，只能包含字母、数字、“-”及“_”", "example": "test_ns" }, { "name": "Ttl", "type": "integer", "required": false, "description": "已废弃", "example": "259200000" }, { "name": "RetentionTime", "type": "integer", "required": false, "description": "已废弃", "example": "259200000" }, { "name": "Remark", "type": "string", "required": false, "description": "说明，最大128个字符", "example": "test remark info." } ], "required": [ "ClusterId", "NamespaceId" ] }, { "name": "CreateRocketMQRole", "description": "创建角色。 当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群的创建角色接口文档见 [CreateRole](https://cloud.tencent.com/document/api/1493/98864)。", "status": "online", "parameters": [ { "name": "RoleName", "type": "string", "required": true, "description": "角色名称，不支持中字以及除了短线和下划线外的特殊字符且长度必须大于0且小等于32。", "example": "test_role_name" }, { "name": "ClusterId", "type": "string", "required": true, "description": "必填字段，集群Id", "example": "rocketmq-2p9vx3ax9jxg" }, { "name": "Remark", "type": "string", "required": false, "description": "备注说明，长度必须大等于0且小等于128。", "example": "测试角色" }, { "name": "PermType", "type": "string", "required": false, "description": "角色授权类型（集群：Cluster; 主题或消费组：TopicAndGroup）", "example": "Cluster" } ], "required": [ "RoleName", "ClusterId" ] }, { "name": "CreateRocketMQTopic", "description": "批量创建 RocketMQ 主题。 当前云 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群的创建 Topic 接口文档见 [CreateTopic](https://cloud.tencent.com/document/api/1493/97947)。", "status": "online", "parameters": [ { "name": "Topic", "type": "string", "required": true, "description": "主题名称，3-64个字符，只能包含字母、数字、“-”及“_”", "example": "order-topic" }, { "name": "Namespaces", "type": "array", "required": true, "description": "主题所在的命名空间，4.x 通用集群命名空间固定为: tdmq_default", "example": "[\"ns01\"]", "item_type": "string" }, { "name": "Type", "type": "string", "required": true, "description": "主题类型，可选值为Normal, GlobalOrder, PartitionedOrder, Transaction, DelayScheduled。Transaction仅在专享版支持。", "example": "Normal" }, { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "rocketmq-4k4orqgq" }, { "name": "Remark", "type": "string", "required": false, "description": "主题说明，最大128个字符", "example": "info-mark" }, { "name": "PartitionNum", "type": "integer", "required": false, "description": "分区数，全局顺序无效", "example": "1" } ], "required": [ "Topic", "Namespaces", "Type", "ClusterId" ] }, { "name": "CreateRocketMQTopicV2", "description": "创建 RocketMQ 主题。 当前云 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群的创建 Topic 接口文档见 [CreateTopic](https://cloud.tencent.com/document/api/1493/97947)。", "status": "online", "parameters": [ { "name": "Topic", "type": "string", "required": true, "description": "主题名称", "example": "test_topic" }, { "name": "Type", "type": "string", "required": true, "description": "主题类型，可选值为Normal, GlobalOrder, PartitionedOrder, Transaction, DelayScheduled。Transaction仅在专享版支持。", "example": "Normal" }, { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "rocketmq-4k4orqgq" }, { "name": "Namespace", "type": "string", "required": true, "description": "主题所在的命名空间，4.x 通用集群命名空间固定为: tdmq_default", "example": "test_ns" }, { "name": "Remark", "type": "string", "required": false, "description": "备注", "example": "info-mark" }, { "name": "PartitionNum", "type": "integer", "required": false, "description": "分区数，全局顺序无效", "example": "3" }, { "name": "TagList", "type": "array", "required": false, "description": "标签列表", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签的key的值 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_tag_key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签的Value的值 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_tag_value1" } ] } ], "required": [ "Topic", "Type", "ClusterId", "Namespace" ] }, { "name": "CreateRocketMQVipInstance", "description": "创建 RocketMQ 4.x 集群。 当前 API 适用集群：4.x 专享集群 和 4.x 通用集群。创建 5.x 集群的接口文档见 [CreateInstance](https://cloud.tencent.com/document/api/1493/97868)。", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "实例名称", "example": "mq-instance" }, { "name": "Spec", "type": "string", "required": true, "description": "集群规格，支持规格有 1.通用型:rocket-vip-basic-0; 2.基础型:rocket-vip-basic-1; 3.标准型:rocket-vip-basic-2; 4.高阶Ⅰ型:rocket-vip-basic-3; 5.高阶Ⅱ型:rocket-vip-basic-4", "example": "rocket-vip-basic-1" }, { "name": "StorageSize", "type": "integer", "required": true, "description": "单节点存储空间，GB为单位，最低200GB", "example": "500" }, { "name": "ZoneIds", "type": "array", "required": true, "description": "节点部署的区域ID列表，如广州一区，则是100001，具体可查询腾讯云官网", "example": "[\"100001\"]", "item_type": "string" }, { "name": "VpcInfo", "type": "object", "required": true, "description": "VPC信息", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "vpc信息", "example": "vpc-9dlrd5h1" }, { "name": "SubnetId", "type": "string", "required": true, "description": "子网信息", "example": "subnet-jadmas" } ] }, { "name": "TimeSpan", "type": "integer", "required": true, "description": "购买时长，月为单位", "example": "12" }, { "name": "NodeCount", "type": "integer", "required": false, "description": "节点数量，创建专享集群时必填", "example": "6" }, { "name": "GeneralSkuCode", "type": "string", "required": false, "description": "通用集群规格标识，新购通用集群时必填，从 [DescribeRocketMQGeneralSKUs](https://cloud.tencent.com/document/api/1179/127066) 接口返回的 [GeneralSKU](https://cloud.tencent.com/document/api/1179/46089#GeneralSKU) 字段获取。", "example": "general_12k" }, { "name": "SupportsMigrateToCloud", "type": "boolean", "required": false, "description": "是否用于迁移上云，默认为false", "example": "false" }, { "name": "EnablePublic", "type": "boolean", "required": false, "description": "是否开启公网", "example": "false" }, { "name": "Bandwidth", "type": "integer", "required": false, "description": "公网带宽，在开启公网情况下为必传字段", "example": "0" }, { "name": "IpRules", "type": "array", "required": false, "description": "公网白名单", "example": "无", "item_type": "object", "children": [ { "name": "IpRule", "type": "string", "required": true, "description": "ip网段信息", "example": "0.0.0.0/0" }, { "name": "Allow", "type": "boolean", "required": true, "description": "允许或者拒绝", "example": "true" }, { "name": "Remark", "type": "string", "required": false, "description": "备注信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "test remark info" } ] }, { "name": "Tags", "type": "array", "required": false, "description": "标签", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签的key的值 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_tag_key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签的Value的值 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_tag_value1" } ] } ], "required": [ "Name", "Spec", "StorageSize", "ZoneIds", "VpcInfo", "TimeSpan" ] }, { "name": "CreateRole", "description": "创建角色", "status": "online", "parameters": [ { "name": "RoleName", "type": "string", "required": true, "description": "角色名称，不支持中字以及除了短线和下划线外的特殊字符且长度必须大于0且小等于32。", "example": "test_role_123" }, { "name": "Remark", "type": "string", "required": true, "description": "备注说明，长度必须大等于0且小等于128。", "example": "devDemo" }, { "name": "ClusterId", "type": "string", "required": true, "description": "必填字段，集群Id", "example": "pulsar-xk3ne8k2qkp8" } ], "required": [ "RoleName", "Remark", "ClusterId" ] }, { "name": "CreateSubscription", "description": "创建一个主题的订阅关系", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境（命名空间）名称。", "example": "default" }, { "name": "TopicName", "type": "string", "required": true, "description": "主题名称。", "example": "cloud_test" }, { "name": "SubscriptionName", "type": "string", "required": true, "description": "订阅者名称，不超过128个字符。", "example": "cloud_sub" }, { "name": "IsIdempotent", "type": "boolean", "required": true, "description": "是否幂等创建，若否不允许创建同名的订阅关系。", "example": "true" }, { "name": "ClusterId", "type": "string", "required": true, "description": "Pulsar 集群的ID", "example": "pulsar-5r59xd4vnx" }, { "name": "Remark", "type": "string", "required": false, "description": "备注，128个字符以内。", "example": "创建订阅关系" }, { "name": "AutoCreatePolicyTopic", "type": "boolean", "required": false, "description": "是否自动创建死信和重试主题，True 表示创建，False表示不创建，默认自动创建死信和重试主题。", "example": "true" }, { "name": "PostFixPattern", "type": "string", "required": false, "description": "指定死信和重试主题名称规范，LEGACY表示历史命名规则，COMMUNITY表示Pulsar社区命名规范", "example": "LEGACY" } ], "required": [ "EnvironmentId", "TopicName", "SubscriptionName", "IsIdempotent", "ClusterId" ] }, { "name": "CreateTopic", "description": "新增指定分区、类型的消息主题", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境（命名空间）名称。", "example": "default" }, { "name": "TopicName", "type": "string", "required": true, "description": "主题名，不支持中字以及除了短线和下划线外的特殊字符且不超过64个字符。", "example": "test_topic" }, { "name": "Partitions", "type": "integer", "required": true, "description": "入参为1，即是创建非分区topic，无分区；入参大于1，表示分区topic的分区数，最大不允许超过32。", "example": "2" }, { "name": "ClusterId", "type": "string", "required": true, "description": "Pulsar 集群的ID", "example": "pulsar-5r59xd4vnx" }, { "name": "Remark", "type": "string", "required": false, "description": "备注，128字符以内。", "example": "2个分区的普通消息队列" }, { "name": "TopicType", "type": "integer", "required": false, "description": "该入参将逐步弃用，可切换至PulsarTopicType参数 0： 普通消息； 1 ：全局顺序消息； 2 ：局部顺序消息； 3 ：重试队列； 4 ：死信队列。", "example": "0" }, { "name": "PulsarTopicType", "type": "integer", "required": false, "description": "Pulsar 主题类型 0: 非持久非分区 1: 非持久分区 2: 持久非分区 3: 持久分区", "example": "0" }, { "name": "MsgTTL", "type": "integer", "required": false, "description": "未消费消息过期时间，单位：秒，取值范围：60秒~15天。", "example": "60" }, { "name": "UnackPolicy", "type": "string", "required": false, "description": "不传默认是原生策略，DefaultPolicy表示当订阅下达到最大未确认消息数 5000 时，服务端将不再向当前订阅下的所有消费者推送消息，DynamicPolicy表示动态调整订阅下的最大未确认消息数，具体配额是在 5000 和消费者数量*20之间取最大值。每个消费者默认最大 unack 消息数为 20，超过该限制时仅影响该消费者，不影响其他消费者。", "example": "DefaultPolicy" }, { "name": "IsolateConsumerEnable", "type": "boolean", "required": false, "description": "是否开启异常消费者隔离", "example": "true" }, { "name": "AckTimeOut", "type": "integer", "required": false, "description": "消费者 Ack 超时时间，单位：秒，范围60-（3600*24）", "example": "60" }, { "name": "PulsarTopicMessageType", "type": "integer", "required": false, "description": "Pulsar主题消息类型0: 混合消息1:普通消息2:延迟消息", "example": "0" }, { "name": "Tags", "type": "array", "required": false, "description": "主题标签", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签的key的值 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_tag_key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签的Value的值 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_tag_value1" } ] }, { "name": "DelayMessagePolicy", "type": "string", "required": false, "description": "defaultPolicy/timingwheelPolicy不传默认是社区版本延迟消息策略", "example": "defaultPolicy" } ], "required": [ "EnvironmentId", "TopicName", "Partitions", "ClusterId" ] }, { "name": "DeleteCluster", "description": "删除集群", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群Id，传入需要删除的集群Id。", "example": "pulsar-ge3n43v3wj" } ], "required": [ "ClusterId" ] }, { "name": "DeleteCmqQueue", "description": "删除cmq队列", "status": "online", "parameters": [ { "name": "QueueName", "type": "string", "required": true, "description": "队列名字，在单个地域同一账号下唯一。队列名称是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)。", "example": "testQueue" } ], "required": [ "QueueName" ] }, { "name": "DeleteCmqSubscribe", "description": "删除cmq订阅", "status": "online", "parameters": [ { "name": "TopicName", "type": "string", "required": true, "description": "主题名字，在单个地域同一账号下唯一。主题名称是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)。", "example": "test-topic" }, { "name": "SubscriptionName", "type": "string", "required": true, "description": "订阅名字，在单个地域同一账号的同一主题下唯一。订阅名称是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)。", "example": "test-sub" } ], "required": [ "TopicName", "SubscriptionName" ] }, { "name": "DeleteCmqTopic", "description": "删除cmq主题", "status": "online", "parameters": [ { "name": "TopicName", "type": "string", "required": true, "description": "主题名字，在单个地域同一账号下唯一。主题名称是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)。", "example": "test-topic" } ], "required": [ "TopicName" ] }, { "name": "DeleteEnvironmentRoles", "description": "删除环境角色授权。", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境（命名空间）名称。", "example": "devNs" }, { "name": "RoleNames", "type": "array", "required": true, "description": "角色名称数组。", "example": "[\"test_role\"]", "item_type": "string" }, { "name": "ClusterId", "type": "string", "required": true, "description": "必填字段，集群的ID", "example": "pulsar-xk3ne8k2qkp8" } ], "required": [ "EnvironmentId", "RoleNames", "ClusterId" ] }, { "name": "DeleteEnvironments", "description": "批量删除租户下的命名空间", "status": "online", "parameters": [ { "name": "EnvironmentIds", "type": "array", "required": true, "description": "环境（命名空间）数组，每次最多删除20个。", "example": "[test1,test2]", "item_type": "string" }, { "name": "ClusterId", "type": "string", "required": true, "description": "Pulsar 集群的ID", "example": "pulsar-ge3n43v3wj" } ], "required": [ "EnvironmentIds", "ClusterId" ] }, { "name": "DeleteProCluster", "description": "删除专业集群——预付费，仅通过API 调用", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群Id", "example": "pulsar-rd42kgdwpe4g" } ], "required": [ "ClusterId" ] }, { "name": "DeleteRabbitMQBinding", "description": "解绑RabbitMQ路由关系", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如 amqp-xxxxxxxx。有效的 InstanceId 可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询。", "example": "amqp-jero744g" }, { "name": "VirtualHost", "type": "string", "required": true, "description": "VirtualHost 名称，形如 testvhost。有效的 VirtualHost 名称可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询，在左侧导航栏点击 Vhost，并在 Vhost 列表中找到Vhost名称。", "example": "testVhost" }, { "name": "BindingId", "type": "integer", "required": true, "description": "路由关系Id", "example": "127469" } ], "required": [ "InstanceId", "VirtualHost", "BindingId" ] }, { "name": "DeleteRabbitMQPermission", "description": "删除RabbitMQ的权限", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如 amqp-xxxxxxxx。有效的 InstanceId 可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询。", "example": "amqp-2ppxx4rq" }, { "name": "User", "type": "string", "required": true, "description": "用户名，形如 admin。有效的 User 名称可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询，点击集群列表中的集群，进入集群详情，并在用户与权限页签中找到用户列表，从而找到用户名称。", "example": "admin" }, { "name": "VirtualHost", "type": "string", "required": true, "description": "VirtualHost 名称，形如 testvhost。有效的 VirtualHost 名称可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询，在左侧导航栏点击 Vhost，并在 Vhost 列表中找到 Vhost 名称。", "example": "testVhost" } ], "required": [ "InstanceId", "User", "VirtualHost" ] }, { "name": "DeleteRabbitMQUser", "description": "删除RabbitMQ的用户", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如 amqp-xxxxxxxx。有效的 InstanceId 可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询。", "example": "amqp-2ppxx4rq" }, { "name": "User", "type": "string", "required": true, "description": "用户名，形如 admin。有效的 User 名称可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询，点击集群列表中的集群，进入集群详情，并在用户与权限页签中找到用户列表，从而找到用户名称。", "example": "admin" } ], "required": [ "InstanceId", "User" ] }, { "name": "DeleteRabbitMQVipInstance", "description": "删除 RabbitMQ 托管版实例", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如amqp-xxxxxxxx。有效的 InstanceId 可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询。", "example": "amqp-2ppxx4rq" }, { "name": "IsIntl", "type": "boolean", "required": false, "description": "是否国际站请求，默认 false", "example": "false" } ], "required": [ "InstanceId" ] }, { "name": "DeleteRabbitMQVirtualHost", "description": "删除RabbitMQ的vhost", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如amqp-xxxxxxxx。有效的 InstanceId 可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询。", "example": "amqp-2ppxx4rq" }, { "name": "VirtualHost", "type": "string", "required": true, "description": "VirtualHost 名称，形如 testvhost。有效的 VirtualHost 名称可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询，在左侧导航栏点击 Vhost，并在 Vhost 列表中找到Vhost名称。", "example": "testVhost" } ], "required": [ "InstanceId", "VirtualHost" ] }, { "name": "DeleteRocketMQCluster", "description": "删除 RocketMQ 集群。 当前 API 适用集群：4.x 虚拟集群。删除 4.x 专享或通用集群的接口文档见 [DeleteRocketMQVipInstance](https://cloud.tencent.com/document/api/1179/95802)，删除 5.x 集群的接口文档见 [DeleteInstance](https://cloud.tencent.com/document/product/1493/97867)。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "待删除的集群Id。", "example": "rocketmq-xxxxx" } ], "required": [ "ClusterId" ] }, { "name": "DeleteRocketMQEnvironmentRoles", "description": "批量删除角色授权。 当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群的删除角色接口文档见 [DeleteRole](https://cloud.tencent.com/document/api/1493/98863)。", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "命名空间，4.x 通用集群命名空间固定为: tdmq_default", "example": "test_namespace" }, { "name": "RoleNames", "type": "array", "required": true, "description": "角色名称数组。", "example": "[\"test_role_name\"]", "item_type": "string" }, { "name": "ClusterId", "type": "string", "required": true, "description": "集群的ID", "example": "rocketmq-mq-4k4orqgq" } ], "required": [ "EnvironmentId", "RoleNames", "ClusterId" ] }, { "name": "DeleteRocketMQGroup", "description": "删除 RocketMQ 消费组。 当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。删除 5.x 集群消费组的接口文档见 [DeleteConsumerGroup](https://cloud.tencent.com/document/api/1493/97942)。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "rocketmq-2p9vx3ax9jxg" }, { "name": "NamespaceId", "type": "string", "required": true, "description": "消费组所在的命名空间，4.x 通用集群命名空间固定为: tdmq_default", "example": "test_namespace" }, { "name": "GroupId", "type": "string", "required": true, "description": "消费组名称", "example": "test_group" } ], "required": [ "ClusterId", "NamespaceId", "GroupId" ] }, { "name": "DeleteRocketMQNamespace", "description": "删除 RocketMQ 命名空间。 当前 API 适用集群：4.x 虚拟集群和 4.x 专享集群，其他集群类型均不支持该功能。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "rocketmq-4k4orqgq" }, { "name": "NamespaceId", "type": "string", "required": true, "description": "命名空间名称", "example": "prod" } ], "required": [ "ClusterId", "NamespaceId" ] }, { "name": "DeleteRocketMQRoles", "description": "批量删除角色。 当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群的删除角色接口文档见 [DeleteRole](https://cloud.tencent.com/document/api/1493/98863)。", "status": "online", "parameters": [ { "name": "RoleNames", "type": "array", "required": true, "description": "角色名称数组。", "example": "[\"test_role_name\"]", "item_type": "string" }, { "name": "ClusterId", "type": "string", "required": true, "description": "必填字段，集群Id", "example": "rocketmq-2p9vx3ax9jxg" } ], "required": [ "RoleNames", "ClusterId" ] }, { "name": "DeleteRocketMQTopic", "description": "删除 RocketMQ 主题。 当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。删除 5.x 集群主题的接口文档见 [DeleteTopic](https://cloud.tencent.com/document/api/1493/97946)。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "rocketmq-2p9vx3ax9jxg" }, { "name": "NamespaceId", "type": "string", "required": true, "description": "主题所在的命名空间，4.x 通用集群命名空间固定为: tdmq_default", "example": "test_namespace" }, { "name": "Topic", "type": "string", "required": true, "description": "主题名称", "example": "test_topic" } ], "required": [ "ClusterId", "NamespaceId", "Topic" ] }, { "name": "DeleteRocketMQVipInstance", "description": "删除 RocketMQ 专享或通用集群。 当前 API 适用集群：4.x 专享集群 和 4.x 通用集群。删除 5.x 集群的接口文档见 [DeleteInstance](https://cloud.tencent.com/document/api/1493/97867)。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "实例的集群ID", "example": "rocketmq-ajknm838qzg4" } ], "required": [ "ClusterId" ] }, { "name": "DeleteRoles", "description": "删除角色，支持批量。", "status": "online", "parameters": [ { "name": "RoleNames", "type": "array", "required": true, "description": "角色名称数组。", "example": "[\"test_role_1\",\"test_role_2\"]", "item_type": "string" }, { "name": "ClusterId", "type": "string", "required": true, "description": "必填字段，集群Id", "example": "pulsar-xk3ne8k2qkp8" } ], "required": [ "RoleNames", "ClusterId" ] }, { "name": "DeleteSubscriptions", "description": "删除订阅关系", "status": "online", "parameters": [ { "name": "SubscriptionTopicSets", "type": "array", "required": true, "description": "订阅关系集合，每次最多删除20个。", "example": "无", "item_type": "object", "children": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境（命名空间）名称。", "example": "devNs" }, { "name": "TopicName", "type": "string", "required": true, "description": "主题名称。", "example": "devTopic" }, { "name": "SubscriptionName", "type": "string", "required": true, "description": "订阅名称。", "example": "devSub" } ] }, { "name": "ClusterId", "type": "string", "required": false, "description": "pulsar集群Id。", "example": "pulsar-xk3ne8k2qkp8" }, { "name": "EnvironmentId", "type": "string", "required": false, "description": "环境（命名空间）名称。", "example": "devNs" }, { "name": "Force", "type": "boolean", "required": false, "description": "是否强制删除，默认为false", "example": "false" } ], "required": [ "SubscriptionTopicSets" ] }, { "name": "DeleteTopics", "description": "批量删除topics", "status": "online", "parameters": [ { "name": "TopicSets", "type": "array", "required": true, "description": "主题集合，每次最多删除20个。", "example": "无", "item_type": "object", "children": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境（命名空间）名称。", "example": "devNs" }, { "name": "TopicName", "type": "string", "required": true, "description": "主题名称。", "example": "devTopic" } ] }, { "name": "ClusterId", "type": "string", "required": true, "description": "pulsar集群Id。", "example": "pulsar-xk3ne8k2qkp8" }, { "name": "EnvironmentId", "type": "string", "required": false, "description": "环境（命名空间）名称。", "example": "devNs" }, { "name": "Force", "type": "boolean", "required": false, "description": "是否强制删除，默认为false", "example": "false" } ], "required": [ "TopicSets", "ClusterId" ] }, { "name": "DescribeAMQPClusters", "description": "历史原因，该接口位于tdmq-manager，目前rabbitmq产品没有使用该接口，当前使用的是DescribeRabbitMQVipInstances。不过从调用链上看，线网还有请求流程，所以走预下线流程。 获取amqp集群列表", "status": "deprecated", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "偏移量", "example": "1" }, { "name": "Limit", "type": "integer", "required": true, "description": "限制数目", "example": "10" }, { "name": "IdKeyword", "type": "string", "required": false, "description": "按照集群ID关键字搜索", "example": "xxx" }, { "name": "NameKeyword", "type": "string", "required": false, "description": "按照集群名称关键字搜索", "example": "xxx" }, { "name": "ClusterIdList", "type": "array", "required": false, "description": "集群ID列表过滤", "example": "无", "item_type": "string" }, { "name": "IsTagFilter", "type": "boolean", "required": false, "description": "标签过滤查找时，需要设置为true", "example": "无" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤器。目前支持按标签过滤。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "过滤参数的名字", "example": "paramName" }, { "name": "Values", "type": "array", "required": false, "description": "数值", "example": "[\"a\"]", "item_type": "string" } ] } ], "required": [ "Offset", "Limit" ] }, { "name": "DescribeAllTenants", "description": "获取某个租户的虚拟集群列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "查询偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "查询限制条数", "example": "10" }, { "name": "ClusterName", "type": "string", "required": false, "description": "物理集群名称", "example": "gz_cluster_1" }, { "name": "TenantId", "type": "string", "required": false, "description": "虚拟集群ID", "example": "pulsar-xk3ne8k2qkp8" }, { "name": "TenantName", "type": "string", "required": false, "description": "虚拟集群名称", "example": "devName" }, { "name": "Types", "type": "array", "required": false, "description": "协议类型数组", "example": "pulsar", "item_type": "string" }, { "name": "SortBy", "type": "string", "required": false, "description": "排序字段名，支持createTime，updateTime", "example": "createTime" }, { "name": "SortOrder", "type": "string", "required": false, "description": "升序排列ASC，降序排列DESC", "example": "desc" } ], "required": [ "Offset", "Limit" ] }, { "name": "DescribeBindClusters", "description": "获取用户绑定的专享集群列表", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeBindVpcs", "description": "获取租户VPC绑定关系", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "起始下标，不填默认为0。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，不填则默认为10，最大值为20。", "example": "1" }, { "name": "ClusterId", "type": "string", "required": false, "description": "Pulsar 集群的ID", "example": "pulsar-xk3ne8k2qkp8" } ], "required": [] }, { "name": "DescribeClusterDetail", "description": "获取集群的详细信息", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群的ID", "example": "pulsar-ge3n43v3wj" } ], "required": [ "ClusterId" ] }, { "name": "DescribeClusters", "description": "获取集群列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "起始下标，不填默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，不填则默认为10，最大值为20。", "example": "1" }, { "name": "ClusterIdList", "type": "array", "required": false, "description": "集群ID列表过滤", "example": "[\"cluster001\"]", "item_type": "string" }, { "name": "IsTagFilter", "type": "boolean", "required": false, "description": "是否标签过滤", "example": "true" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤器。目前支持按标签过滤。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "过滤参数的名字", "example": "paramName" }, { "name": "Values", "type": "array", "required": false, "description": "数值", "example": "[\"a\"]", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeCmqQueueDetail", "description": "查询cmq队列详情", "status": "online", "parameters": [ { "name": "QueueName", "type": "string", "required": true, "description": "精确匹配QueueName", "example": "test-queue" } ], "required": [ "QueueName" ] }, { "name": "DescribeCmqQueues", "description": "查询cmq全量队列", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "分页时本页获取队列列表的起始位置。如果填写了该值，必须也要填写 limit 。该值缺省时，后台取默认值 0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页时本页获取队列的个数，如果不传递该参数，则该参数默认为20，最大值为50。", "example": "1" }, { "name": "QueueName", "type": "string", "required": false, "description": "根据QueueName进行过滤", "example": "testqueue" }, { "name": "QueueNameList", "type": "array", "required": false, "description": "CMQ 队列名称列表过滤", "example": "[\"testqueue1\"]", "item_type": "string" }, { "name": "IsTagFilter", "type": "boolean", "required": false, "description": "标签过滤查找时，需要设置为 true", "example": "true" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤器。目前支持按标签过滤，标签的Name需要加前缀“tag:”，例如：tag:负责人、tag:环境、tag:业务", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "过滤参数的名字", "example": "paramName" }, { "name": "Values", "type": "array", "required": false, "description": "数值", "example": "[\"a\"]", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeCmqSubscriptionDetail", "description": "查询cmq订阅详情", "status": "online", "parameters": [ { "name": "TopicName", "type": "string", "required": false, "description": "主题名字，在单个地域同一账号下唯一。主题名称是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线（-）。", "example": "Conn" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页时本页获取主题列表的起始位置。如果填写了该值，必须也要填写 limit 。该值缺省时，后台取默认值 0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页时本页获取主题的个数，如果不传递该参数，则该参数默认为20，最大值为50。", "example": "0" }, { "name": "SubscriptionName", "type": "string", "required": false, "description": "根据SubscriptionName进行模糊搜索", "example": "sub" }, { "name": "QueueName", "type": "string", "required": false, "description": "队列名称，订阅绑定的endpoint", "example": "testqueue" }, { "name": "QueryType", "type": "string", "required": false, "description": "查询类型。取值：（1）topic；（2）queue。 默认值是topic。如果 queryType 是 topic，则查询主题下的订阅列表；如果 queryType 是 queue，则查询队列绑定的订阅列表。", "example": "topic" } ], "required": [] }, { "name": "DescribeCmqTopicDetail", "description": "查询cmq主题详情", "status": "online", "parameters": [ { "name": "TopicName", "type": "string", "required": false, "description": "精确匹配TopicName。", "example": "topic-test" } ], "required": [] }, { "name": "DescribeCmqTopics", "description": "枚举cmq全量主题", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "分页时本页获取队列列表的起始位置。如果填写了该值，必须也要填写 limit 。该值缺省时，后台取默认值 0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页时本页获取队列的个数，如果不传递该参数，则该参数默认为20，最大值为50。", "example": "1" }, { "name": "TopicName", "type": "string", "required": false, "description": "根据TopicName进行模糊搜索", "example": "topic" }, { "name": "TopicNameList", "type": "array", "required": false, "description": "CMQ 主题名称列表过滤", "example": "[\"topic1\"]", "item_type": "string" }, { "name": "IsTagFilter", "type": "boolean", "required": false, "description": "标签过滤查找时，需要设置为 true", "example": "true" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤器。目前支持按标签过滤，标签的Name需要加前缀“tag:”，例如：tag:负责人、tag:环境、tag:业务", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "过滤参数的名字", "example": "paramName" }, { "name": "Values", "type": "array", "required": false, "description": "数值", "example": "[\"a\"]", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeEnvironmentAttributes", "description": "获取指定命名空间的属性", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境（命名空间）名称。", "example": "default" }, { "name": "ClusterId", "type": "string", "required": true, "description": "Pulsar 集群的ID", "example": "pulsar-ge3n43v3wj" } ], "required": [ "EnvironmentId", "ClusterId" ] }, { "name": "DescribeEnvironmentRoles", "description": "获取命名空间角色列表", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "Pulsar 集群的ID", "example": "pulsar-ge3n43v3wj" }, { "name": "EnvironmentId", "type": "string", "required": false, "description": "环境（命名空间）名称。", "example": "ns-test" }, { "name": "Offset", "type": "integer", "required": false, "description": "起始下标，不填默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，不填则默认为10，最大值为20。", "example": "10" }, { "name": "RoleName", "type": "string", "required": false, "description": "角色名称", "example": "role" }, { "name": "Filters", "type": "array", "required": false, "description": "* RoleName 按照角色名进行过滤，精确查询。 类型：String 必选：否", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "过滤参数的名字", "example": "paramName" }, { "name": "Values", "type": "array", "required": false, "description": "数值", "example": "[\"a\"]", "item_type": "string" } ] } ], "required": [ "ClusterId" ] }, { "name": "DescribeEnvironments", "description": "获取租户下命名空间列表", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "Pulsar 集群的ID", "example": "pulsar-ge3n43v3wj" }, { "name": "EnvironmentId", "type": "string", "required": false, "description": "命名空间名称，模糊搜索。", "example": "default" }, { "name": "Offset", "type": "integer", "required": false, "description": "起始下标，不填默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，不填则默认为10，最大值为20。", "example": "5" }, { "name": "Filters", "type": "array", "required": false, "description": "* EnvironmentId 按照名称空间进行过滤，精确查询。 类型：String 必选：否", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "过滤参数的名字", "example": "paramName" }, { "name": "Values", "type": "array", "required": false, "description": "数值", "example": "[\"a\"]", "item_type": "string" } ] } ], "required": [ "ClusterId" ] }, { "name": "DescribeMqMsgTrace", "description": "查询消息轨迹", "status": "online", "parameters": [ { "name": "Protocol", "type": "string", "required": true, "description": "pulsar、rocketmq、rabbitmq、cmq", "example": "pulsar" }, { "name": "MsgId", "type": "string", "required": true, "description": "消息id", "example": "29292216:15:2" }, { "name": "ClusterId", "type": "string", "required": false, "description": "集群id，cmq为空", "example": "pulsar-pnvjp9mbd947" }, { "name": "EnvironmentId", "type": "string", "required": false, "description": "命名空间，cmq为空", "example": "devNs" }, { "name": "TopicName", "type": "string", "required": false, "description": "主题，cmq为空，rocketmq查询死信时值为groupId", "example": "devTopic" }, { "name": "QueueName", "type": "string", "required": false, "description": "cmq必填，其他协议填空", "example": "devCmq" }, { "name": "GroupName", "type": "string", "required": false, "description": "消费组、订阅", "example": "devName" }, { "name": "QueryDlqMsg", "type": "boolean", "required": false, "description": "查询死信时该值为true，只对Rocketmq有效", "example": "false" }, { "name": "ProduceTime", "type": "string", "required": false, "description": "生产时间", "example": "2024-04-11T23:03:47.328+08:00" } ], "required": [ "Protocol", "MsgId" ] }, { "name": "DescribeMsg", "description": "消息详情", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境（命名空间）名称。", "example": "default" }, { "name": "MsgId", "type": "string", "required": true, "description": "消息ID。", "example": "16836:8:-1" }, { "name": "TopicName", "type": "string", "required": true, "description": "主题名。", "example": "msg_dev" }, { "name": "ClusterId", "type": "string", "required": false, "description": "Pulsar 集群的ID", "example": "pulsar-b843bz38z5mz" } ], "required": [ "EnvironmentId", "MsgId", "TopicName" ] }, { "name": "DescribeMsgTrace", "description": "查询单条消息的消息轨迹", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境（命名空间）。", "example": "devNs" }, { "name": "MsgId", "type": "string", "required": true, "description": "消息ID。", "example": "16839:8:-1" }, { "name": "ProduceTime", "type": "string", "required": true, "description": "消息生产时间。", "example": "2025-07-07 15:54:11,286" }, { "name": "Offset", "type": "integer", "required": false, "description": "起始下标，不填默认为0。", "example": "2" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，不填则默认为10，最大值为20。", "example": "2" }, { "name": "SubscriptionName", "type": "string", "required": false, "description": "消费组名称模糊匹配。", "example": "devSub" }, { "name": "ClusterId", "type": "string", "required": false, "description": "Pulsar 集群的ID", "example": "pulsar-pnvjp9mbd947" }, { "name": "TopicName", "type": "string", "required": false, "description": "topic 名字", "example": "topicNameUser" } ], "required": [ "EnvironmentId", "MsgId", "ProduceTime" ] }, { "name": "DescribeNamespaceBundlesOpt", "description": "运营端获取命名空间bundle列表", "status": "online", "parameters": [ { "name": "ClusterName", "type": "string", "required": true, "description": "物理集群名", "example": "cluster-s3hklt5n" }, { "name": "TenantId", "type": "string", "required": true, "description": "虚拟集群（租户）ID", "example": "pulsar-nzw8q5b3g7b2" }, { "name": "NamespaceName", "type": "string", "required": true, "description": "命名空间名", "example": "default" }, { "name": "NeedMetrics", "type": "boolean", "required": true, "description": "是否需要监控指标，若传false，则不需要传Limit和Offset分页参数", "example": "true" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询限制条数", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "查询偏移量", "example": "0" }, { "name": "Bundle", "type": "string", "required": false, "description": "过滤的 bundle", "example": "0x03d70a3c_0x051eb851" }, { "name": "OwnerBroker", "type": "string", "required": false, "description": "bundle 所属的 broker IP 地址，支持模糊查询", "example": "127.0.0.1" }, { "name": "Tenant", "type": "string", "required": false, "description": "租户(如果没有自定义租户名称，和 tenantId 相同；如果有配置自定义租户名称，则为自定义租户名 user_tenant)", "example": "pulsar-nzw8q5b3g7b2" } ], "required": [ "ClusterName", "TenantId", "NamespaceName", "NeedMetrics" ] }, { "name": "DescribeNodeHealthOpt", "description": "运营端获节点健康状态", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "节点实例ID", "example": "ins-pkqqy3e2" } ], "required": [ "InstanceId" ] }, { "name": "DescribePublisherSummary", "description": "获取消息生产概览信息", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "pulsar-xk3ne8k2qkp8" }, { "name": "Namespace", "type": "string", "required": true, "description": "命名空间名称", "example": "devNs" }, { "name": "Topic", "type": "string", "required": true, "description": "主题名称", "example": "devTopic" } ], "required": [ "ClusterId", "Namespace", "Topic" ] }, { "name": "DescribePublishers", "description": "获取生产者信息列表", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "pulsar-xk3ne8k2qkp8" }, { "name": "Namespace", "type": "string", "required": true, "description": "命名空间名称", "example": "devNs" }, { "name": "Topic", "type": "string", "required": true, "description": "主题名称", "example": "devTopic" }, { "name": "Filters", "type": "array", "required": false, "description": "参数过滤器，支持ProducerName，Address字段", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "过滤参数的名字", "example": "paramName" }, { "name": "Values", "type": "array", "required": false, "description": "数值", "example": "[\"a\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "查询偏移量，默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询条数，默认为20", "example": "10" }, { "name": "Sort", "type": "object", "required": false, "description": "排序器", "example": "无", "children": [ { "name": "Name", "type": "string", "required": true, "description": "排序字段", "example": "msgRateIn" }, { "name": "Order", "type": "string", "required": true, "description": "升序ASC，降序DESC", "example": "ASC" } ] } ], "required": [ "ClusterId", "Namespace", "Topic" ] }, { "name": "DescribePulsarProInstanceDetail", "description": "获取Pulsar专业版集群实例信息", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群id", "example": "pulsar-x4r939zkwmm2" } ], "required": [ "ClusterId" ] }, { "name": "DescribePulsarProInstances", "description": "查询用户已购的Pulsar专业版实例列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "查询条件过滤器", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "过滤参数的名字", "example": "paramName" }, { "name": "Values", "type": "array", "required": false, "description": "数值", "example": "[\"a\"]", "item_type": "string" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "查询数目上限，默认20", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "查询起始位置", "example": "1" } ], "required": [] }, { "name": "DescribeRabbitMQBindings", "description": "查询RabbitMQ路由关系列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如 amqp-xxxxxxxx。有效的 InstanceId 可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询。", "example": "amqp-jero744g" }, { "name": "VirtualHost", "type": "string", "required": true, "description": "VirtualHost 名称，形如 testvhost。有效的 VirtualHost 名称可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询，在左侧导航栏点击 Vhost，并在 Vhost 列表中找到Vhost名称。", "example": "testvhost" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页 offset，默认 0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页 limit，默认 20", "example": "20" }, { "name": "SearchWord", "type": "string", "required": false, "description": "搜索关键词，根据源exchange名称/目标资源名称/绑定key进行模糊搜索", "example": "amq" }, { "name": "SourceExchange", "type": "string", "required": false, "description": "根据源Exchange精准搜索过滤", "example": "amq.direct" }, { "name": "QueueName", "type": "string", "required": false, "description": "根据目标队列名精准搜索过滤，和 DestinationExchange 过滤不可同时设置", "example": "prod.queue" }, { "name": "DestinationExchange", "type": "string", "required": false, "description": "根据目标Exchange精准搜索过滤，和QueueName过滤不可同时设置", "example": "amq.topic" } ], "required": [ "InstanceId", "VirtualHost" ] }, { "name": "DescribeRabbitMQExchanges", "description": "查询RabbitMQ exchange 列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如 amqp-xxxxxxxx。有效的 InstanceId 可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询。", "example": "amqp-2ppxx4rq" }, { "name": "VirtualHost", "type": "string", "required": true, "description": "VirtualHost 名称，形如 testvhost。有效的 VirtualHost 名称可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询，在左侧导航栏点击 Vhost，并在 Vhost 列表中找到Vhost名称。", "example": "testVhost" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页 offset，默认 0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页 limit，默认 20", "example": "20" }, { "name": "SearchWord", "type": "string", "required": false, "description": "搜索关键词, 支持模糊匹配", "example": "testSearchWord" }, { "name": "ExchangeTypeFilters", "type": "array", "required": false, "description": "筛选 exchange 类型, 数组中每个元素为选中的过滤类型，仅支持 direct、fanout、topic、header", "example": "[\"fanout\",\"direct\"]", "item_type": "string" }, { "name": "ExchangeCreatorFilters", "type": "array", "required": false, "description": "筛选 exchange 创建来源, \"system\":\"系统创建\", \"user\":\"用户创建\"", "example": "[\"system\"]", "item_type": "string" }, { "name": "ExchangeName", "type": "string", "required": false, "description": "exchange 名称，用于精确匹配", "example": "exchange1" }, { "name": "SortElement", "type": "string", "required": false, "description": "排序依据的字段： MessageRateInOut - 生产消费速率之和； MessageRateIn - 生产速率； MessageRateOut - 消费速率；", "example": "MessageRateInOut" }, { "name": "SortOrder", "type": "string", "required": false, "description": "排序顺序，ascend 或 descend ascend：升序 descend：降序", "example": "descend" } ], "required": [ "InstanceId", "VirtualHost" ] }, { "name": "DescribeRabbitMQNodeList", "description": "查询 RabbitMQ 托管版节点列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如amqp-xxxxxxxx。有效的 InstanceId 可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询。", "example": "amqp-2ppxx4rq" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认值 0", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "一页限制，默认值 20", "example": "20" }, { "name": "NodeName", "type": "string", "required": false, "description": "模糊搜索节点名字", "example": "node-xxx" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤参数的名字和数值，当前仅支持根据节点状态筛选。 \"Name\": \"nodeStatus\" \"Value\": running or down", "example": "\"nodeStatus\": \"running\"", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "过滤参数的名字", "example": "paramName" }, { "name": "Values", "type": "array", "required": false, "description": "数值", "example": "[\"a\"]", "item_type": "string" } ] }, { "name": "SortElement", "type": "string", "required": false, "description": "按指定元素排序，现在只有2个 cpuUsage：节点CPU利用率 diskUsage：节点磁盘利用率", "example": "cpuUsage" }, { "name": "SortOrder", "type": "string", "required": false, "description": "升序/降序 ascend/descend", "example": "ascend/descend" } ], "required": [ "InstanceId" ] }, { "name": "DescribeRabbitMQPermission", "description": "查询RabbitMQ权限列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如 amqp-xxxxxxxx。有效的 InstanceId 可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询。", "example": "amqp-2ppxx4rq" }, { "name": "User", "type": "string", "required": false, "description": "用户名，形如 admin。有效的 User 名称可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询，点击集群列表中的集群，进入集群详情，并在用户与权限页签中找到用户列表，从而找到用户名称。", "example": "admin" }, { "name": "VirtualHost", "type": "string", "required": false, "description": "VirtualHost 名称，形如 testvhost。有效的 VirtualHost 名称可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询，在左侧导航栏点击 Vhost，并在 Vhost 列表中找到 Vhost 名称。", "example": "testVhost" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页 Offset，默认 0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页 Limit，默认 20", "example": "20" } ], "required": [ "InstanceId" ] }, { "name": "DescribeRabbitMQQueueDetail", "description": "查询RabbitMQ队列详情", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如 amqp-xxxxxxxx。有效的 InstanceId 可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询", "example": "amqp-jero744g" }, { "name": "VirtualHost", "type": "string", "required": true, "description": "VirtualHost 名称，形如 testvhost。有效的 VirtualHost 名称可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询，在左侧导航栏点击 Vhost，并在 Vhost 列表中找到 Vhost 名称", "example": "testVhost" }, { "name": "QueueName", "type": "string", "required": true, "description": "队列名称", "example": "prod.queue" } ], "required": [ "InstanceId", "VirtualHost", "QueueName" ] }, { "name": "DescribeRabbitMQQueues", "description": "查询RabbitMQ队列列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如 amqp-xxxxxxxx。有效的 InstanceId 可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询。", "example": "amqp-2ppxx4rq" }, { "name": "VirtualHost", "type": "string", "required": false, "description": "VirtualHost 名称，形如 testvhost。有效的 VirtualHost 名称可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询，在左侧导航栏点击 Vhost，并在 Vhost 列表中找到Vhost名称。", "example": "testVhost" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页 Offset，默认 0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页 Limit，默认 20", "example": "20" }, { "name": "SearchWord", "type": "string", "required": false, "description": "搜索关键词", "example": "prod" }, { "name": "QueueType", "type": "string", "required": false, "description": "队列类型筛选，不填或 \"all\"：筛选普通队列 和 quorum 队列；\"classic\"：筛选 classic(普通) 队列；\"quorum\"：筛选 quorum 队列", "example": "all" }, { "name": "SortElement", "type": "string", "required": false, "description": "排序依据的字段： ConsumerNumber - 在线消费者数量； MessageHeapCount - 消息堆积数； MessageRateInOut - 生产消费速率之和； MessageRateIn - 生产速率； MessageRateOut - 消费速率；", "example": "MessageHeapCount" }, { "name": "SortOrder", "type": "string", "required": false, "description": "排序顺序，ascend 或 descend ascend：升序 descend：降序", "example": "ascend" } ], "required": [ "InstanceId" ] }, { "name": "DescribeRabbitMQUser", "description": "查询RabbitMQ用户列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如 amqp-xxxxxxxx。有效的 InstanceId 可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询。", "example": "amqp-2ppxx4rq" }, { "name": "SearchUser", "type": "string", "required": false, "description": "用户名检索，支持前缀匹配，后缀匹配", "example": "test_user" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页 Offset，默认 0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页 Limit，默认 20", "example": "20" }, { "name": "User", "type": "string", "required": false, "description": "用户名，精确查询", "example": "test_user" }, { "name": "Tags", "type": "array", "required": false, "description": "用户标签，用于决定改用户访问 RabbitMQ Management 的权限范围 management：普通控制台用户，monitoring：管理型控制台用户，其他值：非控制台用户", "example": "[\"tag1\",\"tag2\"]", "item_type": "string" } ], "required": [ "InstanceId" ] }, { "name": "DescribeRabbitMQVipInstance", "description": "获取单个 RabbitMQ 托管版实例信息", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "实例 ID，形如 amqp-xxxxxxxx。有效的 InstanceId 可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询。", "example": "amqp-jero744g" } ], "required": [ "ClusterId" ] }, { "name": "DescribeRabbitMQVipInstances", "description": "查询用户已购的 RabbitMQ 托管版实例列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "查询条件过滤器", "example": "{ \"Name\": \"instanceIds\", \"Values\": [ \"amqp-jero744g\" ] }", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "过滤参数的名字", "example": "paramName" }, { "name": "Values", "type": "array", "required": false, "description": "数值", "example": "[\"a\"]", "item_type": "string" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "查询数目上限，默认 20", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "查询起始位置，默认 0", "example": "1" } ], "required": [] }, { "name": "DescribeRabbitMQVirtualHost", "description": "查询RabbitMQ vhost列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群实例Id", "example": "amqp-xxx" }, { "name": "VirtualHost", "type": "string", "required": false, "description": "vhost名,不传则查询全部", "example": "testVhost" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页Offset", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页Limit", "example": "20" }, { "name": "Filters", "type": "object", "required": false, "description": "search-virtual-host：vhost名称模糊查询，之前前缀和后缀匹配", "example": "查询条件", "children": [ { "name": "Name", "type": "string", "required": false, "description": "过滤参数的名字", "example": "paramName" }, { "name": "Values", "type": "array", "required": false, "description": "数值", "example": "[\"a\"]", "item_type": "string" } ] }, { "name": "SortElement", "type": "string", "required": false, "description": "排序依据的字段： MessageHeapCount - 消息堆积数； MessageRateInOut - 生产消费速率之和； MessageRateIn - 生产速率； MessageRateOut - 消费速率；", "example": "MessageHeapCount" }, { "name": "SortOrder", "type": "string", "required": false, "description": "排序顺序，ascend 或 descend", "example": "ascend" } ], "required": [ "InstanceId" ] }, { "name": "DescribeRocketMQCluster", "description": "查询 RocketMQ 虚拟集群信息。 当前 API 适用集群：4.x 虚拟集群。查询 4.x 专享或通用集群信息的接口文档见 [DescribeRocketMQVipInstanceDetail](https://cloud.tencent.com/document/api/1179/86725)，查询 5.x 集群信息的接口文档见 [DescribeInstance](https://cloud.tencent.com/document/api/1493/97866)。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "rocketmq-rd3545bkkj49" } ], "required": [ "ClusterId" ] }, { "name": "DescribeRocketMQClusters", "description": "查询 RocketMQ 虚拟集群列表。 当前 API 适用集群：4.x 虚拟集群。查询 5.x 集群列表接口文档见 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028)，或者使用 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口适用所有集群类型。", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "限制数目", "example": "10" }, { "name": "IdKeyword", "type": "string", "required": false, "description": "按照集群ID关键字搜索", "example": "rocketmq-a52qova7x97b" }, { "name": "NameKeyword", "type": "string", "required": false, "description": "按照集群名称关键字搜索", "example": "test_name" }, { "name": "ClusterIdList", "type": "array", "required": false, "description": "集群ID列表过滤", "example": "[\"rocketmq-a52qova7x97b\"]", "item_type": "string" }, { "name": "IsTagFilter", "type": "boolean", "required": false, "description": "标签过滤查找时，需要设置为true", "example": "true" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤器。目前支持标签过滤。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "过滤参数的名字", "example": "paramName" }, { "name": "Values", "type": "array", "required": false, "description": "数值", "example": "[\"a\"]", "item_type": "string" } ] } ], "required": [ "Offset", "Limit" ] }, { "name": "DescribeRocketMQConsumeStats", "description": "查询 RocketMQ 消费详情列表。 当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。查询 5.x 集群消费详情的接口文档见 [DescribeConsumerGroup](https://cloud.tencent.com/document/api/1493/97941)。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "实例ID", "example": "rocketmq-7j8m97bqpx5d" }, { "name": "NamespaceId", "type": "string", "required": true, "description": "消费组所在的命名空间，4.x 通用集群命名空间固定为: tdmq_default", "example": "test_namespace" }, { "name": "ConsumerGroup", "type": "string", "required": true, "description": "消费组", "example": "test_group" } ], "required": [ "ClusterId", "NamespaceId", "ConsumerGroup" ] }, { "name": "DescribeRocketMQConsumerConnectionDetail", "description": "查询 RocketMQ 消费者客户端详情。 当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群的查询消费者客户端详情接口文档见 [DescribeConsumerClient](https://cloud.tencent.com/document/api/1493/115240)。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "rocketmq-2p9vx3ax9jxg" }, { "name": "NamespaceId", "type": "string", "required": true, "description": "消费组所在的命名空间，4.x 通用集群命名空间固定为: tdmq_default", "example": "test_ns" }, { "name": "GroupId", "type": "string", "required": true, "description": "消费组名称", "example": "test_group" }, { "name": "ClientId", "type": "string", "required": true, "description": "消费端实例ID", "example": "local@23645@0@30ey5aef8w" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "限制数目", "example": "20" }, { "name": "FilterType", "type": "array", "required": false, "description": "按主题类型过滤查询结果，可选择Normal, GlobalOrder, PartitionedOrder, Retry, Transaction, DeadLetter", "example": "[\"Normal\"]", "item_type": "string" } ], "required": [ "ClusterId", "NamespaceId", "GroupId", "ClientId", "Offset", "Limit" ] }, { "name": "DescribeRocketMQConsumerConnections", "description": "查询 RocketMQ 消费组下的客户端连接列表。 当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群查询消费组下的客户端连接列表接口文档见 [DescribeConsumerClientList](https://cloud.tencent.com/document/api/1493/120140)。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "rocketmq-2p9vx3ax9jxg" }, { "name": "NamespaceId", "type": "string", "required": true, "description": "消费组所在的命名空间，4.x 通用集群命名空间固定为: tdmq_default", "example": "test_ns" }, { "name": "GroupId", "type": "string", "required": true, "description": "消费组ID", "example": "test_group" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "限制数目", "example": "20" }, { "name": "SortedBy", "type": "string", "required": false, "description": "对查询结果排序，此为排序字段，目前支持Accumulative（消息堆积量）", "example": "Accumulative" }, { "name": "SortOrder", "type": "string", "required": false, "description": "查询结果排序规则，ASC为升序，DESC为降序", "example": "ASC" } ], "required": [ "ClusterId", "NamespaceId", "GroupId", "Offset", "Limit" ] }, { "name": "DescribeRocketMQEnvironmentRoles", "description": "查询角色授权列表。 当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群的查询角色列表接口文档见 [DescribeRoleList](https://cloud.tencent.com/document/api/1493/98862)。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "必填字段，RocketMQ集群的ID", "example": "rocketmq-ge3n43v3wj" }, { "name": "EnvironmentId", "type": "string", "required": false, "description": "命名空间，4.x 通用集群命名空间固定为: tdmq_default", "example": "test_ns" }, { "name": "Offset", "type": "integer", "required": false, "description": "起始下标，不填默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，不填则默认为10，最大值为20。", "example": "20" }, { "name": "RoleName", "type": "string", "required": false, "description": "角色名称", "example": "test_role" }, { "name": "Filters", "type": "array", "required": false, "description": "RoleName按照角色名进行过滤，精确查询。类型：String必选：否", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "过滤参数的名字", "example": "paramName" }, { "name": "Values", "type": "array", "required": false, "description": "数值", "example": "[\"a\"]", "item_type": "string" } ] } ], "required": [ "ClusterId" ] }, { "name": "DescribeRocketMQGeneralSKUs", "description": "查询通用集群售卖规格。 当前 API 适用集群：4.x 通用集群。查询 5.x 集群的售卖规格接口文档见 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676)。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeRocketMQGroups", "description": "查询 RocketMQ 消费组列表。 当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。查询 5.x 集群的消费组列表接口文档见 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535)。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "rocketmq-4k4orqgq" }, { "name": "NamespaceId", "type": "string", "required": true, "description": "消费组所在的命名空间，4.x 通用集群命名空间固定为: tdmq_default", "example": "test_ns" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "单次查询最大条数。取值范围：[0~100]，默认值为20", "example": "20" }, { "name": "FilterTopic", "type": "string", "required": false, "description": "主题名称，输入此参数可查询该主题下所有的订阅组", "example": "test_topic" }, { "name": "FilterGroup", "type": "string", "required": false, "description": "按消费组名称查询消费组，支持模糊查询", "example": "test_group" }, { "name": "SortedBy", "type": "string", "required": false, "description": "按照指定字段排序，可选值为 subscribeNum: 订阅 Topic 个数", "example": "subscribeNum" }, { "name": "SortOrder", "type": "string", "required": false, "description": "按升序或降序排列，可选值为asc，desc", "example": "asc" }, { "name": "FilterOneGroup", "type": "string", "required": false, "description": "订阅组名称，指定此参数后将只返回该订阅组信息", "example": "test_group" }, { "name": "Types", "type": "array", "required": false, "description": "group类型", "example": "[\"TCP\"]", "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": [ "ClusterId", "NamespaceId", "Offset", "Limit" ] }, { "name": "DescribeRocketMQMigratingTopicList", "description": "查询Topic迁移状态列表，源集群和目标集群客户端数量信息需要配合DescribeRocketMQSmoothMigrationTaskTopicInsNum接口查询", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "迁移任务名称", "example": "4ed3a07b-36ef-4522-968b-5434dff663xi" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页大小", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量", "example": "10" }, { "name": "Filters", "type": "array", "required": false, "description": "查询过滤器，支持topicname、MigrationStatus查询", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "过滤参数的名字", "example": "paramName" }, { "name": "Values", "type": "array", "required": false, "description": "数值", "example": "[\"a\"]", "item_type": "string" } ] } ], "required": [ "TaskId", "Limit", "Offset" ] }, { "name": "DescribeRocketMQMsg", "description": "查询 RocketMQ 消息详情。 当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群的查询消息详情接口文档见 [DescribeMessage](https://cloud.tencent.com/document/api/1493/114594)。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群id", "example": "rocketmq-4k4orqgq" }, { "name": "EnvironmentId", "type": "string", "required": true, "description": "命名空间，4.x 通用集群命名空间固定为: tdmq_default", "example": "test_ns" }, { "name": "TopicName", "type": "string", "required": true, "description": "主题，查询死信时传groupId", "example": "test_topic" }, { "name": "MsgId", "type": "string", "required": true, "description": "消息id", "example": "092BAE5A1656070DEA4E276DF0760089" }, { "name": "PulsarMsgId", "type": "string", "required": true, "description": "pulsar消息id", "example": "092BAE5A1656070DEA4E276DF0760089" }, { "name": "QueryDeadLetterMessage", "type": "boolean", "required": false, "description": "查询死信时该值为true，只对Rocketmq有效", "example": "false" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页Offset", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页Limit", "example": "20" }, { "name": "FilterTrackGroup", "type": "string", "required": false, "description": "根据消费组名称过滤消费详情", "example": "test_group" } ], "required": [ "ClusterId", "EnvironmentId", "TopicName", "MsgId", "PulsarMsgId" ] }, { "name": "DescribeRocketMQMsgTrace", "description": "查询消息轨迹。 当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群查询消息轨迹的接口文档见 [DescribeMessageTrace](https://cloud.tencent.com/document/api/1493/114302)。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群id", "example": "rocketmq-4k4orqgq" }, { "name": "EnvironmentId", "type": "string", "required": true, "description": "命名空间，4.x 通用集群命名空间固定为: tdmq_default", "example": "test_ns" }, { "name": "TopicName", "type": "string", "required": true, "description": "主题，rocketmq查询死信时值为groupId", "example": "test_topic" }, { "name": "MsgId", "type": "string", "required": true, "description": "消息id", "example": "092BAE5A1656070DEA4E276DF0760089" }, { "name": "GroupName", "type": "string", "required": false, "description": "消费组、订阅", "example": "test_group" }, { "name": "QueryDeadLetterMessage", "type": "string", "required": false, "description": "查询死信时该值为true", "example": "false" } ], "required": [ "ClusterId", "EnvironmentId", "TopicName", "MsgId" ] }, { "name": "DescribeRocketMQNamespaces", "description": "获取 RocketMQ 命名空间列表。 当前 API 适用集群：4.x 虚拟集群和 4.x 专享集群，其他集群类型均不支持该功能。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "rocketmq-4k4orqgq" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "限制数目", "example": "10" }, { "name": "NameKeyword", "type": "string", "required": false, "description": "按名称搜索", "example": "ordername" } ], "required": [ "ClusterId", "Offset", "Limit" ] }, { "name": "DescribeRocketMQProducers", "description": "查询 RocketMQ 指定主题下的生产者客户端列表。 当前 API 适用集群：4.x 专享集群 和 4.x 通用集群。查询 5.x 集群主题下的生产者客户端列表接口文档见 [DescribeProducerList](https://cloud.tencent.com/document/api/1493/122548)。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "rocketmq-5kze4gr222mx" }, { "name": "NamespaceId", "type": "string", "required": true, "description": "主题所在的命名空间，4.x 通用集群命名空间固定为: tdmq_default", "example": "test_ns" }, { "name": "Topic", "type": "string", "required": true, "description": "主题名", "example": "test_topic" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页offset", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页limit", "example": "20" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤查询条件列表，支持以下过滤参数： - ClientId：生产者客户端ID - ClientIp：生产者客户端IP", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "过滤参数的名字", "example": "paramName" }, { "name": "Values", "type": "array", "required": false, "description": "数值", "example": "[\"a\"]", "item_type": "string" } ] } ], "required": [ "ClusterId", "NamespaceId", "Topic", "Offset", "Limit" ] }, { "name": "DescribeRocketMQPublicAccessMonitorData", "description": "查询公网指标监控数据，目前仅支持客户端到 LB 的入带宽和出宽带指标。 当前 API 适用集群：4.x 专享集群 和 4.x 通用集群。5.x 集群暂不支持该功能。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群 ID", "example": "rocketmq-a52qova7x97b" }, { "name": "MetricName", "type": "string", "required": true, "description": "指标名称，仅支持单指标拉取。指标枚举如下： - ClientIntraffic：入流量 - ClientOuttraffic：出流量", "example": "ClientOuttraffic" }, { "name": "StartTime", "type": "string", "required": false, "description": "起始时间", "example": "2018-09-22T19:51:23+08:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间，默认为当前时间", "example": "2018-09-22T20:51:23+08:00" }, { "name": "Period", "type": "integer", "required": false, "description": "监控统计周期，如60。默认为取值为300，单位为s。", "example": "60" } ], "required": [ "InstanceId", "MetricName" ] }, { "name": "DescribeRocketMQPublicAccessPoint", "description": "查询 RocketMQ 集群的公网接入点信息。 当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。查询 5.x 集群的公网接入点信息接口文档见 [DescribeInstance](https://cloud.tencent.com/document/api/1493/97866)。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群ID，当前只支持专享集群", "example": "rocketmq-a52qova7x97b" } ], "required": [ "InstanceId" ] }, { "name": "DescribeRocketMQRoles", "description": "查询角色列表。 当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群的查询角色列表接口文档见 [DescribeRoleList](https://cloud.tencent.com/document/api/1493/98862)。", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "起始下标，不填默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "返回数量，不填则默认为10，最大值为20。", "example": "20" }, { "name": "ClusterId", "type": "string", "required": true, "description": "必填字段，集群Id", "example": "rocketmq-2p9vx3ax9jxg" }, { "name": "RoleName", "type": "string", "required": false, "description": "角色名称，模糊查询", "example": "test_role_name" }, { "name": "Filters", "type": "array", "required": false, "description": "RoleName按照角色名进行过滤，精确查询。类型：String必选：否", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "过滤参数的名字", "example": "paramName" }, { "name": "Values", "type": "array", "required": false, "description": "数值", "example": "[\"a\"]", "item_type": "string" } ] } ], "required": [ "Offset", "Limit", "ClusterId" ] }, { "name": "DescribeRocketMQSmoothMigrationTask", "description": "用于获取RocketMQ平滑迁移任务详情", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务ID", "example": "a50e97f6-8d2b-4fa8-b1f8-ba47bc50780e" } ], "required": [ "TaskId" ] }, { "name": "DescribeRocketMQSubscriptions", "description": "查询 RocketMQ 消费组订阅关系列表。 当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群查询消费组订阅的主题列表接口文档见 [DescribeTopicListByGroup](https://cloud.tencent.com/document/api/1493/115314)。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "rocketmq-4k4orqgq" }, { "name": "Namespace", "type": "string", "required": true, "description": "消费组所在的命名空间，4.x 通用集群命名空间固定为: tdmq_default", "example": "test_namespace" }, { "name": "Group", "type": "string", "required": true, "description": "消费组名称", "example": "test_group" }, { "name": "Offset", "type": "integer", "required": true, "description": "查询起始位置", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "查询限制条数", "example": "20" } ], "required": [ "ClusterId", "Namespace", "Group", "Offset", "Limit" ] }, { "name": "DescribeRocketMQTopUsages", "description": "用于获取RocketMQ指标排序列表，比如集群实例下占用存储空间最多的主题排序。 当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群暂不支持该功能。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "rocketmq-vvqb9emabapx" }, { "name": "MetricName", "type": "string", "required": true, "description": "指标名称，支持以下： consumeLag，消费组堆积数量 deadLetterCount，死信数量 topicRateIn, Topic生产速率 topicRateOut，Topic消费速率 topicStorageSize，Topic存储空间 topicApiCalls，Topic API调用次数", "example": "consumeLag" }, { "name": "Limit", "type": "integer", "required": true, "description": "排序数量，最大20", "example": "10" } ], "required": [ "ClusterId", "MetricName", "Limit" ] }, { "name": "DescribeRocketMQTopic", "description": "获取RocketMQ主题详情", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "rocketmq-4k4orqgq" }, { "name": "NamespaceId", "type": "string", "required": true, "description": "命名空间", "example": "test_ns" }, { "name": "TopicName", "type": "string", "required": true, "description": "主题名称", "example": "test_topic" }, { "name": "ConsumerGroup", "type": "string", "required": false, "description": "消费组名称", "example": "test_group" }, { "name": "Offset", "type": "integer", "required": false, "description": "订阅列表分页参数Offset", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "订阅列表分页参数Limit", "example": "10" } ], "required": [ "ClusterId", "NamespaceId", "TopicName" ] }, { "name": "DescribeRocketMQTopicMsgs", "description": "查询 RocketMQ 消息列表。 当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群的查询消息列表接口文档见 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593)。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群 ID", "example": "rocketmq-4k4orqgq" }, { "name": "EnvironmentId", "type": "string", "required": true, "description": "命名空间，4.x 通用集群命名空间固定为: tdmq_default", "example": "test_namespace" }, { "name": "TopicName", "type": "string", "required": true, "description": "主题名称，查询死信时为groupId", "example": "test_topic" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间", "example": "2021-12-22 12:22:22" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间", "example": "2021-12-22 12:22:22" }, { "name": "MsgId", "type": "string", "required": false, "description": "消息 ID", "example": "092BAE5A1656070DEA4E276DF0760089" }, { "name": "MsgKey", "type": "string", "required": false, "description": "消息 key", "example": "test_key" }, { "name": "Offset", "type": "integer", "required": false, "description": "查询偏移", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询限额", "example": "20" }, { "name": "TaskRequestId", "type": "string", "required": false, "description": "标志一次分页事务", "example": "2e5ecbb3-f2d6-49d3-9c82-8648f8ed8748" }, { "name": "NumOfLatestMsg", "type": "integer", "required": false, "description": "查询最近N条消息 最大不超过1024，默认-1为其他查询条件", "example": "20" }, { "name": "Tag", "type": "string", "required": false, "description": "TAG表达式", "example": "test_tag" }, { "name": "QueryDeadLetterMessage", "type": "boolean", "required": false, "description": "死信查询时该值为true，只对Rocketmq有效", "example": "false" } ], "required": [ "ClusterId", "EnvironmentId", "TopicName", "StartTime", "EndTime" ] }, { "name": "DescribeRocketMQTopicStats", "description": "查询 RocketMQ 主题生产详情列表。 当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群暂不支持该功能。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "实例ID", "example": "rocketmq-7j8m97bqpx5d" }, { "name": "NamespaceId", "type": "string", "required": true, "description": "主题所在的命名空间，4.x 通用集群命名空间固定为: tdmq_default", "example": "test_namespace" }, { "name": "TopicName", "type": "string", "required": true, "description": "主题名", "example": "test_topic" } ], "required": [ "ClusterId", "NamespaceId", "TopicName" ] }, { "name": "DescribeRocketMQTopics", "description": "查询 RocketMQ 主题列表。 当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。查询 5.x 集群的主题列表接口文档见 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030)。", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "查询偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "查询限制数", "example": "10" }, { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "rocketmq-4k4orqgq" }, { "name": "NamespaceId", "type": "string", "required": true, "description": "主题所在的命名空间，4.x 通用集群命名空间固定为: tdmq_default", "example": "test_ns" }, { "name": "FilterType", "type": "array", "required": false, "description": "按主题类型过滤查询结果，可选择Normal, GlobalOrder, PartitionedOrder, Transaction", "example": "[\"Normal\"]", "item_type": "string" }, { "name": "FilterName", "type": "string", "required": false, "description": "按主题名称搜索，支持模糊查询", "example": "test_topic" }, { "name": "FilterGroup", "type": "string", "required": false, "description": "按订阅消费组名称过滤", "example": "test_group" }, { "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": [ "Offset", "Limit", "ClusterId", "NamespaceId" ] }, { "name": "DescribeRocketMQTopicsByGroup", "description": "查询 RocketMQ 消费组订阅的主题列表。 当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群查询消费组订阅的主题列表接口文档见 [DescribeTopicListByGroup](https://cloud.tencent.com/document/api/1493/115314)。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "rocketmq-4k4orqgq" }, { "name": "NamespaceId", "type": "string", "required": true, "description": "消费组所在的命名空间，4.x 通用集群命名空间固定为: tdmq_default", "example": "test_ns" }, { "name": "GroupId", "type": "string", "required": true, "description": "消费组名称", "example": "test_group" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制条数", "example": "10" } ], "required": [ "ClusterId", "NamespaceId", "GroupId" ] }, { "name": "DescribeRocketMQVipInstanceDetail", "description": "查询 RocketMQ 集群信息。 当前 API 适用集群：4.x 专享集群 和 4.x 通用集群。查询 5.x 集群信息的接口文档见 [DescribeInstance](https://cloud.tencent.com/document/api/1493/97866)。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "rocketmq-4k4orqgq" } ], "required": [ "ClusterId" ] }, { "name": "DescribeRocketMQVipInstances", "description": "查询 RocketMQ 4.x 集群列表。 当前 API 适用集群：4.x 专享集群 和 4.x 通用集群。查询 5.x 集群列表接口文档见 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028)，或者使用 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口适用所有集群类型。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "查询条件过滤器，支持的查询条件如下： instanceIds - 实例ID instanceName - 实例名称 status - 实例状态", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "过滤参数的名字", "example": "paramName" }, { "name": "Values", "type": "array", "required": false, "description": "数值", "example": "[\"a\"]", "item_type": "string" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "查询数目上限，默认20", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "查询起始位置", "example": "1" } ], "required": [] }, { "name": "DescribeRoles", "description": "获取角色列表", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "必填字段，集群Id", "example": "pulsar-xk3ne8k2qkp8" }, { "name": "RoleName", "type": "string", "required": false, "description": "角色名称，模糊查询", "example": "devRole1" }, { "name": "Offset", "type": "integer", "required": false, "description": "起始下标，不填默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，不填则默认为10，最大值为20。", "example": "10" }, { "name": "Filters", "type": "array", "required": false, "description": "* RoleName 按照角色名进行过滤，精确查询。 类型：String 必选：否", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "过滤参数的名字", "example": "paramName" }, { "name": "Values", "type": "array", "required": false, "description": "数值", "example": "[\"a\"]", "item_type": "string" } ] } ], "required": [ "ClusterId" ] }, { "name": "DescribeSubscriptions", "description": "查询指定环境和主题下的订阅者列表", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境（命名空间）名称。", "example": "devNs" }, { "name": "TopicName", "type": "string", "required": true, "description": "主题名称。", "example": "devtopic" }, { "name": "ClusterId", "type": "string", "required": true, "description": "Pulsar 集群的ID", "example": "pulsar-b843bz38z5mz" }, { "name": "Offset", "type": "integer", "required": false, "description": "起始下标，不填默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，不填则默认为10，最大值为20。", "example": "10" }, { "name": "SubscriptionName", "type": "string", "required": false, "description": "订阅者名称，模糊匹配。", "example": "devSub" }, { "name": "Filters", "type": "array", "required": false, "description": "数据过滤条件。", "example": "无", "item_type": "object", "children": [ { "name": "ConsumerHasCount", "type": "boolean", "required": false, "description": "是否仅展示包含真实消费者的订阅。", "example": "false" }, { "name": "ConsumerHasBacklog", "type": "boolean", "required": false, "description": "是否仅展示消息堆积的订阅。", "example": "false" }, { "name": "ConsumerHasExpired", "type": "boolean", "required": false, "description": "是否仅展示存在消息超期丢弃的订阅。", "example": "false" }, { "name": "SubscriptionNames", "type": "array", "required": false, "description": "按照订阅名过滤，精确查询。", "example": "false", "item_type": "string" } ] } ], "required": [ "EnvironmentId", "TopicName", "ClusterId" ] }, { "name": "DescribeTopicMsgs", "description": "消息查询", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境（命名空间）名称。", "example": "default" }, { "name": "TopicName", "type": "string", "required": true, "description": "主题名。", "example": "test-topic3" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间。", "example": "2020-09-22 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间。", "example": "2020-09-22 00:00:00" }, { "name": "Offset", "type": "integer", "required": false, "description": "起始下标，不填默认为0。", "example": "2" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，不填则默认为10，最大值为20。", "example": "2" }, { "name": "MsgId", "type": "string", "required": false, "description": "消息ID。", "example": "29292216:15:2" }, { "name": "ClusterId", "type": "string", "required": false, "description": "Pulsar 集群的ID", "example": "pulsar-pnvjp9mbd947" } ], "required": [ "EnvironmentId", "TopicName", "StartTime", "EndTime" ] }, { "name": "DescribeTopics", "description": "获取环境下主题列表", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境（命名空间）名称。", "example": "devNs" }, { "name": "ClusterId", "type": "string", "required": true, "description": "Pulsar 集群的ID", "example": "cluster1" }, { "name": "TopicName", "type": "string", "required": false, "description": "主题名模糊匹配。", "example": "topic1" }, { "name": "Offset", "type": "integer", "required": false, "description": "起始下标，不填默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，不填则默认为10，最大值为20。", "example": "20" }, { "name": "TopicType", "type": "integer", "required": false, "description": "topic类型描述： 0：非持久非分区主题类型； 1：非持久分区主题类型； 2：持久非分区主题类型； 3：持久分区主题类型；", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "* TopicName 按照主题名字查询，精确查询。 类型：String 必选：否", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "过滤参数的名字", "example": "paramName" }, { "name": "Values", "type": "array", "required": false, "description": "数值", "example": "[\"a\"]", "item_type": "string" } ] }, { "name": "TopicCreator", "type": "integer", "required": false, "description": "创建来源： 1：用户创建 2：系统创建", "example": "1" } ], "required": [ "EnvironmentId", "ClusterId" ] }, { "name": "ExecuteDisasterRecovery", "description": "执行域名异地访问切换，域名的访问指向将切换至备份集群。", "status": "online", "parameters": [], "required": [] }, { "name": "ExportRocketMQMessageDetail", "description": "导出RocketMQ消息详情", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群id", "example": "rocketmq-2sdw2" }, { "name": "EnvironmentId", "type": "string", "required": true, "description": "应用命名空间", "example": "test_namespace" }, { "name": "TopicName", "type": "string", "required": true, "description": "Topic名称 如果是死信消息 isDlqMsg=true", "example": "test_topic" }, { "name": "MsgId", "type": "string", "required": true, "description": "消息id", "example": "7F0000013AEC18B4AAC278B640D30002" }, { "name": "IncludeMsgBody", "type": "boolean", "required": true, "description": "是否包含消息体", "example": "false" }, { "name": "DeadLetterMsg", "type": "boolean", "required": false, "description": "是否死信消息", "example": "false" } ], "required": [ "ClusterId", "EnvironmentId", "TopicName", "MsgId", "IncludeMsgBody" ] }, { "name": "GetTopicList", "description": "获取环境下主题列表", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境（命名空间）名称。", "example": "devNs" }, { "name": "ClusterId", "type": "string", "required": true, "description": "Pulsar 集群的ID", "example": "cluster1" }, { "name": "Offset", "type": "integer", "required": false, "description": "起始下标，不填默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，不填则默认为10，最大值为20。", "example": "20" } ], "required": [ "EnvironmentId", "ClusterId" ] }, { "name": "ImportRocketMQConsumerGroups", "description": "输入迁移任务id和要导入的Group，导入后台", "status": "online", "parameters": [ { "name": "Groups", "type": "array", "required": true, "description": "导入topic", "example": "[ \t\t{ \t\t\t\"Namespace\": \"tdmq_default\", \t\t\t\"GroupName\": \"ConsumerGroup_29106\", \t\t\t\"ConsumeBroadcastEnable\": true, \t\t\t\"ConsumeEnable\": true \t\t} \t]", "item_type": "object", "children": [ { "name": "Namespace", "type": "string", "required": true, "description": "命名空间", "example": "test_ns" }, { "name": "GroupName", "type": "string", "required": true, "description": "消费组名称", "example": "test_group" }, { "name": "ConsumeBroadcastEnable", "type": "boolean", "required": true, "description": "是否开启广播消费", "example": "false" }, { "name": "ConsumeEnable", "type": "boolean", "required": true, "description": "是否开启消费", "example": "false" }, { "name": "Remark", "type": "string", "required": false, "description": "备注信息", "example": "remark info" }, { "name": "ConsumerGroupType", "type": "string", "required": false, "description": "协议类型，支持以下枚举值 TCP; HTTP;", "example": "TCP" } ] }, { "name": "TaskId", "type": "string", "required": true, "description": "任务id", "example": "20157405-8691-4972-b7ec-52fd0839b7a9t" } ], "required": [ "Groups", "TaskId" ] }, { "name": "ImportRocketMQTopics", "description": "导入topic列表", "status": "online", "parameters": [ { "name": "Topics", "type": "array", "required": true, "description": "导入topic", "example": "[ \t\t{ \t\t\t\"Namespace\": \"\", \t\t\t\"TopicName\": \"Topic_11334\", \t\t\t\"Type\": \"Normal\", \t\t\t\"Partitions\": 3, \t\t\t\"Remark\": \"236\" \t\t} \t]", "item_type": "object", "children": [ { "name": "Namespace", "type": "string", "required": true, "description": "命名空间", "example": "test_ns" }, { "name": "TopicName", "type": "string", "required": true, "description": "主题名称", "example": "test_topic" }, { "name": "Type", "type": "string", "required": true, "description": "主题类型： Normal，普通 PartitionedOrder, 分区顺序 Transaction，事务消息 DelayScheduled，延迟/定时消息", "example": "Normal" }, { "name": "Partitions", "type": "integer", "required": true, "description": "分区个数", "example": "3" }, { "name": "Remark", "type": "string", "required": false, "description": "备注信息", "example": "remark info" } ] }, { "name": "TaskId", "type": "string", "required": true, "description": "任务ID", "example": "a50e97f6-8d2b-4fa8-b1f8-ba47bc50780e" } ], "required": [ "Topics", "TaskId" ] }, { "name": "ModifyCluster", "description": "更新集群信息", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "Pulsar 集群的ID，需要更新的集群Id。", "example": "pulsar-ge3n43v3wj" }, { "name": "ClusterName", "type": "string", "required": false, "description": "更新后的集群名称。", "example": "devName" }, { "name": "Remark", "type": "string", "required": false, "description": "说明信息。长度限制为 128 字节", "example": "demo" }, { "name": "PublicAccessEnabled", "type": "boolean", "required": false, "description": "开启公网访问，只能为true", "example": "true" } ], "required": [ "ClusterId" ] }, { "name": "ModifyCmqQueueAttribute", "description": "修改cmq队列属性", "status": "online", "parameters": [ { "name": "QueueName", "type": "string", "required": true, "description": "队列名字，在单个地域同一账号下唯一。队列名称是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)。", "example": "queue1" }, { "name": "MaxMsgHeapNum", "type": "integer", "required": false, "description": "最大堆积消息数。取值范围在公测期间为 1,000,000 - 10,000,000，正式上线后范围可达到 1000,000-1000,000,000。默认取值在公测期间为 10,000,000，正式上线后为 100,000,000。", "example": "1000000" }, { "name": "PollingWaitSeconds", "type": "integer", "required": false, "description": "消息接收长轮询等待时间。取值范围 0-30 秒，默认值 0。", "example": "3" }, { "name": "VisibilityTimeout", "type": "integer", "required": false, "description": "消息可见性超时。取值范围 1-43200 秒（即12小时内），默认值 30。", "example": "30" }, { "name": "MaxMsgSize", "type": "integer", "required": false, "description": "消息最大长度，新版CMQ新建的队列默认1024KB，不支持修改", "example": "1024" }, { "name": "MsgRetentionSeconds", "type": "integer", "required": false, "description": "消息最长未确认时间。取值范围 30-43200 秒（30秒~12小时），默认值 3600 (1 小时)。", "example": "7200" }, { "name": "RewindSeconds", "type": "integer", "required": false, "description": "队列是否开启回溯消息能力，该参数取值范围0-1296000，0表示不开启。", "example": "0" }, { "name": "FirstQueryInterval", "type": "integer", "required": false, "description": "第一次查询时间", "example": "0" }, { "name": "MaxQueryCount", "type": "integer", "required": false, "description": "最大查询次数", "example": "0" }, { "name": "DeadLetterQueueName", "type": "string", "required": false, "description": "死信队列名称", "example": "dead-queue" }, { "name": "MaxTimeToLive", "type": "integer", "required": false, "description": "policy为1时必选。最大未消费过期时间。范围300-43200，单位秒，需要小于消息最大保留时间MsgRetentionSeconds", "example": "300" }, { "name": "MaxReceiveCount", "type": "integer", "required": false, "description": "最大接收次数", "example": "1" }, { "name": "Policy", "type": "integer", "required": false, "description": "死信队列策略", "example": "0" }, { "name": "Trace", "type": "boolean", "required": false, "description": "是否开启消息轨迹标识，true表示开启，false表示不开启，不填表示不开启。", "example": "false" }, { "name": "Transaction", "type": "integer", "required": false, "description": "是否开启事务，1开启，0不开启", "example": "0" }, { "name": "RetentionSizeInMB", "type": "integer", "required": false, "description": "队列可回溯存储空间：若开启消息回溯，取值范围：10240MB - 512000MB，若不开启消息回溯，取值：0", "example": "0" } ], "required": [ "QueueName" ] }, { "name": "ModifyCmqSubscriptionAttribute", "description": "修改cmq订阅属性", "status": "online", "parameters": [ { "name": "TopicName", "type": "string", "required": true, "description": "主题名字，在单个地域同一账号下唯一。主题名称是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线（-）。", "example": "test-topic" }, { "name": "SubscriptionName", "type": "string", "required": true, "description": "订阅名字，在单个地域同一账号的同一主题下唯一。订阅名称是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)。", "example": "tese-sub" }, { "name": "NotifyStrategy", "type": "string", "required": false, "description": "向 Endpoint 推送消息出现错误时，CMQ 推送服务器的重试策略。取值如下： （1）BACKOFF_RETRY，退避重试。每隔一定时间重试一次，重试够一定次数后，就把该消息丢弃，继续推送下一条消息。 （2）EXPONENTIAL_DECAY_RETRY，指数衰退重试。每次重试的间隔是指数递增的，例如开始1s，后面是2s，4s，8s···由于 Topic 消息的周期是一天，所以最多重试一天就把消息丢弃。默认值是 EXPONENTIAL_D...", "example": "EXPONENTIAL_DECAY_RETRY" }, { "name": "NotifyContentFormat", "type": "string", "required": false, "description": "推送内容的格式。取值：（1）JSON；（2）SIMPLIFIED，即 raw 格式。如果 Protocol 是 queue，则取值必须为 SIMPLIFIED。如果 Protocol 是 HTTP，两个值均可以，默认值是 JSON。", "example": "SIMPLIFIED" }, { "name": "FilterTags", "type": "array", "required": false, "description": "消息正文。消息标签（用于消息过滤)。标签数量不能超过5个，每个标签不超过16个字符。与(Batch)PublishMessage的MsgTag参数配合使用，规则：1）如果FilterTag没有设置，则无论MsgTag是否有设置，订阅接收所有发布到Topic的消息；2）如果FilterTag数组有值，则只有数组中至少有一个值在MsgTag数组中也存在时（即FilterTag和MsgTag有交集），订阅才接收该发布到Topic的消息；3）如果FilterTag数组...", "example": "[\"new\"]", "item_type": "string" }, { "name": "BindingKey", "type": "array", "required": false, "description": "BindingKey数量不超过5个， 每个BindingKey长度不超过64字节，该字段表示订阅接收消息的过滤策略，每个BindingKey最多含有15个“.”， 即最多16个词组。", "example": "[\"ins\"]", "item_type": "string" } ], "required": [ "TopicName", "SubscriptionName" ] }, { "name": "ModifyCmqTopicAttribute", "description": "修改cmq主题属性", "status": "online", "parameters": [ { "name": "TopicName", "type": "string", "required": true, "description": "主题名字，在单个地域同一账号下唯一。主题名称是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)。", "example": "test-topic" }, { "name": "MaxMsgSize", "type": "integer", "required": false, "description": "消息最大长度。取值范围1024 - 65536 Byte（即1 - 64K），默认值65536。", "example": "1" }, { "name": "MsgRetentionSeconds", "type": "integer", "required": false, "description": "消息保存时间。取值范围60 - 86400 s（即1分钟 - 1天），默认值86400。", "example": "1" }, { "name": "Trace", "type": "boolean", "required": false, "description": "是否开启消息轨迹标识，true表示开启，false表示不开启，不填表示不开启。", "example": "false" } ], "required": [ "TopicName" ] }, { "name": "ModifyEnvironmentAttributes", "description": "修改指定命名空间的属性值", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "命名空间名称。", "example": "default" }, { "name": "MsgTTL", "type": "integer", "required": true, "description": "未消费消息过期时间，单位：秒，范围60秒~15天。", "example": "60" }, { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "pulsar-ge3n43v3wj" }, { "name": "Remark", "type": "string", "required": false, "description": "备注，字符串最长不超过128。", "example": "demo" }, { "name": "RetentionPolicy", "type": "object", "required": false, "description": "消息保留策略", "example": "无", "children": [ { "name": "TimeInMinutes", "type": "integer", "required": true, "description": "消息保留时长", "example": "0" }, { "name": "SizeInMB", "type": "integer", "required": true, "description": "消息保留大小", "example": "0" } ] }, { "name": "AutoSubscriptionCreation", "type": "boolean", "required": false, "description": "是否开启自动创建订阅", "example": "true" }, { "name": "SubscriptionExpirationTime", "type": "integer", "required": false, "description": "离线订阅过期自动清理时间", "example": "1440" }, { "name": "SubscriptionExpirationTimeEnable", "type": "boolean", "required": false, "description": "离线订阅过期自动清理时间开关", "example": "false" } ], "required": [ "EnvironmentId", "MsgTTL", "ClusterId" ] }, { "name": "ModifyEnvironmentRole", "description": "修改环境角色授权。", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境（命名空间）名称。", "example": "default" }, { "name": "RoleName", "type": "string", "required": true, "description": "角色名称。", "example": "test_role" }, { "name": "Permissions", "type": "array", "required": true, "description": "授权项，最多只能包含produce、consume两项的非空字符串数组。", "example": "[\"produce\"]", "item_type": "string" }, { "name": "ClusterId", "type": "string", "required": true, "description": "必填字段，集群的ID", "example": "pulsar-xk3ne8k2qkp8" } ], "required": [ "EnvironmentId", "RoleName", "Permissions", "ClusterId" ] }, { "name": "ModifyPublicNetworkSecurityPolicy", "description": "修改pulsar专业版公网安全策略", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群id", "example": "pulsar-47emajuiaoam" }, { "name": "PolicyList", "type": "array", "required": true, "description": "策略列表", "example": "无", "item_type": "object", "children": [ { "name": "Route", "type": "string", "required": false, "description": "ip或者网段 注意：此字段可能返回 null，表示取不到有效值。", "example": "1.1.1.1" }, { "name": "Policy", "type": "boolean", "required": false, "description": "策略 true就是允许，白名单或者 false 拒绝 黑名单 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "Remark", "type": "string", "required": false, "description": "备注 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] } ], "required": [ "InstanceId", "PolicyList" ] }, { "name": "ModifyRabbitMQPermission", "description": "修改RabbitMQ的权限", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如 amqp-xxxxxxxx。有效的 InstanceId 可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询。", "example": "amqp-2ppxx4rq" }, { "name": "User", "type": "string", "required": true, "description": "用户名，形如 admin。有效的 User 名称可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询，点击集群列表中的集群，进入集群详情，并在用户与权限页签中找到用户列表，从而找到用户名称。", "example": "admin" }, { "name": "VirtualHost", "type": "string", "required": true, "description": "VirtualHost 名称，形如 testvhost。有效的 VirtualHost 名称可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询，在左侧导航栏点击 Vhost，并在 Vhost 列表中找到Vhost名称。", "example": "testVhost" }, { "name": "ConfigRegexp", "type": "string", "required": true, "description": "权限类型，declare相关操作，该用户可操作该vhost下的资源名称正则表达式", "example": ".*" }, { "name": "WriteRegexp", "type": "string", "required": true, "description": "权限类型，消息写入相关操作，该用户可操作该vhost下的资源名称正则表达式", "example": ".*" }, { "name": "ReadRegexp", "type": "string", "required": true, "description": "权限类型，消息读取相关操作，该用户可操作该vhost下的资源名称正则表达式", "example": ".*" } ], "required": [ "InstanceId", "User", "VirtualHost", "ConfigRegexp", "WriteRegexp", "ReadRegexp" ] }, { "name": "ModifyRabbitMQUser", "description": "修改RabbitMQ的用户", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如 amqp-xxxxxxxx。有效的 InstanceId 可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询。", "example": "amqp-2ppxx4rq" }, { "name": "User", "type": "string", "required": true, "description": "用户名，形如rabbitmq。有效的 User 名称可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询，点击集群列表中的集群，进入集群详情，并在用户与权限页签中找到用户列表，从而找到用户名称。当前不支持修改admin的密码。", "example": "admin" }, { "name": "Password", "type": "string", "required": true, "description": "密码，登录时使用。规范：不能为空，8-64个字符，至少要包含小写字母、大写字母、数字、特殊字符【()`~!@#$%^\u0026*_=|{}[]:;',.?/】中的两项", "example": "abc123._" }, { "name": "Description", "type": "string", "required": false, "description": "描述，不传则不修改", "example": "production" }, { "name": "Tags", "type": "array", "required": false, "description": "用户标签，用于决定改用户访问 RabbitMQ Management 的权限范围 management：普通控制台用户，monitoring：管理型控制台用户，其他值：非控制台用户", "example": "monitoring", "item_type": "string" }, { "name": "MaxConnections", "type": "integer", "required": false, "description": "该用户的最大连接数，不传则不修改", "example": "1000" }, { "name": "MaxChannels", "type": "integer", "required": false, "description": "该用户的最大channel数，不传则不修改", "example": "2000" } ], "required": [ "InstanceId", "User", "Password" ] }, { "name": "ModifyRabbitMQVipInstance", "description": "修改RabbitMQ专享版实例", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id", "example": "amqp-jero744g" }, { "name": "ClusterName", "type": "string", "required": false, "description": "集群名称，不填则不修改。非空字符串时必须 3-64 个字符，只能包含数字、字母、“-”和“_”", "example": "prod_rabbitmq" }, { "name": "Remark", "type": "string", "required": false, "description": "备注，不填则不修改", "example": "生产使用集群" }, { "name": "EnableDeletionProtection", "type": "boolean", "required": false, "description": "是否开启删除保护，不填则不修改", "example": "false" }, { "name": "RemoveAllTags", "type": "boolean", "required": false, "description": "是否删除所有标签，默认为false", "example": "false" }, { "name": "Tags", "type": "array", "required": false, "description": "修改实例的标签信息，全量标签信息，非增量", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签的key的值 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_tag_key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签的Value的值 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_tag_value1" } ] }, { "name": "EnableRiskWarning", "type": "boolean", "required": false, "description": "是否开启集群风险提示", "example": "true" } ], "required": [ "InstanceId" ] }, { "name": "ModifyRabbitMQVirtualHost", "description": "修改RabbitMQ的vhost", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如amqp-xxxxxxxx。有效的 InstanceId 可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询。", "example": "amqp-2ppxx4rq" }, { "name": "VirtualHost", "type": "string", "required": true, "description": "VirtualHost 名称，形如 testvhost。有效的 VirtualHost 名称可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询，在左侧导航栏点击 Vhost，并在 Vhost 列表中找到Vhost名称。", "example": "testVhost" }, { "name": "Description", "type": "string", "required": false, "description": "Virtual Host 描述", "example": "For testing" }, { "name": "TraceFlag", "type": "boolean", "required": false, "description": "消息轨迹开关,true打开,false关闭", "example": "false" } ], "required": [ "InstanceId", "VirtualHost" ] }, { "name": "ModifyRocketMQCluster", "description": "修改 RocketMQ 集群属性。 当前 API 适用集群：4.x 虚拟集群。修改 4.x 专享或通用集群属性接口文档见 [ModifyRocketMQInstance](https://cloud.tencent.com/document/api/1179/108862)，修改 5.x 集群属性的接口文档见 [ModifyInstance](https://cloud.tencent.com/document/api/1493/97865)。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "RocketMQ集群ID", "example": "rocketmq-a52qova7x97b" }, { "name": "ClusterName", "type": "string", "required": false, "description": "3-64个字符，只能包含字母、数字、“-”及“_”", "example": "test_name" }, { "name": "Remark", "type": "string", "required": false, "description": "说明信息，不超过128个字符", "example": "remark info" }, { "name": "PublicAccessEnabled", "type": "boolean", "required": false, "description": "是否开启HTTP公网访问", "example": "false" } ], "required": [ "ClusterId" ] }, { "name": "ModifyRocketMQEnvironmentRole", "description": "修改角色授权。 当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群的修改角色接口文档见 [ModifyRole](https://cloud.tencent.com/document/api/1493/98861)。", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "命名空间，4.x 通用集群命名空间固定为: tdmq_default", "example": "test_namespace" }, { "name": "RoleName", "type": "string", "required": true, "description": "角色名称。", "example": "test_role_name" }, { "name": "Permissions", "type": "array", "required": true, "description": "授权项，最多只能包含produce、consume两项的非空字符串数组。", "example": "[\"produce\"]", "item_type": "string" }, { "name": "ClusterId", "type": "string", "required": true, "description": "必填字段，集群的ID", "example": "rocketmq-2p9vx3ax9jxg" }, { "name": "DetailedPerms", "type": "array", "required": false, "description": "Topic\u0026Group维度权限配置", "example": "无", "item_type": "object", "children": [ { "name": "Resource", "type": "string", "required": true, "description": "权限对应的资源", "example": "test_topic" }, { "name": "PermWrite", "type": "boolean", "required": true, "description": "是否开启生产权限", "example": "true" }, { "name": "PermRead", "type": "boolean", "required": true, "description": "是否开启消费权限", "example": "false" }, { "name": "ResourceType", "type": "string", "required": true, "description": "授权资源类型，枚举值如下： - Topic：主题维度 - Group：消费组维度 - Cluster：集群维度（默认值）", "example": "Topic" }, { "name": "Remark", "type": "string", "required": false, "description": "资源备注", "example": "test remark info." } ] } ], "required": [ "EnvironmentId", "RoleName", "Permissions", "ClusterId" ] }, { "name": "ModifyRocketMQGroup", "description": "修改 RocketMQ 消费组属性。 当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。修改 5.x 集群消费组属性的接口文档见 [ModifyConsumerGroup](https://cloud.tencent.com/document/api/1493/97940)。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "rocketmq-2p9vx3ax9jxg" }, { "name": "NamespaceId", "type": "string", "required": true, "description": "消费组所在的命名空间，4.x 通用集群命名空间固定为: tdmq_default", "example": "test_namespace" }, { "name": "GroupId", "type": "string", "required": true, "description": "消费组名称", "example": "test_group" }, { "name": "Remark", "type": "string", "required": false, "description": "说明信息，最长128个字符", "example": "测试消费组" }, { "name": "ReadEnable", "type": "boolean", "required": false, "description": "是否开启消费", "example": "true" }, { "name": "BroadcastEnable", "type": "boolean", "required": false, "description": "是否开启广播消费", "example": "true" }, { "name": "RetryMaxTimes", "type": "integer", "required": false, "description": "最大重试次数", "example": "16" } ], "required": [ "ClusterId", "NamespaceId", "GroupId" ] }, { "name": "ModifyRocketMQInstance", "description": "修改 RocketMQ 专享或通用集群属性。 当前 API 适用集群：4.x 专享集群 和 4.x 通用集群。修改 5.x 集群属性的接口文档见 [ModifyInstance](https://cloud.tencent.com/document/api/1493/97865)。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "专享实例ID", "example": "rocketmq-4k4orqgq" }, { "name": "Name", "type": "string", "required": false, "description": "实例名称", "example": "order-service-instance" }, { "name": "Remark", "type": "string", "required": false, "description": "实例备注信息", "example": "info-mark" }, { "name": "MessageRetention", "type": "integer", "required": false, "description": "实例消息保留时间，小时为单位", "example": "72" }, { "name": "EnableDeletionProtection", "type": "boolean", "required": false, "description": "是否开启删除保护", "example": "false" }, { "name": "SendReceiveRatio", "type": "float", "required": false, "description": "控制生产和消费消息的 TPS 占比，取值范围0～1，默认值为0.5", "example": "0.6" } ], "required": [ "InstanceId" ] }, { "name": "ModifyRocketMQInstanceSpec", "description": "修改 RocketMQ 专享集群配置，可以支持实例规格、节点数和存储的升配和实例规格的降配。本 API 发起订单并成功支付后进入实例配置变更的流程，可通过 [DescribeRocketMQVipInstances](https://cloud.tencent.com/document/api/1179/80903) 查询实例是否已变更完成。 当前 API 适用集群：4.x 专享集群 和 4.x 通用集群。修改 5.x 集群规格的接口文档见 [ModifyInstance](https://cloud.tencent.com/document/api/1493/97865)。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "专享实例ID", "example": "rocketmq-4k4orqgq" }, { "name": "Specification", "type": "string", "required": false, "description": "实例规格， rocket-vip-basic-1 基础型 rocket-vip-basic-2 标准型 rocket-vip-basic-3 高阶Ⅰ型 rocket-vip-basic-4 高阶Ⅱ型", "example": "rocket-vip-basic-1" }, { "name": "NodeCount", "type": "integer", "required": false, "description": "节点数量", "example": "2" }, { "name": "StorageSize", "type": "integer", "required": false, "description": "存储空间，GB为单位", "example": "1000" } ], "required": [ "InstanceId" ] }, { "name": "ModifyRocketMQNamespace", "description": "更新 RocketMQ 命名空间。 当前 API 适用集群：4.x 虚拟集群和 4.x 专享集群，其他集群类型均不支持该功能。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "rocketmq-4k4orqgq" }, { "name": "NamespaceId", "type": "string", "required": true, "description": "命名空间名称，3-64个字符，只能包含字母、数字、“-”及“_”", "example": "prod" }, { "name": "Ttl", "type": "integer", "required": false, "description": "已废弃", "example": "100000" }, { "name": "RetentionTime", "type": "integer", "required": false, "description": "已废弃", "example": "100000" }, { "name": "Remark", "type": "string", "required": false, "description": "说明，最大128个字符", "example": "info-remark" }, { "name": "PublicAccessEnabled", "type": "boolean", "required": false, "description": "是否开启公网访问", "example": "false" } ], "required": [ "ClusterId", "NamespaceId" ] }, { "name": "ModifyRocketMQRole", "description": "修改角色。 当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群的修改角色接口文档见 [ModifyRole](https://cloud.tencent.com/document/api/1493/98861)。", "status": "online", "parameters": [ { "name": "RoleName", "type": "string", "required": true, "description": "角色名称，不支持中字以及除了短线和下划线外的特殊字符且长度必须大于0且小等于32。", "example": "test_role_name" }, { "name": "ClusterId", "type": "string", "required": true, "description": "必填字段，集群Id", "example": "rocketmq-2p9vx3ax9jxg" }, { "name": "Remark", "type": "string", "required": false, "description": "备注说明，长度必须大等于0且小等于128。", "example": "测试修改" }, { "name": "PermType", "type": "string", "required": false, "description": "权限类型，默认按集群授权（Cluster：集群级别；TopicAndGroup：主题\u0026消费组级别）", "example": "Cluster" } ], "required": [ "RoleName", "ClusterId" ] }, { "name": "ModifyRocketMQTopic", "description": "修改 RocketMQ 主题属性。 当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。修改 5.x 集群主题属性的接口文档见 [ModifyTopic](https://cloud.tencent.com/document/api/1493/97944)。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "rocketmq-2p9vx3ax9jxg" }, { "name": "NamespaceId", "type": "string", "required": true, "description": "主题所在的命名空间，4.x 通用集群命名空间固定为: tdmq_default", "example": "test_namespace" }, { "name": "Topic", "type": "string", "required": true, "description": "主题名称", "example": "test_topic" }, { "name": "Remark", "type": "string", "required": true, "description": "说明信息，最大128个字符", "example": "测试修改" }, { "name": "PartitionNum", "type": "integer", "required": false, "description": "分区数，全局类型无效，不可小于当前分区数", "example": "3" } ], "required": [ "ClusterId", "NamespaceId", "Topic", "Remark" ] }, { "name": "ModifyRole", "description": "角色修改", "status": "online", "parameters": [ { "name": "RoleName", "type": "string", "required": true, "description": "角色名称，不支持中字以及除了短线和下划线外的特殊字符且长度必须大于0且小等于32。", "example": "test_role" }, { "name": "ClusterId", "type": "string", "required": true, "description": "必填字段，集群Id", "example": "pulsar-xk3ne8k2qkp8" }, { "name": "Remark", "type": "string", "required": false, "description": "备注说明，长度必须大等于0且小等于128。", "example": "更新角色" }, { "name": "EnvironmentRoleSets", "type": "array", "required": false, "description": "批量绑定名字空间信息", "example": "无", "item_type": "object", "children": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "需要绑定的命名空间Id，不重复且存在资源 注意：此字段可能返回 null，表示取不到有效值。", "example": "devNs" }, { "name": "Permissions", "type": "array", "required": true, "description": "名字空间需要绑定的权限，枚举为 \"consume\" \"produce\" 组合，但是不为空 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"produce\"]", "item_type": "string" } ] }, { "name": "UnbindAllEnvironment", "type": "boolean", "required": false, "description": "全部解绑名字空间，设置为 true", "example": "false" } ], "required": [ "RoleName", "ClusterId" ] }, { "name": "ModifyTopic", "description": "修改主题备注和分区数", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境（命名空间）名称。", "example": "default" }, { "name": "TopicName", "type": "string", "required": true, "description": "主题名。", "example": "test_topic" }, { "name": "Partitions", "type": "integer", "required": true, "description": "分区数，必须大于或者等于原分区数，若想维持原分区数请输入原数目，修改分区数仅对非全局顺序消息起效果，不允许超过32个分区。", "example": "3" }, { "name": "ClusterId", "type": "string", "required": true, "description": "Pulsar 集群的ID", "example": "pulsar-5r59xd4vnx" }, { "name": "Remark", "type": "string", "required": false, "description": "备注，128字符以内。", "example": "修改分区为3" }, { "name": "MsgTTL", "type": "integer", "required": false, "description": "未消费消息过期时间，单位：秒，取值范围：60秒~15天。", "example": "60" }, { "name": "UnackPolicy", "type": "string", "required": false, "description": "不传默认是原生策略，DefaultPolicy表示当订阅下达到最大未确认消息数 5000 时，服务端将不再向当前订阅下的所有消费者推送消息，DynamicPolicy表示动态调整订阅下的最大未确认消息数，具体配额是在 5000 和消费者数量*20之间取最大值。每个消费者默认最大 unack 消息数为 20，超过该限制时仅影响该消费者，不影响其他消费者。", "example": "DefaultPolicy" }, { "name": "IsolateConsumerEnable", "type": "boolean", "required": false, "description": "是否开启异常消费者隔离", "example": "true" }, { "name": "AckTimeOut", "type": "integer", "required": false, "description": "消费者 Ack 超时时间，单位：秒，范围60-（3600*24", "example": "60" }, { "name": "DelayMessagePolicy", "type": "string", "required": false, "description": "defaultPolicy/timingwheelPolicy不传默认是社区版本延迟消息策略", "example": "defaultPolicy" } ], "required": [ "EnvironmentId", "TopicName", "Partitions", "ClusterId" ] }, { "name": "PublishCmqMsg", "description": "发送cmq主题消息", "status": "online", "parameters": [ { "name": "TopicName", "type": "string", "required": true, "description": "主题名", "example": "topic123" }, { "name": "MsgContent", "type": "string", "required": true, "description": "消息内容，消息总大小需不大于1024K", "example": "testmessage" }, { "name": "MsgTag", "type": "array", "required": false, "description": "消息标签，支持传递多标签或单路由，单个标签、路由长度不能超过64个字符。", "example": "[\"a\"]", "item_type": "string" } ], "required": [ "TopicName", "MsgContent" ] }, { "name": "ReceiveMessage", "description": "当前 ReceiveMessage 接口只支持 Partitioned 类型的 Topic。该接口用于接收发送到指定 Partitioned Topic 中的消息，当 Partitioned Topic 中没有消息但还去尝试调用该接口时，会抛出 ReceiveTimeout 的异常。 如何使用 BatchReceivePolicy： BatchReceive 接口提供了如下三个参数： ● MaxNumMessages: 即每次使用 BatchReceive 的时候，最多一次Receive接口返回多少条消息。 ● MaxNumBytes：即每次使用 BatchReceive 的时\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "Topic", "type": "string", "required": true, "description": "接收消息的topic的名字, 这里尽量需要使用topic的全路径，如果不指定，即：tenant/namespace/topic。默认使用的是：public/default", "example": "persistent://tenant/namespace/my-topic" }, { "name": "SubscriptionName", "type": "string", "required": true, "description": "订阅者的名字", "example": "my-sub" }, { "name": "ReceiverQueueSize", "type": "integer", "required": false, "description": "默认值为1000，consumer接收的消息会首先存储到receiverQueueSize这个队列中，用作调优接收消息的速率", "example": "1000" }, { "name": "SubInitialPosition", "type": "string", "required": false, "description": "默认值为：Earliest。用作判定consumer初始接收消息的位置，可选参数为：Earliest, Latest", "example": "Latest" }, { "name": "MaxNumMessages", "type": "integer", "required": false, "description": "用于设置BatchReceivePolicy，指在一次batch中最多接收多少条消息，默认是 0。即不开启BatchReceivePolicy", "example": "100" }, { "name": "MaxNumBytes", "type": "integer", "required": false, "description": "用于设置BatchReceivePolicy，指在一次batch中最多接收的消息体有多大，单位是 bytes。默认是 0，即不开启BatchReceivePolicy", "example": "100000" }, { "name": "Timeout", "type": "integer", "required": false, "description": "用于设置BatchReceivePolicy，指在一次batch消息的接收z中最多等待的超时时间，单位是毫秒。默认是 0，即不开启BatchReceivePolicy", "example": "100" } ], "required": [ "Topic", "SubscriptionName" ] }, { "name": "ResetMsgSubOffsetByTimestamp", "description": "根据时间戳进行消息回溯，精确到毫秒", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "命名空间名称。", "example": "default" }, { "name": "TopicName", "type": "string", "required": true, "description": "主题名称。", "example": "topic" }, { "name": "Subscription", "type": "string", "required": true, "description": "订阅者名称。", "example": "subscription" }, { "name": "ToTimestamp", "type": "integer", "required": true, "description": "时间戳，精确到毫秒。", "example": "1730690396152" }, { "name": "ClusterId", "type": "string", "required": true, "description": "Pulsar 集群的ID", "example": "pulsar-ge3n43v3wj" } ], "required": [ "EnvironmentId", "TopicName", "Subscription", "ToTimestamp", "ClusterId" ] }, { "name": "ResetRocketMQConsumerOffSet", "description": "重置消费位点。 当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群的重置消费位点接口文档见 [ResetConsumerGroupOffset](https://cloud.tencent.com/document/api/1493/116942)。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "rocketmq-2p9vx3ax9jxg" }, { "name": "NamespaceId", "type": "string", "required": true, "description": "命名空间，4.x 通用集群命名空间固定为: tdmq_default", "example": "test_namespace" }, { "name": "GroupId", "type": "string", "required": true, "description": "消费组名称", "example": "test_group" }, { "name": "Type", "type": "integer", "required": true, "description": "重置方式，0表示从最新位点开始，1表示从指定时间点开始", "example": "1" }, { "name": "Topic", "type": "string", "required": false, "description": "主题名称", "example": "test_topic" }, { "name": "ResetTimestamp", "type": "integer", "required": false, "description": "重置指定的时间戳，仅在 Type 为1时生效，以毫秒为单位", "example": "1697945990000" }, { "name": "RetryFlag", "type": "boolean", "required": false, "description": "重置的是否是retry topic", "example": "false" } ], "required": [ "ClusterId", "NamespaceId", "GroupId", "Type" ] }, { "name": "RetryRocketMQDlqMessage", "description": "重发 RocketMQ 死信消息。 当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群的重发死信消息接口文档见 [ResendDeadLetterMessage](https://cloud.tencent.com/document/api/1493/114592)。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群id", "example": "rocketmq-a52qova7x97b" }, { "name": "NamespaceId", "type": "string", "required": true, "description": "命名空间，4.x 通用集群命名空间固定为: tdmq_default", "example": "test_ns" }, { "name": "GroupName", "type": "string", "required": true, "description": "group名称", "example": "test_group" }, { "name": "MessageIds", "type": "array", "required": true, "description": "死信消息ID", "example": "[\"01963F0B14BAF09F27077D244F00000000\"]", "item_type": "string" } ], "required": [ "ClusterId", "NamespaceId", "GroupName", "MessageIds" ] }, { "name": "RewindCmqQueue", "description": "回溯cmq队列", "status": "online", "parameters": [ { "name": "QueueName", "type": "string", "required": true, "description": "队列名字，在单个地域同一账号下唯一。队列名称是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)。", "example": "test-queue" }, { "name": "StartConsumeTime", "type": "integer", "required": true, "description": "设定该时间，则（Batch）receiveMessage接口，会按照生产消息的先后顺序消费该时间戳以后的消息。", "example": "1582108595000" } ], "required": [ "QueueName", "StartConsumeTime" ] }, { "name": "SendBatchMessages", "description": "批量发送消息 注意：TDMQ 批量发送消息的接口是在 TDMQ-HTTP 的服务侧将消息打包为一个 Batch，然后将该 Batch 在服务内部当作一次 TCP 请求发送出去。所以在使用过程中，用户还是按照单条消息发送的逻辑，每一条消息是一个独立的 HTTP 的请求，在 TDMQ-HTTP 的服务内部，会将多个 HTTP 的请求聚合为一个 Batch 发送到服务端。即，批量发送消息在使用上与发送单条消息是一致的，batch ...", "status": "online", "parameters": [ { "name": "Topic", "type": "string", "required": true, "description": "消息要发送的topic的名字, 这里尽量需要使用topic的全路径，即：tenant/namespace/topic。如果不指定，默认使用的是：public/default", "example": "persistent://tenant/namespace/my-topic" }, { "name": "Payload", "type": "string", "required": true, "description": "需要发送消息的内容", "example": "hello tdmq" }, { "name": "StringToken", "type": "string", "required": false, "description": "String 类型的 token，可以不填，系统会自动获取", "example": "abcdefghijklmnopqrstovwxyz" }, { "name": "ProducerName", "type": "string", "required": false, "description": "producer 的名字，要求全局是唯一的，如果不设置，系统会自动生成", "example": "producer1" }, { "name": "SendTimeout", "type": "integer", "required": false, "description": "单位：s。消息发送的超时时间。默认值为：30s", "example": "30" }, { "name": "MaxPendingMessages", "type": "integer", "required": false, "description": "内存中允许缓存的生产消息的最大数量，默认值：1000条", "example": "1000" }, { "name": "BatchingMaxMessages", "type": "integer", "required": false, "description": "每一个batch中消息的最大数量，默认值：1000条/batch", "example": "1000" }, { "name": "BatchingMaxPublishDelay", "type": "integer", "required": false, "description": "每一个batch最大等待的时间，超过这个时间，不管是否达到指定的batch中消息的数量和大小，都会将该batch发送出去，默认：10ms", "example": "10L" }, { "name": "BatchingMaxBytes", "type": "integer", "required": false, "description": "每一个batch中最大允许的消息的大小，默认：128KB", "example": "128*1024" } ], "required": [ "Topic", "Payload" ] }, { "name": "SendCmqMsg", "description": "发送cmq消息", "status": "online", "parameters": [ { "name": "QueueName", "type": "string", "required": true, "description": "队列名", "example": "test-queue" }, { "name": "MsgContent", "type": "string", "required": true, "description": "消息内容", "example": "testmessage" }, { "name": "DelaySeconds", "type": "integer", "required": true, "description": "延迟时间。单位为秒，默认值为0秒，最大不能超过队列配置的消息最长未确认时间。", "example": "100" } ], "required": [ "QueueName", "MsgContent", "DelaySeconds" ] }, { "name": "SendMessages", "description": "发送单条消息 不支持持久topic", "status": "online", "parameters": [ { "name": "Topic", "type": "string", "required": true, "description": "消息要发送的topic的名字, 这里尽量需要使用topic的全路径，即：tenant/namespace/topic。如果不指定，默认使用的是：public/default", "example": "persistent://tenant/namespaces/my-topic" }, { "name": "Payload", "type": "string", "required": true, "description": "要发送的消息的内容", "example": "hello tdmq" }, { "name": "StringToken", "type": "string", "required": false, "description": "Token 是用来做鉴权使用的，可以不填，系统会自动获取", "example": "abcdefghijklmnopqrstovwxyz" }, { "name": "ProducerName", "type": "string", "required": false, "description": "设置 producer 的名字，要求全局唯一。该参数建议用户无需手动配置，此时系统会随机生成，如果手动设置有可能会造成创建 Producer 失败进而导致消息发送失败。 该参数主要用于某些特定场景下，只允许特定的 Producer 生产消息时设置，用户的大部分场景使用不到该特性。", "example": "producer" }, { "name": "SendTimeout", "type": "integer", "required": false, "description": "设置消息发送的超时时间，默认为30s", "example": "30" }, { "name": "MaxPendingMessages", "type": "integer", "required": false, "description": "内存中缓存的最大的生产消息的数量，默认为1000条", "example": "1000" } ], "required": [ "Topic", "Payload" ] }, { "name": "SendMsg", "description": "此接口仅用于测试发生消息，不能作为现网正式生产使用", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境（命名空间）名称。", "example": "userNamespace" }, { "name": "TopicName", "type": "string", "required": true, "description": "主题名称，如果是分区topic需要指定具体分区，如果没有指定则默认发到0分区，例如：my_topic-partition-0。", "example": "cloud_test" }, { "name": "MsgContent", "type": "string", "required": true, "description": "消息内容，不能为空且大小不得大于5242880个byte。", "example": "one_msg" }, { "name": "ClusterId", "type": "string", "required": false, "description": "Pulsar 集群的ID", "example": "pulsar-k3ex2kxanuol" } ], "required": [ "EnvironmentId", "TopicName", "MsgContent" ] }, { "name": "SendRocketMQMessage", "description": "发送 RocketMQ 消息，该接口仅用于控制台发送少量测试消息，不保证SLA，且云 API 存在限流，在真实业务场景下，请使用 RocketMQ SDK 发送消息。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群id", "example": "rocketmq-4k4orqgq" }, { "name": "NamespaceId", "type": "string", "required": true, "description": "命名空间", "example": "test_namespace" }, { "name": "TopicName", "type": "string", "required": true, "description": "topic名称", "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": [ "ClusterId", "NamespaceId", "TopicName", "MsgBody" ] }, { "name": "SetRocketMQPublicAccessPoint", "description": "开启或关闭公网访问、设置安全访问策略。 当前 API 适用集群：4.x 专享集群 和 4.x 通用集群。设置 5.x 集群的公网接入点接口文档见 [ModifyInstanceEndpoint](https://cloud.tencent.com/document/api/1493/115981)。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群ID，当前只支持专享集群", "example": "rocketmq-a52qova7x97b" }, { "name": "Enabled", "type": "boolean", "required": true, "description": "开启或关闭访问", "example": "true" }, { "name": "Bandwidth", "type": "integer", "required": false, "description": "带宽大小，开启或者调整公网时必须指定，Mbps为单位", "example": "2" }, { "name": "PayMode", "type": "integer", "required": false, "description": "付费模式，开启公网时必须指定，0为按小时计费，1为包年包月，当前只支持按小时计费", "example": "0" }, { "name": "Rules", "type": "array", "required": false, "description": "公网访问安全规则列表，Enabled为true时必须传入", "example": "无", "item_type": "object", "children": [ { "name": "IpRule", "type": "string", "required": true, "description": "ip网段信息", "example": "0.0.0.0/0" }, { "name": "Allow", "type": "boolean", "required": true, "description": "允许或者拒绝", "example": "true" }, { "name": "Remark", "type": "string", "required": false, "description": "备注信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "test remark info" } ] }, { "name": "BillingFlow", "type": "boolean", "required": false, "description": "公网是否按流量计费", "example": "false" } ], "required": [ "InstanceId", "Enabled" ] }, { "name": "UnbindCmqDeadLetter", "description": "解绑cmq死信队列", "status": "online", "parameters": [ { "name": "SourceQueueName", "type": "string", "required": true, "description": "死信策略源队列名称，调用本接口会清空该队列的死信队列策略。", "example": "test-queue" } ], "required": [ "SourceQueueName" ] }, { "name": "VerifyRocketMQConsume", "description": "Rocketmq消费验证", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群id", "example": "rocketmq-4k4orqgq" }, { "name": "NamespaceId", "type": "string", "required": true, "description": "命名空间", "example": "test_namespace" }, { "name": "GroupId", "type": "string", "required": true, "description": "消费组ID", "example": "test_group" }, { "name": "MsgId", "type": "string", "required": true, "description": "消息id", "example": "092BAE5A1656070DEA4E276DF0760089" }, { "name": "ClientId", "type": "string", "required": true, "description": "客户端ID", "example": "127.0.0.1@25760#13749780392400" }, { "name": "TopicName", "type": "string", "required": true, "description": "主题名称", "example": "test_topic" } ], "required": [ "ClusterId", "NamespaceId", "GroupId", "MsgId", "ClientId", "TopicName" ] } ] }