全部产品
Search

搜索本产品

    数据库自治服务 DAS：SetEventSubscription - 配置事件订阅设置

    文档中心

    数据库自治服务 DAS：SetEventSubscription - 配置事件订阅设置

    更新时间：Aug 28, 2026

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

    接口说明

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

    • 使用阿里云或 DAS 的 SDK 时，建议使用最新版本。

    • 使用 SDK 调用 DAS 服务时，需要将地域指定为 cn-shanghai。

    • 数据库实例已接入 DAS。

    调试

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

    调试

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    hdm:SetEventSubscription

    update

    *全部资源

    *

    		 无 无

    请求参数

    名称

    类型

    必填

    描述

    示例值
    InstanceId

    string

    是

    实例 ID。

    rm-2ze8g2am97624****
    EventContext

    string

    否

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

    AllContext
    Lang

    string

    否

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

    zh-CN
    MinInterval

    string

    否

    通知最小间隔时间，单位为秒（s）。

    60
    ContactName

    string

    否

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

    默认联系人
    ChannelType

    string

    否

    通知方式。

    • hdm_alarm_sms：手机短信。

    • dingtalk：钉钉机器人。

    • hdm_alarm_sms_and_email：手机短信+邮件。

    • hdm_alarm_sms,dingtalk：手机短信+钉钉机器人。

    hdm_alarm_sms,dingtalk
    ContactGroupName

    string

    否

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

    默认联系组
    Level

    string

    否

    需要进行通知的事件级别，取值：

    • Notice：通知（包含 Notice、Optimization、Warn 和 Critical 级别的事件）。

    • Optimization：优化（包含 Optimization、Warn 和 Critical 级别的事件）。

    • Warn：警告（包含 Warn 和 Critical 级别的事件）。

    • Critical：严重（仅包含 Critical 级别的事件）。

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

    • 通知：暂无建议的数据库异常事件。

    • 优化：根据数据库运行情况给出优化建议的事件。

    • 警告：需要关注的可能会影响数据库的事件。

    • 严重：影响数据库运行的事件。

    Optimization
    Active

    string

    否

    是否启用事件订阅功能：

    • 0：关闭。

    • 1：开启。

    1
    Severity

    string

    否

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

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

    事件类型：

    • AutoScale：弹性伸缩事件。

    • SQLThrottle：限流事件。

    • TimeSeriesAbnormal：时序异常检测事件。

    • SQLOptimize：SQL 优化事件。

    • ResourceOptimize：空间优化事件。

    告警级别：

    • info：一般。

    • noticed：通知。

    • warning：警告。

    • critical：严重。

    {"AutoScale":"critical","SQLThrottle":"info","TimeSeriesAbnormal":"warning"}
    DispatchRule

    string

    否

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

    输入格式：{"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

    返回信息列表。

    RequestId

    string

    请求 ID。

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

    string

    请求返回消息。

    说明

    请求成功时该参数返回 Successful，请求失败时会返回请求异常信息（如错误码等）。

    Successful
    Data

    object

    详细信息列表。

    userId

    string

    用户 ID。

    1088760496****
    instanceId

    string

    实例 ID。

    rm-2ze8g2am97624****
    eventContext

    string

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

    AllContext
    lang

    string

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

    zh_CN
    active

    integer

    是否启用事件订阅：

    • 0：关闭。

    • 1：开启。

    1
    minInterval

    integer

    通知最小间隔时间，单位秒（s）。

    60
    contactName

    string

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

    默认联系人
    contactGroupName

    string

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

    默认联系组
    channelType

    string

    通知方式：

    • hdm_alarm_sms：手机短信。

    • dingtalk：钉钉机器人。

    • hdm_alarm_sms_and_email：手机短信+邮件。

    • hdm_alarm_sms,dingtalk：手机短信+钉钉机器人。

    hdm_alarm_sms,dingtalk
    level

    string

    事件风险级别：

    • Notice：通知。

    • Optimization：优化。

    • Warn：警告。

    • Critical：严重。

    Optimization
    Code

    string

    返回的状态码。

    200
    Success

    string

    请求是否执行成功：

    • true：执行成功。

    • false：执行失败。

    true

    示例

    正常返回示例

    JSON格式

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

    错误码

    HTTP status code

    错误码

    错误信息

    描述
    400 InvalidParams The request parameters are invalid. 请求参数错误
    403 NoPermission You are not authorized to do this action. 没有权限执行该操作

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

    变更历史

    更多信息，参考变更详情。