ListDataServiceFolders - 查询数据服务文件夹列表

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

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
PageNumberinteger

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

1
PageSizeinteger

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

10
ProjectIdlong

工作空间的 ID。

10001
TenantIdlong

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

10002
GroupIdstring

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

ds_123abc
FolderNameKeywordstring

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

文件夹名称关键词

返回参数

名称类型描述示例值
object
RequestIdstring

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

0000-ABCD-EF****
FolderPagingResultobject

文件夹列表的分页结果。

PageNumberinteger

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

1
PageSizeinteger

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

10
TotalCountinteger

总记录数。

100
Foldersarray<object>

文件夹列表。

Folderobject
ParentIdlong

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

0
ModifiedTimestring

文件夹的编辑时间。

2020-09-24T18:37:51+0800
GroupIdstring

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

ds_1234
FolderIdlong

文件夹的 ID。

11
FolderNamestring

文件夹的名称。

test1
ProjectIdlong

工作空间 ID。

10001
CreatedTimestring

文件夹的创建时间。

2020-09-24T18:37:51+0800
TenantIdlong

租户 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错误码错误信息描述
403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.没有权限,请授权
429Throttling.ApiThe request for this resource has exceeded your available limit.对该资源的请求已超过您的可用上限。
429Throttling.SystemThe DataWorks system is busy. Try again later.DataWorks系统繁忙,请稍后再试。
429Throttling.UserYour request is too frequent. Try again later.您的请求过于频繁,请尝试放缓请求速度。
500InternalError.SystemAn internal system error occurred. Try again later.系统内部错误,请稍后再试。
500InternalError.UserId.MissingAn internal system error occurred. Try again later.系统内部错误,请稍后再试。

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

变更历史

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