DataStudio でファイルを作成します。この操作では、Data Integration ノードの作成はできません。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| FileFolderPath |
string |
任意 |
ファイルパス。 |
Business_process/First_Business_Process/MaxCompute/Folder_1/Folder_2 |
| ProjectId |
integer |
任意 |
DataWorks ワークスペース ID。ワークスペース ID を取得するには、DataWorks コンソール にログインし、ワークスペース設定ページに移動します。本操作を適用する 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 コンソール のデータ開発ノードの「プロパティ > スケジュール > 障害時の自動再実行」における「再実行間隔」設定に対応します。コンソール上では再実行間隔の単位は分です。本操作を呼び出す際には、単位を変換してください。 |
120000 |
| RerunMode |
string |
任意 |
再実行ポリシー。有効な値:
本パラメーターは、DataWorks コンソール の DataStudio タスクの「スケジューリング > スケジューリングポリシー」における「再実行のサポート」設定に対応します。 |
ALL_ALLOWED |
| Stop |
boolean |
任意 |
実行スキップの有無を指定します。有効な値:
本パラメーターは、DataWorks コンソール のデータ開発ノードの「プロパティ > スケジュール > 繰り返し」における「実行スキップ」オプションに対応します。 |
false |
| ParaValue |
string |
任意 |
ノードのスケジューリングパラメーター。複数のパラメーターを半角スペースで区切ります。 本パラメーターは、DataWorks コンソール のデータ開発ノードの「プロパティ」における「スケジューリングパラメーター」設定に対応します。「スケジューリングパラメーター」をご参照ください。 |
a=x b=y |
| StartEffectDate |
integer |
任意 |
自動スケジューリング開始時刻(ミリ秒単位のタイムスタンプ)。 本パラメーターは、DataWorks コンソール の DataStudio タスクの「スケジューリング > スケジューリング時間」における「有効期間」の開始時刻に対応します。 |
1671608450000 |
| EndEffectDate |
integer |
任意 |
自動スケジューリング終了時刻(ミリ秒単位のタイムスタンプ)。 本パラメーターは、DataWorks コンソール の DataStudio タスクの「スケジューリング > スケジューリング時間」における「有効期間」の終了時刻に対応します。 |
1671694850000 |
| CronExpress |
string |
任意 |
定期実行用の cron 式。本パラメーターは、DataWorks コンソール の DataStudio タスクの「スケジューリング > スケジューリング時間」における「cron 式」設定に対応します。スケジューリング周期とスケジュール時刻を設定すると、DataWorks が自動的に cron 式を生成します。 例:
DataWorks のスケジューリングシステムの仕様により、cron 式には以下の制限があります:
|
00 05 00 * * ? |
| CycleType |
string |
任意 |
スケジューリング周期のタイプ。有効な値:NOT_DAY(分・時)および DAY(日・週・月)。 本パラメーターは、DataWorks コンソール の DataStudio タスクの「スケジューリング > スケジューリング時間」における「スケジューリング周期」設定に対応します。 |
DAY |
| DependentType |
string |
任意 |
前周期に対する依存モード。有効な値:
|
NONE |
| DependentNodeIdList |
string |
任意 |
現在のノードが依存するノードの ID。本パラメーターは、DependentType パラメーターが USER_DEFINE に設定されている場合にのみ有効です。複数のノード ID をカンマ(,)で区切ります。 本パラメーターは、DataWorks コンソール のデータ開発ノードの「プロパティ > 依存関係 > クロスサイクル依存関係(従来の前周期依存関係)」における「他のノード」オプションに対応します。 |
abc |
| InputList |
string |
任意 |
現在のノードが依存する先祖ノードの出力名。複数の出力名をカンマ(,)で区切ります。 本パラメーターは、DataWorks コンソール のデータ開発ノードの「プロパティ > 依存関係」における「先祖ノードの出力名」設定に対応します。 |
project_root,project.file1,project.001_out |
| ProjectIdentifier |
string |
任意 |
DataWorks ワークスペース名。ワークスペース名を取得するには、DataWorks コンソール にログインし、ワークスペース設定ページに移動します。 本 API 呼び出しの対象となる DataWorks ワークスペースを特定するためには、本パラメーターまたは ProjectId のいずれかを指定する必要があります。 |
dw_project |
| ResourceGroupIdentifier |
string |
任意 |
ファイルから公開されるタスクのリソースグループ。ID を取得するには、DataWorks コンソール にログインし、ワークスペース設定ページに移動して、左側ナビゲーションウィンドウの「リソースグループ」をクリックし、現在のワークスペースにバインドされたリソースグループの ID を確認します。 |
S_res_group_559_1613715566828 |
| ResourceGroupId |
integer |
任意 |
本パラメーターは非推奨です。 |
375827434852437 |
| ConnectionName |
string |
任意 |
ファイルから公開されるタスクの実行時に使用されるデータソース。 ワークスペース内の利用可能なデータソースを照会するには、UpdateDataSource 操作を呼び出します。 |
odps_source |
| AutoParsing |
boolean |
任意 |
ファイルの自動解析を有効にするかどうかを指定します。有効な値:
本パラメーターは、DataWorks コンソール のデータ開発ノードの「プロパティ > 依存関係」における「コードの解析」設定に対応します。 |
true |
| SchedulerType |
string |
任意 |
スケジューリングタイプ。有効な値:
|
NORMAL |
| AdvancedSettings |
string |
任意 |
ノードの高度な設定。 本パラメーターは、DataWorks コンソール の EMR Spark Streaming ノードおよび EMR Streaming SQL ノードの構成タブ右側ナビゲーションウィンドウにある「高度な設定」セクションに対応します。 本パラメーターは、EMR Spark Streaming ノードおよび EMR Streaming SQL ノードのみでサポートされます。値は JSON 形式である必要があります。 |
{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"} |
| StartImmediately |
boolean |
任意 |
ノードをデプロイ後に即座に実行するかどうかを指定します。 本パラメーターは、DataWorks コンソール の EMR Spark Streaming ノードおよび EMR Streaming SQL ノードの構成タブ右側ナビゲーションウィンドウの「設定 > スケジュール」における「開始方法」設定に対応します。 |
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 |
任意 |
前周期からのドライラン状態を継承するかどうかを指定します。有効な値:
|
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。トラブルシューティングに使用します。 |
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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。