すべてのプロダクト
Search

このプロダクト

    DataWorks:ListAlertMessages

    ドキュメントセンター

    DataWorks:ListAlertMessages

    最終更新日:Mar 21, 2026

    アラートのリストをクエリします。

    今すぐお試しください

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

    テスト

    RAM 認証

    この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    PageNumber

    integer

    必須

    ページ番号です。デフォルト値は 1 です。最小値は 1、最大値は 30 です。

    1
    PageSize

    integer

    必須

    1 ページあたりの表示件数です。デフォルト値は 10 です。最大値は 100 です。

    10
    BeginTime

    string

    必須

    クエリ対象となる期間の開始時刻です。ISO 8601 標準に従った `yyyy-MM-dd'T'HH:mm:ssZ` 形式で指定してください。時刻は協定世界時 (UTC) で指定する必要があります。

    2020-04-02T00:00:00+0800
    EndTime

    string

    必須

    クエリ対象となる期間の終了時刻です。ISO 8601 標準に従った `yyyy-MM-dd'T'HH:mm:ssZ` 形式で指定してください。時刻は協定世界時 (UTC) で指定する必要があります。

    2020-04-04T00:00:00+0800
    RemindId

    integer

    任意

    カスタムアラートルールの ID です。このパラメーターは、AlertRuleTypes パラメーターが USER_DEFINE に設定されている場合に有効になります。このパラメーターと BaselineId パラメーターのいずれか一方のみを指定できます。

    9527
    AlertMethods

    string

    任意

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

    • MAIL

    • SMS：ショートメッセージによるアラート通知は、シンガポール、マレーシア（クアラルンプール）、ドイツ（フランクフルト）の各リージョンでのみ利用可能です。

    複数の通知方法を指定できます。カンマ (,) で区切ってください。

    SMS,MAIL,PHONE
    AlertUser

    string

    任意

    アラート受信者として使用される Alibaba Cloud アカウントの ID です。

    12345
    AlertRuleTypes

    string

    任意

    アラートルールの種類です。有効な値は GLOBAL、USER_DEFINE、OTHER です。GLOBAL はグローバルアラートルールであることを示し、USER_DEFINE はユーザーがカスタマイズしたアラートルールであることを示します。OTHER はその他の種類のアラートルールであることを示します。複数の種類を指定できます。カンマ (,) で区切ってください。

    GLOBAL,USER_DEFINE,OTHER
    BaselineId

    integer

    任意

    ベースライン ID です。このパラメーターは、AlertRuleTypes パラメーターが GLOBAL に設定されている場合に有効になります。このパラメーターと RemindId パラメーターのいずれか一方のみを指定できます。

    1234

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーター。

    HttpStatusCode

    integer

    HTTP ステータスコード。

    200
    RequestId

    string

    リクエスト ID。

    0000-ABCD-EFG****
    ErrorMessage

    string

    エラーメッセージ。

    The specified parameters are invalid.
    ErrorCode

    string

    エラーコード。

    Invalid.Tenant.ConnectionNotExists
    Success

    boolean

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

    true
    Data

    object

    返されたアラートに関する情報。

    PageNumber

    string

    ページ番号。

    1
    PageSize

    string

    1ページあたりのエントリ数。

    10
    TotalCount

    string

    返されたアラートの総数。

    100
    AlertMessages

    array<object>

    アラート。

    array<object>

    返されたデータ。

    RemindId

    integer

    トリガーされたカスタムアラートルールの ID。このパラメーターは、`Source` パラメーターの値が `REMIND_ALERT` の場合に返されます。

    1234
    AlertMessageStatus

    string

    通知の送信ステータス。有効な値：`READY_TO_SEND`、`SEND_FAIL`、`SEND_SUCCESS`、`SEND_OVERLIMIT`。値 `READY_TO_SEND` は通知が送信待ちであることを示します。値 `SEND_FAIL` は通知の送信に失敗したことを示します。値 `SEND_SUCCESS` は通知が送信されたことを示します。値 `SEND_OVERLIMIT` は送信された通知の数が上限を超えたことを示します。

    READY_TO_SEND
    AlertUser

    string

    アラート受信者が使用する Alibaba Cloud アカウントの ID。

    9527952795****
    AlertTime

    integer

    アラートが報告されたときのタイムスタンプ。

    1553531401000
    AlertMethod

    string

    通知方法。有効な値：`MAIL`、`SMS`、`PHONE`。`DataWorks Professional Edition` およびそれ以上のエディションのみが `PHONE` 通知方法をサポートします。

    SMS
    Source

    string

    アラートのタイプ。有効な値：`REMIND_ALERT`、`TOPIC_ALERT`、`SLA_ALERT`、`NODE_CYCLE_ALERT`、`NODE_LONELY_ALERT`。値 `REMIND_ALERT` はアラートがカスタムアラートであることを示します。値 `TOPIC_ALERT` はアラートがイベントアラートであることを示します。値 `SLA_ALERT` はアラートがベースラインアラートであることを示します。値 `NODE_CYCLE_ALERT` はアラートがノード依存関係ループに対して報告されたことを示します。値 `NODE_LONELY_ALERT` はアラートが孤立ノードに対して報告されたことを示します。

    REMIND_ALERT
    Content

    string

    アラートの内容。

    Node error
    RemindName

    string

    トリガーされたカスタムアラートルールの名前。このパラメーターは、`Source` パラメーターの値が `REMIND_ALERT` の場合に返されます。

    Custom monitoring rule name
    AlertId

    integer

    アラート ID。

    1234
    Instances

    array<object>

    カスタムアラートルールをトリガーしたインスタンス。このパラメーターは、`Source` パラメーターの値が `REMIND_ALERT` の場合に返されます。`Source` パラメーターの値が `REMIND_ALERT` でない場合、このパラメーターは空のままになります。

    object

    インスタンスに関する情報。

    Status

    string

    インスタンスのステータス。有効な値：`NOT_RUN`、`WAIT_TIME`、`WAIT_RESOURCE`、`RUNNING`、`CHECKING`、`CHECKING_CONDITION`、`FAILURE`、`SUCCESS`。値 `NOT_RUN` はインスタンスが実行されていないことを示します。値 `WAIT_TIME` はインスタンスが実行を待機していることを示します。値 `WAIT_RESOURCE` はインスタンスがリソースを待機していることを示します。値 `RUNNING` はインスタンスが実行中であることを示します。値 `CHECKING` はインスタンスが生成されたノードのデータ品質がチェックされていることを示します。値 `CHECKING_CONDITION` はインスタンスが生成されたノードの分岐条件がチェックされていることを示します。値 `FAILURE` はインスタンスの実行に失敗したことを示します。値 `SUCCESS` はインスタンスが正常に実行されたことを示します。

    NOT_RUN
    InstanceId

    integer

    インスタンス ID。

    12345
    NodeName

    string

    ノードの名前。

    Node name
    NodeId

    integer

    ノード ID。

    1234
    ProjectId

    integer

    ノードが属するワークスペースの ID。

    1234
    Topics

    array<object>

    アラートをトリガーしたイベント。このパラメーターは、`Source` パラメーターの値が `TOPIC_ALERT` の場合に返されます。`Source` パラメーターの値が `TOPIC_ALERT` でない場合、このパラメーターは空のままになります。

    object

    イベントに関する情報。

    TopicName

    string

    イベントの名前。

    9527 error
    InstanceId

    integer

    イベントをトリガーしたインスタンスの ID。

    12345
    TopicId

    integer

    イベント ID。

    1234
    TopicOwner

    string

    イベントオーナーが使用する Alibaba Cloud アカウントの ID。

    9527952795****
    NodeId

    integer

    イベントをトリガーしたノードの ID。

    1234
    TopicStatus

    string

    イベントのステータス。有効な値：`IGNORE`、`NEW`、`FIXING`、`RECOVER`。値 `IGNORE` はイベントが無視されたことを示します。値 `NEW` はイベントが新しいイベントであることを示します。値 `FIXING` はイベントが処理中であることを示します。値 `RECOVER` はイベントが処理されたことを示します。

    FIXING
    Nodes

    array<object>

    さまざまなアラートソースに対して返されるノード。

    • `Source` パラメーターの値が `NODE_CYCLE_ALERT` の場合、ループを形成するノードが返されます。

    • `Source` パラメーターの値が `NODE_LONELY_ALERT` の場合、孤立しているノードが返されます。

    object

    ノードに関する情報。

    Owner

    string

    ノードオーナーが使用する Alibaba Cloud アカウントの ID。

    95279527952****
    NodeName

    string

    ノードの名前。

    Node name
    NodeId

    integer

    ノード ID。

    1234
    ProjectId

    integer

    ノードが属するワークスペースの ID。

    1234
    SlaAlert

    object

    アラートをトリガーしたベースラインインスタンスに関する基本情報。このパラメーターは、`Source` パラメーターの値が `SLA_ALERT` の場合に返されます。`Source` パラメーターの値が `SLA_ALERT` でない場合、このパラメーターは空のままになります。

    Status

    string

    ベースラインのステータス。有効な値：`ERROR`、`SAFE`、`DANGEROUS`、`OVER`。値 `ERROR` は、ベースラインに関連付けられたノードがないか、ベースラインに関連付けられたすべてのノードが一時停止していることを示します。値 `SAFE` は、アラート期間が始まる前にノードが実行されることを示します。値 `DANGEROUS` は、アラート期間が終了してもノードがまだ実行中であるが、コミットされた完了時間には達していないことを示します。値 `OVER` は、コミットされた完了時間を過ぎてもノードがまだ実行中であることを示します。

    SAFE
    BaselineOwner

    string

    ベースラインオーナーが使用する Alibaba Cloud アカウントの ID。複数の ID はコンマ (,) で区切られます。

    952795279****
    BaselineId

    integer

    ベースライン ID。

    1234
    BaselineName

    string

    ベースラインの名前。

    Baseline name
    Bizdate

    integer

    ベースラインインスタンスのデータタイムスタンプ。

    1553443200000
    ProjectId

    integer

    ベースラインが属するワークスペースの ID。

    1234
    InGroupId

    integer

    ベースラインインスタンスのサイクルの ID。時間レベルのサイクルの ID の有効な値：[1,24]。日レベルのサイクルの ID は 1 です。

    1

    例

    成功レスポンス

    JSONJSON

    {
  "HttpStatusCode": 200,
  "RequestId": "0000-ABCD-EFG****",
  "ErrorMessage": "The specified parameters are invalid.",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "PageNumber": "1",
    "PageSize": "10",
    "TotalCount": "100",
    "AlertMessages": [
      {
        "RemindId": 1234,
        "AlertMessageStatus": "READY_TO_SEND",
        "AlertUser": "9527952795****",
        "AlertTime": 1553531401000,
        "AlertMethod": "SMS",
        "Source": "REMIND_ALERT",
        "Content": "Node error",
        "RemindName": "Custom monitoring rule name",
        "AlertId": 1234,
        "Instances": [
          {
            "Status": "NOT_RUN",
            "InstanceId": 12345,
            "NodeName": "Node name",
            "NodeId": 1234,
            "ProjectId": 1234
          }
        ],
        "Topics": [
          {
            "TopicName": "9527 error",
            "InstanceId": 12345,
            "TopicId": 1234,
            "TopicOwner": "9527952795****",
            "NodeId": 1234,
            "TopicStatus": "FIXING"
          }
        ],
        "Nodes": [
          {
            "Owner": "95279527952****",
            "NodeName": "Node name",
            "NodeId": 1234,
            "ProjectId": 1234
          }
        ],
        "SlaAlert": {
          "Status": "SAFE",
          "BaselineOwner": "952795279****",
          "BaselineId": 1234,
          "BaselineName": "Baseline name",
          "Bizdate": 1553443200000,
          "ProjectId": 1234,
          "InGroupId": 1
        }
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    500 Forbidden.Not.Server The dataworksAPI service is not available in this area. Please try it in another area.
    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.Api.Risk The request for this resource has exceeded your daily available limit.
    429 Throttling.Resource You have reached the limit for the resource. Please contact us by submitting a ticket.
    429 Throttling.System The DataWorks system is busy. Try again later.
    429 Throttling.User Your request is too frequent. Try again later.

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

    変更履歴

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