Domain name for API request: wedata.intl.tencentcloudapi.com.
Modifies 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: UpdateOpsAlarmRule. |
| 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. |
| AlarmRuleId | Yes | String | Specifies the unique id of the Alarm rule, obtained through the GetAlarmRule/ListAlarmRule api. |
| AlarmRuleName | No | String | Specifies the new rule name of the Alarm rule. |
| 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 |
| MonitorObjectIds.N | No | Array of String | Pass different business IDs based on the MonitorType setting: 1 (Task): MonitorObjectIds should be a list of task IDs. 2 (Workflow): MonitorObjectIds should be a list of workflow IDs (workflow IDs can be obtained via the ListWorkflows API). 3 (Project): MonitorObjectIds should be a list of project IDs. |
| AlarmTypes.N | No | 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 projectFailureInstanceUpwardVolatilityAlarm: Alarm when the upward fluctuation count 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 projectSuccessInstanceDownwardVolatilityAlarm: Alarm when the downward fluctuation count of successful instances for the day exceeds the threshold projectFailureInstanceCountAlarm: Alarm when the number of failed instances for the day exceeds the threshold projectFailureInstanceProportionAlarm: Alarm when the proportion of failed instances for the day exceeds the threshold reconciliationFailure: Alarm when offline reconciliation task fails reconciliationOvertime: Alarm when offline reconciliation task runs overtime reconciliationMismatch: Alarm when the number of mismatched records in reconciliation exceeds the threshold |
| 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. |
| Status | No | Integer | Enable status of the Alarm rule. valid values: 0 (disabled), 1 (enabled). |
| AlarmLevel | No | Integer | Alarm level. 1. ordinary, 2. important, 3. critical. |
| AlarmGroups.N | No | Array of AlarmGroup | Describes the Alarm recipient configuration message. |
| Description | No | String | Alarm description. |
| Parameter Name | Type | Description |
|---|---|---|
| Data | ModifyAlarmRuleResult | Indicates whether the update is successful. true: update successful. false: failed to update. |
| 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: UpdateOpsAlarmRule
<Common request parameters>
{
"ProjectId": "1460947878944567296",
"AlarmRuleId": "01b38b0a-6102-4b96-ac61-cfabb7f22552",
"AlarmRuleName": "dddd22xxss",
"MonitorObjectType": 2,
"MonitorObjectIds": [
"832b83ea-d285-43bd-b4bb-5a268aa8cb50"
],
"AlarmTypes": [
"failure"
],
"AlarmRuleDetail": {
"Trigger": 2,
"DataBackfillOrRerunTrigger": 1,
"TimeOutExtInfo": [
{
"RuleType": 1,
"Type": 1
}
],
"DataBackfillOrRerunTimeOutExtInfo": [
{
"RuleType": 1,
"Type": 1
}
],
"ProjectInstanceStatisticsAlarmInfoList": [
{
"AlarmType": "projectSuccessInstanceDownwardFluctuationAlarm",
"InstanceThresholdCountPercent": 1,
"InstanceThresholdCount": 2,
"StabilizeThreshold": 3,
"StabilizeStatisticsCycle": 4,
"IsCumulant": true
}
],
"ReconciliationExtInfo": [
{
"RuleType": "reconciliationMismatch",
"MismatchCount": 100,
"Hour": 100,
"Min": 1
}
]
},
"Status": 1,
"AlarmLevel": 3,
"AlarmGroups": [
{
"AlarmEscalationRecipientIds": [],
"AlarmEscalationInterval": 0,
"NotificationFatigue": {
"NotifyCount": 1,
"NotifyInterval": 5,
"QuietIntervals": [
{
"DaysOfWeek": [
1
],
"StartTime": "12:00:00",
"EndTime": "15:00:00"
}
]
},
"AlarmWays": [
"1"
],
"WebHooks": [
{
"AlarmWay": "7",
"WebHooks": [
"xxb"
]
}
],
"AlarmRecipientType": 3,
"AlarmRecipientIds": [
"158"
]
}
],
"Description": "this is your description"
}{
"Response": {
"Data": {
"Status": true
},
"RequestId": "a821688d-110f-49ae-8d79-818cbc2ec0cd"
}
}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 |
Apakah halaman ini membantu?
Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.
masukan