ListMetaCollections-DataWorks(DataWorks)-阿里云帮助中心

Operation description

Collections include: ALBUM (album collection) and ALBUM_CATEGORY (subcategory within an album).

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:*

list

*All Resource

*

None

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 specifies the start point of the current read operation.	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 field used for sorting.	Sort field
CollectionType	string	Yes	The type of collection to query. Valid values: ALBUM: album collection. ALBUM_CATEGORY: subcategory within an album.	ALBUM
Creator	string	No	The user ID of the 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 following parameters: Creator, Administrator, and Follower.

Response elements

Element	Type	Description	Example
	object	The response struct.
RequestId	string	The request ID. Used for locating logs and troubleshooting issues.	E25887B7-579C-54A5-9C4F-83A0DE367DDE
Data	object	The returned object.
NextToken	string	The token for the next page.	37ae2053d87d380f28ce0dc0853ca51e
CollectionList	array	The array object.
	Collection	The returned collection object.
Success	boolean	Indicates whether the call was successful. Valid values: true: The call was successful. false: The call failed.	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
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.