调用SetEventSubscription接口,配置数据库实例的事件订阅设置。
接口说明
使用该接口需满足以下前提条件:
- 使用阿里云或DAS的SDK时,建议使用最新版本。
- 使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。
- 数据库实例已接入DAS。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
hdm:SetEventSubscription | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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 |
返回参数
示例
正常返回示例
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. | 请求参数错误 |
访问错误中心查看更多错误码。