調(diào)用CreateFile,在數(shù)據(jù)開發(fā)中創(chuàng)建一個文件。目前不支持調(diào)用該接口創(chuàng)建數(shù)據(jù)集成節(jié)點任務。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作,用
全部資源
表示。
- 條件關鍵字:是指云產(chǎn)品自身定義的條件關鍵字。
- 關聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯(lián)操作 |
---|---|---|---|---|
dataworks:* | create | *全部資源 * |
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
FileFolderPath | string | 是 | 文件的路徑。 | 業(yè)務流程/第一個業(yè)務流程/MaxCompute/文件夾1/文件夾2 |
ProjectId | long | 是 | DataWorks 工作空間的 ID。您可以登錄 DataWorks 控制臺,進入工作空間配置頁面獲取工作空間 ID。 該參數(shù)與 ProjectIdentifier 參數(shù),二者必須設置其一,用來確定本次 API 調(diào)用操作的 DataWorks 工作空間。 | 10000 |
FileName | string | 是 | 文件的名稱。 | 文件名 |
FileDescription | string | 否 | 文件的描述信息。 | 這里是文件描述 |
FileType | integer | 是 | 文件的代碼類型。 不同文件類型其代碼不同,詳情請參見 DataWorks 節(jié)點合集。 您可以調(diào)用 ListFileType 接口,查詢文件的代碼類型。 | 10 |
Owner | string | 否 | 文件責任人的阿里云用戶 ID。如果該參數(shù)為空,則默認使用調(diào)用者的阿里云用戶 ID。 | 1000000000001 |
Content | string | 否 | 文件代碼內(nèi)容,不同代碼類型(fileType)的文件,代碼格式不同。您可以在運維中心找到對應類型的任務,右鍵單擊查看代碼,查看具體的代碼格式。 | SHOW TABLES; |
AutoRerunTimes | integer | 否 | 出錯自動重跑的次數(shù),取值最大為 10。 | 3 |
AutoRerunIntervalMillis | integer | 否 | 出錯自動重跑時間間隔,單位為毫秒。最大為 1800000 毫秒(30 分鐘)。 該參數(shù)與 DataWorks 控制臺中,數(shù)據(jù)開發(fā)任務的“調(diào)度配置>時間屬性>出錯自動重跑”的”重跑間隔“配置對應。 控制臺中“重跑間隔”的時間單位為分鐘,請在調(diào)用時注意轉(zhuǎn)換時間。 | 120000 |
RerunMode | string | 否 | 重跑屬性。取值如下:
該參數(shù)與 DataWorks 控制臺中,數(shù)據(jù)開發(fā)任務的“調(diào)度配置>時間屬性>重跑屬性”配置內(nèi)容對應。 | ALL_ALLOWED |
Stop | boolean | 否 | 是否暫停調(diào)度,取值如下:
該參數(shù)與 DataWorks 控制臺中,數(shù)據(jù)開發(fā)任務的“調(diào)度配置>時間屬性>調(diào)度類型”配置為”暫停調(diào)度“時對應。 | false |
ParaValue | string | 否 | 調(diào)度參數(shù)。多個參數(shù)之間用空格進行分割。 該參數(shù)與 DataWorks 控制臺中,數(shù)據(jù)開發(fā)任務的“調(diào)度配置>參數(shù)”對應。您可以參考調(diào)度參數(shù)配置。 | a=x b=y |
StartEffectDate | long | 否 | 開始自動調(diào)度的毫秒時間戳。 該參數(shù)與 DataWorks 控制臺中,數(shù)據(jù)開發(fā)任務的“調(diào)度配置>時間屬性>生效日期”配置的開始時間的毫秒時間戳對應。 | 1671608450000 |
EndEffectDate | long | 否 | 停止自動調(diào)度的時間戳,單位為毫秒。 該參數(shù)與 DataWorks 控制臺中,數(shù)據(jù)開發(fā)任務的“調(diào)度配置>時間屬性>生效日期”配置的結(jié)束時間的毫秒時間戳對應。 | 1671694850000 |
CronExpress | string | 否 | 周期調(diào)度的 cron 表達式,該參數(shù)與 DataWorks 控制臺中,數(shù)據(jù)開發(fā)任務的“調(diào)度配置>時間屬性>cron 表達式”對應。配置完“調(diào)度周期”及“定時調(diào)度時間”后,DataWorks 會自動生成相應 cron 表達式。 示例如下:
由于 DataWorks 調(diào)度系統(tǒng)的規(guī)則,cron 表達式有以下限制:
| 00 05 00 * * ? |
CycleType | string | 否 | 調(diào)度周期的類型,包括 NOT_DAY(分鐘、小時)和 DAY(日、周、月)。 該參數(shù)與 DataWorks 控制臺中,數(shù)據(jù)開發(fā)任務的“調(diào)度配置>時間屬性>調(diào)度周期”對應。 | DAY |
DependentType | string | 否 | 依賴上一周期的方式。取值如下:
| NONE |
DependentNodeIdList | string | 否 | 依賴上一周期的節(jié)點列表。 | abc |
InputList | string | 是 | 文件依賴的上游文件的輸出名稱,多個輸出使用英文逗號(,)分隔。 該參數(shù)與 DataWorks 控制臺中,數(shù)據(jù)開發(fā)任務的“調(diào)度配置>調(diào)度依賴“選擇”同周期“時的”父節(jié)點輸出名稱”對應。 | project_root,project.file1,project.001_out |
ProjectIdentifier | string | 否 | DataWorks 工作空間的名稱。您可以登錄 DataWorks 控制臺,進入工作空間配置頁面獲取工作空間名稱。 該參數(shù)與 ProjectId 參數(shù),二者必須設置其一,用來確定本次 API 調(diào)用操作的 DataWorks 工作空間。 | dw_project |
ResourceGroupIdentifier | string | 否 | 文件發(fā)布成任務后,任務執(zhí)行時對應的資源組。您可以調(diào)用 ListResourceGroups 通過 identifier 字段獲取工作空間可用的資源組列表。 說明
您需確認 ListResourceGroups 接口返回的資源組已綁定至創(chuàng)建文件所使用的工作空間,綁定后才能在 CreateFile 中使用。
| group_375827434852437 |
ResourceGroupId | long | 否 | 該字段已廢棄,請勿使用。 文件發(fā)布成任務后,任務執(zhí)行時對應的資源組。對應頁面上調(diào)度配置>資源屬性>調(diào)度資源組的配置。與 ResourceGroupIdentifier 二者設置其一即可。 您可以通過 ListResourceGroups 接口獲取工作空間可用的資源組列表。ResourceGroupType 傳 1,拿到結(jié)果后取出 ID 字段。 | 375827434852437 |
ConnectionName | string | 否 | 文件發(fā)布成任務后,任務執(zhí)行時連接的數(shù)據(jù)源。 您可以調(diào)用 UpdateDataSource 接口獲取工作空間可用的數(shù)據(jù)源列表。 | odps_source |
AutoParsing | boolean | 否 | 文件是否開啟自動解析功能。取值如下:
該參數(shù)與 DataWorks 控制臺中,數(shù)據(jù)開發(fā)任務的“調(diào)度配置>調(diào)度依賴”選擇“同周期”時的“代碼解析”對應。 | true |
SchedulerType | string | 否 | 調(diào)度的類型,取值如下:
| NORMAL |
AdvancedSettings | string | 否 | 任務的高級配置。 該參數(shù)與 DataWorks 控制臺中,EMR Spark Streaming 和 EMR Streaming SQL 數(shù)據(jù)開發(fā)任務,編輯頁面右側(cè)導航欄的“高級設置“對應。 當前僅 EMR Spark Streaming 和 EMR Streaming SQL 任務支持配置該參數(shù),并且參數(shù)為 JSON 格式。 | {"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"} |
StartImmediately | boolean | 否 | 發(fā)布后是否立即啟動。 該參數(shù)與 DataWorks 控制臺中,EMR Spark Streaming 和 EMR Streaming SQL 數(shù)據(jù)開發(fā)任務,編輯頁面右側(cè)導航欄的“配置>時間屬性>啟動方式“對應。 | true |
InputParameters | string | 否 | 節(jié)點的上下文輸入?yún)?shù)。參數(shù)為 JSON 格式,包含的字段可參考 GetFile 接口返回值中的 InputContextParameterList 參數(shù)結(jié)構(gòu)。 該參數(shù)與 DataWorks 控制臺中,數(shù)據(jù)開發(fā)任務的“調(diào)度配置>節(jié)點上下文>本節(jié)點輸入?yún)?shù)“對應。 | [{"ValueSource": "project_001.first_node:bizdate_param","ParameterName": "bizdate_input"}] |
OutputParameters | string | 否 | 節(jié)點的上下文輸出參數(shù)。參數(shù)為 JSON 格式,包含的字段可參考 GetFile 接口返回值中的 OutputContextParameterList 參數(shù)結(jié)構(gòu)。 該參數(shù)與 DataWorks 控制臺中,數(shù)據(jù)開發(fā)任務的“調(diào)度配置>節(jié)點上下文>本節(jié)點輸出參數(shù)“對應。 | [{"Type": 1,"Value": "${bizdate}","ParameterName": "bizdate_param"}] |
IgnoreParentSkipRunningProperty | boolean | 否 | 是否沿用上一周期空跑屬性。取值如下:
| false |
CreateFolderIfNotExists | boolean | 否 | 當參數(shù)中指定的目錄(FileFolderPath)在系統(tǒng)中不存在時,是否自動創(chuàng)建此目錄。取值如下: true:若此目錄不存在,自動創(chuàng)建此目錄 false:若此目錄不存在,調(diào)用失敗 | false |
ApplyScheduleImmediately | boolean | 否 | 是否發(fā)布后立即生效調(diào)度配置 | true |
Timeout | integer | 否 | 調(diào)度配置超時定義 | 1 |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"HttpStatusCode": 200,
"Data": 1000001,
"RequestId": "0000-ABCD-EFG",
"ErrorMessage": "The connection does not exist.",
"Success": true,
"ErrorCode": "Invalid.Tenant.ConnectionNotExists"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | 沒有權(quán)限,請授權(quán) |
429 | Throttling.Api | The request for this resource has exceeded your available limit. | 對該資源的請求已超過您的可用上限。 |
429 | Throttling.System | The DataWorks system is busy. Try again later. | DataWorks系統(tǒng)繁忙,請稍后再試。 |
429 | Throttling.User | Your request is too frequent. Try again later. | 您的請求過于頻繁,請嘗試放緩請求速度。 |
500 | InternalError.System | An internal system error occurred. Try again later. | 系統(tǒng)內(nèi)部錯誤,請稍后再試。 |
500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | 系統(tǒng)內(nèi)部錯誤,請稍后再試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-12-13 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2024-09-02 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2024-04-03 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2023-07-14 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2023-04-25 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |