新功能发布记录
Domain name for API request: mqtt.intl.tencentcloudapi.com.
This API is used to modify message enrichment rules.
Note: All attributes of the current rule must be submitted, even if specific fields are not modified.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: ModifyMessageEnrichmentRule. |
| Version | Yes | String | Common Params. The value used for this API: 2024-05-16. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| Id | Yes | Integer | Message enrichment rule ID. |
| InstanceId | Yes | String | Tencent cloud MQTT instance ID, obtained from the DescribeInstanceList api or console. |
| RuleName | No | String | Rule name, which cannot be empty, contains 3 to 64 characters, and supports chinese, letters, digits, "-", and "_". |
| Condition | No | String | Rule matching conditions in JSON format, Base64 encoding is required. Creating a Billing Resource Order {"clientId":"client-1","username":"client-1","topic":"home/room1"} Specifies the Base64-encoded content. eyJjbGllbnRJZCI6ImNsaWVudC0xIiwidXNlcm5hbWUiOiJjbGllbnQtMSIsInRvcGljIjoiaG9tZS9yb29tMSJ9 |
| Actions | No | String | Specifies the action of rule execution in JSON format, which must be Base64 encoded. Creating a Billing Resource Order {"messageExpiryInterval":360,"responseTopic":"replies/${clientid}","correlationData":"${traceid}","userProperty":[{"key":"trace-id","value":"${traceid}"}]} Specifies the BASE64-encoded string eyJtZXNzYWdlRXhwaXJ5SW50ZXJ2YWwiOjM2MCwicmVzcG9uc2VUb3BpYyI6InJlcGxpZXMvJHtjbGllbnRpZH0iLCJjb3JyZWxhdGlvbkRhdGEiOiIke3RyYWNlaWR9IiwidXNlclByb3BlcnR5IjpbeyJrZXkiOiJ0cmFjZS1pZCIsInZhbHVlIjoiJHt0cmFjZWlkfSJ9XX0=. |
| Priority | No | Integer | Rule priority. a smaller number indicates a higher priority. high priority overrides low priority. the UserProperty field will be merged. |
| Status | No | Integer | Rule status. valid values: 0 (undefined), 1 (activate), 2 (deactivate). default: deactivate. |
| Remark | No | String | Specifies the remark information with a maximum length of 128 characters. |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you the example.
POST / HTTP/1.1
Host: mqtt.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyMessageEnrichmentRule
<Common request parameters>
{
"Id": 6,
"InstanceId": "mqtt-g4r4wpne",
"RuleName": "rule2"
}{
"Error": null,
"RequestId": null,
"Response": {
"RequestId": "018d5c6a-33bb-41b5-aa38-98cd4e226546"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| ResourceNotFound.Instance | ResourceNotFound.Instance |
文档反馈