すべてのプロダクト
Search
ドキュメントセンター

Data Management:ListTasksInTaskFlow

最終更新日:Mar 21, 2026

指定されたタスクフロー内のタスクをクエリします。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dms:ListTasksInTaskFlow

list

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

Tid

integer

任意

テナントの ID。

説明

テナント ID を表示するには、Data Management (DMS) コンソールの右上隅にあるプロフィール画像にポインターを合わせます。詳細については、「現在のテナントに関する情報の表示」をご参照ください。

3***

DagId

integer

必須

タスクフローの ID。`ListTaskFlow` または `ListLhTaskFlowAndScenario` 操作を呼び出して、タスクフロー ID をクエリできます。

32***

レスポンスフィールド

フィールド

説明

object

RequestId

string

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

8B36B063-6B7D-5595-9FCF-3844B7B7ACD4

ErrorCode

string

リクエストが失敗した場合に返されるエラーコード。

UnknownError

ErrorMessage

string

リクエストが失敗した場合に返されるエラーメッセージ。

任务流不存在或没有权限

Success

boolean

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

  • true:リクエストは成功しました。

  • false:リクエストは失敗しました。

true

Tasks

object

Task

array<object>

タスクフロー内のタスク。

object

タスクの詳細。

NodeName

string

ノードの名前。

Cross-Database Spark SQL-1

NodeType

string

ノードのタイプ。このパラメーターの有効な値の詳細については、「NodeType パラメーター」をご参照ください。

SPARK_SQL

NodeContent

string

ノードの構成。

{ "dbId":123456, // 数据库Id "sql":"/* 请使用当前节点所选择的数据库语法编写SQL */", // sql语句 "dbType":"polardb" // 数据库类型 }

TimeVariables

string

ノードに構成された時間変数。

{ "variables":[ // "variables"为固定值 { "name":"var", // name指定变量名 "pattern":"yyyy-MM-dd|+0m+0h-2d+0w+0M+1y" // 见后面解释 } ] }

NodeConfig

string

ノードの詳細設定。

{ "rerun":{ // 必填固定值 "rerunEnable":true, // 是否开启重跑 "rerunCount":1, // 重跑次数 "rerunInterval":10 // 重跑间隔 } }

NodeOutput

string

タスクの出力変数。

{ "outputs":[ { /* 变量提取设置 { "row":0, // 行,-1为所有行 "column":-1, // 列,-1为所有列 /* 分隔符 当选中所有行或所有列时,需要指定连接符。变量返回值为字符串 */ "combiner":"," } */ "extractMethod":"{\"row\":0,\"column\":-1,\"combiner\":\",\"}", "variableName":"var", // 变量名 "description":"For demo" // 变量介绍 } ] }

GraphParam

string

有向非巡回グラフ (DAG) 上のノードの位置。

{\"x\":435,\"y\":192,\"layoutType\":\"Horizontal\"}

NodeId

string

ノードの ID。

92***

成功レスポンス

JSONJSON

{
  "RequestId": "8B36B063-6B7D-5595-9FCF-3844B7B7ACD4",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "任务流不存在或没有权限",
  "Success": true,
  "Tasks": {
    "Task": [
      {
        "NodeName": "Cross-Database Spark SQL-1",
        "NodeType": "SPARK_SQL",
        "NodeContent": "{     \"dbId\":123456, // 数据库Id     \"sql\":\"/* 请使用当前节点所选择的数据库语法编写SQL */\", // sql语句     \"dbType\":\"polardb\" // 数据库类型 }",
        "TimeVariables": "{   \"variables\":[     // \"variables\"为固定值     {       \"name\":\"var\", // name指定变量名       \"pattern\":\"yyyy-MM-dd|+0m+0h-2d+0w+0M+1y\" // 见后面解释     }   ] }",
        "NodeConfig": "{     \"rerun\":{ // 必填固定值         \"rerunEnable\":true, // 是否开启重跑         \"rerunCount\":1, // 重跑次数         \"rerunInterval\":10 // 重跑间隔     } }",
        "NodeOutput": "{     \"outputs\":[         {             /*             变量提取设置             {                 \"row\":0, // 行,-1为所有行                 \"column\":-1, // 列,-1为所有列                 /*                 分隔符                 当选中所有行或所有列时,需要指定连接符。变量返回值为字符串                 */                 \"combiner\":\",\"              }             */             \"extractMethod\":\"{\\\"row\\\":0,\\\"column\\\":-1,\\\"combiner\\\":\\\",\\\"}\",              \"variableName\":\"var\", // 变量名             \"description\":\"For demo\" // 变量介绍         }     ] }",
        "GraphParam": "{\\\"x\\\":435,\\\"y\\\":192,\\\"layoutType\\\":\\\"Horizontal\\\"}",
        "NodeId": "92***"
      }
    ]
  }
}

エラーコード

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

変更履歴

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