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

:CreateFile

最終更新日:Mar 21, 2026

DataStudio でファイルを作成します。この操作は、Data Integration ノード向けのファイル作成には使用できません。

今すぐお試しください

この 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:*

create

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

FileFolderPath

string

任意

ファイルのパスです。

Business_process/First_Business_Process/MaxCompute/Folder_1/Folder_2

ProjectId

integer

任意

DataWorks ワークスペースの ID です。DataWorks コンソールにログインし、「ワークスペース管理」ページへ移動して、ワークスペース ID を確認できます。

この操作を適用する DataWorks ワークスペースを特定するためには、このパラメーターまたは ProjectIdentifier パラメーターのいずれかを設定する必要があります。

10000

FileName

string

必須

ファイル名です。

File name

FileDescription

string

任意

ファイルの説明です。

这里是文件描述

FileType

integer

必須

ファイルのコードの種類です。ファイルの種類に応じて、コードの内容が異なります。詳細については、「DataWorks ノード」をご参照ください。

ファイルのコードの種類を照会するには、ListFileType 操作を呼び出します。

10

Owner

string

任意

ファイル所有者が使用する Alibaba Cloud アカウントの ID です。このパラメーターを設定しない場合、操作を呼び出したユーザーの Alibaba Cloud アカウント ID が使用されます。

1000000000001

Content

string

任意

ファイルのコードです。コードのフォーマットはファイルの種類によって異なります。特定のファイル種類のコードフォーマットを確認するには、オペレーションセンターで該当するノードを右クリックし、「コードの表示」を選択します。

SHOW TABLES;

AutoRerunTimes

integer

任意

エラー発生後の自動再実行回数です。最大値:10。

3

AutoRerunIntervalMillis

integer

任意

エラー発生後の自動再実行間隔です。単位:ミリ秒。最大値:1800000(30 分)。

このパラメーターは、DataWorks コンソールの「プロパティ」タブの「スケジュール」セクションで「エラー時自動再実行」チェックボックスを選択した後に表示される「再実行間隔」パラメーターに対応しています。

DataWorks コンソールで指定する間隔は分単位です。操作呼び出し時に単位の変換にご注意ください。

120000

RerunMode

string

任意

ファイルに対応するノードの再実行可否を指定します。有効な値は以下のとおりです:

  • ALL_ALLOWED:ノードが正常終了した場合でも、失敗した場合でも再実行可能です。

  • FAILURE_ALLOWED:ノードが失敗した場合のみ再実行可能です。

  • ALL_DENIED:ノードが正常終了した場合でも、失敗した場合でも再実行できません。

このパラメーターは、DataWorks コンソールの DataStudio ページの「プロパティ」タブの「スケジュール」セクションに表示される「再実行」パラメーターに対応しています。

ALL_ALLOWED

Stop

boolean

任意

ノードのスケジュール実行を一時停止するかどうかを指定します。有効な値は以下のとおりです:

  • true

  • false

このパラメーターは、DataWorks コンソールの DataStudio ページの「プロパティ」タブの「スケジュール」セクションに表示される「繰り返し」パラメーターに対応しています。

false

ParaValue

string

任意

ノードのスケジュールパラメーターです。複数のパラメーターを半角スペースで区切ります。

このパラメーターは、DataWorks コンソールの「プロパティ」タブの「パラメーター」セクションに対応しています。スケジュールパラメーターの設定方法については、「スケジュールパラメーターの設定」をご参照ください。

a=x b=y

StartEffectDate

integer

任意

自動スケジュールの開始時刻です。1970 年 1 月 1 日 00:00:00 UTC を基準とした経過ミリ秒数を表す UNIX タイムスタンプを指定します。

このパラメーターを設定することは、DataWorks コンソールの DataStudio ページの「プロパティ」タブの「スケジュール」セクションにある「有効期間」パラメーターの開始時刻を指定することと同等です。

1671608450000

EndEffectDate

integer

任意

自動スケジュールの終了時刻です。1970 年 1 月 1 日 00:00:00 UTC を基準とした経過ミリ秒数を表す UNIX タイムスタンプを指定します。

このパラメーターは、DataWorks コンソールの「プロパティ」タブの「スケジュール」セクションにある「有効期間」パラメーターに対応しています。

1671694850000

CronExpress

string

任意

ノードの定期スケジュールポリシーを表す CRON 式です。このパラメーターは、DataWorks コンソールの DataStudio ページの「プロパティ」タブの「スケジュール」セクションに表示される「CRON 式」パラメーターに対応しています。DataWorks コンソールで「スケジュール周期」と「スケジュール時刻」を設定すると、DataWorks が CRON 式の値を自動生成します。

