ListMetaCollections - 查询数据地图集合列表

查询数据地图集合列表,支持查询数据地图类目以及数据专辑两种类型。

接口说明

  1. 需要购买 DataWorks 专业版及以上版本才能使用。

调试

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

授权信息

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

请求参数

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

集合类型,可枚举,取值为

  • Category 类目
  • Album 数据专辑
  • AlbumCategory 专辑子类目
Category
ParentIdstring

父节点集合对象 ID。

as78d756asd
Namestring

集合名称,模糊匹配。

test
Descriptionstring

集合描述,模糊匹配。

测试集合
CreateUserstring

创建者用户 ID,专辑类型有效,默认为当前用户 ID。

123456
Administratorstring

集合管理员 ID,专辑类型有效,默认为当前用户 ID。

12345
SortBystring

排序字段, 支持

  • Id(默认)
  • Name 名称
  • CreateUser 创建者 ID
  • CreateTime 创建时间
  • ModifyTime 修改时间
Name
Orderstring

排序方向,支持

  • Asc(默认)
  • Desc
Asc
PageNumberinteger

分页页码,默认为 1。

1
PageSizeinteger

分页大小,默认为 10,最大为 100。

10

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

E25887B7-579C-54A5-9C4F-83A0DE367DDE
Dataobject

分页结果对象。

TotalCountinteger

总记录数。

10
PageNumberinteger

页码。

1
PageSizeinteger

页大小。

10
MetaCollectionsarray<object>

集合列表。

metaCollectionsobject

集合对象。

Namestring

集合对象名称。

test_category
Idstring

集合对象名称。

7a65sd7aasd
ParentIdstring

父节点集合对象 Id,可为空。

as78d756asd
Descriptionstring

集合对象描述。

测试类目
Typestring

集合类型,可枚举,取值为

  • Category 类目
  • Album 数据专辑
  • AlbumCategory 专辑子类目
Category
CreateUserstring

创建者用户 ID。

456789
CreateTimelong

创建时间毫秒级时间戳。

1668568601000
ModifyTimelong

修改时间毫秒级时间戳。

1668568601000
Administratorsarray

管理员用户 ID 列表,仅专辑类型支持, 需要为同租户下用户,可设置多个。

administratorsstring

管理员用户 ID。

765432

示例

正常返回示例

JSON格式

{
  "RequestId": "E25887B7-579C-54A5-9C4F-83A0DE367DDE",
  "Data": {
    "TotalCount": 10,
    "PageNumber": 1,
    "PageSize": 10,
    "MetaCollections": [
      {
        "Name": "test_category",
        "Id": "7a65sd7aasd",
        "ParentId": "as78d756asd",
        "Description": "测试类目",
        "Type": "Category",
        "CreateUser": 456789,
        "CreateTime": 1668568601000,
        "ModifyTime": 1668568601000,
        "Administrators": [
          765432
        ]
      }
    ]
  }
}

错误码

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