調用該接口查詢指定規則動作的詳細信息。

QPS限制

單個阿里云賬號調用該接口的每秒請求數（QPS）最大限制為50。

說明 RAM用戶共享阿里云賬號配額。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String 是 GetRuleAction

系統規定參數。取值：GetRuleAction。
ActionId Long 是 100001

要查詢的規則動作ID。

您可以通過以下方式查詢規則動作ID：
IotInstanceId String 否 iot_instc_pu****_c*-v64********

實例ID。您可在物聯網平臺控制臺的實例概覽頁面，查看當前實例的ID。

注意
  • 若有ID值，必須傳入該ID值，否則調用會失敗。
  • 若無ID值，則無需傳入。

實例的更多信息，請參見實例概述。

調用API時，除了本文介紹的該API的特有請求參數，還需傳入公共請求參數。公共請求參數說明，請參見公共參數文檔。

返回數據

名稱 類型 示例值 描述
Code String iot.system.SystemException

調用失敗時，返回的錯誤碼。更多信息，請參見錯誤碼。

ErrorMessage String 系統異常

調用失敗時，返回的出錯信息。
RequestId String F2D0755D-F350-40FE-9A6D-491859DB5E5F

阿里云為該請求生成的唯一標識符。
RuleActionInfo Struct

調用成功時，返回的規則動作詳細信息。詳情參見以下參數。
Configuration String {\"topic\":\"/sys/a1zSA28****/device/thing/service/property/set\",\"topicType\":0,\"uid\":\"1231579*******\"}

該規則動作的配置信息。
ErrorActionFlag Boolean false

該規則動作是否為轉發錯誤操作數據的轉發動作，即轉發流轉到其他云產品失敗且重試失敗的數據。

  • true：該規則動作轉發錯誤操作數據。
  • false：該規則動作不轉發錯誤操作數據，而是正常轉發操作。
Id Long 100001

規則動作ID。
RuleId Long 152323

該規則動作對應的規則ID。
Type String REPUBLISH

規則動作類，取值：

  • REPUBLISH：轉發到另一個topic。
  • OTS：存儲到表格存儲。

  • MNS：發送消息到消息服務。

  • ONS：發送數據到消息隊列。

  • TSDB：存儲到高性能時間序列數據庫。

  • FC：發送數據到函數計算。

  • DATAHUB：發送數據到DataHub中。
  • RDS：存儲數據到云數據庫中。
  • AMQP：數據流轉到AMQP消費組。
Success Boolean true

是否調用成功。

  • true：調用成功。
  • false：調用失敗。

示例

請求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=GetRuleAction
&ActionId=1000001
&<公共請求參數>

正常返回示例

XML格式 

<GetRuleActionResponse>
      <RuleActionInfo>
            <Type>REPUBLISH</Type>
            <RuleId>152323</RuleId>
            <Id>100001</Id>
            <Configuration>
                  <topic>/sys/a1zSA28****/device/thing/service/property/set</topic>
                  <topicType>0</topicType>
                  <uid>1231579*******</uid>
            </Configuration>
            <ErrorActionFlag>false</ErrorActionFlag>
      </RuleActionInfo>
      <RequestId>F2D0755D-F350-40FE-9A6D-491859DB5E5F</RequestId>
      <Success>true</Success>
</GetRuleActionResponse>

JSON格式 

{
  "RuleActionInfo": {
    "Type": "REPUBLISH", 
    "RuleId": 152323, 
    "Id": 100001, 
    "Configuration": "{\"topic\":\"/sys/a1zSA28***/device/thing/service/property/set\",\"topicType\":0,\"uid\":\"1231579*******\"}", 
    "ErrorActionFlag": false
  }, 
  "RequestId": "F2D0755D-F350-40FE-9A6D-491859DB5E5F", 
  "Success": true
}