Data Map Collections Overview via ListMetaCollections - DataWorks - Alibaba Cloud - DataWorks

Queries a list of collections in Data Map. Collections include categories and data albums.

Operation description

DataWorks Professional Edition or a higher edition is required.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
Type	string	Yes	The collection type. Valid values: Category Album AlbumCategory: Album subcategory	Category
ParentId	string	No	The ID of the parent collection.	as78d756asd
Name	string	No	The collection name. Supports fuzzy matching.	test
Description	string	No	The collection description. Supports fuzzy matching.	test_collection
CreateUser	string	No	The creator user ID. Valid only for album types. Default: The current user ID.	123456
Administrator	string	No	The administrator ID. Valid only for album types. Default: The current user ID.	12345
SortBy	string	No	The sort field. Valid values: Id (default) Name CreateUser: Creator ID CreateTime: Creation time ModifyTime: Modification time	Name
Order	string	No	The sort order. Valid values: Asc (default): Ascending order Desc	Asc
PageNumber	integer	No	The page number. Default: 1.	1
PageSize	integer	No	The number of entries per page. Default: 10. Maximum: 100.	10

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	E25887B7-XXXX-54A5-9C4F-83A0DE367DDE
Data	object	Pagination information.
TotalCount	integer	The total number of records.	10
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
MetaCollections	array<object>	The list of collections.
	object	The collection.
Name	string	The collection name.	test_category
Id	string	The collection name.	7a65sd7aasd
ParentId	string	The ID of the parent collection. Can be empty.	as78d756asd
Description	string	The collection description.	test_category
Type	string	The collection type. Valid values: Category Album AlbumCategory: Album subcategory	Category
CreateUser	string	The creator user ID.	456789
CreateTime	integer	The creation time in milliseconds (timestamp).	1668568601000
ModifyTime	integer	The modification time in milliseconds (timestamp).	1668568601000
Administrators	array	The list of administrator IDs. Supported only for album types. Administrators must be users within the same tenant. Multiple administrators can be specified.
	string	The administrator ID.	765432

Examples

Success response

JSON format

{
  "RequestId": "E25887B7-XXXX-54A5-9C4F-83A0DE367DDE",
  "Data": {
    "TotalCount": 10,
    "PageNumber": 1,
    "PageSize": 10,
    "MetaCollections": [
      {
        "Name": "test_category",
        "Id": "7a65sd7aasd",
        "ParentId": "as78d756asd",
        "Description": "test_category",
        "Type": "Category",
        "CreateUser": "456789",
        "CreateTime": 1668568601000,
        "ModifyTime": 1668568601000,
        "Administrators": [
          "765432"
        ]
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.