すべてのプロダクト
Search

このプロダクト

    DataWorks:CreateFile

    ドキュメントセンター

    DataWorks:CreateFile

    最終更新日:Jul 31, 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 を取得できます。

    10000
    FileName

    string

    必須

    ファイルの名前。

    ファイル名
    FileDescription

    string

    任意

    ファイルの説明。

    これはファイルの説明です
    FileType

    integer

    必須

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

    10
    Owner

    string

    任意

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

    1000000000001
    Content

    string

    任意

    ファイルのコード内容。コードタイプ (fileType) ごとに異なるコードフォーマットがあります。オペレーションセンターで対応するタイプのノードを見つけ、ノードを右クリックし、「コードをビュー」をクリックすると、具体的なコードフォーマットを確認できます。

    SHOW TABLES;
    AutoRerunTimes

    integer

    任意

    エラー発生時に許可される自動再実行の回数。最大値は 10 です。

    3
    AutoRerunIntervalMillis

    integer

    任意

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

    120000
    RerunMode

    string

    任意

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

    列挙値:

    • ALL_ALLOWED :

      ノードは、実行の成否にかかわらず再実行できます。

    • ALL_DENIED :

      ノードは、実行の成否にかかわらず再実行できません。

    • FAILURE_ALLOWED :

      ノードは、失敗した場合にのみ再実行できます。

    ALL_ALLOWED
    Stop

    boolean

    任意

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

    false
    ParaValue

    string

    任意

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

    a=x b=y
    StartEffectDate

    integer

    任意

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

    1671608450000
    EndEffectDate

    integer

    任意

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

    1671694850000
    CronExpress

    string

    任意

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

    00 05 00 * * ?
    CycleType

    string

    任意

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

    列挙値:

    • NOT_DAY :

      分または時間のスケジューリング。

    • DAY :

      日、週、または月のスケジューリング。

    DAY
    DependentType

    string

    任意

    クロスサイクル依存関係のモード。有効な値:

    列挙値:

    • CHILD_AND_SELF :

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

    • USER_DEFINE :

      依存関係は他のノードです。

    • SELF :

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

    • USER_DEFINE_AND_SELF :

      依存関係は、現在のノードと他のノードのクロスサイクルの組み合わせです。

    • NONE :

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

    • CHILD :

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

    NONE
    DependentNodeIdList

    string

    任意

    現在のノードが前のサイクルから依存するノードのリスト。

    abc
    InputList

    string

    任意

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

    project_root,project.file1,project.001_out
    OutputList

    string

    任意

    ProjectIdentifier

    string

    任意

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

    dw_project
    ResourceGroupIdentifier

    string

    任意

    ファイルの公開後にタスクを実行中に使用されるリソースグループ。 ListResourceGroups 操作を呼び出し、identifier フィールドを使用して、ワークスペースで利用可能なリソースグループのリストを取得できます。

    グループ_375827434852437
    ResourceGroupId

    integer

    任意

    [非推奨] このパラメーターは非推奨です。使用しないでください。 ListResourceGroups 操作を呼び出して、ワークスペースのアクティブなリソースグループのリストを取得できます。ResourceGroupType を 1 に設定し、結果の ID フィールドを使用します。

    375827434852437
    ConnectionName

    string

    任意

    ファイルの公開後にタスクの実行中に接続するデータソース。 UpdateDataSource 操作を呼び出して、ワークスペースで利用可能なデータソースのリストを取得できます。

    odps_ソース
    AutoParsing

    boolean

    任意

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

    true
    SchedulerType

    string

    任意

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

    列挙値:

    • PAUSE :

      一時停止されたタスク。

    • SKIP :

      毎日スケジュールされるドライランタスクですが、スケジューリング開始時に直接成功として設定されます。

    • MANUAL :

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

    • NORMAL :

      通常のスケジューリングタスク。

    NORMAL
    AdvancedSettings

    string

    任意

    タスクの詳細設定項目。

    {"queue":"デフォルト","SPARK_CONF":"--conf spark.driver.memory=2g"}
    StartImmediately

    boolean

    任意

    公開直後にタスクを開始するかどうかを指定します。

    true
    InputParameters

    string

    任意

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

    [{"ValueSource": "project_001.first_ノード:bizdate_param","ParameterName": "bizdate_input"}]
    OutputParameters

    string

    任意

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

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

    boolean

    任意

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

    false
    CreateFolderIfNotExists

    boolean

    任意

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

    false
    ApplyScheduleImmediately

    boolean

    任意

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

    true
    Timeout

    integer

    任意

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

    1
    ImageId

    string

    任意

    カスタムイメージの ID。

    m-bp1h4b5a8ogkbll2f3tr

    レスポンスフィールド

    フィールド

    型

    説明

    例

    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
    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.

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

    変更履歴

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