调用SetEventSubscription接口,配置数据库实例的事件订阅设置。
接口说明
使用该接口需满足以下前提条件:
- 使用阿里云或 DAS 的 SDK 时,建议使用最新版本。
- 使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。
- 数据库实例已接入 DAS。
说明 事件订阅已集成至告警功能。如果在控制台配置了事件告警,通过该 API 接口配置的事件订阅设置将被事件告警覆盖。配置事件告警请参见配置告警。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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 |
ContactGroupName | string | 否 | 告警事件订阅组名称,多个名称以英文逗号分隔。 | 默认联系组 |
Level | string | 否 | 需要进行通知的事件级别,取值:
各个级别事件的含义如下:
| Optimization |
Active | string | 否 | 是否启用事件订阅功能:
| 1 |
Severity | string | 否 | 按照事件类型设置事件的告警级别。 输入格式: 事件类型:
告警级别:
| {"AutoScale":"critical","SQLThrottle":"info","TimeSeriesAbnormal":"warning"} |
DispatchRule | string | 否 | 按照事件类型设置事件的消息通知规则,此参数为空时,以 MinInterval 和 ChannelType 设置为准。 输入格式:
| {"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"}} |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParams | The request parameters are invalid. | 请求参数错误 |
403 | NoPermission | You are not authorized to do this action. | 没有权限执行该操作 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-04-25 | OpenAPI 入参发生变更 | 查看变更详情 |