文档

ListDataServiceFolders

更新时间:

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

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String ListDataServiceFolders

系统规定参数。取值:ListDataServiceFolders

PageNumber Integer 1

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

PageSize Integer 10

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

ProjectId Long 10001

工作空间的ID。

TenantId Long 10002

租户ID。您可登录DataWorks控制台,进入数据开发(DataStudio)页面,单击右上方当前登录用户名称,选择菜单 > 用户信息,获取租户ID。

GroupId String ds_123abc

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

FolderNameKeyword String 文件夹名称关键词

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

返回数据

名称

类型

示例值

描述

RequestId String 0000-ABCD-EF****

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

FolderPagingResult Object

文件夹列表的分页结果。

PageNumber Integer 1

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

PageSize Integer 10

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

TotalCount Integer 100

总记录数。

Folders Array of Folder

文件夹列表。

ParentId Long 0

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

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

文件夹的编辑时间。

GroupId String ds_1234

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

FolderId Long 11

文件夹的ID。

FolderName String test1

文件夹的名称。

ProjectId Long 10001

工作空间ID。

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

文件夹的创建时间。

TenantId Long 10002

租户ID。

示例

请求示例

http(s)://[Endpoint]/?Action=ListDataServiceFolders
&PageNumber=1
&PageSize=10
&ProjectId=10001
&TenantId=10002
&GroupId=ds_123abc
&FolderNameKeyword=文件夹名称关键词
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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
    }
  }
}

错误码

HttpCode

错误码

错误信息

描述

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. 您的请求过于频繁,请尝试放缓请求速度。
500 InternalError.System An internal system error occurred. Try again later. 系统内部错误,请稍后再试。
500 InternalError.UserId.Missing An internal system error occurred. Try again later. 系统内部错误,请稍后再试。

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

  • 本页导读 (1)
文档反馈