Adds a data source to DataWorks.
Debugging
Authorization information
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ProjectId | long | Yes | The ID of the DataWorks workspace to which the data source belongs. You can call the ListProjects operation to query the ID. | 1 |
| Name | string | Yes | The name of the data source. | abc |
| Description | string | No | The description of the data source. | abc |
| DataSourceType | string | Yes | The type of the data source. Valid values:
| rds |
| SubType | string | No | The subtype of the data source.
| mysql |
| EnvType | integer | Yes | The environment in which the data source is used. Valid values: 0 and 1. The value 0 indicates the development environment. The value 1 indicates the production environment. | 1 |
| Content | string | Yes | The details of the data source. Examples of details of some common data sources:
| {"database":"dbname","instanceName":"instancename","password":"password","rdsOwnerId":"123","username":"username"} |
Response parameters
Examples
Sample success responses
JSONformat
{
"HttpStatusCode": 200,
"Data": 123,
"RequestId": "0bc141151593763****",
"Success": true
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | Invalid.Tenant.ConnectionNotExists | The connection does not exist. | The connection does not exist. |
| 400 | Invalid.Tenant.ProjectNotExists | The project does not exist. | The project does not exist. |
| 400 | Invalid.Tenant.UserNotInProject | The user is not in the project. | The user is not in the project. |
| 400 | ConnectionAlreadyExist | The connection with envType %s and name %s already exists. | ConnectionAlreadyExist |
| 400 | DataSource.CheckRamRoleFailure | Failed to check the RAM role. AccountId %s. roleArn %s. | - |
| 400 | DataSource.ConnectionStrProperty.PatternNotMatch | The pattern value %s is invalid. The correct pattern is %s. | - |
| 400 | Invalid.DataSource.DataSourceTypeNotSupport | The dataSourceType %s and subType %s are not supported. | DataSource type not support yet. |
| 400 | Invalid.Param.Odps.EngineIdOrConnectStrEmpty | Either the compute engine ID or the connection string must be specified when data source type is ODPS. | - |
| 400 | MissingParam.ConnectionStr.Property | You must specify property %s required by the data source connection string. | The data source connection str required property missing. |
| 400 | Invalid.DataSource.DataSourceTypeNotExist | The data source type %s does not exist. | The dataSource type %s are not exist. |
| 403 | Invalid.Tenant.UserIsNotProjectOwnerOrAdmin | The user is not a project administrator or owner. | The user is not a project administrator or owner. |
| 403 | Invalid.Tenant.UserNotInTenant | The user is not in tenant. | The user is not in tenant. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2022-07-18 | API Description Update. The Error code has changed | View Change Details |
