調用ListFolders查詢檔案夾的列表。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| ProjectId |
integer |
否 |
DataWorks 工作空間的 ID。 您可以登入 DataWorks 管控台，進入工作空間配置頁面擷取工作空間 ID。該參數與 ProjectIdentifier 參數，二者必須設定其一，用來確定本次 API 呼叫操作的 DataWorks 工作空間。 |
10000 |
| ProjectIdentifier |
string |
否 |
DataWorks 工作空間名稱。 您可以登入 DataWorks 控制台，進入工作空間配置頁面擷取工作空間名稱。該參數與 ProjectId 參數，二者必須設定其一，用來確定本次 API 呼叫操作的 DataWorks 工作空間。 |
dw_project |
| ParentFolderPath |
string |
是 |
父資料夾的路徑 。 |
Business_process/my_first_business_process/MaxCompute |
| PageNumber |
integer |
是 |
請求的資料頁數，用於翻頁 。 |
1 |
| PageSize |
integer |
是 |
每頁顯示的資料條數，預設為 10 條，最大為 100 條 。 |
10 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回結果 。 |
||
| HttpStatusCode |
integer |
HTTP 狀態代碼 。 |
200 |
| ErrorMessage |
string |
錯誤資訊 。 |
The connection does not exist. |
| RequestId |
string |
請求 ID。用於出現錯誤後排查問題 。 |
0000-ABCD-**** |
| ErrorCode |
string |
錯誤碼 。 |
Invalid.Tenant.ConnectionNotExists |
| Success |
boolean |
調用是否成功。取值如下：
|
true |
| Data |
object |
滿足條件的檔案夾的列表資訊 。 |
|
| PageNumber |
integer |
當前資料頁的頁碼 。 |
1 |
| PageSize |
integer |
當前資料頁的資料條數 。 |
10 |
| TotalCount |
integer |
滿足查詢條件的資料總條數 。 |
13 |
| Folders |
array<object> |
檔案夾的列表 。 |
|
|
object |
檔案夾的資訊 。 |
||
| FolderPath |
string |
檔案夾的路徑 。 |
Business_process/my_first_business_process/MaxCompute/ods_layer |
| FolderId |
string |
檔案夾的 ID 。 |
2735c2**** |
樣本
正常返回樣本
JSON格式
{
"HttpStatusCode": 200,
"ErrorMessage": "The connection does not exist.",
"RequestId": "0000-ABCD-****",
"ErrorCode": "Invalid.Tenant.ConnectionNotExists",
"Success": true,
"Data": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 13,
"Folders": [
{
"FolderPath": "Business_process/my_first_business_process/MaxCompute/ods_layer",
"FolderId": "2735c2****"
}
]
}
}錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 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. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。