更新时间：2025-09-03 GMT+08:00
创建用户/客户端流控配置
功能介绍
该接口用于向Kafka实例提交创建用户、客户端级别的流控任务，若成功则返回流控任务的job_id。
URI
POST /v2/kafka/{project_id}/instances/{instance_id}/kafka-user-client-quota
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
instance_id |
是 |
String |
实例ID。 |
|
project_id |
是 |
String |
项目ID，获取方式请参见获取项目ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
user |
否 |
String |
用户名。 不对全部用户/客户端限流时，用户名和客户端ID不能同时为空。 |
|
client |
否 |
String |
客户端ID。 不对全部用户/客户端限流时，用户名和客户端ID不能同时为空。 |
|
user-default |
否 |
Boolean |
是否使用用户默认设置。
|
|
client-default |
否 |
Boolean |
是否使用客户端默认设置。
|
|
producer-byte-rate |
否 |
Long |
生产上限速率（单位为B/s）。 |
|
consumer-byte-rate |
否 |
Long |
消费上限速率（单位为B/s）。
说明：
“生产上限速率”和“消费上限速率”不可同时为空。
|
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
job_id |
String |
创建流控配置的任务ID |
请求示例
创建用户/客户端流控配置。
POST 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" : "ff8080828bdc0f64018bdcadfd8f00d7"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
创建用户/客户端流控配置成功。 |
错误码
请参见错误码。
父主题： 实例管理
