すべてのプロダクト
Search

このプロダクト

    DataWorks:GetRemind

    ドキュメントセンター

    DataWorks:GetRemind

    最終更新日:Mar 21, 2026

    カスタムアラートルールの情報を照会します。

    今すぐお試しください

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

    テスト

    RAM 認証

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

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RemindId

    integer

    必須

    カスタムアラートルールの ID。

    1234

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

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

    HttpStatusCode

    integer

    HTTP ステータスコード。

    200
    RequestId

    string

    リクエスト ID。

    0000-ABCD-EFGH-IJK****
    ErrorMessage

    string

    エラーメッセージ。

    The specified parameters are invalid.
    ErrorCode

    string

    エラーコード。

    1031203110005
    Success

    boolean

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

    true
    Data

    object

    カスタムアラートルールの詳細。

    MaxAlertTimes

    integer

    最大アラート数。

    3
    RemindUnit

    string

    カスタムアラートルールが適用されるオブジェクトのタイプ。有効な値：NODE、BASELINE、PROJECT、BIZPROCESS。NODE はノード、BASELINE はベースライン、PROJECT はワークスペース、BIZPROCESS はワークフローを示します。

    NODE
    AlertInterval

    integer

    アラートが報告される最小間隔。単位：秒。

    1800
    Useflag

    boolean

    カスタムアラートルールが有効かどうかを示します。有効な値：true と false。

    true
    Founder

    string

    カスタムアラートルールの作成者が使用する Alibaba Cloud アカウントの ID。

    9527951795****
    RemindId

    integer

    カスタムアラートルールの ID。

    1234
    DndEnd

    string

    サイレント時間の終了時刻。値は hh:mm 形式です。hh の有効な値：[0,23]。mm の有効な値：[0,59]。

    08:00
    RemindType

    string

    アラートをトリガーする条件。有効な値：FINISHED、UNFINISHED、ERROR、CYCLE_UNFINISHED、TIMEOUT。

    FINISHED
    AlertUnit

    string

    アラート受信者のタイプ。アラート受信者のタイプの詳細については、Receivers パラメーターをご参照ください。有効な値：

    • OWNER：タスクオーナー

    • OTHER：指定された担当者

    • SHIFT_SCHEDULE：勤怠表の担当者

    OWNER
    DndStart

    string

    サイレント時間の開始時刻。値は hh:mm 形式です。hh の有効な値：[0,23]。mm の有効な値：[0,59]。

    00:00
    RemindName

    string

    ルールの名前。

    Rule name
    Detail

    string

    • RemindType パラメーターの値が FINISHED の場合、このパラメーターは空のままです。

    • RemindType パラメーターの値が UNFINISHED の場合、トリガー条件はキーと値のペアとして返されます。例：{"hour":23,"minu":59}。hour の有効な値：[0,47]。minu の有効な値：[0,59]。

    • RemindType パラメーターの値が ERROR の場合、このパラメーターは空のままです。

    • RemindType パラメーターの値が CYCLE_UNFINISHED の場合、トリガー条件はキーと値のペアとして返されます。例：{"1":"05:50","2":"06:50","3":"07:50","4":"08:50","5":"09:50","6":"10:50","7":"11:50","8":"12:50","9":"13:50","10":"14:50","11":"15:50","12":"16:50","13":"17:50","14":"18:50","15":"19:50","16":"20:50","17":"21:50","18":"22:50","19":"23:50","20":"24:50","21":"25:50"}。キーはサイクルの ID を示します。有効な値：[1,288]。値は、サイクルで実行中のノードのタイムアウト期間を示します。値は hh:mm 形式で指定します。hh の有効な値：[0,47]。mm の有効な値：[0,59]。

    • RemindType パラメーターの値が TIMEOUT の場合、タイムアウト期間が返されます。単位：秒。例：1800。この値は、ノードが 30 分以上実行された場合にアラートが報告されることを示します。

    {"hour":23,"minu":59}
    Robots

    array<object>

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

    object

    WebUrl

    string

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

    https://oapi.dingtalk.com/robot/send?access_token=******************************
    AtAll

    boolean

    アラート通知が DingTalk グループに送信されるときに、すべてのグループメンバーに通知するかどうかを示します。有効な値：true と false。

    true
    Nodes

    array<object>

    カスタムアラートルールが適用されるノード。このパラメーターは、RemindUnit パラメーターの値が NODE の場合に返されます。

    object

    Owner

    string

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

    9527951795****
    NodeName

    string

    ノードの名前。

    Node name
    NodeId

    integer

    ノード ID。

    1234
    ProjectId

    integer

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

    1234
    Baselines

    array<object>

    カスタムアラートルールが適用されるベースライン。このパラメーターは、RemindUnit パラメーターの値が BASELINE の場合に返されます。

    object

    BaselineName

    string

    ベースラインの名前。

    Baseline name
    BaselineId

    integer

    ベースライン ID。

    1234
    Projects

    array<object>

    カスタムアラートルールが適用されるワークスペース。このパラメーターは、RemindUnit パラメーターの値が PROJECT の場合に返されます。

    object

    ProjectId

    integer

    ワークスペース ID。

    1234
    BizProcesses

    array<object>

    カスタムアラートルールが適用されるワークフロー。このパラメーターは、RemindUnit パラメーターの値が BIZPROCESS の場合に返されます。

    object

    BizProcessName

    string

    ワークフローの名前。

    Business process name
    BizId

    integer

    ワークフローの ID。

    9527
    AlertTargets

    array

    アラート受信者の説明。アラート受信者の詳細については、Receivers パラメーターをご参照ください。

    string

    • AlertUnit パラメーターの値が OWNER の場合、このパラメーターは空のままです。

    • AlertUnit パラメーターの値が OTHER の場合、指定されたユーザーが使用する Alibaba Cloud アカウントの ID が返されます。

    • AlertUnit パラメーターの値が SHIFT_SCHEDULE の場合、勤怠表の ID が返されます。

    9527952795279527
    AlertMethods

    array

    通知方法。

    string

    通知方法。有効な値：

    • MAIL

    • SMS

    • アラート通知は、シンガポール、マレーシア (クアラルンプール)、ドイツ (フランクフルト) リージョンでのみショートメッセージで送信できます。

    SMS,MAIL
    Webhooks

    array

    Webhook URL

    string

    WeCom または Lark チャットボットの Webhook URL。AlertMethods に Webhooks を指定する必要があります。このパラメーターは DataWorks Enterprise Edition のみがサポートします。

    https://open.feishu.cn/open-apis/bot/v2/hook/*******
    Receivers

    array<object>

    アラート受信者に関する情報。

    object

    アラート受信者に関する情報。

    AlertUnit

    string

    アラート受信者のタイプ。アラート受信者の詳細については、Receivers パラメーターをご参照ください。有効な値：

    • OWNER：タスクオーナーを示します。

    • OTHER：指定された担当者を示します。

    • SHIFT_SCHEDULE：勤怠表の担当者を示します。

    OWNER
    AlertTargets

    array

    アラート受信者。

    string

    • AlertUnit パラメーターの値が OWNER の場合、このパラメーターは空のままです。

    • AlertUnit パラメーターの値が OTHER の場合、指定されたユーザーが使用する Alibaba Cloud アカウントの ID が返されます。

    • AlertUnit パラメーターの値が SHIFT_SCHEDULE の場合、勤怠表の ID が返されます。

    9527952795279527
    AllowNodes

    array

    ホワイトリストに追加されたノードの ID。

    integer

    ホワイトリストに追加されたノードの ID。ホワイトリストに追加したノードはモニターされません。

    123

    例

    成功レスポンス

    JSONJSON

    {
  "HttpStatusCode": 200,
  "RequestId": "0000-ABCD-EFGH-IJK****",
  "ErrorMessage": "The specified parameters are invalid.",
  "ErrorCode": "1031203110005",
  "Success": true,
  "Data": {
    "MaxAlertTimes": 3,
    "RemindUnit": "NODE",
    "AlertInterval": 1800,
    "Useflag": true,
    "Founder": "9527951795****",
    "RemindId": 1234,
    "DndEnd": "08:00",
    "RemindType": "FINISHED",
    "AlertUnit": "OWNER",
    "DndStart": "00:00",
    "RemindName": "Rule name",
    "Detail": "{\"hour\":23,\"minu\":59}",
    "Robots": [
      {
        "WebUrl": "https://oapi.dingtalk.com/robot/send?access_token=******************************",
        "AtAll": true
      }
    ],
    "Nodes": [
      {
        "Owner": "9527951795****",
        "NodeName": "Node name",
        "NodeId": 1234,
        "ProjectId": 1234
      }
    ],
    "Baselines": [
      {
        "BaselineName": "Baseline name",
        "BaselineId": 1234
      }
    ],
    "Projects": [
      {
        "ProjectId": 1234
      }
    ],
    "BizProcesses": [
      {
        "BizProcessName": "Business process name",
        "BizId": 9527
      }
    ],
    "AlertTargets": [
      "9527952795279527"
    ],
    "AlertMethods": [
      "SMS,MAIL"
    ],
    "Webhooks": [
      "https://open.feishu.cn/open-apis/bot/v2/hook/*******"
    ],
    "Receivers": [
      {
        "AlertUnit": "OWNER",
        "AlertTargets": [
          "9527952795279527"
        ]
      }
    ],
    "AllowNodes": [
      123
    ]
  }
}

    エラーコード

    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.

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

    変更履歴

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