CreateDataSource - Create a data source in DataWorks - DataWorks

Operation description

You must have purchased DataWorks Basic Edition or a higher edition.
You must have at least one of the following roles in the DataWorks project workspace:

Tenant Owner, Storage Management Administrator, Project Owner, or O&M

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the ID. This parameter specifies the DataWorks workspace for this API call.	2
Name	string	Yes	The name of the data source. The name can contain letters, digits, and underscores (_), and cannot start with a digit or underscore. The name can be up to 255 characters in length.	demo_holo_datasource
Type	string	Yes	The type of the data source. More than 70 data source types are supported. For more information about the enumerated data source types, refer to References: Data source type list.	hologres
ConnectionPropertiesMode	string	Yes	The connection mode of the data source. Different types have different subtypes with different parameter constraints. For example, a MySQL data source supports the following modes: InstanceMode (instance mode) UrlMode (connection string mode)	UrlMode
Description	string	No	The description of the data source. The description can be up to 3,000 characters in length.	this is a holo datasource
ConnectionProperties	string	Yes	The connection properties of the data source, including the endpoint, access identity, and environment context. The envType property is a member of this object and specifies the data source environment. Valid values: Dev: development environment. Prod: production environment. Different data source types have different property specifications under different connection patterns (ConnectionPropertiesMode). For more information, see Data source connection properties ConnectionProperties.	{ "envType": "Prod", "regionId": "cn-beijing", "instanceId": "hgprecn-cn-x0r3oun4k001", "database": "testdb", "securityProtocol": "authTypeNone", "authType": "Executor", "authIdentity": "1107550004253538" }

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID. You can use this ID to locate logs and troubleshoot issues.	B62EC203-B39E-5DC1-B5B8-EB3C6****
Id	integer	The ID of the created data source. This is the unique identifier of the data source.	22130

Examples

Success response

JSON format

{
  "RequestId": "B62EC203-B39E-5DC1-B5B8-EB3C6****",
  "Id": 22130
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.