ListRule - IoT Platform: Central de Documentação do Alibaba Cloud

Consulta regras paginadas.

Limites de QPS

Você pode chamar esta operação de API até 20 vezes por segundo por conta.

Nota

Os usuários do Resource Access Management (RAM) de uma conta Alibaba Cloud compartilham a cota da conta.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos usar o OpenAPI Explorer para chamar esta operação. A ferramenta também gera dinamicamente códigos de exemplo para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	ListRule	A operação a ser executada. Defina o valor como ListRule.
CurrentPage	Integer	Sim	1	Número da página. Valor máximo: 1000. Valor padrão: 1.
PageSize	Integer	Sim	2	Número de entradas por página. Valores válidos: 1 a 100. Valor padrão: 10.
IotInstanceId	String	Não	iot_instc_pu*_c-v64	ID da instância. Visualize o ID da instância na aba Overview do console IoT Platform. Importante Se a instância tiver um ID, especifique este parâmetro. Caso contrário, a solicitação falhará. Se a aba Overview ou o ID da instância não estiverem visíveis no console IoT Platform, não é necessário especificar este parâmetro. Para mais informações sobre instâncias, consulte Visão geral.
ResourceGroupId	String	Não	rg-acfmxazb4ph****	ID do grupo de recursos. Importante O IoT Platform oferece suporte ao gerenciamento de grupos de recursos apenas por instância. O parâmetro ResourceGroupId é inválido. Não é necessário especificar este parâmetro.

Além dos parâmetros específicos desta operação, especifique os parâmetros comuns de solicitação. Para mais informações, consulte Parâmetros comuns.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
Code	String	iot.system.SystemException	Código de erro retornado se a solicitação falhar. Para mais informações, consulte Códigos de erro.
Data	Array of RuleInfo		Regras retornadas em caso de sucesso. Para mais informações, consulte a descrição do parâmetro RuleInfo neste tópico. Nota As regras retornadas são classificadas em ordem decrescente com base no horário de criação.
RuleInfo
CreateUserId	Long	1231579085000000	ID do usuário que criou a regra.
Created	String	Wed Feb 27 20:45:43 CST 2019	Horário de criação da regra. Exibido em UTC-6.
DataType	String	JSON	Tipo de dados da regra. Valores válidos: JSON e BINARY.
Id	Long	151454	ID da regra.
Modified	String	Wed Feb 27 20:45:43 CST 2019	Horário da última modificação da regra. Exibido em UTC-6.
Name	String	test123	Nome da regra.
ProductKey	String	a1KiV	ProductKey do produto ao qual a regra se aplica.
RuleDesc	String	rule1Desc	Descrição da regra.
Select	String	deviceName() as deviceName	Conteúdo da cláusula SELECT na instrução SQL da regra.
ShortTopic	String	+/thing/event/property/post	Nome do tópico ao qual a regra se aplica, excluindo a ProductKey. Formato: `${deviceName}/topicShortName`. ${deviceName} indica o nome do dispositivo e topicShortName indica o nome personalizado do tópico. Nota O nome do tópico pode conter os caracteres curinga `+` ou `#`. Para mais informações, consulte Tópicos.
Status	String	STOP	Estado da regra. Valores válidos: RUNNING: A regra está em execução. STOP: A regra está parada.
Topic	String	/a1T27vz****/+/thing/event/property/post	Nome do tópico ao qual a regra se aplica, incluindo a ProductKey. Formato: `${productKey}/${deviceName}/topicShortName`. Nota O nome do tópico pode conter os caracteres curinga `+` ou `#`. Para mais informações, consulte Tópicos.
UtcCreated	String	2019-02-27T12:40:43.000Z	Horário de criação da regra. Exibido em UTC.
UtcModified	String	2019-02-27T12:45:43.000Z	Horário da última modificação da regra. Exibido em UTC.
Where	String	Temperature>35	Condição da cláusula WHERE na instrução SQL da regra.
ErrorMessage	String	A system exception occurred.	Mensagem de erro retornada se a solicitação falhar.
Page	Integer	1	Número da página.
PageSize	Integer	2	Número de entradas por página.
RequestId	String	1564B626-DE97-452D-9E9B-305888AC6105	ID da solicitação.
Success	Boolean	true	Indica se a solicitação foi bem-sucedida. Valores válidos: true false
Total	Integer	25	Número total de páginas retornadas.

Exemplos

Exemplos de solicitações

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

Exemplos de respostas de sucesso

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 erro

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.