TestNetworkConnection

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:*

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	The ID of the DataWorks workspace to which the destination data source belongs. You can call the ListProjects operation to obtain the workspace ID.	100001
DatasourceName	string	Yes	The name of the destination data source.	mysql_name
EnvType	string	Yes	The environment to which the destination data source belongs. Valid values: 0: development environment. 1: production environment.	1
ResourceGroup	string	Yes	The identifier of the resource group used by the destination data source. You can call the ListResourceGroups operation to obtain the identifier of the resource group.	S_res_group_2XXXX4_1619100XXXXX

Response elements

Element	Type	Description	Example
	object	The response data structure.
Success	boolean	Indicates whether the request is successful. Valid values: true: The request is successful. false: The request fails.	true
RequestId	string	The unique ID of the request. You can use the ID to locate logs and troubleshoot issues when an error occurs.	0000-ABCD-EFG
TaskList	object	The results of the network connectivity test between the data source and the resource group.
ConnectMessage	string	The cause of the failure if the network connectivity test between the destination data source and the resource group fails. If the test is successful, this parameter is left empty.	Connectable
ConnectStatus	boolean	The result of the network connectivity test between the destination data source and the resource group. Valid values: true: The network connectivity test is successful. false: The network connectivity test fails. You can check the ConnectMessage parameter to locate the cause of the failure.	true

Examples

Success response

JSON format

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

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.