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

Consulta los detalles de un parser específico, incluida su información básica, script de análisis, estado y origen de datos asociado.

Límites de QPS

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

Nota

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

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Se recomienda llamar a esta operación desde OpenAPI Explorer. Esta herramienta genera dinámicamente código de ejemplo para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	GetParser	La operación que se va a ejecutar. Establezca el valor en GetParser.
ParserId	Integer	Sí	1001	El ID del parser. Llame a la operación ListParser para obtener los ID de parser.
IotInstanceId	String	No	iot-n8t***	El ID de la instancia. Busque el ID en la página Overview de la consola de IoT Platform. Importante Si su instancia tiene un ID, debe especificarlo; de lo contrario, la llamada fallará. Si no se generó una página Overview o un ID para su instancia, omita este parámetro. Descripción general.

Esta operación también requiere 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 devuelto si la llamada falla. Los códigos válidos se enumeran en Códigos de error.
Data	Struct		Los detalles del parser.
DataSourceId	Long	1003	El ID del origen de datos asociado con el parser.
Description	String	Forward data.	La descripción del parser.
Name	String	DataParser	El nombre del parser.
ParserId	Long	1001	El ID del parser.
Script	String	var data = payload("json"); var h = data.items.Humidity.value; var t = data.items.Temperature.value; writeTsdb(1000,timestamp(),"temperature", t , {"deviceName":deviceName()}); writeTsdb(1000,timestamp(),"humidity", h , {"deviceName":deviceName()});	El script de análisis publicado del parser.
ScriptDraft	String	var data = payload("json"); var h = data.items.Humidity.value; var t = data.items.Temperature.value; writeTsdb(1000,timestamp(),"temperature", t , {"deviceName":deviceName()}); writeTsdb(1000,timestamp(),"humidity", h , {"deviceName":deviceName()});	El borrador del script de análisis.
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 estado anómalo.
UtcCreated	String	2022-03-27T12:45:43.000Z	La hora en que se creó el parser, en formato UTC. Formato:`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`.
UtcModified	String	2022-04-27T12:45:43.000Z	La hora de la última modificación del parser, en formato UTC. Formato:`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto si la solicitud falla.
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 falló.

Ejemplos

Solicitudes de ejemplo

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=GetParser
&ParserId=1001
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<GetParserResponse>
  <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
  <Data>
        <Status>STOP</Status>
        <Script>var data = payload("json"); var h = data.items.Humidity.value; var t = data.items.Temperature.value; writeTsdb(1000,timestamp(),"temperature", t , {"deviceName":deviceName()}); writeTsdb(1000,timestamp(),"humidity", h , {"deviceName":deviceName()});</Script>
        <Description>Forward data. </Description>
        <UtcCreated>2022-03-27T12:45:43.000Z</UtcCreated>
        <ScriptDraft>var data = payload("json"); var h = data.items.Humidity.value; var t = data.items.Temperature.value; writeTsdb(1000,timestamp(),"temperature", t , {"deviceName":deviceName()}); writeTsdb(1000,timestamp(),"humidity", h , {"deviceName":deviceName()});</ScriptDraft>
        <UtcModified>2022-04-27T12:45:43.000Z</UtcModified>
        <ParserId>1001</ParserId>
        <DataSourceId>1003</DataSourceId>
        <Name>DataParser</Name>
  </Data>
  <Success>true</Success>
</GetParserResponse>

Formato JSON

{
    "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
    "Data": {
        "Status": "STOP",
        "Script": "var data = payload(\"json\"); var h = data.items.Humidity.value; var t = data.items.Temperature.value; writeTsdb(1000,timestamp(),\"temperature\", t , {\"deviceName\":deviceName()}); writeTsdb(1000,timestamp(),\"humidity\", h , {\"deviceName\":deviceName()});",
        "Description": "Forward data.",
        "UtcCreated": "2022-03-27T12:45:43.000Z",
        "ScriptDraft": "var data = payload(\"json\"); var h = data.items.Humidity.value; var t = data.items.Temperature.value; writeTsdb(1000,timestamp(),\"temperature\", t , {\"deviceName\":deviceName()}); writeTsdb(1000,timestamp(),\"humidity\", h , {\"deviceName\":deviceName()});",
        "UtcModified": "2022-04-27T12:45:43.000Z",
        "ParserId": 1001,
        "DataSourceId": 1003,
        "Name": "DataParser"
    },
    "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.	Ocurrió una excepción del sistema.
400	iot.common.InvalidFormattedParameter	The parameter format is invalid.	El formato del parámetro no es válido.
400	iot.rule.QueryRuleFailed	An error occurred while querying the rule.	El sistema no pudo consultar la regla.

Hay códigos de error adicionales disponibles en el Centro de errores de API.