Tests the connectivity of an instance.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| InstanceResourceId |
string |
No |
The ID of the Alibaba Cloud database instance. |
rm-bp1p**** |
| DbType |
string |
No |
The database type. For valid values, see DbType parameter description. |
polardb |
| Region |
string |
No |
The region ID of the instance. |
cn-hangzhou |
| Account |
string |
No |
The account name. |
1878076129455271 |
| Password |
string |
No |
The database password. |
****** |
| Id |
string |
No |
The instance ID. |
24*** |
| InstanceSource |
string |
No |
The instance source. |
RDS |
| Host |
string |
No |
The endpoint of the instance. |
xxx.mysql.rds.aliyuncs.com |
| Port |
string |
No |
The connection port of the database. |
3306 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
The request ID. |
31853A2B-DC9D-5B39-8492-D2AC8BCF550E |
| ErrorCode |
string |
The error code returned if the request failed. |
UnknownError |
| ErrorMessage |
string |
The error message returned if the call failed. |
Specified parameter PageSize is not valid. |
| Success |
boolean |
Indicates whether the request was successful. |
true |
| PingResult |
object |
The returned result. |
|
| ErrorType |
string |
The error type. |
ACCESS_DENIED |
| Success |
boolean |
Indicates whether the request was successful. Valid values:
|
True |
| Title |
string |
The title. |
Access denied |
| Message |
string |
The error message returned if the execution failed. |
successful! |
Examples
Success response
JSON format
{
"RequestId": "31853A2B-DC9D-5B39-8492-D2AC8BCF550E",
"ErrorCode": "UnknownError",
"ErrorMessage": "Specified parameter PageSize is not valid.",
"Success": true,
"PingResult": {
"ErrorType": "ACCESS_DENIED",
"Success": true,
"Title": "Access denied",
"Message": "successful!"
}
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.