调用ListFolders查询文件夹的列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dataworks:* |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| 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. |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。