調用ListFiles查詢文件列表。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| dataworks:* | get | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| FileFolderPath | string | 否 | 文件所在的文件夾路徑。 | 業務流程/我的第一個業務流程/MaxCompute/ods層 |
| ProjectId | long | 否 | DataWorks 工作空間的 ID。您可以登錄 DataWorks 控制臺，進入工作空間配置頁面獲取工作空間 ID。 該參數與 ProjectIdentifier 參數，二者必須設置其一，用來確定本次 API 調用操作的 DataWorks 工作空間。 | 10000 |
| Keyword | string | 否 | 文件名稱的關鍵字。支持模糊匹配，即輸入關鍵字即可查詢包含該關鍵字的所有文件。 | ods |
| ProjectIdentifier | string | 否 | DataWorks 工作空間的名稱。您可以登錄 DataWorks 控制臺，進入工作空間配置頁面獲取工作空間名稱。 該參數與 ProjectId 參數，二者必須設置其一，用來確定本次 API 調用操作的 DataWorks 工作空間。 | dw_project |
| PageNumber | integer | 否 | 請求的數據頁數，用于翻頁。 | 1 |
| PageSize | integer | 否 | 每頁顯示的條數，默認為 10 條，最大為 100 條。 | 10 |
| UseType | string | 否 | 文件所屬的功能模塊。取值如下：
| NORMAL |
| FileTypes | string | 否 | 文件類型。不同文件類型其代碼不同，詳情請參見 DataWorks 節點合集。，查詢文件的代碼類型。 | 10,23 |
| Owner | string | 否 | 文件責任人。 | 3726346**** |
| NodeId | long | 否 | 調度節點的 ID。您可以調用 ListNodes 接口獲取節點 ID。 | 123541234 |
| NeedContent | boolean | 否 | 查詢結果是否包含文件內容（對于內容較多的文件，可能存在較長的網絡傳輸延時）。 | false |
| NeedAbsoluteFolderPath | boolean | 否 | 查詢結果是否包含文件所在的文件夾的路徑。 | false |
| ExactFileName | string | 否 | 精確匹配的文件名稱，查詢結果的文件名稱與該參數完全一致。 | ods_create.sql |
| FileIdIn | string | 否 | Fileld 列表，查詢結果的文件 ID 集合只能是該列表的子集。最多支持一次指定 50 個 FileId。 | 78237,816123 |
返回參數
示例
正常返回示例
JSON格式
{
"HttpStatusCode": 200,
"ErrorMessage": "The connection does not exist.",
"RequestId": "0000-ABCD-EFG",
"ErrorCode": "Invalid.Tenant.ConnectionNotExists",
"Success": true,
"Data": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 13,
"Files": [
{
"CommitStatus": 1,
"AutoParsing": true,
"Owner": "3872572****",
"CreateTime": 1593950832000,
"FileType": 10,
"CurrentVersion": 2,
"BizId": 300000,
"LastEditUser": "38748246285727",
"FileName": "ods_user_info_d",
"ConnectionName": "odps_source",
"UseType": "NORMAL",
"FileFolderId": "2735c2****",
"FileId": 10000001,
"ParentId": -1,
"CreateUser": "382762****",
"IsMaxCompute": false,
"BusinessId": 300000,
"FileDescription": "my test datastudio file",
"LastEditTime": 1593950832000,
"Content": "SHOW TABLES;",
"NodeId": 300001,
"AbsoluteFolderPath": "業務流程/我的第一個業務流程/MaxCompute/ods層"
}
]
}
}錯誤碼
| 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 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |