查询数据库列表

功能介绍

查询指定实例中的数据库。

• 调用接口前，您需要了解API 认证鉴权。
• 调用接口前，您需要提前获取到地区和终端节点，即下文中的Endpoint值。

接口约束

• 实例在异常状态下不能执行该操作。
• 不支持查询只读实例的数据库用户列表。

URI

• URI格式

  GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/database/detail?page={page}&limit={limit}&db-name={db-name}

• 参数说明

  表1 参数说明

  名称	是否必选	说明
  project_id	是	租户在某一region下的project ID。 获取方法请参见获取项目ID。
  instance_id	是	实例ID。
  page	是	分页页码，从1开始。
  limit	是	每页数据条数。取值范围[1, 100]。
  db-name	否	数据库名。当指定该参数时，page和limit参数需要传入但不生效。

请求消息

无。

响应消息

• 正常响应要素说明

  表2 要素说明

  名称	参数类型	说明
  databases	Array of objects	列表中每个元素表示一个数据库。 详情请参见表3。
  total_count	Integer	数据库总数。

  表3 databases元素结构说明

  名称	参数类型	说明
  name	String	数据库名称。
  character_set	String	数据库使用的字符集，例如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
  }

• 异常响应

  请参见异常请求结果。

状态码

请参见状态码。

错误码

请参见错误码。