查询所有数据库(废弃)
功能介绍
该API用于查询出所有的数据库信息。
当前接口已废弃,不推荐使用。
调试
您可以在API Explorer中调试该接口。
URI
- URI格式:
- 参数说明
表1 URI参数 参数名称
是否必选
参数类型
说明
project_id
是
String
项目编号,用于资源隔离。获取方式请参考获取项目ID。
表2 query参数 参数名称
是否必选
参数类型
说明
with-priv
否
Boolean
是否显示权限信息,取值为“true”或者“false”,默认为“false”。
offset
否
Integer
偏移量,取值需要大于等于0,默认值为0。
limit
否
Integer
返回的数据条数,取值需要大于等于0,默认返回所有数据。
keyword
否
String
数据库名过滤关键字,模糊匹配,获取数据库名含有该关键字的所有数据库。
tags
否
String
数据库标签。格式为“key=value”,例如:
- 单标签场景:
GET /v1.0/{project_id}/databases?offset=0&limit=10&with-priv=true&tags=k1%3Dv1
其中,“=”需要转义为“%3D”,“k1”为标签键,“v1”为标签值。
- 多标签场景:
如果涉及到多个标签的场景,则多个标签之间需要通过“,”号分隔,“,”号需要转义为“%2C”,例如:
GET /v1.0/{project_id}/databases?offset=0&limit=10&with-priv=true&tags=k1%3Dv1%2Ck2%3Dv2
其中,“=”需要转义为“%3D”,“k1”为标签键1,“v1”为标签值1,“k2”为标签键2,“v2”为标签值2。
注意:当前只支持所有tags值整体的模糊查询,不支持精确查询。
带入query参数的URL示例如下:
GET /v1.0/{project_id}/databases?with-priv={is_with_priv}&offset={offsetValue}&limit={limitValue}&keyword={keywordValue}?tags={tagsValue}
请求消息
无
响应消息
参数名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
is_success |
否 |
Boolean |
执行请求是否成功。“true”表示请求执行成功。 |
message |
否 |
String |
系统提示信息,执行成功时,信息可能为空。 |
database_count |
否 |
Integer |
数据库的总数。 |
databases |
否 |
Array of objects |
数据库信息。具体参数请参见表4。 |
参数名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
database_name |
否 |
String |
数据库名称。 |
owner |
否 |
String |
数据库的创建者。 |
table_number |
否 |
Integer |
数据库中表的个数。 |
description |
否 |
String |
数据库相关的描述信息。 |
enterprise_project_id |
是 |
String |
企业项目ID,“0”表示default,即默认的企业项目。关于如何设置企业项目请参考《企业管理用户指南》。
说明:
开通了企业管理服务的用户可设置该参数绑定指定的项目。 |
resource_id |
是 |
String |
资源ID。 |
请求示例
无
响应示例
{ "is_success": true, "message": "", "database_count": 1, "databases": [ { "database_name": "db2", "description": "this is for test", "owner": "tenant1", "table_number": 15 } ] }
错误码
调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码。