调用该接口查询解析器列表信息，包括解析器基本信息、启动状态、创建时间和修改时间。

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
}