Queries detailed information of a specified rule action.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | GetRuleAction |
The operation that you want to perform. Set the value to GetRuleAction. |
ActionId | Long | Yes | 100001 |
The ID of the rule action that you want to query. You can call the CreateRuleAction operation to view the ActionId response parameter. You can also call the ListRuleActions operation to view the Id response parameter. |
IotInstanceId | String | No | iot_instc_pu****_c*-v64******** |
The ID of the instance. This parameter is not required for public instances. However, the parameter is required for the instances that you have purchased. |
In addition to the preceding exclusive request parameters, you must specify common request parameters when calling this API operation. For more information about common request parameters, see Common parameters.
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Code | String | iot.system.SystemException |
iot.system.SystemException |
ErrorMessage | String | A system exception occurred. |
The error message returned if the call failed. |
RequestId | String | F2D0755D-F350-40FE-9A6D-491859DB5E5F |
The globally unique ID that is generated by Alibaba Cloud for the request. |
RuleActionInfo | Struct |
The rule action information returned if the call was successful. For more information, see the following parameters. |
|
Configuration | String | {\"topic\":\"/sys/a1zSA28****/device/thing/service/property/set\",\"topicType\":0,\"uid\":\"1231579*******\"} |
The configurations of the rule action. |
ErrorActionFlag | Boolean | false |
Indicates whether the rule action forwarded error operation data that failed to be forwarded to the destination cloud service. A data forwarding failure indicates that forwarding retries also failed.
|
Id | Long | 100001 |
The ID of rule action. |
RuleId | Long | 152323 |
The ID of the rule based on which the rule action is performed. |
Type | String | REPUBLISH |
The type of the rule action. Valid values:
|
Success | Boolean | true |
Indicates whether the call was successful. true indicates that the call was successful. false indicates that the call failed. |
Examples
Sample requests
https://iot.cn-shanghai.aliyuncs.com/?Action=GetRuleAction
&ActionId=1000001
&<Common request parameters>
Sample success responses
XML
format
<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
format
{
"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
}
Error codes
For a list of error codes, visit the API Error Center.