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

Consulta todas as ações de encaminhamento de dados configuradas para uma regra específica. Ao acionar a regra, o sistema encaminha os dados para diferentes destinos conforme as ações definidas.

Limites de QPS

Cada conta Alibaba Cloud pode executar até 50 consultas por segundo (QPS).

Nota

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

Depuração

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

Parâmetros da solicitação

Parâmetro	Tipo de dados	Obrigatório	Exemplo	Descrição
Action	String	Sim	ListRuleActions	A operação a ser executada. Defina o valor como ListRuleActions.
RuleId	Long	Sim	10000	O ID da regra. Faça login no console do IoT Platform e acesse a página de detalhes da instância que deseja gerenciar. Na página de detalhes da instância, escolha Rules Engine > Data Forwarding para obter o ID da regra. Alternativamente, chame a operação ListRule para visualizar o valor do parâmetro Id na resposta.
IotInstanceId	String	Não	iot_instc_pu***_c-v64********	O ID da instância. Visualize o ID da instância na página Overview do console do IoT Platform. Importante Se sua instância possuir um ID, especifique-o neste parâmetro. Caso contrário, a chamada falhará. Se a página Overview ou o ID da instância não aparecer no console do IoT Platform, não configure este parâmetro. Para mais informações sobre a instância, consulte Visão geral.

Além dos parâmetros específicos mencionados anteriormente, especifique os parâmetros comuns ao chamar esta operação. Para mais informações, consulte Parâmetros comuns.

Parâmetros de resposta

Parâmetro	Tipo de dados	Exemplo	Descrição
Code	String	iot.system.SystemException	Código de erro retornado em caso de falha na chamada. Para mais informações, consulte Códigos de erro.
ErrorMessage	String	A system exception occurred.	Mensagem de erro retornada em caso de falha na chamada.
RequestId	String	22254BDB-3DC1-4643-8D1B-EE0437EF09A9	ID da solicitação.
RuleActionList	Array of RuleActionInfo		Em caso de sucesso, retorna todas as ações de encaminhamento de dados configuradas para a regra especificada. Para detalhes sobre os dados retornados, consulte o parâmetro RuleActionInfo abaixo.
RuleActionInfo
Configuration	String	{\"endPoint\":\"http://ShanghaiRegion.cn-shanghai.ots.aliyuncs.com\",\"instanceName\":\"ShanghaiRegion\",\"primaryKeys\":[{\"columnName\":\"temperature\",\"columnType\":\"INTEGER\",\"columnValue\":\"${deviceName}\"}],\"regionName\":\"cn-shanghai\",\"role\":{\"roleArn\":\"acs:ram::1231579085****:role/aliyuniotaccessingotsrole\",\"roleName\":\"AliyunIOTAccessingOTSRole\"},\"tableName\":\"iottest\",\"uid\":\"1231579085****\"}	Configurações do destino de dados.
ErrorActionFlag	Boolean	false	Indica se o destino recebe dados de operações com erro. Esses dados referem-se a falhas em dois encaminhamentos consecutivos. true: O destino recebe dados de operações com erro. false: O destino não recebe dados de operações com erro.
Id	Long	139099	ID da ação de encaminhamento de dados para o destino.
RuleId	Long	10000	ID da regra associada ao encaminhamento de dados para o destino.
Status	String	NORMAL	Status da ação de encaminhamento de dados. Valores válidos: INIT: Configuração em andamento. NORMAL: Configuração concluída; ação pronta para execução. INVALID: Dados de configuração inválidos; falha na execução. SHORTCUT: Exceção detectada; ação interrompida.
Type	String	OTS	Tipo da ação de encaminhamento de dados. Valores válidos: REPUBLISH: Encaminhamento para um tópico. OTS: Armazenamento no Tablestore. MNS: Encaminhamento para o Message Service (MNS). ONS: Encaminhamento para o Message Queue for Apache RocketMQ. TSDB: Armazenamento no Time Series Database. FC: Encaminhamento para o Function Compute. RDS: Encaminhamento para o ApsaraDB RDS. AMQP: Encaminhamento para um grupo de consumidores do Advanced Message Queuing Protocol (AMQP).
Success	Boolean	true	Indica se a chamada foi bem-sucedida. true: Chamada bem-sucedida. false: Falha na chamada.

Exemplos

Exemplos de solicitações

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

Exemplo de resposta de sucesso

Formato XML

<ListRuleActionsResponse>
  <RuleActionList>
        <RuleActionInfo>
              <Type>OTS</Type>
              <RuleId>10000</RuleId>
              <Id>139099</Id>
              <Status>NORMAL</Status>
              <Configuration>{"endPoint":"http://ShanghaiRegion.cn-shanghai.ots.aliyuncs.com","instanceName":"ShanghaiRegion","primaryKeys":[{"columnName":"temperature","columnType":"INTEGER","columnValue":"${deviceName}"}],"regionName":"cn-shanghai","role":{"roleArn":"acs:ram::1231579085******:role/aliyuniotaccessingotsrole","roleName":"AliyunIOTAccessingOTSRole"},"tableName":"iottest","uid":"1231579085******"}</Configuration>
              <ErrorActionFlag>false</ErrorActionFlag>
        </RuleActionInfo>
        <RuleActionInfo>
              <Type>REPUBLISH</Type>
              <RuleId>152323</RuleId>
              <Id>142401</Id>
              <Status>NORMAL</Status>
              <Configuration>{"topic":"/sys/a1zSA28H***/device/thing/service/property/set","topicType":0,"uid":"1231579085******"}</Configuration>
              <ErrorActionFlag>false</ErrorActionFlag>
        </RuleActionInfo>
  </RuleActionList>
  <RequestId>22254BDB-3DC1-4643-8D1B-EE0437EF09A9</RequestId>
  <Success>true</Success>
</ListRuleActionsResponse>

Formato JSON

{
  "RuleActionList": {
    "RuleActionInfo": [
      {
        "Type": "OTS", 
        "RuleId": 10000, 
        "Id": 139099, 
        "Status":"NORMAL",
        "Configuration": "{\"endPoint\":\"http://ShanghaiRegion.cn-shanghai.ots.aliyuncs.com\",\"instanceName\":\"ShanghaiRegion\",\"primaryKeys\":[{\"columnName\":\"temperature\",\"columnType\":\"INTEGER\",\"columnValue\":\"${deviceName}\"}],\"regionName\":\"cn-shanghai\",\"role\":{\"roleArn\":\"acs:ram::1231579085******:role/aliyuniotaccessingotsrole\",\"roleName\":\"AliyunIOTAccessingOTSRole\"},\"tableName\":\"iottest\",\"uid\":\"1231579085******\"}", 
        "ErrorActionFlag": false
      }, 
      {
        "Type": "REPUBLISH", 
        "RuleId": 152323, 
        "Id": 142401, 
        "Status": "NORMAL",
        "Configuration": "{\"topic\":\"/sys/a1zSA28H***/device/thing/service/property/set\",\"topicType\":0,\"uid\":\"1231579085******\"}", 
        "ErrorActionFlag": false
      }
    ]
  }, 
  "RequestId": "22254BDB-3DC1-4643-8D1B-EE0437EF09A9", 
  "Success": true
}

Códigos de erro

Para obter uma lista de códigos de erro, visite o Centro de Erros.