测试数据库连接 - CheckDbConnection
功能介绍
功能介绍:测试数据库连接是否可用,校验数据库类型、连接信息及账号权限,返回连接测试结果。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v1/{project_id}/sdg/server/test-connection
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 不涉及 取值范围: 以IAM服务接口返回值为准,长度为32个字符,满足正则匹配"^[a-z0-9]{32}$" 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于接口请求的身份认证。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| db_type | 是 | String | 参数解释: 数据库类型 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| db_version | 否 | String | 参数解释: 数据库版本号 约束限制: 最大长度256字符 取值范围: 不涉及 默认取值: 不涉及 |
| connect_info | 否 | ConnectInfo object | 参数解释: 数据库连接信息 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| use_db_url | 否 | Boolean | 参数解释: 是否使用数据库URL 约束限制: 不涉及 取值范围: true-是,false-否 默认取值: 不涉及 |
| db_url | 否 | String | 参数解释: 数据库连接URL 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| id | 否 | String | 参数解释: 资源ID,标识数据库资源实例,可通过查询数据源列表接口获取 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| ins_type | 否 | String | 参数解释: 连接信息类型 约束限制: 最大长度65535字符 取值范围: 默认取值: 不涉及 |
| region | 否 | String | 参数解释: 连接区域 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| ds_name | 否 | String | 参数解释: 数据源名称 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| ds_type | 否 | String | 参数解释: 数据源类型 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| ds_address | 否 | String | 参数解释: 数据源IP地址 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| ds_port | 否 | Integer | 参数解释: 数据源端口 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| ds_user | 否 | String | 参数解释: 数据源用户名 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| ds_version | 否 | String | 参数解释: 数据源版本 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| ds_password | 否 | String | 参数解释: 数据源密码 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| ins_id | 否 | String | 参数解释: 实例ID 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| ins_name | 否 | String | 参数解释: 实例名称 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| subnet_id | 否 | String | 参数解释: 子网ID 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| vpc_id | 否 | String | 参数解释: VPC ID 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| security_group_id | 否 | String | 参数解释: 安全组ID 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| asset_name | 否 | String | 参数解释: 资产名称 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| owner_account_id | 否 | String | 参数解释: 归属成员账号ID 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| owner_project_id | 否 | String | 参数解释: 归属账号所在项目ID 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| project_id | 否 | String | 参数解释: 项目ID 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| create_time | 否 | Long | 参数解释: 创建时间,Unix时间戳,单位为毫秒 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| scan_metadata | 否 | Boolean | 参数解释: 是否扫描元数据 约束限制: 不涉及 取值范围: true-是,false-否 默认取值: 不涉及 |
| is_external | 否 | Boolean | 参数解释: 是否为外部数据库 约束限制: 不涉及 取值范围: true-是,false-否 默认取值: 不涉及 |
| rds_one_key_authorization | 否 | Boolean | 参数解释: RDS一键授权 约束限制: 不涉及 取值范围: true-是,false-否 默认取值: 不涉及 |
| service_name | 否 | String | 参数解释: 服务名称 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| sid | 否 | String | 参数解释: 数据库SID 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| label_id | 否 | String | 参数解释: 标签ID 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
请求示例
测试数据库连接请求体
{
"db_type" : "MYSQL",
"db_version" : "8.0",
"connect_info" : {
"ds_address" : "10.0.0.10",
"ds_port" : 3306,
"ds_name" : "customer_db",
"ds_user" : "db_user",
"ds_password" : "******"
}
} 响应示例
状态码:200
{
"status" : "success",
"msg" : "测试数据库连接成功",
"id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 操作成功 |
错误码
请参见错误码。