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

Consulta reglas por página.

Límites de QPS

Puede llamar a esta operación de API hasta 20 veces por segundo por cuenta.

Nota

Los usuarios de Resource Access Management (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 su comodidad, le recomendamos que llame a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	ListRule	La operación que desea realizar. Establezca el valor en ListRule.
CurrentPage	Integer	Sí	1	El número de página. Valor máximo: 1000. Valor predeterminado: 1.
PageSize	Integer	Sí	2	El número de entradas por página. Valores válidos: de 1 a 100. Valor predeterminado: 10.
IotInstanceId	String	No	iot_instc_pu*_c-v64	El ID de la instancia. Puede consultar el ID de la instancia en la pestaña Overview de la consola de IoT Platform. Importante Si la instancia tiene un ID, debe especificar este parámetro. Si no lo especifica, la solicitud fallará. Si la pestaña Overview o el ID de la instancia no se muestran en la consola de IoT Platform, no es necesario que especifique este parámetro. Para obtener más información sobre las instancias, consulte Descripción general.
ResourceGroupId	String	No	rg-acfmxazb4ph****	El ID del resource group. Importante IoT Platform admite la gestión de resource groups únicamente por instancia. El parámetro ResourceGroupId no es válido. No es necesario que especifique este parámetro.

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

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.system.SystemException	El código de error devuelto si la solicitud falló. Para obtener más información, consulte Códigos de error.
Data	Array of RuleInfo		Las reglas devueltas si la solicitud fue exitosa. Para obtener más información, consulte la descripción del parámetro RuleInfo en este tema. Nota Las reglas devueltas se ordenan en forma descendente según la hora de creación.
RuleInfo
CreateUserId	Long	1231579085000000	El ID del usuario que creó la regla.
Created	String	Wed Feb 27 20:45:43 CST 2019	La hora en que se creó la regla. La hora se muestra en UTC-6.
DataType	String	JSON	El tipo de datos de la regla. Valores válidos: JSON y BINARY.
Id	Long	151454	El ID de la regla.
Modified	String	Wed Feb 27 20:45:43 CST 2019	La hora de la última modificación de la regla. La hora se muestra en UTC-6.
Name	String	test123	El nombre de la regla.
ProductKey	String	a1KiV	La clave ProductKey del producto al que se aplica la regla.
RuleDesc	String	rule1Desc	La descripción de la regla.
Select	String	deviceName() as deviceName	El contenido en la cláusula SELECT de la instrucción SQL de la regla.
ShortTopic	String	+/thing/event/property/post	El nombre del topic al que se aplica la regla, sin incluir ProductKey. El valor tiene el formato `${deviceName}/topicShortName`. ${deviceName} indica el nombre del dispositivo y topicShortName indica el nombre personalizado del topic. Nota El nombre del topic puede contener el carácter comodín `+` o `#`. Para obtener más información, consulte Topics.
Status	String	STOP	El estado de la regla. Valores válidos: RUNNING: La regla se está ejecutando. STOP: La regla está detenida.
Topic	String	/a1T27vz****/+/thing/event/property/post	El nombre del topic al que se aplica la regla, incluyendo ProductKey. El valor tiene el formato `${productKey}/${deviceName}/topicShortName`. Nota El nombre del topic puede contener el carácter comodín `+` o `#`. Para obtener más información, consulte Topics.
UtcCreated	String	2019-02-27T12:40:43.000Z	La hora en que se creó la regla. La hora se muestra en UTC.
UtcModified	String	2019-02-27T12:45:43.000Z	La hora de la última modificación de la regla. La hora se muestra en UTC.
Where	String	Temperature>35	La condición en la cláusula WHERE de la instrucción SQL de la regla.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto si la solicitud falló.
Page	Integer	1	El número de página.
PageSize	Integer	2	El número de entradas por página.
RequestId	String	1564B626-DE97-452D-9E9B-305888AC6105	El ID de la solicitud.
Success	Boolean	true	Indica si la solicitud fue exitosa. Valores válidos: true false
Total	Integer	25	El número total de páginas devueltas.

Ejemplos

Solicitudes de ejemplo

https://iot.cn-shanghai.aliyuncs.com/?Action=ListRule
&PageSize=2
&CurrentPage=1
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<ListRuleResponse>
  <Data>
        <RuleInfo>
              <DataType>JSON</DataType>
              <ProductKey>a1T27vz****</ProductKey>
              <CreateUserId>198426864326****</CreateUserId>
              <UtcModified>2020-02-26T06:38:27.000Z</UtcModified>
              <UtcCreated>2020-02-26T02:50:44.000Z</UtcCreated>
              <Where>Temperature&gt;35</Where>
              <Name>testrule2</Name>
              <Status>STOP</Status>
              <Select>deviceName() as DeviceName</Select>
              <Created>Wed Feb 26 10:50:44 CST 2020</Created>
              <Modified>Wed Feb 26 14:38:27 CST 2020</Modified>
              <Topic>/a1T27vz****/+/thing/event/property/post</Topic>
              <Id>497350</Id>
        </RuleInfo>
  </Data>
  <Page>1</Page>
  <PageSize>1</PageSize>
  <RequestId>1A6131EC-7504-4673-B997-DEFC6B363A37</RequestId>
  <Success>true</Success>
  <Total>5</Total>
</ListRuleResponse>

Formato JSON

{
	"Data": {
		"RuleInfo": [
			{
				"DataType": "JSON",
				"ProductKey": "a1T27vz****",
				"CreateUserId": "198426864326****",
				"UtcModified": "2020-02-26T06:38:27.000Z",
				"UtcCreated": "2020-02-26T02:50:44.000Z",
				"Where": "Temperature>35",
				"Name": "testrule2",
				"Status": "STOP",
				"Select": "deviceName() as DeviceName",
				"Created": "Wed Feb 26 10:50:44 CST 2020",
				"Modified": "Wed Feb 26 14:38:27 CST 2020",
				"Topic": "/a1T27vz****/+/thing/event/property/post",
				"Id": 497350
			}
		]
	},
	"Page": 1,
	"PageSize": 1,
	"RequestId": "1A6131EC-7504-4673-B997-DEFC6B363A37",
	"Success": true,
	"Total": 5
}

Códigos de error

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.