ListMetaCollections - DataWorks - Alibaba Cloud Documentation Center

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.

Operation description

The type can be ALBUM or ALBUM_CATEGORY. ALBUM indicates data albums. ALBUM_CATEGORY indicates categories.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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.	test
OrderBy	string	No	The name of the sorting field.	test
CollectionType	string	Yes	ALBUM: data album ALBUM_CATEGORY: category in a data album	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 configure only one of the Creator, Administrator, and Follower parameters.

Response parameters

Parameter	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.
CollectionList	Collection	The collection.
Success	boolean	Indicates whether the request was successful. Valid values: true false	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

Sample success responses

JSONformat

{
  "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
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

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history