Domain name for API request: wedata.intl.tencentcloudapi.com.
This API is used to set alarm rules.
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: CreateOpsAlarmRule. |
| Version | Yes | String | Common Params. The value used for this API: 2025-08-06. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| ProjectId | Yes | String | Project ID. |
| AlarmRuleName | Yes | String | Specifies the Alarm rule name. |
| MonitorObjectIds.N | Yes | Array of String | Monitoring Object Business ID List - Pass different business IDs depending on the value of MonitorType: 1 (Task): MonitorObjectIds should contain a list of task IDs. 2 (Workflow): MonitorObjectIds should contain a list of workflow IDs (workflow IDs can be obtained using the ListWorkflows API). 3 (Project): MonitorObjectIds should contain a list of project IDs. |
| AlarmTypes.N | Yes | Array of String | Alarm Rule Monitoring Types: failure: Failure alarm overtime: Timeout alarm success: Success alarm backTrackingOrRerunSuccess: Alarm when backfill/rerun succeeds backTrackingOrRerunFailure: Alarm when backfill/rerun fails projectFailureInstanceUpwardFluctuationAlarm: Alarm when the upward fluctuation rate of failed instances for the day exceeds the threshold projectSuccessInstanceDownwardFluctuationAlarm: Alarm when the downward fluctuation rate of successful instances for the day exceeds the threshold reconciliationFailure: Alarm when an offline reconciliation task fails reconciliationOvertime: Alarm when an offline reconciliation task runs overtime reconciliationMismatch: Alarm when the number of mismatched records in reconciliation exceeds the threshold |
| AlarmGroups.N | Yes | Array of AlarmGroup | Alarm recipient configuration. |
| MonitorObjectType | No | Integer | Monitoring Object Type Task-level Monitoring - Can be configured by Task / Workflow / Project: 1 = Task (default) 2 = Workflow 3 = Project Project-level Monitoring - Monitors overall task fluctuations within a project: 7 = Project fluctuation monitoring alarm |
| AlarmRuleDetail | No | AlarmRuleDetail | Alarm Rule Configuration Information Success Alarms - No configuration required; Failure Alarms - Can be configured to trigger on the first failure or on all retry failures; Timeout Alarms - Require configuration of the timeout type and timeout threshold; Project Fluctuation Alarms - Require configuration of the fluctuation rate and the debounce cycle. |
| AlarmLevel | No | Integer | Alarm level. 1. ordinary, 2. important, 3. critical (default: 1. ordinary). |
| Description | No | String | Describes the Alarm rule. |
| Parameter Name | Type | Description |
|---|---|---|
| Data | CreateAlarmRuleData | Specifies the unique id of the Alarm rule. |
| 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. |
POST / HTTP/1.1
Host: wedata.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateOpsAlarmRule
<Common request parameters>
{
"ProjectId": "1460947878944567296",
"AlarmRuleName": "ruleName222",
"MonitorObjectIds": [
"832b83ea-d285-43bd-b4bb-5a268aa8cb50"
],
"AlarmTypes": [
"failure"
],
"AlarmGroups": [
{
"AlarmWays": [
"1"
],
"AlarmRecipientType": 2
}
],
"MonitorObjectType": 2,
"AlarmRuleDetail": {
"TimeOutExtInfo": [
{
"RuleType": 1,
"Type": 1,
"Min": 1
}
]
}
}{
"Response": {
"Data": {
"AlarmRuleId": "d736b8ba-b6d9-4a21-824a-84bdda3d9731"
},
"RequestId": "71ff56d1-7400-48f9-9c79-c749281c01c0"
}
}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 |
|---|---|
| FailedOperation | Operation failed. |
| InvalidParameter.MissingRequestParameter | Missing Servlet Request Parameter |
| InvalidParameterValue.RuleNameRepeated | Alarm rule name is duplicate. |
| InvalidParameterValue.ValidationError | Param Validation Error |
文档反馈