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.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| dataworks:AddEntityIntoMetaCollection | none | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| MetaCollectionId | string | Yes | The collection ID. You can refer to the return result of the ListMetaCollections operation. | category.123 |
| Id | string | Yes | The entity ID. Currently, only table entities are supported. You can call the ListTables operation to obtain the ID. | maxcompute-table |
| Remark | string | No | Remarks added when adding the entity to a collection. This parameter is currently valid only for album collections. | test |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490"
}Error codes
For a list of error codes, visit the Service error codes.