ListParser - IoT Platform - Centro de documentación de Alibaba Cloud

Consulta los detalles de los parsers, incluida la información básica, el estado, la hora de creación y la hora de modificación.

Límites de QPS

Cada cuenta de Alibaba Cloud puede ejecutar hasta 10 consultas por segundo (QPS).

Nota

Los usuarios de RAM de una cuenta de Alibaba Cloud comparten la cuota de dicha cuenta.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para mayor comodidad, se recomienda invocar esta operación en OpenAPI Explorer. Esta herramienta genera dinámicamente el código de ejemplo de la operación para distintos SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	ListParser	La operación que desea ejecutar. Establezca el valor en `ListParser`.
CurrentPage	Integer	Sí	1	El número de la página que se devolverá. Valores válidos: de 1 a 100.
PageSize	Integer	Sí	10	El número de entradas que se devolverán en cada página. Valor máximo: 100.
IotInstanceId	String	No	iot-n8t****	El ID de la instancia. Consulte el ID de la instancia en la página Overview de la consola de IoT Platform. Importante Si su instancia tiene un ID, debe especificar dicho ID en este parámetro. De lo contrario, la llamada terminará con errores. Si no se generó ninguna página Overview ni ningún ID para su instancia, no es necesario configurar este parámetro. Para obtener más información, consulte Descripción general.
SearchName	String	No	DataParser	La palabra clave utilizada para coincidir con los nombres de los parsers.

Además de los parámetros de solicitud específicos de la operación, debe especificar los parámetros de solicitud comunes al invocar esta operación. Para obtener más información, consulte Parámetros de solicitud comunes.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.system.SystemException	El código de error. Para obtener más información, consulte Códigos de error.
Data	Array of ParserList		Los parsers que coinciden con la búsqueda.
ParserList
Description	String	Forward data.	La descripción del parser.
Name	String	DataParser	El nombre del parser.
ParserId	Long	1001	El ID del parser.
Status	String	STOP	El estado del parser. Valores válidos: RUNNING: el parser se está ejecutando. STOP: el parser está deshabilitado. ABNORMAL: el parser presenta un comportamiento anómalo.
UtcCreated	String	2022-03-21T12:45:43.000Z	La hora en que se creó el parser. La hora se muestra en formato UTC. Formato: `yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`.
UtcModified	String	2022-03-25T12:45:43.000Z	La hora de la última actualización del parser. La hora se muestra en formato UTC. Formato: `yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`.
ErrorMessage	String	A system exception occurred.	El mensaje de error.
RequestId	String	E4C0FF92-2A86-41DB-92D3-73B60310D25E	El ID de la solicitud.
Success	Boolean	true	Indica si la llamada fue exitosa. true: la llamada fue exitosa. false: la llamada terminó con errores.
Total	Integer	100	El número total de entradas devueltas.

Ejemplos

Solicitudes de ejemplo

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

Respuestas exitosas de ejemplo

Formato XML

<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>

Formato JSON

{
    "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
}

Códigos de error

HttpCode	Código de error	Mensaje de error	Descripción
400	iot.system.SystemException	An internal error occurred. Try again later.	El mensaje de error devuelto porque ocurrió una excepción del sistema.
400	iot.common.InvalidPageParams	The specified pagination size or pagination parameter is invalid.	El mensaje de error devuelto porque el tamaño o el número de página especificados no son válidos.
400	iot.common.InvalidFormattedParameter	The parameter format is invalid.	El mensaje de error devuelto porque el formato del parámetro no es válido.
400	iot.rule.QueryRulePageActionError	An error occurred while querying the rule action list across multiple pages.	El mensaje de error devuelto porque el sistema no pudo consultar las reglas.

Para consultar la lista de códigos de error, visite el centro de errores de API.