查询集合信息。 集合的概念包括数据地图页面上的专辑、专辑中的子类目等。 通过本接口可以指定集合类型查询集合信息。
集合包括: ALBUM(专辑集合), ALBUM_CATEGORY(专辑内的子类目)。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListMetaCollections | 系统规定参数。取值:ListMetaCollections。 |
ParentQualifiedName | String | 否 | Album.1234 | 父集合唯一标识 |
NextToken | String | 否 | 12345 | 分页信息,指定本次读取的起始点 |
PageSize | Integer | 否 | 10 | 每页显示的条数,默认为10条,最大100条。 |
Keyword | String | 否 | 关键词 | 关键字。 |
OrderBy | String | 否 | 排序字段 | 排序字段名称。 |
CollectionType | String | 是 | ALBUM、ALBUM_CATEGORY | ALBUM:专辑集合, ALBUM_CATEGORY:专辑内的类目 |
Creator | String | 否 | 1200759642363000 | 创建者用户ID。 |
Administrator | String | 否 | 1200759642363000 | 集合管理员ID |
Follower | String | 否 | 1200759642363000 | 集合关注者ID |
Creator、Administrator、Follower 这三个参数,最多可以设置一个
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | E25887B7-579C-54A5-9C4F-83A0DE367DDE | 请求的ID。用于定位日志,排查问题。 |
Data | Object | 返回对象 |
|
NextToken | String | 37ae2053d87d380f28ce0dc0853ca51e | 下一页的token |
CollectionList | Array of Collection | 数组对象 |
|
Success | Boolean | true | 调用是否成功。取值如下:
|
ErrorCode | String | Invalid.Collection.NotExists | 错误码。 |
ErrorMessage | String | The specified parameters are invalid. | 错误信息。 |
HttpStatusCode | Integer | 200 | HTTP状态码。 |
示例
请求示例
http(s)://[Endpoint]/?Action=ListMetaCollections
&ParentQualifiedName=Album.1234
&NextToken=分页信息,指定本次读取的起始点
&PageSize=10
&Keyword=关键词
&OrderBy=排序字段
&CollectionType=ALBUM、ALBUM_CATEGORY
&Creator=1200759642363000
&Administrator=1200759642363000
&Follower=1200759642363000
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ListMetaCollectionsResponse>
<RequestId>E25887B7-579C-54A5-9C4F-83A0DE367DDE</RequestId>
<Data>
<NextToken>37ae2053d87d380f28ce0dc0853ca51e</NextToken>
<CollectionList>
<QualifiedName>album.12334</QualifiedName>
<CollectionType>album</CollectionType>
<Name>collectionName</Name>
<Comment>comment</Comment>
<OwnerId>1234444</OwnerId>
<OwnerName>owner</OwnerName>
<CreateTime>1668600147617</CreateTime>
<UpdateTime>1668600148617</UpdateTime>
<Level>1</Level>
</CollectionList>
</Data>
<Success>true</Success>
<ErrorCode>Invalid.Collection.NotExists</ErrorCode>
<ErrorMessage>The specified parameters are invalid.</ErrorMessage>
<HttpStatusCode>200</HttpStatusCode>
</ListMetaCollectionsResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/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
}
错误码
访问错误中心查看更多错误码。