すべてのプロダクト
Search

このプロダクト

    DataWorks:ListReminds

    ドキュメントセンター

    DataWorks:ListReminds

    最終更新日:Mar 21, 2026

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

    今すぐお試しください

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

    テスト

    RAM 認証

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

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    PageNumber

    integer

    必須

    返すページ番号。有効値：1～30。デフォルト値：1。

    1
    PageSize

    integer

    必須

    各ページに返すエントリ数。デフォルト値：10。最大値：100。

    10
    Founder

    string

    任意

    カスタムアラートルールを作成するために使用される Alibaba Cloud アカウントの ID。

    9527952795****
    NodeId

    integer

    任意

    カスタムアラートルールが適用されるノードの ID。この ID を使用して、ノードに適用されているカスタムアラートルールを検索できます。

    1234
    RemindTypes

    string

    任意

    ノードのアラートをトリガーする条件。有効値：FINISHED、UNFINISHED、ERROR、CYCLE_UNFINISHED、TIMEOUT。値 FINISHED は、ノードの実行が完了したことを示します。値 UNFINISHED は、指定した時点でノードがまだ実行中であることを示します。値 ERROR は、ノードの実行中にエラーが発生したことを示します。値 CYCLE_UNFINISHED は、指定されたスケジューリングサイクルでノードの実行が完了しないことを示します。値 TIMEOUT は、ノードがタイムアウトしたことを示します。カスタムアラートルールには複数の条件を指定できます。複数の条件を指定する場合は、コンマ (,) で区切ります。

    FINISHED,ERROR
    AlertTarget

    string

    任意

    アラート通知を受信するために使用される Alibaba Cloud アカウントの ID。

    9527952795****
    SearchText

    string

    任意

    ルールを検索するために使用されるルール名内のキーワード。あいまい検索がサポートされています。

    模糊搜索规则名称

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    HttpStatusCode

    integer

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

    200
    RequestId

    string

    リクエスト ID。この ID を使用して、問題のトラブルシューティングを行うことができます。

    0000-ABCD-EFG****
    ErrorMessage

    string

    返されたエラーメッセージ。

    The specified parameters are invalid.
    ErrorCode

    string

    返されたエラーコード。

    1031203110005
    Success

    boolean

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

    true
    Data

    object

    返されたデータ。

    PageNumber

    integer

    返されたページのページ番号。

    1
    PageSize

    integer

    ページごとに返されるエントリ数。

    10
    TotalCount

    integer

    返されたカスタムアラートルールの総数。

    100
    Reminds

    array<object>

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

    object

    Founder

    string

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

    952795****
    RemindId

    integer

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

    1234
    AlertUnit

    string

    アラート受信者。有効値：OWNER と OTHER。値 OWNER はノード所有者を示します。値 OTHER は指定されたユーザーを示します。

    OWNER
    RemindType

    string

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

    FINISHED
    DndEnd

    string

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

    08:00
    DndStart

    string

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

    00:00
    RemindUnit

    string

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

    NODE
    Useflag

    boolean

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

    true
    RemindName

    string

    カスタムアラートルールの名前。

    规则名称
    AlertTargets

    array

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

    string

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

    952795****
    NodeIds

    array

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

    integer

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

    1234
    BizProcessIds

    array

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

    integer

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

    9527
    ProjectIds

    array

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

    integer

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

    1234
    BaselineIds

    array

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

    integer

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

    9527
    AlertMethods

    array

    通知方法。有効値：MAIL、SMS、PHONE。値 MAIL は、通知がメールで送信されることを示します。DataWorks Professional Edition 以上のエディションのみが PHONE 通知方法をサポートします。

    string

    通知方法。有効値：MAIL、SMS、PHONE。値 MAIL は、通知がメールで送信されることを示します。DataWorks Professional Edition 以上のエディションのみが PHONE 通知方法をサポートします。

    SMS

    例

    成功レスポンス

    JSONJSON

    {
  "HttpStatusCode": 200,
  "RequestId": "0000-ABCD-EFG****",
  "ErrorMessage": "The specified parameters are invalid.",
  "ErrorCode": "1031203110005",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "Reminds": [
      {
        "Founder": "952795****",
        "RemindId": 1234,
        "AlertUnit": "OWNER",
        "RemindType": "FINISHED",
        "DndEnd": "08:00",
        "DndStart": "00:00",
        "RemindUnit": "NODE",
        "Useflag": true,
        "RemindName": "规则名称",
        "AlertTargets": [
          "952795****"
        ],
        "NodeIds": [
          1234
        ],
        "BizProcessIds": [
          9527
        ],
        "ProjectIds": [
          1234
        ],
        "BaselineIds": [
          9527
        ],
        "AlertMethods": [
          "SMS"
        ]
      }
    ]
  }
}

    エラーコード

    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.System The DataWorks system is busy. Try again later.
    429 Throttling.User Your request is too frequent. Try again later.

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

    変更履歴

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