帮你快速理解、总结文档立即下载
文档中心>消息队列 CKafka 版>API 文档>其他接口>批量创建限流规则

批量创建限流规则

最近更新时间：2026-08-06 01:19:51
我的收藏

本页目录：

1. 接口描述

接口请求域名： ckafka.tencentcloudapi.com 。

实例限流规则相关接口

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：CreateThrottleRule。
Version 是 String 公共参数，本接口取值：2019-08-19。
Region 是 String 公共参数，详见产品支持的 地域列表。
InstanceId 是 String

实例Id


示例值：ckafka-test
ThrottleType 是 Integer

限流类型:

枚举值：

  • 1： 用户/客户端限流
  • 2： 消费组维度限流
  • 3： Topic限流

示例值：1
GroupNameList.N 否 Array of String

消费组名


示例值：["group-test"]
ConsumeThrottle 否 Integer

消费限流值,生产消费限流值,必填一个单位MB/s


示例值：100
ProduceThrottle 否 Integer

生产限流值,生产消费限流值,单位MB/s


示例值：20
ClientIdList.N 否 Array of String

用户客户端id


示例值：["client-test"]
UserNameList.N 否 Array of String

用户名


示例值：["user-test"]
TopicNameList.N 否 Array of String

topic名称


示例值：["topic-test"]

3. 输出参数

参数名称 类型 描述
Result JgwOperateResponse

返回信息
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建实例限流规则接口

创建实例限流规则接口

输入示例

POST / HTTP/1.1
Host: ckafka.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateThrottleRule
<公共请求参数>

{
    "InstanceId": "ckafka-o9gv345o",
    "GroupNameList": [
        "test5"
    ],
    "ConsumeThrottle": 15,
    "ThrottleType": 2
}

输出示例

{
    "Response": {
        "RequestId": "58d37b32-3288-4856-b539-3c7c399b74f9",
        "Result": {
            "Data": {
                "FlowId": 0
            },
            "ReturnCode": "0",
            "ReturnMessage": "apply ok"
        }
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation 操作失败。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
ResourceNotFound 资源不存在。
中国站