すべてのプロダクト
Search

このプロダクト

    DataWorks:CreateFile

    ドキュメントセンター

    DataWorks:CreateFile

    最終更新日:Jul 16, 2026

    DataStudio にファイルを作成します。この操作では Data Integration ノードの作成はサポートされていません。

    今すぐお試しください

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

    テスト

    RAM 認証

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

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    FileFolderPath

    string

    任意

    ファイルのパス。

    Business_process/First_Business_Process/MaxCompute/Folder_1/Folder_2
    ProjectId

    integer

    任意

    DataWorks ワークスペースの ID。DataWorks コンソール にログインし、ワークスペース設定項目ページに移動してワークスペース ID を取得できます。

    この API 呼び出しの対象となる DataWorks ワークスペースを特定するには、このパラメーターまたは ProjectIdentifier のいずれかを指定する必要があります。

    10000
    FileName

    string

    必須

    ファイルの名前。

    File name
    FileDescription

    string

    任意

    ファイルの説明。

    test
    FileType

    integer

    必須

    ファイルのコードタイプ。

    ファイルタイプごとに異なるコードが割り当てられています。詳細については、「DataWorks ノード」を参照してください。

    ListFileType 操作を呼び出して、ファイルのコードタイプをクエリできます。

    10
    Owner

    string

    任意

    ファイル所有者の Alibaba Cloud ユーザー ID。このパラメーターが空の場合、デフォルトで呼び出し元の Alibaba Cloud ユーザー ID が使用されます。

    1000000000001
    Content

    string

    任意

    ファイルのコード内容。コードタイプ (fileType) ごとに異なるコードフォーマットがあります。

    オペレーションセンターで対応するタイプのノードを見つけ、ノードを右クリックして [コードを表示] をクリックすると、具体的なコードフォーマットを確認できます。

    SHOW TABLES;
    AutoRerunTimes

    integer

    任意

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

    3
    AutoRerunIntervalMillis

    integer

    任意

    失敗時の自動再実行の間隔 (ミリ秒単位)。最大値は 1800000 ミリ秒 (30 分) です。

    このパラメーターは、DataWorks コンソール の DataStudio ノードにおける「スケジュール設定 > 時間プロパティ > エラー時の自動再実行」セクションの「再実行間隔」設定に対応します。

    コンソールの「再実行間隔」は分単位です。この操作を呼び出す際は、適宜時間を換算してください。

    120000
    RerunMode

    string

    任意

    再実行プロパティ。有効な値:

    • ALL_ALLOWED: ノードの実行が成功しても失敗しても、再実行できます。

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

    • ALL_DENIED: ノードの実行が成功しても失敗しても、再実行できません。

    このパラメーターは、DataWorks コンソール の DataStudio ノードにおける「スケジュール設定 > 時間プロパティ > 再実行プロパティ」設定に対応します。

    ALL_ALLOWED
    Stop

    boolean

    任意

    スケジューリングを一時停止するかどうかを指定します。有効な値:

    • true: スケジューリングを一時停止します。

    • false: スケジューリングを一時停止しません。

    このパラメーターは、DataWorks コンソール の DataStudio ノードにおいて「スケジュール設定 > 時間プロパティ > スケジューリングタイプ」を「スケジューリングの一時停止」に設定することに対応します。

    false
    ParaValue

    string

    任意

    スケジューリングパラメーター。複数のパラメーターはスペースで区切ります。

    このパラメーターは、DataWorks コンソール の DataStudio ノードにおける「スケジュール設定 > スケジューリングパラメーター」設定に対応します。詳細については、「スケジューリングパラメーター」を参照してください。

    a=x b=y
    StartEffectDate

    integer

    任意

    自動スケジューリングを開始するタイムスタンプ (ミリ秒単位)。

    このパラメーターは、DataWorks コンソール の DataStudio ノードにおける「スケジュール設定 > 時間プロパティ > 有効期間」設定の開始時刻 (ミリ秒単位) に対応します。

    1671608450000
    EndEffectDate

    integer

    任意

    自動スケジューリングを停止するタイムスタンプ (ミリ秒単位)。

    このパラメーターは、DataWorks コンソール の DataStudio ノードにおける「スケジュール設定 > 時間プロパティ > 有効期間」設定の終了時刻 (ミリ秒単位) に対応します。

    1671694850000
    CronExpress

    string

    任意

    エポックベースの時間指定スケジューリング用の cron 式。このパラメーターは、DataWorks コンソール の DataStudio ノードにおける「スケジュール設定 > 時間プロパティ > cron 式」設定に対応します。スケジューリングのエポックと時間指定スケジューリングの時刻をセットすると、DataWorks が対応する cron 式を自動的に生成します。

    例:

    • 毎日 05:30 に時間指定スケジューリング: 00 30 05 * * ?

    • 毎時 15 分に時間指定スケジューリング: 00 15 00-23/1 * * ?

    • 10 分ごとにスケジュール: 00 00/10 * * * ?

    • 毎日 08:00 から 17:00 まで 10 分ごとにスケジュール: 00 00-59/10 8-17 * * * ?

    • 毎月 1 日の 00:20 に時間指定スケジューリング: 00 20 00 1 * ?

    • 1 月 1 日の 00:10 から 3 か月ごとにスケジュール: 00 10 00 1 1-12/3 ?

    • 毎週火曜日と金曜日の 00:05 に時間指定スケジューリング: 00 05 00 * * 2,5

    DataWorks スケジューリングシステムのルールにより、cron 式には以下の使用制限があります。

    • 最小値のスケジューリング間隔は 5 分です。

    • 每日の最も早いスケジューリング時刻は 00:05 です。

    00 05 00 * * ?
    CycleType

    string

    任意

    スケジューリング周期のタイプ。有効な値: NOT_DAY (分または時間)、DAY (日、週、または月)。

    このパラメーターは、DataWorks コンソール の DataStudio ノードにおける「スケジュール設定 > 時間プロパティ > スケジューリング周期」設定に対応します。

    DAY
    DependentType

    string

    任意

    クロスサイクル依存関係のタイプ。有効な値:

    • SELF: 依存関係は現在のノードです。

    • CHILD: 依存関係は第 1 レベルの子ノードです。

    • USER_DEFINE: 依存関係は他の指定されたノードです。

    • NONE: 依存関係が選択されていません。ノードは前のサイクルに依存しません。

    • USER_DEFINE_AND_SELF: 依存関係は、現在のノードと他の指定されたノードのクロスサイクルの組み合わせです。

    • CHILD_AND_SELF: 依存関係は、第 1 レベルの子ノードと現在のノードのクロスサイクルの組み合わせです。

    NONE
    DependentNodeIdList

    string

    任意

    DependentType が USER_DEFINE にセットされている場合、現在のファイルが依存するノードの ID。複数のノード ID はカンマ (,) で区切ります。

    このパラメーターは、DataWorks コンソール の DataStudio ノードにおいて「スケジュール設定 > スケジューリング依存関係」のパラメータ設定が「クロスエポック依存関係 (前のエポック)」にセットされ、依存関係として「他のノード」を選択した際に指定されるノード ID に対応します。

    abc
    InputList

    string

    任意

    現在のファイルが依存する上流ファイルの出力名。複数の出力名はカンマ (,) で区切ります。

    このパラメーターは、DataWorks コンソール の DataStudio ノードにおける「スケジュール設定 > スケジューリング依存関係」セクションで設定される「上流ノード出力名」に対応します。

    project_root,project.file1,project.001_out
    ProjectIdentifier

    string

    任意

    DataWorks ワークスペース名。ワークスペース名を取得するには、DataWorks コンソール にログインし、ワークスペース設定ページに移動します。

    本 API 呼び出しの対象となる DataWorks ワークスペースを特定するためには、本パラメーターまたは ProjectId のいずれかを指定する必要があります。

    dw_project
    ResourceGroupIdentifier

    string

    任意

    DataWorks ワークスペースの名前。DataWorks コンソール にログインし、ワークスペース設定項目ページに移動してワークスペース名を取得できます。

    この API 呼び出しの対象となる DataWorks ワークスペースを特定するには、このパラメーターまたは ProjectId のいずれかを指定する必要があります。

    S_res_group_559_1613715566828
    ResourceGroupId

    integer

    任意

    ファイルがノードとして公開され、そのノードが実行される際に使用されるスケジュールリソース。DataWorks コンソール にログインし、ワークスペース設定項目ページに移動して、左側のナビゲーションウィンドウで リソースグループ をクリックすると、現在のワークスペースにバインドされているリソースグループの ID を取得できます。

    375827434852437
    ConnectionName

    string

    任意

    このフィールドは非推奨です。使用しないでください。

    odps_source
    AutoParsing

    boolean

    任意

    ファイルがノードとして公開され、そのノードが実行される際に接続するデータソース。

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

    true
    SchedulerType

    string

    任意

    ファイルの自動解析を有効にするかどうかを指定します。有効な値:

    • true: ファイルはコードを自動的に解析します。

    • false: ファイルはコードを自動的に解析しません。

    このパラメーターは、DataWorks コンソール の DataStudio ノードにおける「スケジュール設定 > スケジューリング依存関係」セクションのコード解析設定に対応します。

    NORMAL
    AdvancedSettings

    string

    任意

    スケジューリングタイプ。有効な値:

    • NORMAL: 通常のスケジューリングノード。

    • MANUAL: 毎日スケジュールされない手動ノード。これは手動ワークフロー内のノードに対応します。

    • PAUSE: 一時停止されたノード。

    • SKIP: 毎日スケジュールされるが、スケジューリング開始時に直接成功として設定されるドライランノード。

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

    boolean

    任意

    ノードの詳細設定項目。

    このパラメーターは、DataWorks コンソール の EMR Spark Streaming および EMR Streaming SQL DataStudio ノードの編集ページにある、右側のナビゲーションバーの「詳細設定項目」に対応します。

    現在、このパラメーターをサポートしているのは EMR Spark Streaming および EMR Streaming SQL ノードのみです。パラメーター値は JSON フォーマットです。

    true
    InputParameters

    string

    任意

    公開後すぐにノードを開始するかどうかを指定します。

    このパラメーターは、DataWorks コンソール の EMR Spark Streaming および EMR Streaming SQL DataStudio ノードの編集ページにある、右側のナビゲーションバーの「設定 > 時間プロパティ > 起動方法」設定に対応します。

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

    string

    任意

    ノードのコンテキスト入力パラメーター。パラメーター値は JSON フォーマットです。含まれるフィールドについては、 GetFile 操作の応答にある InputContextParameterList パラメーター構造を参照してください。

    このパラメーターは、DataWorks コンソール の DataStudio ノードにおける「スケジュール設定 > ノードコンテキストパラメーター > このノードの入力パラメーター」設定に対応します。

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

    boolean

    任意

    ノードのコンテキスト出力パラメーター。パラメーター値は JSON フォーマットです。含まれるフィールドについては、 GetFile 操作の応答にある OutputContextParameterList パラメーター構造を参照してください。

    このパラメーターは、DataWorks コンソール の DataStudio ノードにおける「スケジュール設定 > ノードコンテキストパラメーター > このノードの出力パラメーター」設定に対応します。

    false
    CreateFolderIfNotExists

    boolean

    任意

    前のサイクルからドライランプロパティを継承するかどうかを指定します。有効な値:

    • true: 前のサイクルからドライランプロパティを継承します。

    • false: 前のサイクルからドライランプロパティを継承しません。

    false
    ApplyScheduleImmediately

    boolean

    任意

    指定されたディレクトリ (FileFolderPath) がシステムに存在しない場合に、ディレクトリを自動的に作成するかどうかを指定します。有効な値:

    • true: ディレクトリが存在しない場合は自動的に作成します。

    • false: ディレクトリが存在しない場合、呼び出しは失敗します。

    true
    Timeout

    integer

    任意

    公開後にスケジューリング構成がすぐに効果があるかどうかを指定します。

    1
    ImageId

    string

    任意

    スケジューリング構成で定義されたタイムアウト値。

    m-bp1h4b5a8ogkbll2f3tr

    任意

    カスタムイメージの ID。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答パラメーター。

    HttpStatusCode

    integer

    HTTP 状態コード。

    200
    Data

    integer

    作成後のファイルの ID。

    1000001
    RequestId

    string

    リクエストの一意の ID。この 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.

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

    変更履歴

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