すべてのプロダクト
Search

このプロダクト

    Database Autonomy Service:GetEventSubscription

    ドキュメントセンター

    Database Autonomy Service:GetEventSubscription

    最終更新日:Mar 13, 2026

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

    操作説明

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

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

    • DAS の操作を SDK で呼び出す場合、リージョン 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:GetEventSubscription

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    InstanceId

    string

    必須

    インスタンス ID。

    rm-2ze8g2am97624****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    B6D17591-B48B-4D31-9CD6-9B9796B2****
    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

    string

    イベント通知間の最小間隔。単位：秒。

    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>

    ユーザー ID。

    object

    name

    string

    アラート連絡先の名前。

    张先生
    phone

    string

    アラート連絡先の携帯電話番号。

    1390000****
    email

    string

    アラート連絡先のメールアドレス。

    a***@example.net
    dingtalkHook

    string

    DingTalk チャットボットの Webhook URL。

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

    array

    アラート連絡先が所属する連絡先グループ。

    string

    アラート連絡先の名前。

    张先生
    isCmsReduplicated

    boolean

    アラート連絡先の名前が CloudMonitor 上の連絡先名と同じかどうかを示します。

    • true

    • false

    true
    userId

    string

    ユーザー ID。

    1088760496****
    contactGroups

    array<object>

    アラート連絡先グループ。

    object

    name

    string

    アラート連絡先グループの名前。

    张先生
    description

    string

    アラート連絡先グループの説明。

    默认联系人
    contacts

    string

    アラート連絡先グループのメンバー。

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

    string

    ユーザー ID。

    1088760496****
    eventSendGroup

    array

    イベントサブスクリプションを送信可能なサポート対象のイベントシナリオ。

    string

    イベント通知を送信可能なサポート対象のイベントシナリオ。返される値は AllContext のみであり、これはすべてのシナリオがサポートされることを示します。

    AllContext
    id

    integer

    データベースのプライマリキー ID。

    1
    gmtCreate

    integer

    イベントサブスクリプションが有効化された時刻。この値は UNIX タイムスタンプであり、協定世界時 (UTC) 1970 年 1 月 1 日 00:00:00 からの経過ミリ秒数を表します。

    1633071840000
    gmtModified

    integer

    イベントサブスクリプション設定が最後に変更された時刻。この値は UNIX タイムスタンプであり、協定世界時 (UTC) 1970 年 1 月 1 日 00:00:00 からの経過ミリ秒数を表します。

    1633071850000
    Code

    string

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

    200
    Success

    string

    リクエストが成功したかどうかを示します。有効な値は以下のとおりです：

    • true

    • false

    true

    例

    成功レスポンス

    JSONJSON

    {
  "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 ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidParams The request parameters are invalid.
    403 NoPermission You are not authorized to do this action.

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

    変更履歴

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