All Products
Search
Document Center

DataWorks:TestNetworkConnection

Last Updated:Nov 21, 2024

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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ProjectIdlongYes

The ID of the DataWorks workspace to which the data sources belong. You can call the ListProjects operation to query the ID of the workspace.

10000
DatasourceNamestringYes

The name of the data source.

mysql_name
EnvTypestringYes

The environment in which the data source resides. Valid values:

  • 0: development environment
  • 1: production environment
1
ResourceGroupstringYes

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

ParameterTypeDescriptionExample
object
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
RequestIdstring

The request ID. You can locate logs and troubleshoot issues based on the ID.

0000-ABCD-EFG
TaskListobject

The information about the connectivity test.

ConnectMessagestring

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.

ConnectStatusboolean

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": "",
    "ConnectStatus": true
  }
}

Error codes

HTTP status codeError codeError message
400Invalid.DI.ParameterThe parameter is invalid.
403Forbidden.DI.NoPrivilegeNo access.
500InternalError.DI.ParameterA DI internal error occurred.

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

Change history

Change timeSummary of changesOperation
No change history