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

Consulte los detalles de una regla específica.

Límites

Máximo: 50 QPS por cuenta de Alibaba Cloud.

Nota

Los usuarios de RAM comparten la cuota de la cuenta.

Depuración

OpenAPI Explorer calcula automáticamente las firmas y genera código de ejemplo para el SDK. Se recomienda invocar esta operación en OpenAPI Explorer.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	GetRule	La operación que se va a ejecutar. Establezca el valor en GetRule.
RuleId	Long	Sí	100000	El ID de la regla. Consúltelo en la consola de IoT Platform, en Rules > Data Forwarding, o bien mediante la operación ListRule.
IotInstanceId	String	No	iot-cn-0pp1n8t****	El ID de la instancia. Consulte el ID en la página Overview de la consola de IoT Platform. Importante Obligatorio si su instancia tiene un ID. Sin este parámetro, la llamada falla. No es obligatorio si su instancia no tiene página Overview ni ID. Descripción general.

Al invocar esta operación, también debe especificar los 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 cuando la llamada termina con errores. Para más información, consulte Códigos de error.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto cuando la llamada termina con errores.
RequestId	String	58D4CEC0-3E95-4DBE-AFC1-809D1400E52F	El ID de la solicitud.
RuleInfo	Struct		Los detalles de la regla devueltos cuando la llamada es exitosa.
CreateUserId	Long	100000000000000	El ID del usuario que creó la regla.
Created	String	Thu Feb 28 14:14:33 CST 2019	La hora de creación, en formato UTC-6.
DataType	String	JSON	El tipo de datos de la regla. Valores válidos: JSON y BINARY.
Id	Long	100000	El ID de la regla.
Modified	String	Thu Feb 28 14:20:58 CST 2019	La hora de la última modificación, en formato UTC-6.
Name	String	iotrules	El nombre de la regla.
ProductKey	String	a1KiV******	El ProductKey del producto al que se aplica la regla.
RuleDesc	String	rule1Desc	La descripción de la regla.
Select	String	deviceName() as deviceName	La cláusula Select de la instrucción SQL de la regla.
ShortTopic	String	+/user/pm25data	El tema al que se aplica la regla, sin incluir el nivel de ProductKey. Formato: `${deviceName}/topicShortName`. ${deviceName} es el nombre del dispositivo y topicShortName es el nombre del tema personalizado. Nota Los comodines `+` y `#` se describen en Comodines de temas.
Status	String	STOP	El estado de la regla. Valores válidos: RUNNING: Running STOP: Stopped
Topic	String	/a1QsMlL44pp/+/user/pm25data	El tema completo al que se aplica la regla. Formato: `${productKey}/${deviceName}/topicShortName`. Nota Los comodines `+` y `#` se describen en Comodines de temas.
TopicType	Integer	1	El tipo de tema. Se devuelve únicamente si la regla incluye una instrucción SQL. Valores válidos: 0: tema de comunicación básica o tema de comunicación TSL. 1: tema personalizado. 2: tema de estado del dispositivo. Devuelve -1 si no se configuró ninguna instrucción SQL.
UtcCreated	String	2019-02-28T06:14:33.000Z	La hora de creación, en formato UTC.
UtcModified	String	2019-02-28T06:20:58.000Z	La hora de la última modificación, en formato UTC.
Where	String	Temperature>35	La cláusula Where de la instrucción SQL de la regla.
Success	Boolean	true	Indica si la llamada fue exitosa. true: la llamada fue exitosa. false: la llamada terminó con errores.

Ejemplos

Solicitudes de ejemplo

https://iot.cn-shanghai.aliyuncs.com/?Action=GetRule
&RuleId=100000
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<GetRuleResponse>
  <RequestId>85648524-E5EE-418E-BD16-FAFBB4FF3645</RequestId>
  <Success>true</Success>
  <RuleInfo>
        <DataType>JSON</DataType>
        <ShortTopic>+/user/pm25data</ShortTopic>
        <ProductKey>a1QsMl****</ProductKey>
        <UtcModified>2019-12-23T03:34:45.000Z</UtcModified>
        <CreateUserId>198426864326****</CreateUserId>
        <UtcCreated>2019-12-23T02:32:06.000Z</UtcCreated>
        <Name>Ruff_rule1</Name>
        <Status>RUNNING</Status>
        <Select>deviceName() as deviceName , timestamp('yyyy-MM-dd HH:mm:ss') as time, pm25, pm10</Select>
        <Created>Mon Dec 23 10:32:06 CST 2019</Created>
        <Modified>Mon Dec 23 11:34:45 CST 2019</Modified>
        <TopicType>1</TopicType>
        <Topic>/a1QsMlL****/+/user/pm25data</Topic>
        <Id>425367</Id>
  </RuleInfo>
</GetRuleResponse>

Formato JSON

{
    "RequestId": "85648524-E5EE-418E-BD16-FAFBB4FF3645",
    "Success": true,
    "RuleInfo": {
        "DataType": "JSON",
        "ShortTopic": "+/user/pm25data",
        "ProductKey": "a1QsMl****",
        "UtcModified": "2019-12-23T03:34:45.000Z",
        "CreateUserId": "198426864326****",
        "UtcCreated": "2019-12-23T02:32:06.000Z",
        "Name": "Ruff_rule1",
        "Status": "RUNNING",
        "Select": "deviceName() as deviceName , timestamp('yyyy-MM-dd HH:mm:ss') as time, pm25, pm10",
        "Created": "Mon Dec 23 10:32:06 CST 2019",
        "Modified": "Mon Dec 23 11:34:45 CST 2019",
        "TopicType": 1,
        "Topic": "/a1QsMlL****/+/user/pm25data",
        "Id": 425367
    }
}

Códigos de error

Todos los códigos de error se enumeran en el Centro de errores de API.