Retrieves a list of collections. Collections include data albums displayed on the Data Map page and categories created in data albums. You can filter collections by type.
Operation description
Collections include ALBUM (data album) and ALBUM_CATEGORY (category within a data album).
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ParentQualifiedName |
string |
No |
The unique identifier of the parent collection. |
Album.1234 |
| NextToken |
string |
No |
The pagination token that is used in the next request to retrieve a new page of results. |
12345 |
| PageSize |
integer |
No |
The number of entries per page. Default value: 10. Maximum value: 100. |
10 |
| Keyword |
string |
No |
The keyword. |
keyword |
| OrderBy |
string |
No |
The name of the sorting field. |
sortField |
| CollectionType |
string |
Yes |
|
ALBUM |
| Creator |
string |
No |
The ID of the collection creator. |
1200759642363000 |
| Administrator |
string |
No |
The ID of the collection administrator. |
1200759642363000 |
| Follower |
string |
No |
The ID of the collection follower. |
1200759642363000 |
You can set at most one of the Creator, Administrator, and Follower parameters.
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response parameters. |
||
| RequestId |
string |
The request ID. |
E25887B7-579C-54A5-9C4F-83A0DE367DDE |
| Data |
object |
The returned result. |
|
| NextToken |
string |
A pagination token. It can be used in the next request to retrieve a new page of results. |
37ae2053d87d380f28ce0dc0853ca51e |
| CollectionList |
array |
The collections. |
|
| Collection |
The collection. |
||
| Success |
boolean |
Indicates whether the request was successful. Valid values:
|
true |
| ErrorCode |
string |
The error code. |
Invalid.Collection.NotExists |
| ErrorMessage |
string |
The error message. |
The specified parameters are invalid. |
| HttpStatusCode |
integer |
The HTTP status code. |
200 |
Examples
Success response
JSON format
{
"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
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 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 |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.