TestDataSourceConnectivity - DataWorks - Alibaba Cloud Documentation Center

Tests the connectivity between a data source and a resource group.

Operation description

This API operation is available for all DataWorks editions.
Your account must be assigned one of the following roles of the desired workspace: Tenant Owner, Workspace Administrator, Deploy, Develop, Workspace Owner, and O&M

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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 Resources is 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:TestDataSourceConnectivity	get	All Resources ``	none	none

Request parameters

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

Response parameters

Parameter	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.
DetailLogs	array<object>	The detailed logs of each step in the connectivity test.
	object
StartTime	long	The start time of a step.	1730217600001
EndTime	long	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.

Examples

Sample success responses

JSONformat

{
  "RequestId": "4CDF7B72-020B-542A-8465-21CFFA81****",
  "Connectivity": {
    "ConnectState": "Connectable",
    "ConnectMessage": "",
    "DetailLogs": [
      {
        "StartTime": 1730217600001,
        "EndTime": 1730217604002,
        "Code": "validate_input_parameters",
        "Message": ""
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history