CreateNode API と FlowSpec で DataStudio ノードをプロビジョニング - DataWorks

操作説明

重要この API オペレーションでは一括操作はサポートされていません。FlowSpec に複数のノードが定義されている場合、最初のノードのみが処理され、それ以降のノードは無視されます。

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProjectId	integer	必須	DataWorks ワークスペースの ID です。DataWorks コンソール（https://workbench.data.aliyun.com/console）にログインし、「ワークスペース」ページに移動することで、ID を確認できます。このパラメーターを設定して、API オペレーションを適用する DataWorks ワークスペースを指定する必要があります。	123456
ContainerId	string	任意	ノードをコンテナ内に作成する場合に指定します。このパラメーターは、ワークフローまたはコンテナノードなど、コンテナの固有識別子を表します。説明このパラメーターを指定した場合、FlowSpec で定義された path フィールドは無視されます。説明 SDK バージョン 8.0.0 より前では、このフィールドのデータの型は Long でしたが、SDK バージョン 8.0.0 以降では String に変更されています。この変更は SDK の通常利用に影響しません。パラメーターの戻り値は、SDK で定義されたデータの型に基づきます。ただし、SDK をバージョン 8.0.0 をまたいでアップグレードする場合、データの型の変更によりコンパイルエラーが発生する可能性があります。その場合は、手動でデータの型を更新してください。	23451286945488XXXX
Scene	string	必須	ノードをコンテナ内に作成する場合に指定します。このパラメーターは、ワークフローまたはコンテナノードなど、コンテナの固有識別子を表します。説明このパラメーターを指定した場合、FlowSpec で定義された path フィールドは無視されます。説明 SDK バージョン 8.0.0 より前では、このフィールドのデータの型は Long でしたが、SDK バージョン 8.0.0 以降では String に変更されています。この変更は SDK の通常利用に影響しません。パラメーターの戻り値は、SDK で定義されたデータの型に基づきます。ただし、SDK をバージョン 8.0.0 をまたいでアップグレードする場合、データの型の変更によりコンパイルエラーが発生する可能性があります。その場合は、手動でデータの型を更新してください。	DATAWORKS_PROJECT
Spec	string	必須	ノードを記述する FlowSpec 情報です。詳細については、「FlowSpec」をご参照ください。説明 FlowSpec のテンプレートをすばやく取得するにはどうすればよいですか？ Data Studio にアクセスし、任意のノードを開きます。右側の [バージョン] をクリックし、最新のバージョンを特定した後、[スケジューリング設定] をクリックすると、現在のノードの FlowSpec 記述を取得できます。この FlowSpec 記述を活用して、要件に合致するテンプレートを迅速に構築できます。説明ノードの内容をどのように設定しますか？ $.spec.nodes[].script.content フィールドにノードのコードを入力します。説明バッチ同期ノードをどのように設定しますか？「コードエディタを使用したオフライン同期タスクの設定」の手順 4 を参考にスクリプトを作成し、その内容を $.spec.nodes[*].script.content フィールドに入力します。あるいは、コンソールでバッチ同期ノードを作成し、そのバージョン情報を表示することで、スクリプト内容を取得することもできます。	{ "version": "1.1.0", "kind": "Node", "spec": { "nodes": [ { "recurrence": "Normal", "timeout": 0, "instanceMode": "T+1", "rerunMode": "Allowed", "rerunTimes": 3, "rerunInterval": 180000, "datasource": { "name": "odps_test" }, "script": { "path": "XX/OpenAPI_Test/odpsSQL_Test", "runtime": { "command": "ODPS_SQL" }, "content": "select now();" }, "trigger": { "type": "Scheduler", "cron": "00 00 00 * * ?", "startTime": "1970-01-01 00:00:00", "endTime": "9999-01-01 00:00:00", "timezone": "Asia/Shanghai", "delaySeconds": 0 }, "runtimeResource": { "resourceGroup": "S_res_group_XXXX_XXXX" }, "name": "odpsSQL_Test", "inputs": { "nodeOutputs": [ { "data": "project_root", "artifactType": "NodeOutput" } ] }, "outputs": { "nodeOutputs": [ { "data": "output_data", "artifactType": "NodeOutput", "refTableName": "odpsSQL_Test" } ] } } ] } }

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
RequestId	string	リクエスト ID です。	AFBB799F-8578-51C5-A766-E922EDB8XXXX
Id	string	Data Studio ノードの固有識別子です。説明 SDK バージョン 8.0.0 より前では、このフィールドのデータの型は Long でしたが、SDK バージョン 8.0.0 以降では String に変更されています。この変更は SDK の通常利用に影響しません。パラメーターの戻り値は、SDK で定義されたデータの型に基づきます。ただし、SDK をバージョン 8.0.0 をまたいでアップグレードする場合、データの型の変更によりコンパイルエラーが発生する可能性があります。その場合は、手動でデータの型を更新してください。	860438872620113XXXX

例

成功レスポンス

JSONJSON

{
  "RequestId": "AFBB799F-8578-51C5-A766-E922EDB8XXXX",
  "Id": "860438872620113XXXX"
}

エラーコード

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

変更履歴

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