すべてのプロダクト
Search

このプロダクト

    DataWorks:GetAlertMessage

    ドキュメントセンター

    DataWorks:GetAlertMessage

    最終更新日:Mar 21, 2026

    AlertId パラメーターで指定されたアラート ID を基に、アラート情報を照会します。

    今すぐお試しください

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

    テスト

    RAM 認証

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

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    AlertId

    string

    必須

    アラート ID。アラート ID は、ListAlertMessages 操作を呼び出して取得できます。

    1421

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

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

    RequestId

    string

    リクエスト ID。

    0000-ABCD-EFG****
    HttpStatusCode

    integer

    HTTP ステータスコード。

    200
    ErrorMessage

    string

    エラーメッセージ。

    The specified parameters are invalid.
    ErrorCode

    string

    エラーコード。

    Invalid.Tenant.ConnectionNotExists
    Success

    boolean

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

    • true

    • false

    true
    Data

    object

    返されたアラートの情報。

    RemindId

    integer

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

    1234
    AlertMessageStatus

    string

    通知の送信ステータス。有効な値：

    • READY_TO_SEND：通知は送信待ちです。

    • SEND_FAIL：通知の送信に失敗しました。

    • SEND_SUCCESS：通知が送信されました。

    • SEND_OVERLIMIT：送信された通知数が上限を超えています。

    READY_TO_SEND
    AlertUser

    string

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

    9527952795****
    AlertTime

    integer

    アラートが報告された時刻。

    1553524393000
    AlertMethod

    string

    通知方法。有効な値：

    • MAIL

    • SMS

    • PHONE：PHONE 通知方法は、DataWorks Professional Edition およびそれより上位のエディションでのみサポートされます。

    SMS
    Source

    string

    アラートの種別。有効な値：

    • 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。

    123
    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
    InstanceId

    integer

    インスタンス ID。

    12312****
    NodeName

    string

    ノード名。

    Node name
    NodeId

    integer

    ノード ID。

    1234
    ProjectId

    integer

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

    1234
    Topics

    array<object>

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

    object

    イベントの情報。

    TopicName

    string

    イベント名。

    error
    InstanceId

    integer

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

    12345
    TopicId

    integer

    イベント ID。

    412431
    TopicOwner

    string

    イベント所有者として使用される Alibaba Cloud アカウントの ID。

    9527952795****
    NodeId

    integer

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

    1234
    TopicStatus

    string

    イベントのステータス。有効な値：

    • 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

    SAFE
    BaselineOwner

    string

    ベースライン所有者として使用される Alibaba Cloud アカウントの ID。複数の ID はカンマ (,) で区切られます。

    952795279****
    BaselineId

    integer

    ベースライン ID。

    15142123
    BaselineName

    string

    ベースライン名。

    Baseline name
    Bizdate

    integer

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

    1553443200000
    ProjectId

    integer

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

    1234
    InGroupId

    integer

    ベースラインインスタンスのサイクル ID。時間単位のサイクルの ID の有効範囲：[1, 24]。日単位のサイクルの ID は 1 です。

    1

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

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

    変更履歴

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