GetMetaCollection - DataWorks - Alibaba Cloud Documentation Center

Queries the information about a collection in Data Map. Collections include categories and data albums.

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
Id	string	Yes	The collection ID.	category.123

Response parameters

Parameter	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	1AFAE64E-D1BE-432B-A9****
MetaCollection	object	The collection details.
Id	string	The collection ID.	category.123
Type	string	The collection type. Valid values: Category Album AlbumCategory: Album subcategory.	Category
ParentId	string	The parent collection ID. This parameter can be empty.	category.12
Name	string	The collection name.	test_category
Description	string	The collection description.	test
CreateTime	long	The creation time in milliseconds.	1668568601000
ModifyTime	long	The last modified time in milliseconds.	1668568601000
CreateUser	string	The ID of the creator.	456789
Administrators	array	The list of administrator IDs. Valid only for the album type. The IDs must belong to users in the same tenant. Multiple IDs can be specified.
administrators	long	The ID of the administrator.	765432

Examples

Sample success responses

JSONformat

{
  "RequestId": "1AFAE64E-D1BE-432B-A9****",
  "MetaCollection": {
    "Id": "category.123",
    "Type": "Category",
    "ParentId": "category.12\n\n",
    "Name": "test_category",
    "Description": "test",
    "CreateTime": 1668568601000,
    "ModifyTime": 1668568601000,
    "CreateUser": 456789,
    "Administrators": [
      765432
    ]
  }
}

Error codes

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