ListMetaCollections - 查询集合信息 - 大数据开发治理平台 DataWorks

查询集合信息。集合的概念包括数据地图页面上的专辑、专辑中的子类目等。通过本接口可以指定集合类型查询集合信息。

接口说明

集合包括： ALBUM（专辑集合）， ALBUM_CATEGORY（专辑内的子类目）。

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
ParentQualifiedName	string	否	父集合唯一标识	Album.1234
NextToken	string	否	分页信息，指定本次读取的起始点	12345
PageSize	integer	否	每页显示的条数，默认为 10 条，最大 100 条。	10
Keyword	string	否	关键字。	关键词
OrderBy	string	否	排序字段名称。	排序字段
CollectionType	string	是	查询的集合类型，取值范围： ALBUM：专辑集合 ALBUM_CATEGORY：专辑内的类目	ALBUM
Creator	string	否	创建者用户 ID。	1200759642363000
Administrator	string	否	集合管理员 ID	1200759642363000
Follower	string	否	集合关注者 ID	1200759642363000

Creator、Administrator、Follower 这三个参数，最多可以设置一个

返回参数

名称	类型	描述	示例值
	object	返回结构
RequestId	string	请求的 ID。用于定位日志，排查问题。	E25887B7-579C-54A5-9C4F-83A0DE367DDE
Data	object	返回对象
NextToken	string	下一页的 token	37ae2053d87d380f28ce0dc0853ca51e
CollectionList	array	数组对象
CollectionList	Collection	返回的集合对象
Success	boolean	调用是否成功。取值如下： true：调用成功。 false：调用失败。	true
ErrorCode	string	错误码。	Invalid.Collection.NotExists
ErrorMessage	string	错误信息。	The specified parameters are invalid.
HttpStatusCode	integer	HTTP 状态码。	200

示例

正常返回示例

JSON格式

{
  "RequestId": "E25887B7-579C-54A5-9C4F-83A0DE367DDE",
  "Data": {
    "NextToken": "37ae2053d87d380f28ce0dc0853ca51e",
    "CollectionList": [
      {
        "QualifiedName": "album.12334",
        "CollectionType": "album",
        "Name": "collectionName",
        "Comment": "comment",
        "OwnerId": "1234444",
        "OwnerName": "owner",
        "CreateTime": 1668600147617,
        "UpdateTime": 1668600148617,
        "Level": 1
      }
    ]
  },
  "Success": true,
  "ErrorCode": "Invalid.Collection.NotExists",
  "ErrorMessage": "The specified parameters are invalid.",
  "HttpStatusCode": 200
}

错误码

HTTP status code	错误码	错误信息
400	Invalid.Collection.ParamError	msg: %s
400	Invalid.User.NotExist	msg: %s
400	Invalid.Collection.QualifiedNameError	msg: %s
400	Invalid.Collection.CollectionNotCompatible	msg: %s
400	Invalid.Collection.EntityOverflow	msg: %s
400	Invalid.Collection.NotExist	msg: %s
400	Invalid.Collection.AlreadyExist	msg: %s
400	Invalid.Collection.UnsupportedOperation	msg: %s
400	InvalidParameter.Meta.Missing	msg: %s
400	Forbidden.No.Permission	msg: %s
400	InvalidParameter.Meta.IllegalData	msg: %s

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史