# 创建用户/客户端流控配置 - CreateKafkaUserClientQuotaTask #### 功能介绍 该接口用于向Kafka实例提交创建用户、客户端级别的流控任务，若成功则返回流控任务的job_id。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-kafka/api-call-process.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-kafka/api-grant-policy.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dms:instance:setClientQuota | Write | kafka | - g:ResourceTag/\ - g:EnterpriseProjectId | dms:instance:modify | - | #### URI POST /v2/kafka/{project_id}/instances/{instance_id}/kafka-user-client-quota 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID，获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-kafka/kafka-api-0036212547.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释**： 实例ID。获取方法如下：调用"查询所有实例列表"接口，从响应体中获取实例ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | user | 否 | String | **参数解释**： 用户名。 **约束限制**： 不对全部用户/客户端限流时，用户名和客户端ID不能同时为空。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | client | 否 | String | **参数解释**： 客户端ID。 **约束限制**： 不对全部用户/客户端限流时，用户名和客户端ID不能同时为空。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | user_default | 否 | Boolean | **参数解释**： 是否使用用户默认设置。 **约束限制**： 不涉及。 **取值范围**： - true：表示对全部用户限流。此时不能同时设置用户名。 - false：表示对特定用户限流。此时需要设置用户名。 **默认取值**： false。 | | client_default | 否 | Boolean | **参数解释**： 是否使用客户端默认设置。 **约束限制**： 不涉及。 **取值范围**： - true：表示对全部客户端限流。此时不能设置客户端ID。 - false：表示对特定客户端限流。此时需要设置客户端ID。 **默认取值**： false。 | | producer_byte_rate | 否 | Long | **参数解释**： 生产上限速率（单位为B/s）。 **约束限制**： "生产上限速率"和"消费上限速率"不可同时为空。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | consumer_byte_rate | 否 | Long | **参数解释**： 消费上限速率（单位为B/s）。 **约束限制**： "生产上限速率"和"消费上限速率"不可同时为空。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | job_id | String | **参数解释**： 创建流控配置的任务ID。 **取值范围**： 不涉及。 | #### 请求示例 创建用户/客户端流控配置。 ``` POST https://{endpoint}/v2/kafka/{project_id}/instances/{instance_id}/kafka-user-client-quota { "user" : "test", "client" : "", "user_default" : false, "client_default" : true, "producer_byte_rate" : 3145728, "consumer_byte_rate" : 2097152 } ``` #### 响应示例 **状态码：200** 创建用户/客户端流控配置成功。 ``` { "job_id" : "ff8080828bdc0f64018bdcadfd8f00d7" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 创建用户/客户端流控配置。 ``` 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("")) .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("test"); 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] 创建用户/客户端流控配置。 ``` # 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("")) \ .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="test" ) 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] 创建用户/客户端流控配置。 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := kafka.KafkaClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := kafka.NewKafkaClient(hcClient) request := &model.CreateKafkaUserClientQuotaTaskRequest{} request.InstanceId = "{instance_id}" consumerByteRateCreateKafkaUserClientQuotaTaskReq:= int64(2097152) producerByteRateCreateKafkaUserClientQuotaTaskReq:= int64(3145728) clientDefaultCreateKafkaUserClientQuotaTaskReq:= true userDefaultCreateKafkaUserClientQuotaTaskReq:= false clientCreateKafkaUserClientQuotaTaskReq:= "" userCreateKafkaUserClientQuotaTaskReq:= "test" 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) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Kafka/sdk?api=CreateKafkaUserClientQuotaTask)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 创建用户/客户端流控配置成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-kafka/ErrorCode.html)。