查询所有数据库

功能介绍

该API用于查询出所有的数据库信息。

URI

• URI格式：

  GET /v1.0/{project_id}/databases

• 参数说明

  表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": true,
  "message": "",
  "database_count": 1,
  "databases": [
    {
      "database_name": "db2",
      "description": "this is for test",
      "owner": "tenant1",
      "table_number": 15

    }
  ]
}

状态码

状态码如表5所示。

错误码

调用接口出错后，将不会返回上述结果，而是返回错误码和错误信息，更多介绍请参见错误码。