CreateMetaEntityDef-阿里云帮助中心

Operation description

DataWorks Professional Edition or a more advanced 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

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

create

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	The name of the type definition. Custom types must match `^[a-z0-9][a-z0-9_]$`. Extended table types must match `^[a-z0-9][a-z0-9_]-table$`.	biz_api
DisplayName	string	Yes	The display name, up to 32 characters.	Business API
Description	string	No	The description.	description
Extend	string	No	The extension mode. Valid values: NONE: default value. Indicates a custom entity with freely defined attributes. TABLE: indicates an extended table type. This type integrates in the same way as existing table types in DataWorks Data Map. You do not need to provide attribute definitions and can create corresponding Database/Table objects. Valid values: TABLE : Extended table entity. NONE : Custom entity.	TABLE
AttributeDefs	array	No	The attribute definition list for custom entities. This parameter cannot be specified when extend is set to TABLE.	[]
	MetaEntityAttributeDef	No	The attribute definition.

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	0A04C673-BEFA-5803-94E5-89E2D9F8C567
Success	boolean	Indicates whether the request was successful.	true
EntityType	string	The entity type after creation.	custom_entity-biz_api

Examples

Success response

JSON format

{
  "RequestId": "0A04C673-BEFA-5803-94E5-89E2D9F8C567",
  "Success": true,
  "EntityType": "custom_entity-biz_api"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.