QueryConsumerGroupList - IoT Platform

QPS限制

單個阿里雲帳號調用該介面的每秒請求數（QPS）最大限制為5。

說明 RAM使用者共用阿里雲帳號配額。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	QueryConsumerGroupList	系統規定參數。取值：QueryConsumerGroupList。
CurrentPage	Integer	是	1	指定顯示返回結果中的第幾頁，最小值為1。
PageSize	Integer	是	2	指定返回結果中每頁顯示的消費組數量，最小值為1，最大值為1000。
IotInstanceId	String	否	iot-cn-0pp1n8t****	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。
Fuzzy	Boolean	否	false	是否使用模糊查詢。可選值： true：使用模糊查詢，需指定GroupName參數。 false：查詢該使用者的所有消費組。預設為false。
GroupName	String	否	A類消費組	模糊查詢時要查詢的消費組名稱，當Fuzzy取值為true時傳入。

調用API時，除了本文介紹的該API的特有請求參數，還需傳入公用請求參數。公用請求參數說明，請參見公用參數文檔。

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
CurrentPage	Integer	1	當前頁碼。
Data	Array of ConsumerGroupDTO		調用成功時，返回的消費組詳情，請參見ConsumerGroupDTO。
ConsumerGroupDTO
CreateTime	String	2020-05-20T00:05:20.000Z	消費組建立時間。為UTC時間，以毫秒計，格式為“yyyy-MM-dd'T'HH:mm:ss.SSSZ”。
GroupId	String	nJRaJPn5U1JITGf******	消費組ID。
GroupName	String	XX消費組1	消費組名稱。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
PageCount	Integer	4	返回結果總頁數。
PageSize	Integer	2	每頁顯示的消費組數。
RequestId	String	73B9DF43-7780-47DE-8BED-077729D28BD2	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	是否調用成功。 true：調用成功。 false：調用失敗。
Total	Integer	8	查詢到的消費組總數。

樣本

請求樣本

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

正常返回樣本

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
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。