更新时间：2025-09-03 GMT+08:00
查询Topic流控配置
功能介绍
该接口用于查询Topic级别的流控任务。
URI
GET /v2/kafka/{project_id}/instances/{instance_id}/kafka-topic-quota
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
instance_id |
是 |
String |
参数解释： 实例ID。获取方法如下：调用“查询所有实例列表”接口，从响应体中获取实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
project_id |
是 |
String |
参数解释： 项目ID，获取方式请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
type |
否 |
String |
参数解释： 查询类型。 约束限制： 查询类型必须以字母开头且只支持大小写字母、中横线、下划线以及数字。 取值范围： 默认为topic 默认取值： topic |
|
limit |
否 |
String |
参数解释： 每一页显示的流控数量。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
offset |
否 |
String |
参数解释： 页数。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
keyword |
否 |
String |
参数解释： 查询关键字。 约束限制： 查询关键字必须以字母开头且只支持大小写字母、中横线、下划线以及数字。 取值范围： 不涉及。 默认取值： 不涉及。 |
请求参数
无
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
quotas |
Array of KafkaTopicQuota objects |
Topic流控配置 |
|
count |
Integer |
Topic流控数量 |
请求示例
查询Topic流控配置。
GET https://{endpoint}/v2/{engine}/{project_d}/instances/{instance_id}/kafka-user-client-quota?type=topic&offset=0&limit=10&keyword=topic-02
响应示例
状态码：200
查询Topic流控配置成功。
{
"quotas" : [ {
"topic" : "topic-001",
"producer-byte-rate" : 1024,
"consumer-byte-rate" : 2048
} ],
"count" : 1
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询Topic流控配置成功。 |
错误码
请参见错误码。
父主题： 主题管理
