Adds a data source to the development environment or production environment of a workspace.
Operation description
- This API operation is available for all DataWorks editions.
- You can call this operation only if you are assigned one of the following roles in DataWorks:
- Tenant Owner, Workspace Administrator, Workspace Owner, and O&M
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:CreateDataSource | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ProjectId | long | 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 is used to determine the DataWorks workspaces used for this API call. | 2 |
| Name | string | Yes | The name of the data source. The name can be up to 255 characters in length and can contain letters, digits, and underscores (_). The name must start with a letter. | demo_holo_datasource |
| Type | string | Yes | The type of the data source. More than 70 types of data sources are supported in DataWorks. For more information, see Data source types. | hologres |
| ConnectionPropertiesMode | string | Yes | The mode in which you want to add the data source. The mode varies based on the data source type. Valid values for MySQL data sources:
| UrlMode |
| Description | string | No | The description of the data source. The description cannot exceed 3,000 characters in length. | this is a holo datasource |
| ConnectionProperties | string | Yes | The connection configurations of the data source, including the connection address, access identity, and environment information. The envType parameter specifies the environment in which the data source is used. Valid values of the envType parameter:
The parameters that you need to configure for the data source vary based on the mode in which the data source is added. For more information, see Data source connection information (ConnectionProperties). | { "envType": "Prod", "regionId": "cn-beijing", "instanceId": "hgprecn-cn-x0r3oun4k001", "database": "testdb", "securityProtocol": "authTypeNone", "authType": "Executor", "authIdentity": "1107550004253538" } |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "B62EC203-B39E-5DC1-B5B8-EB3C61707009",
"Id": 22130
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|