Add an entity to a collection with AddMetaCollectionEntity - DataWorks - Alibaba Cloud - DataWorks

Operation description

Before you begin: Before calling this operation, activate DataWorks Professional Edition or a higher edition. The Basic Edition and Standard Edition do not support the metadata collection feature.

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:*

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CollectionQualifiedName	string	Yes	The unique identifier of the collection.	album.2222
EntityQualifiedName	string	Yes	The unique identifier of the entity.	maxcompute-table.projectA.tableB
Remark	string	No	The remarks on the entity.	this is a remark

Response elements

Element	Type	Description	Example
	object	The response struct.
RequestId	string	The request ID. You can use the ID to locate logs and troubleshoot issues.	0000-ABCD-E****
Status	boolean	The operation result. Valid values: true: Succeeded. false: Failed.	true
HttpStatusCode	integer	The HTTP status code.	200
ErrorMessage	string	The error message.	The specified product does not exist.
ErrorCode	string	The error code.	9999
Success	boolean	Indicates whether the call was successful. Valid values: true: The call was successful. false: The call failed.	true

Examples

Success response

JSON format

{
  "RequestId": "0000-ABCD-E****",
  "Status": true,
  "HttpStatusCode": 200,
  "ErrorMessage": "The specified product does not exist.",
  "ErrorCode": "9999",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	Invalid.Entity.NotExist	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.