tencent cloud

数据开发治理平台 WeData

产品动态
动态发布记录(2026年)
产品简介
产品概述
产品优势
产品架构
产品功能
应用场景
购买指南
计费概述
产品版本购买说明
执行资源购买说明
购买方式
欠费说明
退费说明
准备工作
账号和权限管理概述
添加白名单/安全组(可选)
通过 Microsoft Entra ID(Azure AD)单点登录(SSO)WeData
操作指南
管理控制台
项目管理
数据集成
Studio
数据开发
数据分析
数据科学
数据治理(with Unity Semantics)
API 文档
History
Introduction
API Category
Making API Requests
Smart Ops Related Interfaces
Project Management APIs
Resource Group APIs
Data Development APIs
Data Asset - Data Dictionary APIs
Data Development APIs
Ops Center APIs
Data Operations Related Interfaces
Data Exploration APIs
Asset APIs
Metadata Related Interfaces
Task Operations APIs
Data Security APIs
Instance Operation and Maintenance Related Interfaces
Data Map and Data Dictionary APIs
Data Quality Related Interfaces
DataInLong APIs
Platform Management APIs
Data Source Management APIs
Data Quality APIs
Platform Management APIs
Asset Data APIs
Data Source Management APIs
Data Types
Error Codes
WeData API 2025-08-06
服务等级协议
相关协议
隐私协议
数据处理和安全协议
联系我们
词汇表

UpdateOpsAlarmRule

聚焦模式
字号
最后更新时间: 2026-03-02 12:26:01

1. API Description

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.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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.

3. Output Parameters

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.

4. Example

Example1 UpdateOpsAlarmRule

Input Example

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

Output Example

{
    "Response": {
        "Data": {
            "Status": true
        },
        "RequestId": "a821688d-110f-49ae-8d79-818cbc2ec0cd"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