查询告警开关设置

最近更新时间: 2025-02-18 17:50:29

1. 接口描述

接口请求域名: cds.api3.fincloud.tencent.cn。

查询各类告警开关的设置

默认接口请求频率限制:20次/秒。

接口更新时间:2023-03-16 16:49:26。

接口既验签名又鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:DescribeAlarmSetting
Version String 公共参数,本接口取值:2018-04-20
Region String 公共参数,本接口不需要传递此参数。

3. 输出参数

参数名称 类型 描述
AlarmSwitchAgentLogout Uint64 agent掉线告警,值为0或者1
AlarmSwitchMail Uint64 邮件告警,值为0或者1
AlarmSwitchQps Uint64 QPS告警,值为0或者1
AlarmSwitchRule Uint64 行为规则告警,值为0或者1
AlarmSwitchSql Uint64 sql风险告警,值为0或者1
AlarmSwitchSms Uint64 短信告警,值为0或者1
AlarmSwitchEnterpriseWechat Uint64 企业微信告警,值为0或者1
AlarmDuration Uint64 时间间隔
ReportNotification Int64 报表通知 int 1关闭 2开启 不变更为0
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
FailedOperation.DasbErrorCode
FailedOperation.DasbInvalidSecretId
FailedOperation.DasbInvalidSecretKey
FailedOperation.DasbAmountNotEnough
InvalidParameter.ResourceId
UnauthorizedOperation.NoPermission
UnsupportedOperation
ResourceInUse
UnauthorizedOperation
MissingParameter
InvalidParameter
AuthFailure
InternalError
RequestLimitExceeded
ResourceInsufficient
LimitExceeded
ResourceUnavailable
ResourceNotFound
DryRunOperation
OperationDenied
ResourcesSoldOut
InvalidParameterValue
FailedOperation
UnknownParameter