全部產品
Search
文件中心

IoT Platform:GetRuleAction

更新時間:Feb 11, 2025

調用該介面查詢指定規則動作的詳細資料。

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:儲存到Table Store。
  • MNS:發送訊息到Message Service。

  • FC:發送資料到Function Compute。

  • 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
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。