Queries information about collections. Collections include data albums that are displayed on the Data Map page and categories that are created in the data albums. You can call this API operation to query collections by type.
The type can be ALBUM or ALBUM_CATEGORY. ALBUM indicates data albums. ALBUM_CATEGORY indicates categories.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
Action | String | Yes | ListMetaCollections | The operation that you want to perform. Set the value to ListMetaCollections. |
ParentQualifiedName | String | No | Album.1234 | The unique identifier of the parent collection. |
NextToken | String | No | 12345 | The pagination token that is used in the next request to retrieve a new page of results. |
PageSize | Integer | No | 10 | The number of entries per page. Valid values: 1 to 100. Default value: 10. |
Keyword | String | No | Keyword | The keyword. |
OrderBy | String | No | Sorting field | The name of the sorting field. |
CollectionType | String | Yes |
| ALBUM: data album ALBUM_CATEGORY: category in a data album |
Creator | String | No | 1200759642363000 | The ID of the collection creator. |
Administrator | String | No | 1200759642363000 | The ID of the collection administrator. |
Follower | String | No | 1200759642363000 | The ID of the collection follower. |
You can configure only one of the Creator, Administrator, and Follower parameters.
Response parameters
Parameter | Type | Example | Description |
RequestId | String | E25887B7-579C-54A5-9C4F-83A0DE367DDE | The request ID. You can locate logs and troubleshoot issues based on the ID. |
Data | Object | The response parameters. | |
NextToken | String | 37ae2053d87d380f28ce0dc0853ca51e | The pagination token that is used in the next request to retrieve a new page of results. |
CollectionList | Array of Collection | The collections. | |
Success | Boolean | true | Indicates whether the request was successful. Valid values:
|
ErrorCode | String | Invalid.Collection.NotExists | The error code returned. |
ErrorMessage | String | The specified parameters are invalid. | The error message returned. |
HttpStatusCode | Integer | 200 | The HTTP status code returned. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=ListMetaCollections
&ParentQualifiedName=Album.1234
&NextToken=The pagination token that is used in the next request to retrieve a new page of results.
&PageSize=10
&Keyword=Keyword
&OrderBy=Sorting field
&CollectionType=ALBUM and ALBUM_CATEGORY
&Creator=1200759642363000
&Administrator=1200759642363000
&Follower=1200759642363000
&<Common request parameters>Sample success responses
XML format
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 format
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
}Error codes
For a list of error codes, see Service error codes.