TestNetworkConnection - DataWorks - Alibaba Cloud Documentation Center

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

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

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.	10000
DatasourceName	string	Yes	The name of the data source.	mysql_name
EnvType	string	Yes	The environment in which the data source resides. Valid values: 0: development environment 1: production environment	1
ResourceGroup	string	Yes	The identifier of the resource group. You can call the ListResourceGroups operation to query the identifier of the resource group.	S_res_group_2XXXX4_1619100XXXXX

Response parameters

Parameter	Type	Description	Example
	object
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
RequestId	string	The request ID. You can locate logs and troubleshoot issues based on the ID.	0000-ABCD-EFG
TaskList	object	The information about the connectivity test.
ConnectMessage	string	The reason why the data source and resource group failed the connectivity test. If data source and the resource group passed the connectivity test, this parameter is left empty.	Connectable
ConnectStatus	boolean	The result of the connectivity test. Valid values: true: The data source and the resource group passed the connectivity test. false: The data source and the resource group failed the connectivity test. You can troubleshoot issues based on the ConnectMessage parameter.	true

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "RequestId": "0000-ABCD-EFG\t",
  "TaskList": {
    "ConnectMessage": "Connectable",
    "ConnectStatus": true
  }
}

Error codes

HTTP status code	Error code	Error message
400	Invalid.DI.Parameter	The parameter is invalid.
403	Forbidden.DI.NoPrivilege	No access.
500	InternalError.DI.Parameter	A DI internal error occurred.

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

Change history

Change time	Summary of changes	Operation

No change history