查询数据库列表
调试
您可以在API Explorer中调试该接口。
接口约束
- 实例在异常、冻结或主备切换中状态下不能执行该操作。
- 不支持查询只读实例的数据库列表。
URI
- URI格式
GET /v3/{project_id}/instances/{instance_id}/database/detail?page={page}&limit={limit}&db-name={db-name}&recover_model={recover_model}
- 参数说明
表1 参数说明 名称
是否必选
说明
project_id
是
参数解释：
租户在某一Region下的项目ID。
获取方法请参见获取项目ID。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
instance_id
是
参数解释：
实例ID。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
page
是
参数解释：
分页页码。
约束限制：
不涉及。
取值范围：
从1开始的正整数。
默认取值：
不涉及。
limit
是
参数解释：
每页数据条数。
约束限制：
不涉及。
取值范围：
[1, 100]区间内正整数。
默认取值：
不涉及。
db-name
否
参数解释：
数据库名。
约束限制：
当指定该参数时，page和limit参数需要传入但不生效。
取值范围：
不涉及。
默认取值：
不涉及。
recover_model
否
参数解释：
数据库恢复健康模式。
约束限制：
不涉及。
取值范围：
- FULL：完整模式。
- SIMPLE：简单模式。
- BULK_LOGGED：大容量日志恢复模式。
默认取值：
不涉及。
请求消息
响应消息
- 正常响应要素说明
表2 要素说明 名称
参数类型
说明
databases
Array of objects
参数解释：
列表中每个元素表示一个数据库。
详情请参见表3。
total_count
Integer
参数解释：
数据库总数。
取值范围：
不涉及。
表3 databases元素结构说明 名称
参数类型
说明
name
String
参数解释：
数据库名称。
取值范围：
不涉及。
character_set
String
参数解释：
数据库使用的字符集。
取值范围：
SQL Server支持的字符集列表，请参见表2。
取值示例：Chinese_PRC_CI_AS。
state
String
参数解释：
数据库状态。
取值范围：
- Creating：表示创建中。
- Running：表示使用中。
- Deleting：表示删除中。
- NotExists：表示不存在。
- 正常响应样例
{ "databases": [ { "name": "master", "character_set": "Chinese_PRC_CI_AS", "state": "Running" }, { "name": "msdb", "character_set": "Chinese_PRC_CI_AS", "state": "Running" }, { "name": "model", "character_set": "Chinese_PRC_CI_AS", "state": "Running" }, { "name": "tempdb", "character_set": "Chinese_PRC_CI_AS", "state": "Running" }, { "name": "rdsadmin", "character_set": "Chinese_PRC_CI_AS", "state": "Running" }, { "name": "rds-test", "character_set": "Chinese_PRC_CI_AS", "state": "Running" } ], "total_count": 6 } - 异常响应
请参见异常请求结果。
状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。
