GetEventSubscription - 擷取事件訂閱設定 -

調用GetEventSubscription介面，擷取資料庫執行個體的事件訂閱設定。

介面說明

使用該介面需滿足以下前提條件：

使用阿里雲或 DAS 的 SDK 時，建議使用最新版本。
使用 SDK 調用 DAS 服務時，需要將地區指定為 cn-shanghai。
資料庫執行個體已接入 DAS。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

hdm:GetEventSubscription

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	執行個體 ID。	rm-2ze8g2am97624****

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	B6D17591-B48B-4D31-9CD6-9B9796B2****
Message	string	請求返回訊息。說明請求成功時該參數返回 Successful，請求失敗時會返回請求異常資訊（如錯誤碼等）。	Successful
Data	object	詳細資料列表。
userId	string	使用者識別碼。	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：DingTalk機器人。 hdm_alarm_sms_and_email：手機簡訊+郵件。 hdm_alarm_sms,dingtalk：手機簡訊+DingTalk機器人。	hdm_alarm_sms,dingtalk
level	string	事件風險層級，即觸發哪種層級的事件後需要通知您： Notice：通知。 Optimization：最佳化。 Warn：警告。 Critical：嚴重。	Optimization
contacts	array<object>	警示連絡人清單。
	object
name	string	警示連絡人名稱。	張先生
phone	string	警示連絡人電話。	1390000****
email	string	警示連絡人郵箱。	a***@example.net
dingtalkHook	string	DingTalk機器人的 Webhook 地址。	https://oapi.dingtalk.com/robot/send?access_token=68fa29a9eaf3ba9994f54fxxxc1aa9879700308f90e9c23ebfb3663642c9****
groups	array	警示連絡人所屬的聯絡組列表。
	string	警示連絡人名稱。	張先生
isCmsReduplicated	boolean	是否和CloudMonitor上的連絡人姓名相同。 true：是。 false：否。	true
userId	string	使用者識別碼。	1088760496****
contactGroups	array<object>	警示聯絡組列表。
	object
name	string	警示聯絡組名稱。	張先生
description	string	警示聯絡組描述。	預設連絡人
contacts	string	警示聯絡群組成員列表。	"[\"張先生\",\"王女士\",\"李先生\"]"
userId	string	使用者識別碼。	1088760496****
eventSendGroup	array	支援發送的事件情境列表。
	string	支援發送的事件情境，當前僅支援 AllContext，表示支援所有情境。	AllContext
id	integer	資料庫主鍵 ID。	1
gmtCreate	integer	開啟事件訂閱的時間，格式為 Unix 時間戳記，單位為毫秒（ms）。	1633071840000
gmtModified	integer	最後修改事件訂閱設定的時間，格式為 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.	沒有許可權執行該操作

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。