調用該接口查詢解析器列表信息,包括解析器基本信息、啟動狀態、創建時間和修改時間。
QPS限制
單個阿里云賬號調用該接口的每秒請求數(QPS)最大限制為10。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListParser |
系統規定參數。取值:ListParser。 |
CurrentPage | Integer | 是 | 1 |
指定顯示返回結果中的第幾頁,取值范圍為1~100。 |
PageSize | Integer | 是 | 10 |
指定返回結果中每頁顯示的記錄數量,最大值不超過100。 |
IotInstanceId | String | 否 | iot-n8t**** |
實例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 |
解析器狀態。可取值有:
|
UtcCreated | String | 2022-03-21T12:45:43.000Z |
創建解析器的UTC時間。格式為 |
UtcModified | String | 2022-03-25T12:45:43.000Z |
更新解析器的UTC時間。格式為 |
ErrorMessage | String | 系統異常 |
調用失敗時,返回的出錯信息。 |
RequestId | String | E4C0FF92-2A86-41DB-92D3-73B60310D25E |
阿里云為該請求生成的唯一標識符。 |
Success | Boolean | true |
表示是否調用成功。
|
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
}