Criação de cotas de usuário ou cliente
Função
Essa API é usada para enviar uma tarefa para criar cotas de usuário ou cliente para uma instância do Kafka. Um job_id será retornado se a tarefa for bem-sucedida.
Método de chamada
Para obter detalhes, consulte Chamada de APIs.
URI
POST /v2/kafka/{project_id}/instances/{instance_id}/kafka-user-client-quota
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
instance_id |
Sim |
String |
ID da instância. |
project_id |
Sim |
String |
ID do projeto. Para obter detalhes, consulte Obtenção de um ID de projeto. |
Parâmetros de solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
user |
Não |
String |
Nome de usuário. O nome de usuário ou o ID do cliente deve ser especificado se as cotas não forem aplicadas a todos os usuários ou clientes. |
client |
Não |
String |
ID do cliente. O nome de usuário ou o ID do cliente deve ser especificado se as cotas não forem aplicadas a todos os usuários ou clientes. |
user-default |
Não |
Boolean |
Indica se as configurações padrão do usuário devem ser usadas.
|
client-default |
Não |
Boolean |
Indica se as configurações padrão do cliente devem ser usadas.
|
producer-byte-rate |
Não |
Long |
Limite da taxa de produção. A unidade é byte/s. |
consumer-byte-rate |
Não |
Long |
Limite da taxa de consumo. A unidade é byte/s.
NOTA:
O limite da taxa de produção ou o limite da taxa de consumo deve ser especificado. |
Parâmetros de resposta
Código de status: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
job_id |
String |
ID da tarefa para criar cotas. |
Exemplo de solicitações
Criação de cotas de usuários ou clientes
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 }
Exemplo de respostas
Código de status: 200
Cotas de usuário ou cliente criadas.
{ "job_id" : "ff8080828bdc0f64018bdcadfd8f00d7" }
Código de exemplo do SDK
O código de exemplo do SDK é o seguinte.
Java
Criação de cotas de usuários ou clientes
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()); } } } |
Python
Criação de cotas de usuários ou clientes
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 |
# coding: utf-8 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 = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("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) |
Go
Criação de cotas de usuários ou clientes
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) } } |
Mais
Para obter o código de exemplo do SDK de mais linguagens de programação, consulte a guia Código de exemplo no API Explorer. O código de exemplo do SDK pode ser gerado automaticamente.
Códigos de status
Código de status |
Descrição |
---|---|
200 |
Cotas de usuário ou cliente criadas. |
Códigos de erro
Consulte Códigos de erro.