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

更新时间:
复制 MD 格式

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

接口说明

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

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:ListMetaCollections

list

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

Type

string

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

  • Category 类目

  • Album 数据专辑

  • AlbumCategory 专辑子类目

枚举值:

  • Category :

    类目

  • Album :

    数据专辑

  • AlbumCategory :

    专辑子类目

Category

ParentId

string

父节点集合对象 ID。

as78d756asd

Name

string

集合名称,模糊匹配。

数据资产主题域

Description

string

集合描述,模糊匹配。

测试集合

CreateUser

string

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

123456

Administrator

string

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

12345

SortBy

string

排序字段, 支持

  • Id(默认)

  • Name 名称

  • CreateUser 创建者 ID

  • CreateTime 创建时间

  • ModifyTime 修改时间

Name

Order

string

排序方向,支持

  • Asc(默认)

  • Desc

Asc

PageNumber

integer

分页页码,默认为 1。

1

PageSize

integer

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

10

返回参数

名称

类型

描述

示例值

object

返回结果。

RequestId

string

请求 ID。

E25887B7-XXXX-54A5-9C4F-83A0DE367DDE

Data

object

分页结果对象。

TotalCount

integer

总记录数。

10

PageNumber

integer

页码。

1

PageSize

integer

页大小。

10

MetaCollections

array<object>

集合列表。

object

集合对象。

Name

string

集合对象名称。

test_category

Id

string

集合对象名称。

7a65sd7aasd

ParentId

string

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

as78d756asd

Description

string

集合对象描述。

测试类目

Type

string

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

  • Category 类目

  • Album 数据专辑

  • AlbumCategory 专辑子类目

Category

CreateUser

string

创建者用户 ID。

456789

CreateTime

integer

创建时间毫秒级时间戳。

1668568601000

ModifyTime

integer

修改时间毫秒级时间戳。

1668568601000

Administrators

array

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

string

管理员用户 ID。

765432

示例

正常返回示例

JSON格式

{
  "RequestId": "E25887B7-XXXX-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"
        ]
      }
    ]
  }
}

错误码

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

变更历史

更多信息,参考变更详情