Modifying User or Client Quotas
Function
This API is used to submit a task to modify user or client quotas of a Kafka instance. A job_id is returned if the task succeeds.
Calling Method
For details, see Calling APIs.
URI
PUT /v2/kafka/{project_id}/instances/{instance_id}/kafka-user-client-quota
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
instance_id |
Yes |
String |
Instance ID. |
project_id |
Yes |
String |
Project ID. For details, see Obtaining a Project ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
user |
No |
String |
Username. Either the username or the client ID must be specified if the quotas are not applied to all users or clients. |
client |
No |
String |
Client ID. Either the username or the client ID must be specified if the quotas are not applied to all users or clients. |
user-default |
No |
Boolean |
Indicates whether to use the default user settings.
|
client-default |
No |
Boolean |
Indicates whether to use the default client settings.
|
producer-byte-rate |
No |
Long |
Production rate limit. The unit is byte/s. |
consumer-byte-rate |
No |
Long |
Consumption rate limit. The unit is byte/s.
NOTE:
Either the production rate limit or the consumption rate limit must be specified. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
job_id |
String |
ID of the task for modifying quotas. |
Example Requests
Modifying user or client quotas
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 }
Example Responses
Status code: 200
User or client quotas modified.
{ "job_id" : "8abfa7b38ba79a20018ba9afc550576a" }
SDK Sample Code
The SDK sample code is as follows.
Modifying user or client quotas
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()); } } } |
Modifying user or client quotas
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) |
Modifying user or client quotas
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) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
User or client quotas modified. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot