更新时间:2025-12-29 GMT+08:00
修改Topic流控配置
功能介绍
该接口用于向Kafka实例提交修改Topic级别的流控任务,若成功则返回流控任务的job_id。
URI
PUT /v2/kafka/{project_id}/instances/{instance_id}/kafka-topic-quota
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| instance_id | 是 | String | 参数解释: 实例ID。获取方法如下:调用“查询所有实例列表”接口,从响应体中获取实例ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| project_id | 是 | String | 参数解释: 项目ID,获取方式请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| topic | 否 | String | Topic名称 |
| producer_byte_rate | 否 | Integer | 生产者速率 |
| consumer_byte_rate | 否 | Integer | 消费者速率 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| job_id | String | 流控配置的任务ID |
请求示例
修改Topic流控配置。
PUT https://{endpoint}/v2/kafka/{project_id}/instances/{instance_id}/kafka-topic-quota
{
"topic" : "topic-001",
"producer_byte_rate" : 1024,
"consumer_byte_rate" : 2048
} 响应示例
状态码:200
修改Topic流控配置成功。
{
"job_id" : "ff8080828bdc0f64018bdcadfd8f00d7"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 修改Topic流控配置成功。 |
错误码
请参见错误码。
父主题: 主题管理