DataStudio でファイルを作成します。この操作は、Data Integration ノード向けのファイル作成には使用できません。
今すぐお試しください
テスト
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 |
任意 |
ファイルに対応するノードの再実行可否を指定します。有効な値は以下のとおりです:
このパラメーターは、DataWorks コンソールの DataStudio ページの「プロパティ」タブの「スケジュール」セクションに表示される「再実行」パラメーターに対応しています。 |
ALL_ALLOWED |
| Stop |
boolean |
任意 |
ノードのスケジュール実行を一時停止するかどうかを指定します。有効な値は以下のとおりです:
このパラメーターは、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 式の値を自動生成します。 例:
DataWorks のスケジューリングシステムでは、CRON 式に以下の制限があります:
|
00 05 00 * * ? |
| CycleType |
string |
任意 |
ファイルに対応するノードのスケジュール周期の種類です。有効な値は NOT_DAY および DAY です。NOT_DAY は分または時間単位でのスケジュール実行を意味し、DAY は日・週・月単位でのスケジュール実行を意味します。 このパラメーターは、DataWorks コンソールの DataStudio ページの「プロパティ」タブの「スケジュール」セクションに表示される「スケジュール周期」パラメーターに対応しています。 |
DAY |
| DependentType |
string |
任意 |
ノードのクロスサイクルスケジュール依存関係の種類です。有効な値は以下のとおりです:
|
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 |
任意 |
ファイルに対する自動解析機能を有効化するかどうかを指定します。有効な値は以下のとおりです:
このパラメーターは、DataWorks コンソールの DataStudio ページの「プロパティ」タブの「依存関係」セクションで「同一サイクル」を選択した後に表示される「コードの解析」パラメーターに対応しています。 |
true |
| SchedulerType |
string |
任意 |
ノードのスケジュールタイプです。有効な値は以下のとおりです:
|
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 |
任意 |
前サイクルのドライラン属性を使用するかどうかを指定します。有効な値は以下のとおりです:
|
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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。