データベースインスタンスのイベントサブスクリプション設定を構成します。
操作説明
この操作を呼び出す前に、次の点にご注意ください。
Alibaba Cloud SDK または Database Autonomy Service (DAS) SDK を使用してこの操作を呼び出す場合は、最新バージョンの SDK を使用することを推奨します。
SDK を使用して DAS の API 操作を呼び出す場合、リージョン ID を cn-shanghai に設定する必要があります。
管理対象のデータベースインスタンスが DAS に接続されていることを確認してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
hdm:SetEventSubscription |
update |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| InstanceId |
string |
必須 |
インスタンス ID。 |
rm-2ze8g2am97624**** |
| EventContext |
string |
任意 |
サポートされているイベントシナリオ。値を AllContext に設定すると、すべてのシナリオがサポートされることを示します。 |
AllContext |
| Lang |
string |
任意 |
イベント通知の言語。値を zh-CN に設定すると、イベント通知が中国語で送信されることを示します。 |
zh-CN |
| MinInterval |
string |
任意 |
連続するイベント通知の最小間隔。単位:秒。 |
60 |
| ContactName |
string |
任意 |
アラート通知を受信する連絡先の名前。複数の名前はコンマ (,) で区切ります。 |
Default contact |
| ChannelType |
string |
任意 |
通知方法。有効値:
|
hdm_alarm_sms,dingtalk |
| ContactGroupName |
string |
任意 |
アラート通知を受信する連絡先グループの名前。複数の名前はコンマ (,) で区切ります。 |
Default contact group |
| Level |
string |
任意 |
イベントのリスクレベル。有効値:
各レベルのイベントの詳細は次のとおりです。
|
Optimization |
| Active |
string |
任意 |
イベントサブスクリプション機能を有効にするかどうかを指定します。有効値:
|
1 |
| Severity |
string |
任意 |
イベントタイプに基づくアラートの重要度。 このパラメーターは、 イベントタイプの有効値:
アラートの重要度の有効値:
|
{"AutoScale":"critical","SQLThrottle":"info","TimeSeriesAbnormal":"warning"} |
| DispatchRule |
string |
任意 |
イベントタイプに基づく通知ルール。このパラメーターを空のままにすると、MinInterval と ChannelType の値が優先されます。 このパラメーターは、
|
{"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 |
ユーザー ID。 |
1088760496**** |
| instanceId |
string |
インスタンス ID。 |
rm-2ze8g2am97624**** |
| eventContext |
string |
サポートされているイベントシナリオ。このパラメーターでは AllContext のみが返され、すべてのシナリオがサポートされていることを示します。 |
AllContext |
| lang |
string |
イベント通知の言語。このパラメーターでは zh-CN のみが返され、イベント通知が中国語で送信されることを示します。 |
zh_CN |
| active |
integer |
イベントサブスクリプション機能が有効になっているかどうかを示します。有効値:
|
1 |
| minInterval |
integer |
連続するイベント通知の最小間隔。単位:秒。 |
60 |
| contactName |
string |
アラート通知を受信する連絡先の名前。複数の名前はコンマ (,) で区切られます。 |
Default contact |
| contactGroupName |
string |
アラート通知を受信する連絡先グループの名前。複数の名前はコンマ (,) で区切られます。 |
Default contact group |
| channelType |
string |
通知方法。有効値:
|
hdm_alarm_sms,dingtalk |
| level |
string |
イベントのリスクレベル。有効値:
|
Optimization |
| Code |
string |
返される HTTP ステータスコード。 |
200 |
| Success |
string |
リクエストが成功したかどうかを示します。有効値:
|
true |
例
成功レスポンス
JSONJSON
{
"RequestId": "097F0C56-B252-515A-B602-FC56EF93EF8A",
"Message": "Successful",
"Data": {
"userId": "1088760496****",
"instanceId": "rm-2ze8g2am97624****",
"eventContext": "AllContext",
"lang": "zh_CN",
"active": 1,
"minInterval": 60,
"contactName": "Default contact",
"contactGroupName": "Default contact group",
"channelType": "hdm_alarm_sms,dingtalk",
"level": "Optimization"
},
"Code": "200",
"Success": "true"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidParams | The request parameters are invalid. | |
| 403 | NoPermission | You are not authorized to do this action. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。