查询RDS实例下的数据库信息
更新时间 2025-09-18 16:25:25
最近更新时间: 2025-09-18 16:25:25
接口功能介绍
查询RDS实例下的数据库信息。
接口约束
无
URI
GET /RDS2/v1/open-api/database/schemas
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| outerProdInstId | 是 | String | 实例ID |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| project-id | 否 | String | 项目id | b829cb71308746a094853c21d5aac0a1 | |
| inst-id | 否 | String | 实例id （和参数outerProdInstId保持一致） | 264729201196525109 | |
| regionId | 是 | String | 资源池regionId，比如实例在资源池A，则需要填写A资源池的regionId | 81f7728662dd11ec810800155d307d5b |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回码 取值范围：0 成功 | 0 | |
| message | String | 返回消息 | ||
| returnObj | Array of Objects | 返回对象 | returnObj | |
| error | String | 错误码。当接口失败时才返回具体错误编码，成功不返回或者为空 | MYSQL_10001 | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| userVOList | Array of Objects | 用户信息列表 | userVO | |
| grantSchema | String | 数据库名称 | ||
| charsetName | String | 字符名 | ||
| collationName | String | 字符排序 | ||
| remark | String | 数据库备注 | ||
| 表 userVO |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| accountName | String | 数据库用户名 | ||
| readOnly | Boolean | 用户读写权限 | ||
| selectPriv | String | 查询权限 | ||
| insertPriv | String | 写入权限 |
枚举参数
无
请求示例
请求url
/RDS2/v1/open-api/database/schemas?outerProdInstId=b829cb71308746a094853c21d5aac0a1
请求头header
无
请求体body
无
响应示例
{
"statusCode": 0,
"message": "success",
"returnObj": [{
"userVOList": [{
"selectPriv": "Y",
"accountName": "lcx2",
"readOnly": true,
"insertPriv": "N"
}],
"grantSchema": "testdb2",
"charsetName" : "uft8",
"collationName": "utf8_general_ci",
"remark": "rmk1"
},
{
"userVOList": [{
"selectPriv": "Y",
"accountName": "lcx",
"readOnly": false,
"insertPriv": "Y"
},
{
"selectPriv": "Y",
"accountName": "lcx2",
"readOnly": true,
"insertPriv": "N"
}
],
"grantSchema": "testdatabase",
"charsetame" : "uft8",
"collationName": "utf8_general_ci",
"remark": "rmk2"
}
]
}
状态码
请参考 状态码
错误码
请参考 错误码
