更新时间:2025-08-15 GMT+08:00

查询用户列表

功能介绍

查询用户列表(仅AMQP版本支持)。

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/instances/{instance_id}/users

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

instance_id

String

参数解释

实例ID。获取方法如下:调用“查询所有实例列表”接口,从响应体中获取实例ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

offset

String

参数解释

分页查询偏移量。

约束限制

不涉及。

取值范围

大于等于0。

默认取值

0。

limit

String

参数解释

分页查询单页数量。

约束限制

不涉及。

取值范围

0~50。

默认取值

10。

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

users

Array of AMQPUser objects

参数解释

用户列表。

total

Integer

参数解释

总用户个数。

取值范围

不涉及。

表4 AMQPUser

参数

参数类型

描述

access_key

String

参数解释

用户名。

取值范围

不涉及。

secret_key

String

参数解释

密钥。

取值范围

  • 8-32个字符。

  • 至少包含以下字符中的3种:

    • 大写字母

    • 小写字母

    • 数字

    • 特殊字符`~!@#$%^&*()-_=+\|[{}];:'",<.>/?。

  • 不能与名称或倒序的名称相同。

vhosts

Array of AMQPUserPerm objects

参数解释

需要配置权限的Vhost,一个用户可以配置多个Vhost下的资源权限。

表5 AMQPUserPerm

参数

参数类型

描述

vhost

String

参数解释

需要配置权限的Vhost名称,一个用户可以配置多个Vhost下的资源权限。

取值范围

不涉及。

conf

String

参数解释

使用正则表达式匹配资源配置权限。例如,在输入框内输入“^janeway-.*”,则表示授权给该用户当前Vhost下,所有名称以“janeway-”开头的资源的配置权限。

取值范围

不涉及。

write

String

参数解释

使用正则表达式匹配资源写权限。例如,在输入框内输入“.*”,则表示授权给该用户当前Vhost下,所有资源的写权限。

取值范围

不涉及。

read

String

参数解释

使用正则表达式匹配资源读权限。例如,在输入框内输入“.*”,则表示授权给该用户当前Vhost下,所有资源的读权限。

取值范围

不涉及。

请求示例

查询用户列表。

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/users?offset=0&limit=10

响应示例

状态码:200

查询用户列表成功。

{
  "users" : [ {
    "access_key" : "admin123",
    "secret_key" : "**************",
    "vhosts" : [ {
      "vhost" : "default",
      "conf" : ".*",
      "write" : ".*",
      "read" : ".*"
    } ]
  } ],
  "total" : 1
}

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


public class ListUserSolution {

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

        RabbitMQClient client = RabbitMQClient.newBuilder()
                .withCredential(auth)
                .withRegion(RabbitMQRegion.valueOf("<YOUR REGION>"))
                .build();
        ListUserRequest request = new ListUserRequest();
        request.withInstanceId("{instance_id}");
        try {
            ListUserResponse response = client.listUser(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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkrabbitmq.v2.region.rabbitmq_region import RabbitMQRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkrabbitmq.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 = RabbitMQClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(RabbitMQRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListUserRequest()
        request.instance_id = "{instance_id}"
        response = client.list_user(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
package main

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

    request := &model.ListUserRequest{}
	request.InstanceId = "{instance_id}"
	response, err := client.ListUser(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

查询用户列表成功。

错误码

请参见错误码