更新时间:2024-03-15 GMT+08:00

设置用户权限

功能介绍

设置用户权限。

Kafka实例开启SASL功能时,才支持多用户管理的功能。

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/instances/{instance_id}/topics/accesspolicy

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见获取项目ID

instance_id

String

实例ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

topics

Array of AccessPolicyTopicEntity objects

topic列表。

表3 AccessPolicyTopicEntity

参数

是否必选

参数类型

描述

name

String

topic名称。

policies

Array of AccessPolicyEntity objects

权限列表。

表4 AccessPolicyEntity

参数

是否必选

参数类型

描述

user_name

String

用户名称。

设置用户权限时,为必选参数。

access_policy

String

权限类型。

  • all:拥有发布、订阅权限;

  • pub:拥有发布权限;

  • sub:拥有订阅权限。

设置用户权限时,为必选参数。

响应参数

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码: 403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

设置用户权限,为root用户授予发布和订阅topic-test的权限。

POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/topics/accesspolicy

{
  "topics" : [ {
    "name" : "topic-test",
    "policies" : [ {
      "user_name" : "root",
      "access_policy" : "all"
    } ]
  } ]
}

响应示例

SDK代码示例

SDK代码示例如下。

设置用户权限,为root用户授予发布和订阅topic-test的权限。

 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
57
58
59
60
61
62
63
64
65
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.*;

import java.util.List;
import java.util.ArrayList;

public class UpdateTopicAccessPolicySolution {

    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();
        UpdateTopicAccessPolicyRequest request = new UpdateTopicAccessPolicyRequest();
        request.withInstanceId("{instance_id}");
        UpdateTopicAccessPolicyReq body = new UpdateTopicAccessPolicyReq();
        List<AccessPolicyEntity> listTopicsPolicies = new ArrayList<>();
        listTopicsPolicies.add(
            new AccessPolicyEntity()
                .withUserName("root")
                .withAccessPolicy(AccessPolicyEntity.AccessPolicyEnum.fromValue("all"))
        );
        List<AccessPolicyTopicEntity> listbodyTopics = new ArrayList<>();
        listbodyTopics.add(
            new AccessPolicyTopicEntity()
                .withName("topic-test")
                .withPolicies(listTopicsPolicies)
        );
        body.withTopics(listbodyTopics);
        request.withBody(body);
        try {
            UpdateTopicAccessPolicyResponse response = client.updateTopicAccessPolicy(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());
        }
    }
}

设置用户权限,为root用户授予发布和订阅topic-test的权限。

 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
# 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 = UpdateTopicAccessPolicyRequest()
        request.instance_id = "{instance_id}"
        listPoliciesTopics = [
            AccessPolicyEntity(
                user_name="root",
                access_policy="all"
            )
        ]
        listTopicsbody = [
            AccessPolicyTopicEntity(
                name="topic-test",
                policies=listPoliciesTopics
            )
        ]
        request.body = UpdateTopicAccessPolicyReq(
            topics=listTopicsbody
        )
        response = client.update_topic_access_policy(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

设置用户权限,为root用户授予发布和订阅topic-test的权限。

 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
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.UpdateTopicAccessPolicyRequest{}
	request.InstanceId = "{instance_id}"
	userNamePolicies:= "root"
	accessPolicyPolicies:= model.GetAccessPolicyEntityAccessPolicyEnum().ALL
	var listPoliciesTopics = []model.AccessPolicyEntity{
        {
            UserName: &userNamePolicies,
            AccessPolicy: &accessPolicyPolicies,
        },
    }
	var listTopicsbody = []model.AccessPolicyTopicEntity{
        {
            Name: "topic-test",
            Policies: listPoliciesTopics,
        },
    }
	request.Body = &model.UpdateTopicAccessPolicyReq{
		Topics: listTopicsbody,
	}
	response, err := client.UpdateTopicAccessPolicy(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

204

更新成功。

400

参数无效。

403

鉴权失败。

错误码

请参见错误码