调用ListFolders查询文件夹的列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListFolders

要执行的操作。

PageNumber Integer 1

请求的数据页数,用于翻页。

PageSize Integer 50

请求的数据页大小。

ParentFolderPath String 业务流程/我的第一个业务流程/MaxCompute

父文件夹的路径。

ProjectId Long 10000

Dataworks工作空间的ID,您可以单击页面右上角的小扳手图标,进入工作空间管理页面查看。

RegionId String cn-zhangjiakou

服务所在地域的列表。

ProjectIdentifier String dw_project

Dataworks工作空间的唯一标识符,即数据开发页面顶部切换工作空间处的英文标识。

该参数与ProjectId参数二者必须设置其一,以确定本次API调用操作的Dataworks工作空间。

返回数据

名称 类型 示例值 描述
Data Struct

满足条件的文件夹的列表信息。

Folders Array

文件夹的列表。

FolderId String 2735c2****

文件夹的ID。

FolderPath String 业务流程/我的第一个业务流程/MaxCompute/ods层

文件夹的路径。

PageNumber Integer 1

当前数据页的页码。

PageSize Integer 10

当前数据页的大小。

TotalCount Integer 13

满足查询条件的数据总条数。

ErrorCode String 0

错误码。

ErrorMessage String Success

错误信息。

HttpStatusCode Integer 200

HTTP状态码。

RequestId String 0000-ABCD-EFG****

本次调用的唯一ID。出现错误后,您可以根据该ID排查问题。

Success Boolean true

调用是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=ListFolders
&PageNumber=1
&PageSize=50
&ParentFolderPath=业务流程/我的第一个业务流程/MaxCompute
&ProjectId=10000
&RegionId=cn-zhangjiakou
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>0000-ABCD-EFG****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <TotalCount>13</TotalCount>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <Folders>
        <FolderPath>业务流程/我的第一个业务流程/MaxCompute/ods层</FolderPath>
        <FolderId>2735c2****</FolderId>
    </Folders>
</Data>
<ErrorCode>0</ErrorCode>
<ErrorMessage>Success</ErrorMessage>
<Success>true</Success>

JSON 格式

{
    "RequestId": "0000-ABCD-EFG****",
    "HttpStatusCode": 200,
    "Data": {
        "TotalCount": 13,
        "PageSize": 10,
        "PageNumber": 1,
        "Folders": {
            "FolderPath": "业务流程/我的第一个业务流程/MaxCompute/ods层",
            "FolderId": "2735c2****"
        }
    },
    "ErrorCode": 0,
    "ErrorMessage": "Success",
    "Success": true
}

错误码

HttpCode 错误码 错误信息 描述
403 Forbidden.Access Access is forbidden. Activate DataWorks first. 您被限制访问,可能是由于您还未激活DataWorks。
500 InternalError.System An internal system error occurred. Try again later. 系统内部错误,请稍后再试。
500 InternalError.UserId.Missing An internal system error occurred. Try again later. 系统内部错误,请稍后再试。
403 ResourceNotAuthorized.Api You are not authorized to access the resources. 您无法访问未取得授权的资源。
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. 您的请求过于频繁,请尝试放缓请求速度。

访问错误中心查看更多错误码。