调用ListDataServiceFolders查询数据服务文件夹列表。

调试

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

请求参数

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

要执行的操作。

PageNumber Integer 1

页码,从1开始。默认值为1。

PageSize Integer 10

每页显示的条数,默认为10条,最大100条。

ProjectId Long 10001

工作空间的ID。

RegionId String cn-shanghai

地域ID。

TenantId Long 10002

租户ID。

GroupId String ds_123abc

指定文件夹所属业务流程的ID。

FolderNameKeyword String 文件夹名称关键词

文件夹名称关键词,可以进行子串匹配。

返回数据

名称 类型 示例值 描述
FolderPagingResult Struct

文件夹列表的分页结果。

Folders Array of Folder

文件夹列表。

CreatedTime String 2020-09-24T18:37:51+0800

文件夹的创建时间。

FolderId Long 11

文件夹的ID。

FolderName String test1

文件夹的名称。

GroupId String ds_1234

文件夹所属业务流程的ID。

ModifiedTime String 2020-09-24T18:37:51+0800

文件夹的编辑时间。

ParentId Long 0

父文件夹的ID。业务流程下根文件夹ID等于0,用户创建文件夹ID大于0。

ProjectId Long 10001

工作空间ID。

TenantId Long 10002

租户ID。

PageNumber Integer 1

页码,和请求中的PageNumber一致。

PageSize Integer 10

每页显示的条数,默认为10条,最大100条。

TotalCount Integer 100

总记录数。

RequestId String 0000-ABCD-EF****

请求ID,一次请求的唯一标识。

示例

请求示例

http(s)://[Endpoint]/?Action=ListDataServiceFolders
&PageNumber=1
&PageSize=10
&ProjectId=10001
&RegionId=cn-shanghai
&TenantId=10002
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>0000-ABCD-EF****</RequestId>
<FolderPagingResult>
    <TotalCount>100</TotalCount>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <Folders>
        <ParentId>0</ParentId>
        <TenantId>10002</TenantId>
        <CreatedTime>2020-09-24T18:37:51+0800</CreatedTime>
        <ModifiedTime>2020-09-24T18:37:51+0800</ModifiedTime>
        <ProjectId>10001</ProjectId>
        <FolderId>11</FolderId>
        <FolderName>test1</FolderName>
        <GroupId>ds_1234</GroupId>
    </Folders>
</FolderPagingResult>

JSON 格式

{
    "RequestId": "0000-ABCD-EF****",
    "FolderPagingResult": {
        "TotalCount": 100,
        "PageSize": 10,
        "PageNumber": 1,
        "Folders": {
            "ParentId": 0,
            "TenantId": 10002,
            "CreatedTime": "2020-09-24T18:37:51+0800",
            "ModifiedTime": "2020-09-24T18:37:51+0800",
            "ProjectId": 10001,
            "FolderId": 11,
            "FolderName": "test1",
            "GroupId": "ds_1234"
        }
    }
}

错误码

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. 您的请求过于频繁,请尝试放缓请求速度。

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