調用CreateUdfFile，在數據開發中創建函數類型文件。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| FileFolderPath | string | 是 | 函數文件所在的文件夾路徑。 | 業務流程/第一個業務流程/函數/字符串處理 |
| ProjectId | long | 否 | DataWorks 工作空間的 ID，您可以單擊頁面右上角的小扳手圖標，進入工作空間管理頁面查看。 | 10000 |
| FileName | string | 是 | 函數的名稱。 | StringConcat |
| FunctionType | string | 是 | 函數的分類，對應創建函數表單中的函數類型一項，包括 MATH（數學運算函數）、AGGREGATE（聚合函數）、STRING（字符串處理函數）、DATE（日期處理函數）、ANALYTIC（窗口函數）和 OTHER（其他函數）。 | STRING |
| ClassName | string | 是 | 函數定義所在的類名，對應創建函數表單的類名一項。 | com.alibaba.DataWorks.api.udf.StringConcat |
| Resources | string | 是 | 函數引用的資源名列表，對應創建表中的資源列表。多個資源名稱之間使用英文逗號（,）分隔。 | string-concat-1.0.0.jar,commons-lang-2.6.jar |
| UdfDescription | string | 是 | 函數用途的說明，對應創建函數表單中的描述。 | 把幾個字符串連接起來生成一個新的字符串 |
| CmdDescription | string | 否 | 函數調用的命令格式，對應創建函數表單中的命令格式。 | StringConcat(String... substrs) |
| ParameterDescription | string | 否 | 函數入參的說明，對應創建函數表單中的參數說明。 | 需要連接的字符串列表 |
| ReturnValue | string | 否 | 函數的返回值說明，對應創建函數表單中的返回值。 | 所有字符串按照輸入順序前后連接生成的新字符串 |
| Example | string | 否 | 函數調用示例，對應創建函數表單中的示例。 | StringConcat('a', 'b', 'c') |
| ProjectIdentifier | string | 否 | DataWorks 工作空間的唯一標識符，即數據開發頁面頂部切換工作空間處的英文標識。 | dw_project |
| CreateFolderIfNotExists | boolean | 否 | 當參數中指定的目錄（FileFolderPath）在系統中不存在時，是否自動創建此目錄。取值如下： true：若此目錄不存在，自動創建此目錄 false：若此目錄不存在，調用失敗 | false |
返回參數
示例
正常返回示例
JSON格式
{
"HttpStatusCode": 200,
"Data": 100000002,
"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. | 沒有權限，請授權 |
| 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系統繁忙，請稍后再試。 |
| 429 | Throttling.User | Your request is too frequent. Try again later. | 您的請求過于頻繁，請嘗試放緩請求速度。 |
| 500 | InternalError.System | An internal system error occurred. Try again later. | 系統內部錯誤，請稍后再試。 |
| 500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | 系統內部錯誤，請稍后再試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-07-14 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |