文档首页/ 分布式消息服务Kafka版/ API参考/ API V2(推荐)/ 用户管理/ 查询用户/客户端流控配置 - ShowKafkaUserClientQuota
更新时间:2026-07-15 GMT+08:00
分享

查询用户/客户端流控配置 - ShowKafkaUserClientQuota

功能介绍

该接口用于向Kafka实例查询流控的配置,若成功则返回流控配置的列表。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    dms:instance:getClientQuota

    Read

    kafka

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId

    dms:instance:get

    -

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID,获取方式请参见获取项目ID

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

instance_id

String

参数解释

实例ID。获取方法如下:调用“查询所有实例列表”接口,从响应体中获取实例ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

参数解释

分页查询偏移量,表示从此偏移量开始查询。

约束限制

不涉及。

取值范围

大于等于0。

默认取值

0。

limit

Integer

参数解释

分页查询单页数量。

约束限制

不涉及。

取值范围

0~100。

默认取值

10。

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

quotas

Array of QuotaResp objects

参数解释

客户端流控配置列表。

count

Integer

参数解释

用户/客户端流控配置数目。

取值范围

不涉及。

表4 QuotaResp

参数

参数类型

描述

user

String

参数解释

用户名。

取值范围

不涉及。

client

String

参数解释

客户端ID。

取值范围

不涉及。

user-default

Boolean

参数解释

是否使用用户默认设置。

取值范围

  • true:表示对全部用户限流。

  • false:表示对特定用户限流。

client-default

Boolean

参数解释

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

取值范围

  • true:表示对全部客户端限流。

  • false:表示对特定客户端限流。

producer-byte-rate

Long

参数解释

生产上限速率(单位为B/s)。

取值范围

不涉及。

consumer-byte-rate

Long

参数解释

消费上限速率(单位为B/s)。

取值范围

不涉及。

请求示例

查询用户/客户端流控配置。

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

响应示例

状态码:200

查询客户端流控配置成功。

{
  "quotas" : [ {
    "user" : "test",
    "client" : null,
    "user-default" : false,
    "client-default" : true,
    "producer-byte-rate" : 2097152,
    "consumer-byte-rate" : 2097152
  } ],
  "count" : 1
}

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.kafka.v2.region.KafkaRegion;
import com.huaweicloud.sdk.kafka.v2.*;
import com.huaweicloud.sdk.kafka.v2.model.*;


public class ShowKafkaUserClientQuotaSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        KafkaClient client = KafkaClient.newBuilder()
                .withCredential(auth)
                .withRegion(KafkaRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowKafkaUserClientQuotaRequest request = new ShowKafkaUserClientQuotaRequest();
        request.withInstanceId("{instance_id}");
        try {
            ShowKafkaUserClientQuotaResponse response = client.showKafkaUserClientQuota(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkkafka.v2.region.kafka_region import KafkaRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkkafka.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = KafkaClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(KafkaRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowKafkaUserClientQuotaRequest()
        request.instance_id = "{instance_id}"
        response = client.show_kafka_user_client_quota(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    kafka "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := kafka.KafkaClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := kafka.NewKafkaClient(hcClient)

    request := &model.ShowKafkaUserClientQuotaRequest{}
	request.InstanceId = "{instance_id}"
	response, err := client.ShowKafkaUserClientQuota(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

查询客户端流控配置成功。

错误码

请参见错误码

相关文档