文档首页/ 数据管理服务 DAS/ API参考/ API（公测中）/ 云DBA/ 测试数据库实例连接 - ExecuteTestConnection
更新时间：2025-12-04 GMT+08:00
查看PDF
分享

测试数据库实例连接 - ExecuteTestConnection

功能介绍

测试数据库实例连接。

调试

您可以在API Explorer中调试该接口。

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    das:instance:executeTestConnection

    write

    instance

    -

    das:connections:login

    -

URI

POST /v3/{project_id}/connections/test-connection

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的项目ID。

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

engine_type

是

String

参数解释：

数据库引擎类型。

约束限制：

不涉及。

取值范围：

  • mysql
  • sqlserver
  • postgresql
  • taurus
  • gaussdbv5
  • mongodb
  • ddm

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID。标识实例的唯一标识。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

connection_id

是

String

参数解释：

连接ID。用户使用数据库账号与数据库建立的连接ID（数据库用户ID由创建实例连接接口创建）。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字、中划线组成，且长度为36个字符的UUID。

默认取值：

不涉及

network_type

是

String

参数解释：

数据库来源类型。

约束限制：

不涉及。

取值范围：

  • rds
  • gaussdb
  • dds
  • ddm

默认取值：

不涉及。

username

是

String

参数解释：

用户名。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

password

是

String

参数解释：

密码。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

node_ids

否

Array of strings

参数解释：

节点ID。标识实例节点的唯一标识。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

port

否

Integer

参数解释：

端口。

约束限制：

不涉及。

取值范围：

[1,65536]

默认取值：

不涉及。

database_name

否

String

参数解释：

数据库名字。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

无。

请求示例

POST https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/connections/test-connection 
 
{ 
  "engine_type" : "mysql", 
  "network_type" : "rds", 
  "username" : "root", 
  "connection__id" : "99af0766-c3f4-4e4e-a95e-14a1b070188e", 
  "password" : "xxxxxx",
  "instance_id": "47d0524891964dc48cee42c371928777in01"
}

响应示例

状态码： 200

Success.

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： 云DBA

相关文档