すべてのプロダクト
Search

このプロダクト

    SchedulerX:GetWorkflowInstance

    ドキュメントセンター

    SchedulerX:GetWorkflowInstance

    最終更新日:Mar 23, 2026

    指定されたワークフローインスタンスの詳細情報を照会します。対象となる情報には、ワークフローインスタンスの状態、各ジョブインスタンスの状態、およびジョブインスタンス間の依存関係が含まれます。本操作は、Professional Edition のみで利用可能です。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    edas:ReadSchedulerxWorkflowQuery

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    リージョン ID。

    cn-hangzhou
    Namespace

    string

    必須

    名前空間 ID。SchedulerX コンソールの [名前空間] ページから取得できます。

    adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
    NamespaceSource

    string

    任意

    名前空間のソース。このパラメーターは、特殊なサードパーティのみで必要です。

    schedulerx
    GroupId

    string

    必須

    アプリケーショングループ ID。SchedulerX コンソールの [アプリケーション管理] ページから取得できます。

    testSchedulerx.defaultGroup
    WorkflowId

    integer

    必須

    ワークフロー ID。

    123
    WfInstanceId

    integer

    必須

    ワークフローインスタンス ID。

    123456

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答スキーマ

    RequestId

    string

    リクエスト ID。

    39090022-1F3B-4797-8518-6B61095F1AF0
    Code

    integer

    HTTP ステータスコード。

    200
    Success

    boolean

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

    • true

    • false

    true
    Message

    string

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

    workflowId=xxx is not existed
    Data

    object

    ワークフローインスタンスの詳細情報。

    WfInstanceInfo

    object

    ワークフローインスタンスの詳細情報。対象となる情報には、ワークフローインスタンスの状態、実行開始時刻、実行終了時刻、各ジョブインスタンスの状態、およびジョブインスタンス間の依存関係が含まれます。

    Status

    integer

    ワークフローインスタンスの状態。有効な値：

    • 1：保留中

    • 2：準備中

    • 3：実行中

    • 4：成功

    • 5：失敗

    5
    StartTime

    string

    ワークフローインスタンスの実行開始時刻。

    2023-01-03 18:00:01
    EndTime

    string

    ワークフローインスタンスの実行終了時刻。

    2023-01-03 18:00:21
    ScheduleTime

    string

    ワークフローインスタンスの実行予定時刻。

    2023-01-03 18:00:00
    DataTime

    string

    ワークフローインスタンスのデータタイムスタンプ。

    2023-01-03 18:00:00
    WfInstanceDag

    object

    ワークフローインスタンスの有向非循環グラフ (DAG)。ノードおよび依存関係を含みます。

    Nodes

    array<object>

    ジョブインスタンス。

    object

    JobInstanceId

    integer

    ジョブインスタンス ID。

    24058796
    JobId

    integer

    ジョブ ID。

    1472
    StartTime

    string

    ジョブの実行開始時刻。

    2023-01-03 18:00:03
    EndTime

    string

    ジョブの実行終了時刻。

    2023-01-03 18:00:21
    ScheduleTime

    string

    ジョブの実行予定時刻。

    2023-01-03 18:00:03
    DataTime

    string

    ジョブのデータタイムスタンプ。

    2023-01-03 18:00:00
    WorkAddr

    string

    ジョブインスタンスが実行されたワーカー。

    10.163.0.101:34027
    Result

    string

    ジョブの実行結果。

    code=200
    Attempt

    integer

    ジョブの失敗時の再試行回数。

    0
    Status

    integer

    ジョブインスタンスの状態。有効な値：1（実行待ち）、3（実行中）、4（実行完了）、5（実行失敗）、9（拒否）。列挙型クラス：com.alibaba.schedulerx.common.domain.InstanceStatus。

    4
    JobName

    string

    ジョブ名。

    TestJob
    Edges

    array<object>

    ジョブインスタンス間の依存関係。

    object

    各ジョブインスタンスの上流および下流の依存関係。

    Source

    integer

    現在のジョブインスタンスの上流ジョブインスタンス。値が 0 の場合、上流ジョブインスタンスはルートノードであることを示します。

    24058798
    Target

    integer

    現在のジョブインスタンスの下流ジョブインスタンス。

    24058796

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "39090022-1F3B-4797-8518-6B61095F1AF0",
  "Code": 200,
  "Success": true,
  "Message": "workflowId=xxx is not existed",
  "Data": {
    "WfInstanceInfo": {
      "Status": 5,
      "StartTime": "2023-01-03 18:00:01",
      "EndTime": "2023-01-03 18:00:21",
      "ScheduleTime": "2023-01-03 18:00:00",
      "DataTime": "2023-01-03 18:00:00"
    },
    "WfInstanceDag": {
      "Nodes": [
        {
          "JobInstanceId": 24058796,
          "JobId": 1472,
          "StartTime": "2023-01-03 18:00:03",
          "EndTime": "2023-01-03 18:00:21",
          "ScheduleTime": "2023-01-03 18:00:03",
          "DataTime": "2023-01-03 18:00:00",
          "WorkAddr": "10.163.0.101:34027",
          "Result": "code=200",
          "Attempt": 0,
          "Status": 4,
          "JobName": "TestJob"
        }
      ],
      "Edges": [
        {
          "Source": 24058798,
          "Target": 24058796
        }
      ]
    }
  }
}

    エラーコード

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

    変更履歴

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