Querying Databases

Function

This API is used to query databases of a specified DB instance.

• Before calling this API, learn how to authenticate it.
• Before calling this API, learn about request header parameters.

Constraints

• This operation cannot be performed when the DB instance is in the abnormal state.
• The details about databases of read replicas cannot be queried.

URI

• URI format

  GET /v3/{project_id}/instances/{instance_id}/database/detail?page={page}&limit={limit}

Request

• Request parameters

  None

Response

• Normal response

  Table 2 Parameters

  Parameter	Type	Description
  databases	Array of objects	Definition Each element in the list indicates a database. For details, see Table 3.
  total_count	Integer	Definition Indicates the total number of databases. Range N/A

  Table 3 databases element structure description

  Parameter	Type	Description
  name	String	Definition Indicates the database name. Range N/A
  owner	String	Definition Indicates the database owner. Range N/A
  character_set	String	Definition Indicates the character set used by the database, such as UTF8. Range N/A
  collate_set	String	Definition Indicates the database collation, such as en_US.UTF-8. Range N/A
  size	Integer	Definition Indicates the database size, in bytes. Range N/A

• Example normal response

  {
      "databases": [
          {
              "name": "rds_test",
              "owner": "root",
              "character_set": "UTF8",
              "collate_set":"en_US.UTF-8",
              "size":10777247
          },
         {
             "name": "rds_test2",
             "owner":"root",
             "character_set": "UTF8",
             "collate_set":"en_US.UTF-8",
             "size":1055623
          },
         {
             "name": "rds_test3",
             "owner":"root",
             "character_set": "UTF8",
             "collate_set":"en_US.UTF-8",
             "size":107772488
         }
      ],
      "total_count": 3
  }

• Abnormal response

  For details, see Abnormal Request Results.

Status Code

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.