ListDataServiceFolders - 查询数据服务文件夹列表 - 大数据开发治理平台 DataWorks

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
PageNumber	integer	是	页码，从 1 开始。默认值为 1。	1
PageSize	integer	是	每页显示的条数，默认为 10 条，最大 100 条。	10
ProjectId	long	是	工作空间的 ID。	10001
TenantId	long	否	租户 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>	文件夹列表。
Folder	object
ParentId	long	父文件夹的 ID。业务流程下根文件夹 ID 等于 0，用户创建文件夹 ID 大于 0。	0
ModifiedTime	string	文件夹的编辑时间。	2020-09-24T18:37:51+0800
GroupId	string	文件夹所属业务流程的 ID。	ds_1234
FolderId	long	文件夹的 ID。	11
FolderName	string	文件夹的名称。	test1
ProjectId	long	工作空间 ID。	10001
CreatedTime	string	文件夹的创建时间。	2020-09-24T18:37:51+0800
TenantId	long	租户 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	错误码	错误信息	描述
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.	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.	系统内部错误，请稍后再试。

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

变更历史

变更时间	变更内容概要	操作
2023-10-09	OpenAPI 错误码发生变更	查看变更详情