# 测试数据库连接 - CheckDbConnection #### 功能介绍 功能介绍：测试数据库连接 #### 接口约束 - 无特殊约束。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dsc/dsc_02_0008.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dsc/dsc_02_0031.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI POST /v1/{project_id}/sdg/server/test-connection 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID。可参考获取项目ID获取。 **约束限制：** 不涉及 **取值范围：** 以IAM服务接口返回值为准，字符长度32-32，满足正则匹配"\^\[a-z0-9\]{32}$" **默认取值：** 不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及 **取值范围：** IAM服务查询用户Token接口为准 **默认取值：** 不涉及 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | db_type | 否 | String | **参数解释：** 数据库类型 **约束限制：** 不涉及 **取值范围：** - "OBS" 对象存储服务 - "MSSQL" SQLServer数据库 - "MYSQL" MySQL数据库 - "ES" Elasticsearch搜索引擎 - "PG" PostgreSQL数据库 - "GREENPLUM" Greenplum数据库 - "ORACLE" Oracle数据库 - "MRS_HIVE" MRS Hive数据仓库 - "HBASE" HBase数据库 - "DWS" 数据仓库服务 - "KINGBASE" 人大金仓数据库 - "OPENGAUSS" 高斯数据库 - "DMDBMS" 达梦数据库 - "Hive" Hive数据仓库 - "MARIADB" MariaDB数据库 - "TAURUS_DB" TaurusDB数据库 - "TDSQL" TDSQL数据库 - "HIVE_ONLY" 仅自建Hive - "DLI" 数据湖探索 - "MONGODB" MongoDB数据库 - "LTS" 日志服务 **默认取值：** 不涉及 | | db_version | 否 | String | **参数解释：** 数据库版本号 **约束限制：** 最大长度256字符 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | status | String | **参数解释：** 请求状态，success为成功。 **取值范围：** 不涉及 | | msg | String | **参数解释：** 提示信息 **取值范围：** 不涉及 | | id | String | **参数解释：** 资源ID **取值范围：** 不涉及 | #### 请求示例 测试数据库连接请求体 ``` { "db_type" : "MYSQL", "db_version" : "8.0" } ``` #### 响应示例 **状态码：200** ``` { "status" : "success", "msg" : "测试数据库连接成功", "id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 操作成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dsc/ErrorCode.html)。