SetEventSubscription - 配置事件訂閱設定 -

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

介面說明

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

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

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

hdm:SetEventSubscription

update

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
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：DingTalk機器人。 hdm_alarm_sms_and_email：手機簡訊+郵件。 hdm_alarm_sms,dingtalk：手機簡訊+DingTalk機器人。	hdm_alarm_sms,dingtalk
ContactGroupName	string	否	警示事件訂閱組名稱，多個名稱以英文逗號分隔。	預設聯絡組
Level	string	否	需要進行通知的事件層級，取值： Notice：通知（包含 Notice、Optimization、Warn 和 Critical 層級的事件）。 Optimization：最佳化（包含 Optimization、Warn 和 Critical 層級的事件）。 Warn：警告（包含 Warn 和 Critical 層級的事件）。 Critical：嚴重（僅包含 Critical 層級的事件）。各個層級事件的含義如下：通知：暫無建議的資料庫例外狀況事件。最佳化：根據資料庫運行情況給出最佳化建議的事件。警告：需要關注的可能會影響資料庫的事件。嚴重：影響資料庫啟動並執行事件。	Optimization
Active	string	否	是否啟用事件訂閱功能： 0：關閉。 1：開啟。	1
Severity	string	否	按照事件類型設定事件的警示層級。輸入格式：`{"事件類型 1":"警示層級", "事件類型 2":"警示層級"}`。事件類型： AutoScale：Auto Scaling事件。 SQLThrottle：限流事件。 TimeSeriesAbnormal：時序異常檢測事件。 SQLOptimize：SQL 最佳化事件。 ResourceOptimize：空間最佳化事件。警示層級： info：一般。 noticed：通知。 warning：警告。 critical：嚴重。	{"AutoScale":"critical","SQLThrottle":"info","TimeSeriesAbnormal":"warning"}
DispatchRule	string	否	按照事件類型設定事件的訊息通知規則，此參數為空白時，以 MinInterval 和 ChannelType 設定為準。輸入格式：`{"silenced": {"事件類型 1":是否開啟自適應靜默, "事件類型 2":是否開啟自適應靜默},"min_interval":{"事件類型 1":通知最小間隔, "事件類型 2":通知最小間隔},"alert_type": {"事件類型 1":"通知方式", "事件類型 2":"通知方式"}}`。 silenced：是否開啟自適應靜默。開啟自適應靜默後，事件中連續警示的發送間隔變為min_interval設定值和該事件期間 1/3 中的最大值。 1：開啟。 2：關閉。 min_interval：通知最小間隔時間，單位為秒（s）。 alert_type：通知方式，取值： hdm_alarm_sms：手機簡訊。 dingtalk：DingTalk機器人。 hdm_alarm_sms_and_email：手機簡訊+郵件。 hdm_alarm_sms,dingtalk：手機簡訊+DingTalk機器人。	{"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"}}

返回參數

名稱	類型	描述	樣本值
	object	返回資訊列表。
RequestId	string	請求 ID。	097F0C56-B252-515A-B602-FC56EF93EF8A
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	integer	通知最小間隔時間，單位秒（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
Code	string	返回的狀態代碼。	200
Success	string	請求是否執行成功： true：執行成功。 false：執行失敗。	true

樣本

正常返回樣本

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.	請求參數錯誤
403	NoPermission	You are not authorized to do this action.	沒有許可權執行該操作

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

變更歷史

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