调用GetEventSubscription获取事件订阅设置_数据库自治服务(DAS)-阿里云帮助中心

调用GetEventSubscription接口，获取数据库实例的事件订阅设置。

接口说明

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

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

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	rm-2ze8g2am97624****

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	B6D17591-B48B-4D31-9CD6-9B9796B2****
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	string	通知最小间隔时间，单位秒（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
contacts	array<object>	告警联系人列表。
contacts	object
name	string	告警联系人名称。	张先生
phone	string	告警联系人电话。	1390000****
email	string	告警联系人邮箱。	a***@example.net
dingtalkHook	string	钉钉机器人的 Webhook 地址。	https://oapi.dingtalk.com/robot/send?access_token=68fa29a9eaf3ba9994f54fxxxc1aa9879700308f90e9c23ebfb3663642c9****
groups	array	告警联系人所属的联系组列表。
groups	string	告警联系人名称。	张先生
isCmsReduplicated	boolean	是否和云监控上的联系人姓名相同。 true：是。 false：否。	true
userId	string	用户 ID。	1088760496****
contactGroups	array<object>	告警联系组列表。
contactGroups	object
name	string	告警联系组名称。	张先生
description	string	告警联系组描述。	默认联系人
contacts	string	告警联系组成员列表。	"[\"张先生\",\"王女士\",\"李先生\"]"
userId	string	用户 ID。	1088760496****
eventSendGroup	array	支持发送的事件场景列表。
eventSendGroup	string	支持发送的事件场景，当前仅支持 AllContext，表示支持所有场景。	AllContext
id	long	数据库主键 ID。	1
gmtCreate	long	开启事件订阅的时间，格式为 Unix 时间戳，单位为毫秒（ms）。	1633071840000
gmtModified	long	最后修改事件订阅设置的时间，格式为 Unix 时间戳，单位为毫秒（ms）。	1633071850000
Code	string	返回的状态码。	200
Success	string	请求是否执行成功： true：执行成功。 false：执行失败。	true

示例

正常返回示例

JSON格式

{
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "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",
    "contacts": [
      {
        "name": "张先生",
        "phone": "1390000****",
        "email": "a***@example.net",
        "dingtalkHook": "https://oapi.dingtalk.com/robot/send?access_token=68fa29a9eaf3ba9994f54fxxxc1aa9879700308f90e9c23ebfb3663642c9****",
        "groups": [
          "张先生"
        ],
        "isCmsReduplicated": true,
        "userId": "1088760496****"
      }
    ],
    "contactGroups": [
      {
        "name": "张先生",
        "description": "默认联系人",
        "contacts": "\"[\\\"张先生\\\",\\\"王女士\\\",\\\"李先生\\\"]\"",
        "userId": "1088760496****"
      }
    ],
    "eventSendGroup": [
      "AllContext"
    ],
    "id": 1,
    "gmtCreate": 1633071840000,
    "gmtModified": 1633071850000
  },
  "Code": "200",
  "Success": "true"
}

错误码

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

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史