ListQueueConsumers - 查询Queue的消费者_云消息队列 RabbitMQ 版(RabbitMQ)-阿里云帮助中心

接口说明

云消息队列 RabbitMQ 版仅支持查看在线 Consumer 客户端，不支持查看离线 Consumer 客户端。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

amqp:GetQueue

list

*Instance

acs:amqp:{#regionId}:{#accountId}:/instances/{#instanceId}

无

amqp:GetInstance

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	云消息队列 RabbitMQ 版实例的 ID。	amqp-cn-5yd3aw******
VirtualHost	string	是	Vhost 名称。	test
Queue	string	是	队列名称。	queue-rabbit-springboot-advance5
NextToken	string	否	用来标记当前查询结束的位置，以便下一次调用时作为参数传入，继续翻页。首次调用或返回最后一页时，取值为空字符串。	caeba0bbb2be03f84eb48b699f0a****
QueryCount	integer	否	拉取数据的条数。如果不设置，默认值为 1。取值范围：[1,100]。	1

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	4409B7D5-E4EC-4EB5-804A-385DCDFCD***
Data	object	返回数据。
MaxResults	integer	最大结果集。	1
NextToken	string	表示当前调用返回读取到的位置，空代表数据已经读取完毕。	caebacccb2be03f84eb48b699f0a****
Consumers	array<object>	消费者信息。
	object
ConsumerTag	string	消费者标签。	sgen-1

示例

正常返回示例

JSON格式

{
  "RequestId": "4409B7D5-E4EC-4EB5-804A-385DCDFCD***",
  "Data": {
    "MaxResults": 1,
    "NextToken": "caebacccb2be03f84eb48b699f0a****",
    "Consumers": [
      {
        "ConsumerTag": "sgen-1"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
404	InstanceIdNotExist	The instance resource does not exist.
404	InstanceNotExist	The instance resource does not exist.	实例资源不存在

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。