文档首页/ 分布式消息服务Kafka版/ API参考（联盟区域）/ API V2（推荐）/ 实例管理/ 修改用户/客户端流控配置
更新时间：2025-12-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

修改用户/客户端流控配置

功能介绍

该接口用于向Kafka实例提交修改用户、客户端级别的流控任务，若成功则返回流控任务的job_id。

URI

PUT /v2/kafka/{project_id}/instances/{instance_id}/kafka-user-client-quota

表1 路径参数

参数

是否必选

参数类型

描述

instance_id

是

String

实例ID。

project_id

是

String

项目ID，获取方式请参见获取项目ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

user

否

String

用户名。

不对全部用户/客户端限流时，用户名和客户端ID不能同时为空。

client

否

String

客户端ID。

不对全部用户/客户端限流时，用户名和客户端ID不能同时为空。

user_default

否

Boolean

是否使用用户默认设置。

  • 是：表示对全部用户限流。此时不能同时设置用户名。

  • 否：表示对特定用户限流。此时需要设置用户名。

client_default

否

Boolean

是否使用客户端默认设置。

  • 是：表示对全部客户端限流。此时不能设置客户端ID。

  • 否：表示对特定客户端限流。此时需要设置客户端ID。

producer_byte_rate

否

Long

生产上限速率（单位为B/s）。

consumer_byte_rate

否

Long

消费上限速率（单位为B/s）。

说明：
“生产上限速率”和“消费上限速率”不可同时为空。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

job_id

String

修改流控配置的任务ID

请求示例

修改用户/客户端流控配置。

PUT https://{endpoint}/v2/kafka/{project_id}/instances/{instance_id}/kafka-user-client-quota

{
  "user" : "",
  "client" : "",
  "user_default" : false,
  "client_default" : true,
  "producer_byte_rate" : 3145728,
  "consumer_byte_rate" : 2097152
}

响应示例

状态码：200

修改用户/客户端流配置成功。

{
  "job_id" : "8abfa7b38ba79a20018ba9afc550576a"
}

状态码

状态码

描述

200

修改用户/客户端流配置成功。

错误码

请参见错误码。

父主题： 实例管理