使用AMQP服務(wù)端訂閱時，可以調(diào)用該接口查詢用戶所有消費組列表，或按消費組名稱進行模糊查詢。

QPS限制

單個阿里云賬號調(diào)用該接口的每秒請求數(shù)（QPS）最大限制為5。

說明 RAM用戶共享阿里云賬號配額。

調(diào)試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數(shù)

名稱 類型 是否必選 示例值 描述
Action String 是 QueryConsumerGroupList

系統(tǒng)規(guī)定參數(shù)。取值：QueryConsumerGroupList。
CurrentPage Integer 是 1

指定顯示返回結(jié)果中的第幾頁，最小值為1。
PageSize Integer 是 2

指定返回結(jié)果中每頁顯示的消費組數(shù)量，最小值為1，最大值為1000。
IotInstanceId String 否 iot-cn-0pp1n8t****

實例ID。您可在物聯(lián)網(wǎng)平臺控制臺的實例概覽頁面，查看當前實例的ID。

注意
  • 若有ID值，必須傳入該ID值，否則調(diào)用會失敗。
  • 若無ID值，則無需傳入。

實例的更多信息，請參見實例概述。

Fuzzy Boolean 否 false

是否使用模糊查詢?？蛇x值：

  • true：使用模糊查詢，需指定GroupName參數(shù)。
  • false：查詢該用戶的所有消費組。

默認為false。

GroupName String 否 A類消費組

模糊查詢時要查詢的消費組名稱，當Fuzzy取值為true時傳入。

調(diào)用API時，除了本文介紹的該API的特有請求參數(shù)，還需傳入公共請求參數(shù)。公共請求參數(shù)說明，請參見公共參數(shù)文檔。

返回數(shù)據(jù)

名稱 類型 示例值 描述
Code String iot.system.SystemException

調(diào)用失敗時，返回的錯誤碼。更多信息，請參見錯誤碼。

CurrentPage Integer 1

當前頁碼。
Data Array of ConsumerGroupDTO

調(diào)用成功時，返回的消費組詳情，請參見ConsumerGroupDTO。
ConsumerGroupDTO
CreateTime String 2020-05-20T00:05:20.000Z

消費組創(chuàng)建時間。為UTC時間，以毫秒計，格式為“yyyy-MM-dd'T'HH:mm:ss.SSSZ”。
GroupId String nJRaJPn5U1JITGf******

消費組ID。
GroupName String XX消費組1

消費組名稱。
ErrorMessage String 系統(tǒng)異常

調(diào)用失敗時，返回的出錯信息。
PageCount Integer 4

返回結(jié)果總頁數(shù)。
PageSize Integer 2

每頁顯示的消費組數(shù)。
RequestId String 73B9DF43-7780-47DE-8BED-077729D28BD2

阿里云為該請求生成的唯一標識符。
Success Boolean true

是否調(diào)用成功。

  • true：調(diào)用成功。
  • false：調(diào)用失敗。
Total Integer 8

查詢到的消費組總數(shù)。

示例

請求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryConsumerGroupList
&CurrentPage=1
&PageSize=2
&Fuzzy=true
&GroupName=A類消費組
&<公共請求參數(shù)>

正常返回示例

XML格式 

<QueryConsumerGroupListResponse>
    <PageSize>2</PageSize>
    <PageCount>4</PageCount>
    <CurrentPage>1</CurrentPage>
    <Total>8</Total>
    <Data>
        <ConsumerGroupDTO>
            <GroupId>nJRaJPn5U1JITGf******</GroupId>
            <GroupName>A類消費組1</GroupName>
            <CreateTime>2020-05-29T03:37:56.000Z</CreateTime>
        </ConsumerGroupDTO>
        <ConsumerGroupDTO>
            <GroupId>qJRaJPndeefwgef******</GroupId>
            <GroupName>A類消費組2</GroupName>
            <CreateTime>2020-01-17T07:27:01.000Z</CreateTime>
        </ConsumerGroupDTO>
    </Data>
    <RequestId>73B9DF43-7780-47DE-8BED-077729D28BD2</RequestId>
    <Success>true</Success>
</QueryConsumerGroupListResponse>

JSON格式 

{
    "PageSize": 2,
    "PageCount": 4,
    "CurrentPage": 1,
    "Total": 8,
    "Data": {
        "ConsumerGroupDTO": [
            {
                "GroupId": "nJRaJPn5U1JITGf******",
                "GroupName": "A類消費組1",
                "CreateTime": "2020-05-29T03:37:56.000Z"
            },
            {
                "GroupId": "qJRaJPndeefwgef******",
                "GroupName": "A類消費組2",
                "CreateTime": "2020-01-17T07:27:01.000Z"
            }
        ]
    },
  "RequestId": "73B9DF43-7780-47DE-8BED-077729D28BD2",
  "Success": true
}