すべてのプロダクト
Search
ドキュメントセンター

Database Autonomy Service:SetEventSubscription

最終更新日:Dec 19, 2025

データベースインスタンスのイベントサブスクリプション設定を構成します。

操作説明

この操作を呼び出す前に、次の点にご注意ください。

  • Alibaba Cloud SDK または Database Autonomy Service (DAS) SDK を使用してこの操作を呼び出す場合は、最新バージョンの SDK を使用することを推奨します。

  • SDK を使用して DAS の API 操作を呼び出す場合、リージョン ID を cn-shanghai に設定する必要があります。

  • 管理対象のデータベースインスタンスが DAS に接続されていることを確認してください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは 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:DingTalk チャットボット。

  • hdm_alarm_sms_and_email:ショートメッセージとメール。

  • hdm_alarm_sms,dingtalk:ショートメッセージと DingTalk チャットボット。

hdm_alarm_sms,dingtalk

ContactGroupName

string

任意

アラート通知を受信する連絡先グループの名前。複数の名前はコンマ (,) で区切ります。

Default contact group

Level

string

任意

イベントのリスクレベル。有効値:

  • Notice:通知をトリガーするイベント。NoticeOptimizationWarnCritical レベルのイベントが含まれます。

  • Optimization:最適化をトリガーするイベント。OptimizationWarnCritical レベルのイベントが含まれます。

  • Warn:警告をトリガーするイベント。WarnCritical レベルのイベントが含まれます。

  • Critical:重大な警告をトリガーするイベント。

各レベルのイベントの詳細は次のとおりです。

  • Notice:提案が生成されないデータベースの例外に関連するイベント。

  • Optimization:データベースのステータスに基づいて最適化の提案が生成されるイベント。

  • Warn:データベースの実行に影響を与える可能性のあるイベント。

  • Critical:データベースの実行に影響を与えるイベント。

Optimization

Active

string

任意

イベントサブスクリプション機能を有効にするかどうかを指定します。有効値:

  • 0:イベントサブスクリプション機能を無効にします。

  • 1:イベントサブスクリプション機能を有効にします。

1

Severity

string

任意

イベントタイプに基づくアラートの重要度。

このパラメーターは、{"イベントタイプ 1":"アラートの重要度", "イベントタイプ 2":"アラートの重要度"} の形式で指定します。

イベントタイプの有効値:

  • AutoScale:自動スケーリングイベント。

  • SQLThrottle:スロットリングイベント。

  • TimeSeriesAbnormal:時系列異常を検出するためのイベント。

  • SQLOptimize:SQL 最適化イベント。

  • ResourceOptimize:ストレージ最適化イベント。

アラートの重要度の有効値:

  • info

  • noticed

  • warning

  • critical

{"AutoScale":"critical","SQLThrottle":"info","TimeSeriesAbnormal":"warning"}

DispatchRule

string

任意

イベントタイプに基づく通知ルール。このパラメーターを空のままにすると、MinIntervalChannelType の値が優先されます。

このパラメーターは、{"silenced": {"イベントタイプ 1":アダプティブサイレンスを有効にするかどうかを指定, "イベントタイプ 2":アダプティブサイレンスを有効にするかどうかを指定},"min_interval": {"イベントタイプ 1":イベント通知の最小間隔, "イベントタイプ 2":イベント通知の最小間隔},"alert_type": {"イベントタイプ 1":"通知方法", "イベントタイプ 2":"通知方法"}} の形式で指定します。

  • silenced:アダプティブサイレンスを有効にするかどうかを指定します。アダプティブサイレンスを有効にすると、イベントの連続するアラート通知の間隔は、min_interval で指定された最小間隔とイベント期間の 3 分の 1 のうち、大きい方になります。有効値:

    • 1:アダプティブサイレンスを有効にします。

    • 2:アダプティブサイレンスを無効にします。

  • min_interval:イベント通知の最小間隔。単位:秒。

  • 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

ユーザー ID。

1088760496****

instanceId

string

インスタンス ID。

rm-2ze8g2am97624****

eventContext

string

サポートされているイベントシナリオ。このパラメーターでは AllContext のみが返され、すべてのシナリオがサポートされていることを示します。

AllContext

lang

string

イベント通知の言語。このパラメーターでは zh-CN のみが返され、イベント通知が中国語で送信されることを示します。

zh_CN

active

integer

イベントサブスクリプション機能が有効になっているかどうかを示します。有効値:

  • 0:イベントサブスクリプション機能は無効です。

  • 1:イベントサブスクリプション機能は有効です。

1

minInterval

integer

連続するイベント通知の最小間隔。単位:秒。

60

contactName

string

アラート通知を受信する連絡先の名前。複数の名前はコンマ (,) で区切られます。

Default contact

contactGroupName

string

アラート通知を受信する連絡先グループの名前。複数の名前はコンマ (,) で区切られます。

Default contact group

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

返される HTTP ステータスコード。

200

Success

string

リクエストが成功したかどうかを示します。有効値:

  • true

  • false

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.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。