呼叫ListDataServiceFolders查詢資料服務資料夾列表。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| PageNumber |
integer |
否 |
頁碼，從 1 開始。預設值為 1。 |
1 |
| PageSize |
integer |
否 |
每頁顯示的筆數，預設為 10 筆，最大 50 筆。 |
10 |
| ProjectId |
integer |
是 |
工作空間的 ID。 可透過 ListProjects 取得有效工作空間 ID，也可在 DataWorks 主控台的工作空間設定中檢視；文件範例值僅用於展示格式。 |
10001 |
| TenantId |
integer |
否 |
租戶 ID。您可登入 DataWorks 主控台，進入資料開發（DataStudio）頁面，點擊右上方目前登入使用者名稱，選擇選單 > 使用者資訊，取得租戶 ID。 |
10002 |
| GroupId |
string |
否 |
指定資料夾所屬業務流程的 ID。 |
ds_123abc |
| FolderNameKeyword |
string |
否 |
資料夾名稱關鍵字，可以進行子字串匹配。 |
資料夾名稱關鍵字 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求 ID，一次請求的唯一標識。 |
0000-ABCD-EF**** |
| FolderPagingResult |
object |
資料夾列表的分頁結果。 |
|
| PageNumber |
integer |
頁碼，和請求中的 PageNumber 一致。 |
1 |
| PageSize |
integer |
每頁顯示的筆數，預設為 10 筆，最大 100 筆。 |
10 |
| TotalCount |
integer |
總記錄數。 |
100 |
| Folders |
array<object> |
資料夾列表。 |
|
|
object |
|||
| ParentId |
integer |
父資料夾的 ID。業務流程下根資料夾 ID 等於 0，使用者建立資料夾 ID 大於 0。 |
0 |
| ModifiedTime |
string |
資料夾的編輯時間。 格式範例為 |
2020-09-24T18:37:51+0800 |
| GroupId |
string |
資料夾所屬業務流程的 ID。 |
ds_1234 |
| FolderId |
integer |
資料夾的 ID。 |
11 |
| FolderName |
string |
資料夾的名稱。 |
test1 |
| ProjectId |
integer |
工作空間 ID。 |
10001 |
| CreatedTime |
string |
資料夾的建立時間。 格式範例為 |
2020-09-24T18:37:51+0800 |
| TenantId |
integer |
租戶 ID。 |
10002 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "0000-ABCD-EF****",
"FolderPagingResult": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 100,
"Folders": [
{
"ParentId": 0,
"ModifiedTime": "2020-09-24T18:37:51+0800",
"GroupId": "ds_1234",
"FolderId": 11,
"FolderName": "test1",
"ProjectId": 10001,
"CreatedTime": "2020-09-24T18:37:51+0800",
"TenantId": 10002
}
]
}
}錯誤碼
|
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. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。