例:

  • 毎日 05:30 に実行されるノードの CRON 式:00 30 05 * * ?

  • 毎時 15 分に実行されるノードの CRON 式:00 15 00-23/1 * * ?

  • 10 分ごとに実行されるノードの CRON 式:00 00/10 * * * ?

  • 毎日 08:00 ~ 17:00 の間、10 分ごとに実行されるノードの CRON 式:00 00-59/10 8-17 * * * ?

  • 毎月 1 日 00:20 に実行されるノードの CRON 式:00 20 00 1 * ?

  • 1 月 1 日 00:10 から 3 ヶ月ごとに実行されるノードの CRON 式:00 10 00 1 1-12/3 ?

  • 毎週火曜日および金曜日の 00:05 に実行されるノードの CRON 式:00 05 00 * * 2,5

DataWorks のスケジューリングシステムでは、CRON 式に以下の制限があります:

  • CRON 式で指定可能な最小スケジュール間隔は 5 分です。

  • CRON 式で指定可能な 1 日あたりの最も早いスケジュール時刻は 00:05 です。

00 05 00 * * ?

CycleType

string

任意

ファイルに対応するノードのスケジュール周期の種類です。有効な値は NOT_DAY および DAY です。NOT_DAY は分または時間単位でのスケジュール実行を意味し、DAY は日・週・月単位でのスケジュール実行を意味します。

このパラメーターは、DataWorks コンソールの DataStudio ページの「プロパティ」タブの「スケジュール」セクションに表示される「スケジュール周期」パラメーターに対応しています。

DAY

DependentType

string

任意

ノードのクロスサイクルスケジュール依存関係の種類です。有効な値は以下のとおりです:

  • SELF:現在のサイクルで生成されたノードのインスタンスは、前サイクルで生成された同一ノードのインスタンスに依存します。

  • CHILD:現在のサイクルで生成されたノードのインスタンスは、前サイクルで生成された直近のレベルの子孫ノードのインスタンスに依存します。

  • USER_DEFINE:現在のサイクルで生成されたノードのインスタンスは、前サイクルで生成された 1 つ以上の指定ノードのインスタンスに依存します。

  • NONE:ノードに対してクロスサイクルスケジュール依存関係が選択されていません。

  • USER_DEFINE_AND_SELF:現在のサイクルで生成されたノードのインスタンスは、前サイクルで生成された同一ノードのインスタンスおよび前サイクルで生成された 1 つ以上の指定ノードのインスタンスに依存します。

  • CHILD_AND_SELF:現在のサイクルで生成されたノードのインスタンスは、前サイクルで生成された直近のレベルの子孫ノードのインスタンスおよび前サイクルで生成された同一ノードのインスタンスに依存します。

NONE

DependentNodeIdList

string

任意

現在のノードが依存する、前サイクルでインスタンスを生成するノードの ID です。

abc

InputList

string

任意

現在のファイルが依存する親ファイルの出力名です。複数の出力名を指定する場合は、カンマ (,) で区切ります。

このパラメーターは、DataWorks コンソールの「プロパティ」タブの「依存関係」セクションの「親ノード」下にある「出力名」パラメーターに対応しています。

project_root,project.file1,project.001_out

ProjectIdentifier

string

任意

DataWorks ワークスペースの名前です。DataWorks コンソールにログインし、「ワークスペース管理」ページへ移動して、ワークスペース名を確認できます。

この操作を適用する DataWorks ワークスペースを特定するためには、このパラメーターまたは ProjectId パラメーターのいずれかを設定する必要があります。

dw_project

ResourceGroupIdentifier

string

任意

ノードの実行に使用されるリソースグループの識別子です。ListResourceGroups 操作を呼び出して、ワークスペース内で利用可能なリソースグループを照会できます。この操作のレスポンス内の Identifier パラメーターが、利用可能なリソースグループの識別子を示します。

説明

ListResourceGroups 操作のレスポンスに含まれる利用可能なリソースグループが、CreateFile 操作でファイルを作成するワークスペースに関連付けられていることを確認してください。

group_375827434852437

ResourceGroupId

integer

任意

このパラメーターは非推奨です。使用しないでください。

ノードの実行に使用されるリソースグループの ID です。このパラメーターは、DataWorks コンソールの「プロパティ」タブの「リソースグループ」セクションに表示される「リソースグループ」パラメーターに対応しています。ノードの実行に使用されるリソースグループを特定するには、ResourceGroupId または ResourceGroupIdentifier のいずれかのパラメーターを設定する必要があります。

ListResourceGroups 操作を呼び出して、ワークスペース内で利用可能なリソースグループを照会できます。この操作を呼び出す際には、ResourceGroupType パラメーターを 1 に設定してください。レスポンスの Id パラメーターが、利用可能なリソースグループの ID を示します。

375827434852437

ConnectionName

string

任意

ノードが実行されるデータソースの名前です。

UpdateDataSource 操作を呼び出して、ワークスペース内で利用可能なデータソースを照会できます。

odps_source

AutoParsing

