SetEventSubscription - 配置事件订阅设置

调用SetEventSubscription接口,配置数据库实例的事件订阅设置。

接口说明

使用该接口需满足以下前提条件:

  • 使用阿里云或 DAS 的 SDK 时,建议使用最新版本。
  • 使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。
  • 数据库实例已接入 DAS。

说明 事件订阅已集成至告警功能。如果在控制台配置了事件告警,通过该 API 接口配置的事件订阅设置将被事件告警覆盖。配置事件告警请参见配置告警

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。

rm-2ze8g2am97624****
EventContextstring

支持的事件场景,当前仅支持 AllContext,表示支持所有场景。

AllContext
Langstring

事件通知的语言,当前仅支持zh-CN,表示事件通知为中文。

zh-CN
MinIntervalstring

通知最小间隔时间,单位为秒(s)。

60
ContactNamestring

告警事件订阅人名称,多个名称间以英文逗号分隔。

默认联系人
ChannelTypestring

通知方式。

  • hdm_alarm_sms:手机短信。
  • dingtalk:钉钉机器人。
  • hdm_alarm_sms_and_email:手机短信+邮件。
  • hdm_alarm_sms,dingtalk:手机短信+钉钉机器人。
hdm_alarm_sms,dingtalk
ContactGroupNamestring

告警事件订阅组名称,多个名称以英文逗号分隔。

默认联系组
Levelstring

需要进行通知的事件级别,取值:

  • Notice:通知(包含 NoticeOptimizationWarnCritical 级别的事件)。
  • Optimization:优化(包含 OptimizationWarnCritical 级别的事件)。
  • Warn:警告(包含 WarnCritical 级别的事件)。
  • Critical:严重(仅包含 Critical 级别的事件)。

各个级别事件的含义如下:

  • 通知:暂无建议的数据库异常事件。
  • 优化:根据数据库运行情况给出优化建议的事件。
  • 警告:需要关注的可能会影响数据库的事件。
  • 严重:影响数据库运行的事件。
Optimization
Activestring

是否启用事件订阅功能:

  • 0:关闭。
  • 1:开启。
1
Severitystring

按照事件类型设置事件的告警级别。

输入格式:{"事件类型 1":"告警级别", "事件类型 2":"告警级别"}

事件类型:

  • AutoScale:弹性伸缩事件。
  • SQLThrottle:限流事件。
  • TimeSeriesAbnormal:时序异常检测事件。
  • SQLOptimize:SQL 优化事件。
  • ResourceOptimize:空间优化事件。

告警级别:

  • info:一般。
  • noticed:通知。
  • warning:警告。
  • critical:严重。
{"AutoScale":"critical","SQLThrottle":"info","TimeSeriesAbnormal":"warning"}
DispatchRulestring

按照事件类型设置事件的消息通知规则,此参数为空时,以 MinIntervalChannelType 设置为准。

输入格式:{"silenced": {"事件类型 1":是否打开自适应静默, "事件类型 2":是否打开自适应静默},"min_interval":{"事件类型 1":通知最小间隔, "事件类型 2":通知最小间隔},"alert_type": {"事件类型 1":"通知方式", "事件类型 2":"通知方式"}}

  • silenced:是否打开自适应静默。打开自适应静默后,事件中连续告警的发送间隔变为min_interval设置值和该事件持续时间 1/3 中的最大值。
    • 1:打开。
    • 2:关闭。
  • min_interval:通知最小间隔时间,单位为秒(s)。
  • alert_type:通知方式,取值:
    • hdm_alarm_sms:手机短信。
    • dingtalk:钉钉机器人。
    • hdm_alarm_sms_and_email:手机短信+邮件。
    • hdm_alarm_sms,dingtalk:手机短信+钉钉机器人。
{"silenced": {"AutoScale":1, "SQLThrottle":0, "TimeSeriesAbnormal": 1}, "min_interval": {"AutoScale":300, "SQLThrottle":360, "TimeSeriesAbnormal": 120}, "alert_type": {"AutoScale":"hdm_alarm_sms", "SQLThrottle":"hdm_alarm_sms_and_email", "TimeSeriesAbnormal": "hdm_alarm_sms,dingtalk"}}

返回参数

名称类型描述示例值
object

返回信息列表。

Codestring

返回的状态码。

200
Dataobject

详细信息列表。

activeinteger

是否启用事件订阅:

  • 0:关闭。
  • 1:开启。
1
channelTypestring

通知方式:

  • hdm_alarm_sms:手机短信。
  • dingtalk:钉钉机器人。
  • hdm_alarm_sms_and_email:手机短信+邮件。
  • hdm_alarm_sms,dingtalk:手机短信+钉钉机器人。
hdm_alarm_sms,dingtalk
contactGroupNamestring

告警事件订阅组名称,多个名称间以英文逗号分隔。

默认联系组
contactNamestring

告警事件订阅人名称,多个名称间以英文逗号分隔。

默认联系人
eventContextstring

支持的事件场景,当前仅支持 AllContext,表示支持所有场景。

AllContext
instanceIdstring

实例 ID。

rm-2ze8g2am97624****
langstring

事件通知的语言,当前仅支持zh-CN,表示事件通知为中文。

zh_CN
levelstring

事件风险级别:

  • Notice:通知。
  • Optimization:优化。
  • Warn:警告。
  • Critical:严重。
Optimization
minIntervalinteger

通知最小间隔时间,单位秒(s)。

60
userIdstring

用户 ID。

1088760496****
Messagestring

请求返回消息。

说明 请求成功时该参数返回 Successful,请求失败时会返回请求异常信息(如错误码等)。
Successful
RequestIdstring

请求 ID。

097F0C56-B252-515A-B602-FC56EF93EF8A
Successstring

请求是否执行成功:

  • true:执行成功。
  • false:执行失败。
true

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Data": {
    "active": 1,
    "channelType": "hdm_alarm_sms,dingtalk",
    "contactGroupName": "默认联系组",
    "contactName": "默认联系人",
    "eventContext": "AllContext",
    "instanceId": "rm-2ze8g2am97624****",
    "lang": "zh_CN",
    "level": "Optimization",
    "minInterval": 60,
    "userId": "1088760496****"
  },
  "Message": "Successful",
  "RequestId": "097F0C56-B252-515A-B602-FC56EF93EF8A",
  "Success": "true"
}

错误码

HTTP status code错误码错误信息描述
400InvalidParamsThe request parameters are invalid.请求参数错误
403NoPermissionYou are not authorized to do this action.没有权限执行该操作

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-04-25OpenAPI 入参发生变更查看变更详情