SetEventSubscription_数据库自治服务_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

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

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

流控信息

请求速率为60/1(s)。

授权信息

当前云产品暂无权限信息透出。

请求参数

字段名称字段详情
InstanceIdstring

实例 ID。

示例值:rm-2ze8g2am97624****参考取值来源:
    AddHDMInstance
    GetInstanceInspections
    CreateKillInstanceSessionTask
EventContextstring

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

示例值:AllContext枚举值:参考取值来源:
    GetEventSubscription
Langstring

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

示例值:zh-CN枚举值:
MinIntervalstring

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

示例值:60
ContactNamestring

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

示例值:默认联系人
ChannelTypestring

通知方式。展开详情

示例值:hdm_alarm_sms,dingtalk枚举值:
ContactGroupNamestring

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

示例值:默认联系组
Levelstring

需要进行通知的事件级别,取值:展开详情

示例值:Optimization枚举值:
Activestring

是否启用事件订阅功能:展开详情

示例值:1枚举值:
Severitystring

按照事件类型设置事件的告警级别。展开详情

示例值:{"AutoScale":"critical","SQLThrottle":"info","TimeSeriesAbnormal":"warning"}
DispatchRulestring

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

示例值:{"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"}}

返回参数

字段名称字段详情
Codestring

返回的状态码。

示例值:200
Dataobject

详细信息列表。

Messagestring

请求返回消息。展开详情

示例值:Successful
RequestIdstring

请求 ID。

示例值:097F0C56-B252-515A-B602-FC56EF93EF8A
Successstring

请求是否执行成功:展开详情

示例值:true

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
InvalidParams
The request parameters are invalid.诊断
403
NoPermission
You are not authorized to do this action.诊断

变更历史

变更时间变更内容概要操作
2023-04-25
新增请求参数Severity
新增请求参数DispatchRule

相关示例