调用ListQueueConsumers查询Queue的消费者。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListQueueConsumers

要执行的操作。取值:

ListQueueConsumers

InstanceId String 188077086902***

实例ID。

Queue String queue-rabbit-springboot-advance5

队列名称。

RegionId String cn-hangzhou

地域ID。

VirtualHost String test

Vhost名称。

NextToken String caeba0bbb2be03f84eb48b699f0a****

用来标记当前查询结束的位置,以便下一次调用时作为参数传入,继续翻页。首次调用或返回最后一页时,取值为空字符串。

QueryCount Integer 1

拉取数据的条数。如果不设置,默认值为1。

取值范围:[1,100]。

返回数据

名称 类型 示例值 描述
Data Struct

返回数据。

Consumers Array of QueueConsumerVO

消费者信息。

ConsumerTag String sgen-1

消费者标签。

MaxResults Integer 1

最大结果集。

NextToken String caebacccb2be03f84eb48b699f0a****

表示当前调用返回读取到的位置,空代表数据已经读取完毕。

RequestId String 4409B7D5-E4EC-4EB5-804A-385DCDFCD***

请求ID。

示例

请求示例

http(s)://amqp-open.cn-hangzhou.aliyuncs.com/?Action=ListQueueConsumers
&InstanceId=188077086902***
&Queue=queue-rabbit-springboot-advance5
&RegionId=cn-hangzhou
&VirtualHost=test
&<公共请求参数>

正常返回示例

XML格式

<ListQueueConsumersResponse>
      <RequestId>4409B7D5-E4EC-4EB5-804A-385DCDFCD***</RequestId>
      <Data>
            <NextToken>AAAATzkBMTg4MDc3MDg2OTAyMzQyMAF0ZXN0AXF1ZXVlLXJhYmJpdC1zcHJpbmdib290LWFkdmFuY2U1ATc3NjMxNjIwATE1OTEzNTA5MDkzMDkBrWuX5aAiG4ytL5ffWi0HBUjdleo=</NextToken>
            <MaxResults>1</MaxResults>
            <Consumers>
                  <ConsumerTag>sgen-1</ConsumerTag>
            </Consumers>
      </Data>
</ListQueueConsumersResponse>

JSON格式

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

错误码

HttpCode 错误码 错误信息 描述
500 InternalError The request processing has failed due to some unknown error. 请求因遭遇某些未知错误而失败。

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