更新时间:2024-12-16 GMT+08:00
分享

创建用户/客户端流控配置

功能介绍

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

调用方法

请参见如何调用API

URI

POST /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

请求示例

创建用户/客户端流控配置。

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"
}

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
49
50
51
52
53
54
55
56
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 CreateKafkaUserClientQuotaTaskSolution {

    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();
        CreateKafkaUserClientQuotaTaskRequest request = new CreateKafkaUserClientQuotaTaskRequest();
        request.withInstanceId("{instance_id}");
        CreateKafkaUserClientQuotaTaskReq body = new CreateKafkaUserClientQuotaTaskReq();
        body.withConsumerByteRate(2097152L);
        body.withProducerByteRate(3145728L);
        body.withClientDefault(true);
        body.withUserDefault(false);
        body.withClient("");
        body.withUser("");
        request.withBody(body);
        try {
            CreateKafkaUserClientQuotaTaskResponse response = client.createKafkaUserClientQuotaTask(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
33
34
35
36
37
38
39
40
# 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 = CreateKafkaUserClientQuotaTaskRequest()
        request.instance_id = "{instance_id}"
        request.body = CreateKafkaUserClientQuotaTaskReq(
            consumer_byte_rate=2097152,
            producer_byte_rate=3145728,
            client_default=True,
            user_default=False,
            client="",
            user=""
        )
        response = client.create_kafka_user_client_quota_task(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
51
52
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := kafka.NewKafkaClient(
        kafka.KafkaClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateKafkaUserClientQuotaTaskRequest{}
	request.InstanceId = "{instance_id}"
	consumerByteRateCreateKafkaUserClientQuotaTaskReq:= int64(2097152)
	producerByteRateCreateKafkaUserClientQuotaTaskReq:= int64(3145728)
	clientDefaultCreateKafkaUserClientQuotaTaskReq:= true
	userDefaultCreateKafkaUserClientQuotaTaskReq:= false
	clientCreateKafkaUserClientQuotaTaskReq:= ""
	userCreateKafkaUserClientQuotaTaskReq:= ""
	request.Body = &model.CreateKafkaUserClientQuotaTaskReq{
		ConsumerByteRate: &consumerByteRateCreateKafkaUserClientQuotaTaskReq,
		ProducerByteRate: &producerByteRateCreateKafkaUserClientQuotaTaskReq,
		ClientDefault: &clientDefaultCreateKafkaUserClientQuotaTaskReq,
		UserDefault: &userDefaultCreateKafkaUserClientQuotaTaskReq,
		Client: &clientCreateKafkaUserClientQuotaTaskReq,
		User: &userCreateKafkaUserClientQuotaTaskReq,
	}
	response, err := client.CreateKafkaUserClientQuotaTask(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

创建用户/客户端流控配置成功。

错误码

请参见错误码

相关文档