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

Data Management:CreateTask

最終更新日:Apr 29, 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:CreateTask

create

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

Tid

integer

任意

テナント ID です。

説明

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

3***

DagId

integer

必須

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

7***

NodeName

string

必須

作成するノードの名前です。

zhttest

NodeType

string

必須

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

NORMAL_SQL

NodeContent

string

任意

ノードの構成です。

test

TimeVariables

string

任意

ノードに設定された時間変数です。

test

NodeOutput

string

任意

タスクに設定された出力変数です。

test

GraphParam

string

任意

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

test

ノード関連パラメーターの説明

ノードの構成はノードタイプによって異なります。本トピックは、CreateTask や UpdateTaskOutput などのタスクノード関連操作について補足的に説明するものです。NodeParam、NodeContent、および GraphParam パラメーターは、すべてのタスクノード関連操作に適用されます。
シングルインスタンス SQL 割り当て、スクリプトコード、Elastic Compute Service (ECS) リモートコマンドなどのノードのみが出力変数を持ちます。出力変数の構成はノードタイプによって異なります。詳細については、UpdateTaskOutput 操作の関連トピックをご参照ください。

シングルインスタンス用 SQL

  • DagId

  • NodeName

  • NodeType: 1

  • NodeParam

  • GraphParam

  • NodeContent:

{
    "dbId":123456, // データベース ID。
    "sql":"/* 現在のノードのデータベース構文を使用して SQL ステートメントを記述 */", // SQL ステートメント。
    "dbType":"lindorm_sql" // データベースタイプ。
}

スクリプト

  • DagId

  • NodeName

  • NodeType: 28

  • NodeParam

  • GraphParam

  • NodeOutput

{
    "outputs":[
        {
            "extractMethod":"json", // 値は JSON 形式。
            "variableName":"var", // 変数名。
            "description":"デモの説明" // 変数の説明。
        }
    ]
}
  • NodeContent:

{
    "regionId":"cn-hangzhou", // リージョン ID。
    "gatewayId":"dg-xxxxxxxxxxxxxx", // ゲートウェイ ID。
    "gatewayInstanceId":"dg-node-xxxxxxxxxxxxxx", // ゲートウェイインスタンスの ID。
    "scriptFileName":"demo.sh", // ファイル名。
    "args":[ // 実行パラメーター。
        "-n value",
        "-n1 value1"
    ]
}

ロックフリーなデータ変更

  • DagId

  • NodeName

  • NodeType: 24

  • NodeParam

  • GraphParam

  • NodeContent:

{
    "dbId":123456, // データベース ID。
    "sql":"/* 現在のノードのデータベース構文を使用して SQL ステートメントを記述 */", // SQL ステートメント。
    "dbType":"polardb" // データベースタイプ。
}

シングルインスタンス用 SQL 割り当て

  • DagId

  • NodeName

  • NodeType: 32

  • NodeParam

  • GraphParam

  • NodeOutput:

{
    "outputs":[
        {
            /*
            // 変数抽出設定。
            {
                "row":0, // 行。-1 はすべての行を示す。
                "column":-1, // 列。-1 はすべての列を示す。
                "combiner":"," // デリミタ。すべての行または列を選択する場合、デリミタを指定する必要がある。変数の戻り値は文字列となる。
            }
            */
            "extractMethod":"{\"row\":0,\"column\":-1,\"combiner\":\",\"}", 
            "variableName":"var", // 変数名。
            "description":"デモ用" // 変数の説明。
        }
    ]
}
  • NodeContent:

{
    "dbId":123456, // データベース ID。
    "sql":"/* 現在のノードのデータベース構文を使用して SQL ステートメントを記述。SELECT 文のみサポートされる。デフォルトでは、戻り行数の最大値は 30 行。 *", // SQL ステートメント。
    "dbType":"lindorm_cql" // データベースタイプ。
}

依存関係チェック

  • DagId

  • NodeName

  • NodeType: 2

  • NodeParam

  • GraphParam

  • NodeContent:

{
    "dependentDAGId":132, // 依存オブジェクト:タスクフロー。
    "dependentNodeId":"", // 依存オブジェクト:シングルノード。デフォルトでは、依存オブジェクトは指定されたタスクフローとなる。
    "dependentStartTimePattern":"yyyy-MM-dd HH:mm|-2d+0h+0m", // 開始時刻のオフセット。
    "dependentEndTimePattern":"yyyy-MM-dd HH:mm|+1d +0h+0m", // 終了時刻のオフセット。
    "multiSuccessStrategy":2, // インスタンスチェックポリシー。0 は直前のノードが成功することを示す。1 はすべてのノードが成功することを示す。2 は指定されたノードが成功することを示す。
    "multiSuccessStrategyIndex":1 // インスタンスチェックポリシー:ノード x+1 が成功。
}

テーブル内の時間列のステータスチェック

  • DagId

  • NodeName

  • NodeType: 2

  • NodeParam

  • GraphParam

  • NodeContent:

{
    "dependentDAGId":132, // 依存オブジェクト:タスクフロー。
    "dependentNodeId":"", // 依存オブジェクト:シングルノード。デフォルトでは、依存オブジェクトは指定されたタスクフローとなる。
    "dependentStartTimePattern":"yyyy-MM-dd HH:mm|-2d+0h+0m", // 開始時刻のオフセット。
    "dependentEndTimePattern":"yyyy-MM-dd HH:mm|+1d +0h+0m", // 終了時刻のオフセット。
    "multiSuccessStrategy":2, // インスタンスチェックポリシー。0 は直前のノードが成功することを示す。1 はすべてのノードが成功することを示す。2 は指定されたノードが成功することを示す。
    "multiSuccessStrategyIndex":1 // インスタンスチェックポリシー:ノード x+1 が成功。
}

SQL ステータスチェック

  • DagId

  • NodeName

  • NodeType: 25

  • NodeParam

  • GraphParam

  • NodeContent:

{
    "dbId":123456,
    "sql":"/* 現在のノードのデータベース構文を使用して SQL ステートメントを記述*/ \n\n select 1 from abc",
    "dbType":"lindorm_cql"
}

レスポンスフィールド

フィールド

説明

object

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

RequestId

string

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

CFD8FE00-36D9-4C1B-940D-65A7B73D9066

ErrorCode

string

返されたエラーコードです。

InvalidParameterValid

ErrorMessage

string

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

InvalidParameterValid

Success

boolean

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

  • true

  • false

true

NodeId

integer

タスク作成時に返されたタスクノードの ID です。

3***

成功レスポンス

JSONJSON

{
  "RequestId": "CFD8FE00-36D9-4C1B-940D-65A7B73D9066",
  "ErrorCode": "InvalidParameterValid",
  "ErrorMessage": "InvalidParameterValid",
  "Success": true,
  "NodeId": 0
}

エラーコード

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

変更履歴

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