すべてのプロダクト
Search

このプロダクト

    DataWorks:ListDIAlarmRules

    ドキュメントセンター

    DataWorks:ListDIAlarmRules

    最終更新日:Jul 31, 2026

    Data Integration の新バージョンノードのアラート機能ルールリストを照会します。現在サポートされているノードタイプには、MySQL から Hologres へのフルデータベースリアルタイムソリューションが含まれます。

    操作説明

    タスクの同期タイプにリアルタイム同期が含まれる場合、アラートルールを設定できます。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dataworks:*

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DIJobId

    integer

    必須

    タスク ID。アラートルールに関連付けられたタスクの ID です。

    この値は、ListDIJobs 応答の DIJobPaging.DIJobs[].DIJobId から取得できます。

    11260
    PageNumber

    integer

    任意

    ページ番号。デフォルト値: 1。

    1
    PageSize

    integer

    任意

    ページサイズ。デフォルト値: 10。

    10

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答。

    RequestId

    string

    リクエスト ID。

    74C2FECD-5B3A-554A-BCF5-35****
    DIAlarmRulePaging

    object

    アラートルールのページネーション結果。

    TotalCount

    integer

    レコードの総数。

    2
    PageNumber

    integer

    ページ番号。

    1
    PageSize

    integer

    ページサイズ。

    10
    DIJobAlarmRules

    array<object>

    アラートルールのリスト。

    array<object>

    アラートルール。

    DIAlarmRuleId

    integer

    アラートルール ID です。

    41998
    DIJobId

    integer

    アラートルールが関連付けられたタスクの ID です。

    11260
    Description

    string

    アラートルールの説明です。

    mysql synchronizes to hologres heartbeat alert
    MetricType

    string

    アラートルールにおけるメトリクスタイプです。有効な値は以下のとおりです。

    • Heartbeat

    • FailoverCount

    • Delay

    Heartbeat
    Enabled

    boolean

    アラートルールが有効かどうかを示します。

    true
    TriggerConditions

    array<object>

    アラートルールをトリガーする条件です。

    object

    アラートルールをトリガーする条件です。

    Severity

    string

    重大度レベルです。有効な値は以下のとおりです。

    • Warning

    • Critical

    Warning
    Duration

    integer

    アラート計算の時間間隔です。単位：分。

    15
    Threshold

    integer

    アラートのしきい値です。

    • タスクのステータスに関するアラートルールの場合、しきい値は使用されません。

    • フェールオーバーに関するアラートルールの場合、しきい値はフェールオーバー回数です。

    • 遅延に関するアラートルールの場合、しきい値は遅延時間（秒）です。

    5
    NotificationSettings

    object

    アラート通知の設定項目です。

    NotificationChannels

    array<object>

    アラート通知方法です。

    object

    アラート通知方法です。

    Severity

    string

    重大度レベルです。有効な値は以下のとおりです。

    • Warning

    • Critical

    Warning
    Channels

    array

    アラート通知方法です。

    string

    アラート通知方法です。有効な値は以下のとおりです。

    • Mail：メール

    • Phone：電話通話

    • Sms：ショートメッセージ

    • Ding：DingTalk チャットボットトークン

    Ding
    NotificationReceivers

    array<object>

    アラート通知受信者の設定です。

    object

    アラート通知受信者の設定です。

    ReceiverType

    string

    受信者タイプです。有効な値は AliyunUid および DingToken です。

    • アラート通知方法が Mail、Phone、または Sms の場合、このパラメーターの値は AliyunUid であり、Alibaba Cloud アカウント ID を示します。

    • アラート通知方法が Ding の場合、このパラメーターの値は DingToken であり、DingTalk チャットボットトークンを示します。

    DingToken
    ReceiverValues

    array

    受信者です。

    string

    受信者です。

    • 受信者タイプが Alibaba Cloud アカウント ID の場合、このパラメーターの値はユーザーの Alibaba Cloud アカウント ID です。

    • 受信者タイプが DingTalk チャットボットトークンの場合、このパラメーターの値は DingTalk チャットボットのトークンです。

    token1
    InhibitionInterval

    integer

    アラート抑制間隔の持続時間です。単位：分。

    5

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "74C2FECD-5B3A-554A-BCF5-35****",
  "DIAlarmRulePaging": {
    "TotalCount": 2,
    "PageNumber": 1,
    "PageSize": 10,
    "DIJobAlarmRules": [
      {
        "DIAlarmRuleId": 41998,
        "DIJobId": 11260,
        "Description": "mysql synchronizes to hologres heartbeat alert",
        "MetricType": "Heartbeat",
        "Enabled": true,
        "TriggerConditions": [
          {
            "Severity": "Warning",
            "Duration": 15,
            "Threshold": 5
          }
        ],
        "NotificationSettings": {
          "NotificationChannels": [
            {
              "Severity": "Warning",
              "Channels": [
                "Ding"
              ]
            }
          ],
          "NotificationReceivers": [
            {
              "ReceiverType": "DingToken",
              "ReceiverValues": [
                "token1"
              ]
            }
          ],
          "InhibitionInterval": 5
        }
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    500 InternalError.System An internal system error occurred. Try again later.
    500 InternalError.UserId.Missing An internal system error occurred. Try again later.
    403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.
    429 Throttling.Api The request for this resource has exceeded your available limit.
    429 Throttling.System The DataWorks system is busy. Try again later.
    429 Throttling.User Your request is too frequent. Try again later.

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

    変更履歴

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