接口功能介绍
检查RDS-MySQL实例的联通性。
接口约束
请先订购RDS-MySQL实例。
URI
POST /v2/rds/detect
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
rdsProdInstId | 是 | String | RDS-MySQL实例ID | 5301 | |
dbUser | 是 | String | RDS-MySQL实例数据库用户 | root | |
dbPassword | 是 | String | RDS-MySQL实例数据库密码 |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
code | 是 | String | 返回码 取值范围:0表示成功,1表示失败 | 0 | |
message | 是 | String | 结果描述 | success |
请求示例
请求头header
无
请求体body
{
"rdsProdInstId" : "5270",
"dbUser" : "root",
"dbPassword" : "*********"
}
响应示例
{
"code": 0,
"message": "success"
}
状态码
请参考 状态码说明。