All Products
Search
Document Center

DataWorks:AddEntityIntoMetaCollection

Last Updated:Mar 30, 2026

Adds an entity to a collection in Data Map. Collections include categories and data albums. Entities can be only tables. If you want to add an entity to a data album, the account that you use must be attached the AliyunDataWorksFullAccess policy, or you are the data album creator or administrator.

Operation description

  1. 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

MetaCollectionId

string

Yes

The collection ID. You can refer to the return result of the ListMetaCollections operation.

as78d756asd

Id

string

Yes

The entity ID. Currently, only table entities are supported. You can call the ListTables operation to obtain the ID.

maxcompute-table:::project_name:[schema_name]:table_name

Remark

string

No

Remarks added when adding the entity to a collection. This parameter is currently valid only for album collections.

test

Response elements

Element

Type

Description

Example

object

The response.

RequestId

string

The request ID.

C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490

Examples

Success response

JSON format

{
  "RequestId": "C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.