修改用户/客户端流控配置
功能介绍
该接口用于向Kafka实例提交修改用户、客户端级别的流控任务,若成功则返回流控任务的job_id。
调用方法
请参见如何调用API。
URI
PUT /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 |
请求示例
修改用户/客户端流控配置。
PUT 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" : "8abfa7b38ba79a20018ba9afc550576a" }
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 UpdateKafkaUserClientQuotaTaskSolution { 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(); UpdateKafkaUserClientQuotaTaskRequest request = new UpdateKafkaUserClientQuotaTaskRequest(); request.withInstanceId("{instance_id}"); UpdateKafkaUserClientQuotaTaskReq body = new UpdateKafkaUserClientQuotaTaskReq(); body.withConsumerByteRate(2097152L); body.withProducerByteRate(3145728L); body.withClientDefault(true); body.withUserDefault(false); body.withClient(""); body.withUser(""); request.withBody(body); try { UpdateKafkaUserClientQuotaTaskResponse response = client.updateKafkaUserClientQuotaTask(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 = UpdateKafkaUserClientQuotaTaskRequest() request.instance_id = "{instance_id}" request.body = UpdateKafkaUserClientQuotaTaskReq( consumer_byte_rate=2097152, producer_byte_rate=3145728, client_default=True, user_default=False, client="", user="" ) response = client.update_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.UpdateKafkaUserClientQuotaTaskRequest{} request.InstanceId = "{instance_id}" consumerByteRateUpdateKafkaUserClientQuotaTaskReq:= int64(2097152) producerByteRateUpdateKafkaUserClientQuotaTaskReq:= int64(3145728) clientDefaultUpdateKafkaUserClientQuotaTaskReq:= true userDefaultUpdateKafkaUserClientQuotaTaskReq:= false clientUpdateKafkaUserClientQuotaTaskReq:= "" userUpdateKafkaUserClientQuotaTaskReq:= "" request.Body = &model.UpdateKafkaUserClientQuotaTaskReq{ ConsumerByteRate: &consumerByteRateUpdateKafkaUserClientQuotaTaskReq, ProducerByteRate: &producerByteRateUpdateKafkaUserClientQuotaTaskReq, ClientDefault: &clientDefaultUpdateKafkaUserClientQuotaTaskReq, UserDefault: &userDefaultUpdateKafkaUserClientQuotaTaskReq, Client: &clientUpdateKafkaUserClientQuotaTaskReq, User: &userUpdateKafkaUserClientQuotaTaskReq, } response, err := client.UpdateKafkaUserClientQuotaTask(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
修改用户/客户端流配置成功。 |
错误码
请参见错误码。