文档首页/ 分布式数据库中间件 DDM/ API参考/ API（推荐）/ 实例管理/ RDS连通性检查V3
更新时间：2026-06-09 GMT+08:00
查看PDF
分享

RDS连通性检查V3

功能介绍

RDS连通性检查V3

接口约束

无

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    ddm:instance:checkDataNodeConnection

    Read

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    ddm:instance:list

    -

URI

POST /v3/{project_id}/instances/{instance_id}/rds/connection

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID，此参数是实例的唯一标识。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，后缀为in09，长度为36个字符。

默认取值：

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

infos

是

Array of EsdbCheckRdsConnectionRequestV3 objects

参数解释：

RDS连通性检查相关信息的集合。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表3 EsdbCheckRdsConnectionRequestV3

参数

是否必选

参数类型

描述

endpoint

是

String

参数解释：

RDS实例内网IP地址和数据库端口。

格式为xx.xx.xx.xx:xx。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

username

是

String

参数解释：

RDS账号。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

password

是

String

参数解释：

RDS账号密码。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

rds_instance_id

是

String

参数解释：

RDS实例ID，此参数是实例的唯一标识。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，后缀为in01，长度为36个字符。

默认取值：

不涉及。

请求示例

RDS连通性检查。

POST https://{endpoint}/v3/a8e2a5e2a6xxxxxxxxxx5af5b9ddabe5/instances/b7eabbbc6bxxxxxxxxxxadfffa99a7c2in09/rds/connection

{
  "infos" : [ {
    "endpoint" : "***.**.***.***:****",
    "username" : "root",
    "password" : "********",
    "rds_instance_id" : "b944d6e9a8xxxxxxxxxx74e257b83c84in01"
  } ]
}

响应参数

  • 正常响应参数说明
表4 响应Body参数

参数

参数类型

描述

rds_check_infos

Array of CheckRdsConnectionResqVO objects

参数解释：

RDS测试连通性相关信息的集合。

取值范围：

不涉及。
表5 CheckRdsConnectionResqVO

参数

参数类型

描述

rds_instance_id

String

参数解释：

RDS实例ID，此参数是实例的唯一标识。

取值范围：

只能由英文字母、数字组成，后缀为in09，长度为36个字符。

success

String

参数解释：

是否连通。

取值范围：

  • "true": 表示RDS连通性测试已通过。

  • "false": 表示RDS连通性测试未通过。

error_code

String

参数解释：

连通性检查失败错误码。

取值范围：

不涉及。

error_message

String

参数解释：

连通性检查失败原因。

取值范围：

不涉及。

响应示例

  • 正常响应示例 
    {
  "rds_check_infos" : [ {
    "rds_instance_id" : "b3110ddff4xxxxxxxxxx7f2b752cd2a70in01",
    "success" : "true",
    "error_code" : null,
    "error_message" : null
  } ]
}

状态码

错误码

请参见错误码。

父主题： 实例管理