CheckJDBCSourceNetConnection - AnalyticDB - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Check the network connectivity of the JDBC connection string

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
gpdb:CheckJDBCSourceNetConnection	none	*DBInstance `acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region where the instance is located.	cn-hangzhou
DBInstanceId	string	Yes	Instance ID.	gp-xxxxxxx
JdbcConnectionString	string	No	JDBC connection string.	jdbc:mysql://rm-xxx.mysql.rds.aliyuncs.com:3306/testadmin
DataSourceId	string	No	Either DataSourceId or JdbcConnectionString must be specified as input, otherwise an error will occur. If both parameters are specified, JdbcConnectionString will be used preferentially.	123

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	Request ID.	B4CAF581-2AC7-41AD-8940-D56DF7AADF5B
ConnectionStatus	string	Service status: Network connected: Success Network not connected: Failed	Success
ConnectionMessage	string	Return message: Error message returned when the connection fails, otherwise returns an empty string ("").	connection timeout

Examples

Sample success responses

JSONformat

{
  "RequestId": "B4CAF581-2AC7-41AD-8940-D56DF7AADF5B",
  "ConnectionStatus": "Success",
  "ConnectionMessage": "connection timeout"
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-08-20	The request parameters of the API has changed	View Change Details