文档

ListMetaCollections - 查询集合信息

更新时间:

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

接口说明

集合包括: ALBUM(专辑集合), ALBUM_CATEGORY(专辑内的子类目)。

调试

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

授权信息

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

请求参数

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

父集合唯一标识

Album.1234
NextTokenstring

分页信息,指定本次读取的起始点

12345
PageSizeinteger

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

10
Keywordstring

关键字。

关键词
OrderBystring

排序字段名称。

排序字段
CollectionTypestring
  • ALBUM:专辑集合
  • ALBUM_CATEGORY:专辑内的类目
枚举值:
  • ALBUM专辑集合
  • ALBUM_CATEGORY专辑中类目
ALBUM
Creatorstring

创建者用户 ID。

1200759642363000
Administratorstring

集合管理员 ID

1200759642363000
Followerstring

集合关注者 ID

1200759642363000

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

返回参数

名称类型描述示例值
object

返回结构

RequestIdstring

请求的 ID。用于定位日志,排查问题。

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

返回对象

NextTokenstring

下一页的 token

37ae2053d87d380f28ce0dc0853ca51e
CollectionListarray

数组对象

Collection

返回的集合对象

Successboolean

调用是否成功。取值如下:

  • true:调用成功。
  • false:调用失败。
true
ErrorCodestring

错误码。

Invalid.Collection.NotExists
ErrorMessagestring

错误信息。

The specified parameters are invalid.
HttpStatusCodeinteger

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错误码错误信息
400Invalid.Collection.ParamErrormsg: %s
400Invalid.User.NotExistmsg: %s
400Invalid.Collection.QualifiedNameErrormsg: %s
400Invalid.Collection.CollectionNotCompatiblemsg: %s
400Invalid.Collection.EntityOverflowmsg: %s
400Invalid.Collection.NotExistmsg: %s
400Invalid.Collection.AlreadyExistmsg: %s
400Invalid.Collection.UnsupportedOperationmsg: %s
400InvalidParameter.Meta.Missingmsg: %s
400Forbidden.No.Permissionmsg: %s
400InvalidParameter.Meta.IllegalDatamsg: %s

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)