Validate Data Source Connectivity with TestDataSourceConnectivity API - DataWorks - Alibaba Cloud - DataWorks

Operation description

You must purchase DataWorks Basic Edition or a higher edition to use this feature.
You must have at least one of the following roles in the DataWorks project space:
Tenant Owner, Space Administrator, Deployment, Developer, 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:TestDataSourceConnectivity

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	Yes	The resource group ID.	Serverless_res_group_524257424564736_6831777003XXXXX
DataSourceId	integer	Yes	The ID of the data source for which you want to test the network connectivity.	144544
ProjectId	integer	Yes	The DataWorks workspace ID.	10001

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	4CDF7B72-020B-542A-8465-21CFFA81****
Connectivity	object	The details of the connectivity test.
ConnectState	string	The result of the connectivity test. Valid values: Connectable: The network can be connected. ConfigError: The network can be connected, but the configurations are incorrect. Unreachable: The network cannot be connected. Unsupport: An error is reported due to other causes. For example, the desired resource group is being initialized.	Connectable
ConnectMessage	string	The error message returned if the connectivity test fails. No such a message is returned if the connectivity test is successful.	Failed to connect to the database
DetailLogs	array<object>	The detailed logs of each step in the connectivity test.
	object
StartTime	integer	The start time of a step.	1730217600001
EndTime	integer	The end time of a step.	1730217604002
Code	string	The code of the test item.	validate_input_parameters
Message	string	The name of the step.	Validate input parameters

Examples

Success response

JSON format

{
  "RequestId": "4CDF7B72-020B-542A-8465-21CFFA81****",
  "Connectivity": {
    "ConnectState": "Connectable",
    "ConnectMessage": "Failed to connect to the database",
    "DetailLogs": [
      {
        "StartTime": 1730217600001,
        "EndTime": 1730217604002,
        "Code": "validate_input_parameters",
        "Message": "Validate input parameters"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.