ListParser - IoT Platform

QPS限制

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

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

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	ListParser	系統規定參數。取值：ListParser。
CurrentPage	Integer	是	1	指定顯示返回結果中的第幾頁，取值範圍為1~100。
PageSize	Integer	是	10	指定返回結果中每頁顯示的記錄數量，最大值不超過100。
IotInstanceId	String	否	iot-n8t****	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。
SearchName	String	否	DataParser	傳入解析器名稱中任一字元串，根據該字串檢索能匹配的解析器名稱。

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

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
Data	Array of ParserList		返回的解析器列表資料。
ParserList
Description	String	轉寄資料。	解析器描述。
Name	String	DataParser	解析器名稱。
ParserId	Long	1001	解析器ID。
Status	String	STOP	解析器狀態。可取值有： RUNNING：運行中。 STOP：已停止。 ABNORMAL：存在異常。
UtcCreated	String	2022-03-21T12:45:43.000Z	建立解析器的UTC時間。格式為`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`。
UtcModified	String	2022-03-25T12:45:43.000Z	更新解析器的UTC時間。格式為`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
RequestId	String	E4C0FF92-2A86-41DB-92D3-73B60310D25E	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	表示是否調用成功。 true：調用成功。 false：調用失敗。
Total	Integer	100	返回結果記錄總數。

樣本

請求樣本

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListParser
&CurrentPage=1
&PageSize=10
&<公用請求參數>

正常返回樣本

XML格式

<ListParserResponse>
    <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
    <Total>100</Total>
    <Data>
            <ParserList>
                    <Status>STOP</Status>
                    <Description>轉寄資料1。</Description>
                    <UtcCreated>2022-03-21T12:45:43.000Z</UtcCreated>
                    <UtcModified>2022-03-25T12:45:43.000Z</UtcModified>
                    <ParserId>1001</ParserId>
                    <Name>DataParser1</Name>
            </ParserList>
            <ParserList>
                    <Status>STOP</Status>
                    <Description>轉寄資料2。</Description>
                    <UtcCreated>2022-03-21T12:50:43.000Z</UtcCreated>
                    <UtcModified>2022-03-25T12:48:43.000Z</UtcModified>
                    <ParserId>1002</ParserId>
                    <Name>DataParser2</Name>
            </ParserList>
    </Data>
    <Success>true</Success>
</ListParserResponse>

JSON格式

{
    "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
    "Total": 100,
    "Data": {
        "ParserList": [
            {
                "Status": "STOP",
                "Description": "轉寄資料1。",
                "UtcCreated": "2022-03-21T12:45:43.000Z",
                "UtcModified": "2022-03-25T12:45:43.000Z",
                "ParserId": 1001,
                "Name": "DataParser1"
            },
            {
                "Status": "STOP",
                "Description": "轉寄資料2。",
                "UtcCreated": "2022-03-21T12:50:43.000Z",
                "UtcModified": "2022-03-25T12:48:43.000Z",
                "ParserId": 1002,
                "Name": "DataParser2"
            }
        ]
    },
    "Success": true
}

錯誤碼

HttpCode	錯誤碼	錯誤資訊	描述
400	iot.system.SystemException	An internal error occurred. Try again later.	系統異常。
400	iot.common.InvalidPageParams	The specified pagination size or pagination parameter is invalid.	分頁大小或者分頁頁號不合法。
400	iot.common.InvalidFormattedParameter	The parameter format is invalid.	參數格式錯誤。
400	iot.rule.QueryRulePageActionError	An error occurred while querying the rule action list across multiple pages.	查詢規則列表失敗。

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