Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.
Atualizado em 2024-09-10 GMT+08:00

Modificação de cotas de usuários ou clientes

Função

Essa API é usada para enviar uma tarefa para modificar cotas de usuário ou cliente de 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

PUT /v2/kafka/{project_id}/instances/{instance_id}/kafka-user-client-quota

Tabela 1 Parâmetros de caminho

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

Tabela 2 Parâmetros do corpo da 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.

  • Sim: aplicar a cota a todos os usuários. Nesse caso, o nome de usuário não pode ser definido.
  • Não: aplicar a cota a usuários específicos. Nesse caso, defina o nome de usuário.

client-default

Não

Boolean

Indica se as configurações padrão do cliente devem ser usadas.

  • Sim: aplicar a cota a todos os clientes. Nesse caso, o ID do cliente não pode ser definido.
  • Não: aplicar a cota a clientes específicos. Nesse caso, defina o ID do cliente.

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

Tabela 3 Parâmetros do corpo de resposta

Parâmetro

Tipo

Descrição

job_id

String

ID da tarefa para modificar as cotas.

Exemplo de solicitações

Modificação de cotas de usuários ou clientes

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
}

Exemplo de respostas

Código de status: 200

Cotas de usuário ou cliente modificadas.

{
  "job_id" : "8abfa7b38ba79a20018ba9afc550576a"
}

Código de exemplo do SDK

O código de exemplo do SDK é o seguinte.

Java

Modificaçã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 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());
        }
    }
}

Python

Modificaçã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 = 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)

Go

Modificaçã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.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)
    }
}

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 modificadas.

Códigos de erro

Consulte Códigos de erro.