更新时间:2024-07-05 GMT+08:00

查询消费组的授权用户列表

功能介绍

查询消费组的授权用户列表。

调用方法

请参见如何调用API

URI

GET /v2/{engine}/{project_id}/instances/{instance_id}/groups/{group_id}/accesspolicy

表1 路径参数

参数

是否必选

参数类型

描述

engine

String

消息引擎。

project_id

String

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

instance_id

String

实例ID。

group_id

String

消费组。

表2 Query参数

参数

是否必选

参数类型

描述

offset

String

偏移量,表示从此偏移量开始查询, offset大于等于0。

limit

String

查询数量。

请求参数

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

policies

Array of policies objects

用户列表。

total

Number

总用户个数。

name

String

主题或消费组名称。

表4 policies

参数

参数类型

描述

access_key

String

用户名。

secret_key

String

密钥。

white_remote_address

String

IP白名单。

admin

Boolean

是否为管理员。

perm

String

权限。

请求示例

查询消费组的授权用户列表。

GET https://{endpoint}/v2/{engine}/{project_id}/instances/{instance_id}/groups/{group_id}/accesspolicy

响应示例

状态码: 200

消费组的授权用户列表成功。

{
  "policies" : {
    "access_key" : "test_01",
    "secret_key" : "**************",
    "white_remote_address" : "",
    "admin" : false,
    "perm" : ""
  },
  "total" : 1,
  "name" : "test"
}

SDK代码示例

SDK代码示例如下。

 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
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.rocketmq.v2.region.RocketMQRegion;
import com.huaweicloud.sdk.rocketmq.v2.*;
import com.huaweicloud.sdk.rocketmq.v2.model.*;


public class ListConsumeGroupAccessPolicySolution {

    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);

        RocketMQClient client = RocketMQClient.newBuilder()
                .withCredential(auth)
                .withRegion(RocketMQRegion.valueOf("<YOUR REGION>"))
                .build();
        ListConsumeGroupAccessPolicyRequest request = new ListConsumeGroupAccessPolicyRequest();
        request.withEngine(ListConsumeGroupAccessPolicyRequest.EngineEnum.fromValue("{engine}"));
        request.withInstanceId("{instance_id}");
        request.withGroupId("{group_id}");
        try {
            ListConsumeGroupAccessPolicyResponse response = client.listConsumeGroupAccessPolicy(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());
        }
    }
}
 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkrocketmq.v2.region.rocketmq_region import RocketMQRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkrocketmq.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 = RocketMQClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(RocketMQRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListConsumeGroupAccessPolicyRequest()
        request.engine = "{engine}"
        request.instance_id = "{instance_id}"
        request.group_id = "{group_id}"
        response = client.list_consume_group_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)
 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    rocketmq "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/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 := rocketmq.NewRocketMQClient(
        rocketmq.RocketMQClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListConsumeGroupAccessPolicyRequest{}
	request.Engine = model.GetListConsumeGroupAccessPolicyRequestEngineEnum().ENGINE
	request.InstanceId = "{instance_id}"
	request.GroupId = "{group_id}"
	response, err := client.ListConsumeGroupAccessPolicy(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

消费组的授权用户列表成功。

错误码

请参见错误码