文档

GetEventSubscription - 获取事件订阅设置

更新时间:

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

接口说明

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

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
hdm:GetEventSubscriptionRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。

rm-2ze8g2am97624****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

B6D17591-B48B-4D31-9CD6-9B9796B2****
Messagestring

请求返回消息。

说明 请求成功时该参数返回 Successful,请求失败时会返回请求异常信息(如错误码等)。
Successful
Dataobject

详细信息列表。

userIdstring

用户 ID。

1088760496****
instanceIdstring

实例 ID。

rm-2ze8g2am97624****
eventContextstring

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

AllContext
langstring

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

zh_CN
activeinteger

是否启用事件订阅:

  • 0:关闭。
  • 1:开启。
1
minIntervalstring

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

60
contactNamestring

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

默认联系人
contactGroupNamestring

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

默认联系组
channelTypestring

通知方式:

  • hdm_alarm_sms:手机短信。
  • dingtalk:钉钉机器人。
  • hdm_alarm_sms_and_email:手机短信+邮件。
  • hdm_alarm_sms,dingtalk:手机短信+钉钉机器人。
hdm_alarm_sms,dingtalk
levelstring

事件风险级别,即触发哪种级别的事件后需要通知您:

  • Notice:通知。
  • Optimization:优化。
  • Warn:警告。
  • Critical:严重。
Optimization
contactsobject []

告警联系人列表。

namestring

告警联系人名称。

张先生
phonestring

告警联系人电话。

1390000****
emailstring

告警联系人邮箱。

a***@example.net
dingtalkHookstring

钉钉机器人的 Webhook 地址。

https://oapi.dingtalk.com/robot/send?access_token=68fa29a9eaf3ba9994f54fxxxc1aa9879700308f90e9c23ebfb3663642c9****
groupsarray

告警联系人所属的联系组列表。

string

告警联系人名称。

张先生
isCmsReduplicatedboolean

是否和云监控上的联系人姓名相同。

  • true:是。
  • false:否。
true
userIdstring

用户 ID。

1088760496****
contactGroupsobject []

告警联系组列表。

namestring

告警联系组名称。

张先生
descriptionstring

告警联系组描述。

默认联系人
contactsstring

告警联系组成员列表。

"[\"张先生\",\"王女士\",\"李先生\"]"
userIdstring

用户 ID。

1088760496****
eventSendGrouparray

支持发送的事件场景列表。

string

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

AllContext
idlong

数据库主键 ID。

1
gmtCreatelong

开启事件订阅的时间,格式为 Unix 时间戳,单位为毫秒(ms)。

1633071840000
gmtModifiedlong

最后修改事件订阅设置的时间,格式为 Unix 时间戳,单位为毫秒(ms)。

1633071850000
Codestring

返回的状态码。

200
Successstring

请求是否执行成功:

  • 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错误码错误信息描述
400InvalidParamsThe request parameters are invalid.请求参数错误
403NoPermissionYou are not authorized to do this action.没有权限执行该操作

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