TestInstanceConnection - 实例测试连接

更新时间:
复制 MD 格式

测试实例连接

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

InstanceResourceId

string

阿里云数据库实例 ID

rm-bp1p****

DbType

string

数据库类型,取值请参见 DbType 参数说明

polardb

Region

string

实例所在的 regionId

cn-hangzhou

Account

string

账号名称

1878076129455271

Password

string

数据库密码。

******

Id

string

实例 id

24***

InstanceSource

string

实例来源

RDS

Host

string

实例连接地址

xxx.mysql.rds.aliyuncs.com

Port

string

数据库的连接端口。

3306

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

31853A2B-DC9D-5B39-8492-D2AC8BCF550E

ErrorCode

string

错误码,请求异常时返回。

UnknownError

ErrorMessage

string

调用失败时,返回的错误信息。

Specified parameter PageSize is not valid.

Success

boolean

请求是否成功。

true

PingResult

object

返回结果

ErrorType

string

错误类型。

ACCESS_DENIED

Success

boolean

请求是否成功,返回值如下:

  • true:请求成功

  • false:请求失败

True

Title

string

标题

Access denied

Message

string

执行失败时,返回的错误信息。

successful!

示例

正常返回示例

JSON格式

{
  "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!"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情