Queries the details of parsers. The details include the basic information, status, creation time, and modification time.

QPS limits

Each Alibaba Cloud account can run up to 10 queries per second (QPS).

Note The RAM users of an Alibaba Cloud account share the quota of the Alibaba Cloud account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListParser

The operation that you want to perform. Set the value to ListParser.

CurrentPage Integer Yes 1

The number of the page to return. Valid values: 1 to 100.

PageSize Integer Yes 10

The number of entries to return on each page. Maximum value: 100.

IotInstanceId String No iot-n8t****

The ID of the instance. You can view the ID of the instance on the Overview page in the IoT Platform console.

Notice
  • If your instance has an ID, you must specify the ID for this parameter. Otherwise, the call fails.
  • If no Overview page or ID is generated for your instance, you do not need to configure this parameter.

For more information, see Overview.

SearchName String No DataParser

The string that you want to use as a keyword to match parser names.

In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this operation. For more information, see Common request parameters.

Response parameters

Parameter Type Example Description
Code String iot.system.SystemException

The error code returned if the call fails. For more information, see Error codes.

Data Array of ParserList

The details of the matched parsers.

ParserList
Description String Forward data.

The description of the parser.

Name String DataParser

The name of the parser.

ParserId Long 1001

The ID of the parser.

Status String STOP

The status of the parser. Valid values:

  • RUNNING: The parser is running.
  • STOP: The parser is disabled.
  • ABNORMAL: The parser is abnormal.
UtcCreated String 2022-03-21T12:45:43.000Z

The time when the parser was created. The time is displayed in UTC. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'.

UtcModified String 2022-03-25T12:45:43.000Z

The time when the parser was last updated. The time is displayed in UTC. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'.

ErrorMessage String A system exception occurred.

The error message returned if the call fails.

RequestId String E4C0FF92-2A86-41DB-92D3-73B60310D25E

The ID of the request.

Success Boolean true

Indicates whether the call was successful.

  • true: The call was successful.
  • false: The call failed.
Total Integer 100

The total number of entries returned.

Examples

Sample requests

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListParser
&CurrentPage=1
&PageSize=10
&<Common request parameters>

Sample success responses

XML format 

<ListParserResponse>
    <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
    <Total>100</Total>
    <Data>
            <ParserList>
                    <Status>STOP</Status>
                    <Description>Forward data. </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>Forward data. </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 format 

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