Use CreateMetaCollection to create a collection - DataWorks - Alibaba Cloud - DataWorks

Operation description

Collections have multiple types. The name must be unique within the same collection type.

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	The collection name. Length limit: 1 to 32 characters.	collection_name
Comment	string	No	The comment for the collection. Length limit: 1 to 64 characters.	this is a comment
ParentQualifiedName	string	No	The unique identifier of the parent collection.	album.333508
CollectionType	string	Yes	The collection type.	ALBUM

Categories under an album must be created within the album. Create the album first, and then create subcategories within the album by setting parentQualifiedName to the qualifiedName of the album.

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	E6F0DBDD-5AD****
QualifiedName	string	The unique identifier of the collection.	album.11111
Success	string	Indicates whether the call was successful. Valid values: true: The call was successful. false: The call failed.	true
ErrorCode	string	The error code.	NoPermission
ErrorMessage	string	The error message.	The specified parameters are invalid.
HttpStatusCode	string	The HTTP status code.	200

Examples

Success response

JSON format

{
  "RequestId": "E6F0DBDD-5AD****",
  "QualifiedName": "album.11111",
  "Success": "true",
  "ErrorCode": "NoPermission",
  "ErrorMessage": "The specified parameters are invalid.",
  "HttpStatusCode": "200"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.