Creating User or Client Quotas
Function
This API is used to submit a task to create user or client quotas for a Kafka instance. A job_id is returned if the task succeeds.
Calling Method
For details, see Calling APIs.
URI
POST /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 creating quotas. |
Example Requests
Creating user or client quotas
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 }
Example Responses
Status code: 200
User or client quotas created.
{ "job_id" : "ff8080828bdc0f64018bdcadfd8f00d7" }
SDK Sample Code
The SDK sample code is as follows.
Creating 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 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()); } } } |
Creating 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 = 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) |
Creating 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.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) } } |
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 created. |
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