すべてのプロダクト
Search

このプロダクト

    DataWorks:GetDag

    ドキュメントセンター

    DataWorks:GetDag

    最終更新日:Mar 21, 2026

    有向非循環グラフ (DAG) の情報を照会します。この操作では、手動トリガーワークフロー、手動トリガーのノード、またはデータバックフィルインスタンスに対応する DAG の情報を照会できます。ただし、自動トリガーのノードまたは自動トリガーワークフローに対応する DAG の情報は照会できません。

    操作説明

    Dag Type の種類：

    • MANUAL：手動トリガーワークフロー

    • SMOKE_TEST：スモークテストワークフロー

    • SUPPLY_DATA：データバックフィル

    • BUSINESS_PROCESS_DAG：一時的な業務プロセスワークフロー

    Dag Status の種類：

    • CREATED：作成済み

    • RUNNING：実行中

    • FAILURE：実行失敗

    • SUCCESS：実行成功

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dataworks:*

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DagId

    integer

    必須

    DAG の ID です。以下のいずれかの方法で取得できます。

    • RunCycleDagNodes 操作を呼び出し、レスポンスパラメーター Data の値を取得します。

    • RunSmokeTest 操作を呼び出し、レスポンスパラメーター Data の値を取得します。

    • RunManualDagNodes 操作を呼び出し、レスポンスパラメーター DagId の値を取得します。

    123141452344525
    ProjectEnv

    string

    必須

    ワークスペースの環境です。有効な値は、PROD および DEV です。

    PROD

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

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

    HttpStatusCode

    integer

    HTTP ステータスコードです。

    200
    RequestId

    string

    リクエスト ID です。

    7782a299-b291-4fee-8424-cf8058efa8e8
    ErrorMessage

    string

    エラーメッセージです。

    The connection does not exist.
    ErrorCode

    string

    エラーコードです。

    Invalid.Tenant.ConnectionNotExists
    Success

    boolean

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

    true
    Data

    object

    DAG の詳細です。

    Type

    string

    DAG の種類です。有効な値は、MANUAL、SMOKE_TEST、SUPPLY_DATA、BUSINESS_PROCESS_DAG です。MANUAL は手動トリガーワークフローに対応する DAG を示します。SMOKE_TEST はスモークテストワークフローに対応する DAG を示します。SUPPLY_DATA はデータバックフィルインスタンスに対応する DAG を示します。BUSINESS_PROCESS_DAG は一時的なワークフローに対応する DAG を示します。

    MANUAL_FLOW
    Status

    string

    DAG のステータスです。有効な値は、CREATED、RUNNING、FAILURE、SUCCESS です。

    FAILURE
    FinishTime

    integer

    DAG の実行終了時刻です。

    1605052800000
    CreateTime

    integer

    DAG の作成時刻です。

    1605052800000
    ProjectId

    integer

    ワークスペース ID です。

    112345
    DagId

    integer

    DAG ID です。

    351249682
    Gmtdate

    integer

    DAG の実行予定時刻です。

    1605052800000
    StartTime

    integer

    DAG の実行開始時刻です。

    1605052800000
    CreateUser

    string

    作成者です。

    1736629400048545
    Bizdate

    integer

    データタイムスタンプです。

    1605052800000
    Name

    string

    DAG の名前です。

    test_dag
    ModifyTime

    integer

    DAG の最終更新時刻です。

    1605052800000
    OpSeq

    integer

    操作のシーケンス番号です。

    123

    例

    成功レスポンス

    JSONJSON

    {
  "HttpStatusCode": 200,
  "RequestId": "7782a299-b291-4fee-8424-cf8058efa8e8",
  "ErrorMessage": "The connection does not exist.",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "Type": "MANUAL_FLOW",
    "Status": "FAILURE",
    "FinishTime": 1605052800000,
    "CreateTime": 1605052800000,
    "ProjectId": 112345,
    "DagId": 351249682,
    "Gmtdate": 1605052800000,
    "StartTime": 1605052800000,
    "CreateUser": "1736629400048545",
    "Bizdate": 1605052800000,
    "Name": "test_dag",
    "ModifyTime": 1605052800000,
    "OpSeq": 123
  }
}

    エラーコード

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

    変更履歴

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