boolean

任意

ファイルに対する自動解析機能を有効化するかどうかを指定します。有効な値は以下のとおりです:

  • true

  • false

このパラメーターは、DataWorks コンソールの DataStudio ページの「プロパティ」タブの「依存関係」セクションで「同一サイクル」を選択した後に表示される「コードの解析」パラメーターに対応しています。

true

SchedulerType

string

任意

ノードのスケジュールタイプです。有効な値は以下のとおりです:

  • NORMAL:ノードは自動トリガー型ノードです。

  • MANUAL:ノードは手動トリガー型ノードです。手動トリガー型ノードは自動的にトリガーされません。「手動トリガー型ワークフロー」ペインに表示されるノードに対応します。

  • PAUSE:ノードは一時停止状態です。

  • SKIP:ノードはドライランノードです。ドライランノードはスケジュール通りに起動されますが、実行開始時にステータスが「成功」に設定されます。

NORMAL

AdvancedSettings

string

任意

ノードの詳細設定です。

このパラメーターは、EMR Spark Streaming ノードまたは EMR Streaming SQL ノードでのみ有効です。このパラメーターは、DataWorks コンソールにおけるノードの「詳細設定」タブに対応しています。

このパラメーターの値は JSON 形式である必要があります。

{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}

StartImmediately

boolean

任意

ノードをデプロイした直後に即座に実行するかどうかを指定します。

このパラメーターは、EMR Spark Streaming ノードまたは EMR Streaming SQL ノードでのみ有効です。このパラメーターは、DataWorks コンソールの「構成」タブの「スケジュール」セクションに表示される「開始方法」パラメーターに対応しています。

true

InputParameters

string

任意

ノードの入力パラメーターです。このパラメーターの値は JSON 形式である必要があります。入力パラメーターの詳細については、「GetFile」操作の「レスポンスパラメーター」セクションにある InputContextParameterList パラメーターをご参照ください。

このパラメーターは、DataWorks コンソールの「プロパティ」タブの「入力および出力パラメーター」セクションにある「入力パラメーター」テーブルに対応しています。

[{"ValueSource": "project_001.first_node:bizdate_param","ParameterName": "bizdate_input"}]

OutputParameters

string

任意

ノードの出力パラメーターです。このパラメーターの値は JSON 形式である必要があります。出力パラメーターの詳細については、「GetFile」操作の「レスポンスパラメーター」セクションにある OutputContextParameterList パラメーターをご参照ください。

このパラメーターは、DataWorks コンソールの「プロパティ」タブの「入力および出力パラメーター」セクションにある「出力パラメーター」テーブルに対応しています。

[{"Type": 1,"Value": "${bizdate}","ParameterName": "bizdate_param"}]

IgnoreParentSkipRunningProperty

boolean

任意

前サイクルのドライラン属性を使用するかどうかを指定します。有効な値は以下のとおりです:

  • true:前サイクルのドライラン属性を使用します。

  • false:前サイクルのドライラン属性を使用しません。

false

CreateFolderIfNotExists

boolean

任意

FileFolderPath パラメーターで指定されたディレクトリが存在しない場合に、そのディレクトリを自動的に作成するかどうかを指定します。有効な値は以下のとおりです:

  • true:ディレクトリが存在しない場合、システムが自動的にディレクトリを作成します。

  • false:ディレクトリが存在しない場合、システムはディレクトリを作成しません。この場合、呼び出しは失敗します。

false

ApplyScheduleImmediately

boolean

任意

ノードをデプロイした直後にスケジュール設定を即座に有効化するかどうかを指定します。

true

Timeout

integer

任意

タイムアウト期間です。

1

ImageId

string

任意

カスタムイメージの ID です。

m-bp1h4b5a8ogkbll2f3tr

レスポンスフィールド

フィールド

説明

object

HttpStatusCode

integer

返された HTTP ステータスコードです。

200

Data

integer

作成されたファイルの ID です。

1000001

RequestId

string

リクエスト ID です。トラブルシューティングに使用できます。

0000-ABCD-EFG

ErrorMessage

string

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

The connection does not exist.

Success

boolean

リクエストが成功したかどうかを示します。有効な値は以下のとおりです:

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

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

true

ErrorCode

string

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

Invalid.Tenant.ConnectionNotExists

成功レスポンス

JSONJSON

{
  "HttpStatusCode": 200,
  "Data": 1000001,
  "RequestId": "0000-ABCD-EFG",
  "ErrorMessage": "The connection does not exist.",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists"
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

500 InternalError.System An internal system error occurred. Try again later.
500 InternalError.UserId.Missing An internal system error occurred. Try again later.
403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.
429 Throttling.Api The request for this resource has exceeded your available limit.
429 Throttling.System The DataWorks system is busy. Try again later.
429 Throttling.User Your request is too frequent. Try again later.

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

変更履歴

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