Function

This API is used to query details about a database on a specified DB instance.

• Before calling an API, you need to understand the API in Authentication.
• Before calling this API, obtain the required region and endpoint.

Constraints

Databases cannot be queried when the DB instance is in the abnormal or frozen state.

URI

• URI format

  GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/database

• Example

  https://rds.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/database

• Parameter description

  Table 1 Parameter description

  Name	Mandatory	Description
  project_id	Yes	Specifies the project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID.
  instance_id	Yes	Specifies the DB instance ID.

Request

None

Response

• Normal response

  Table 2 Parameter description

  Name	Type	Description
  databases	Array of objects	Each element in the list indicates a database. For details, see Table 3.

  Table 3 databases element structure description

  Name	Type	Description
  name	String	Indicates the database name.
  character_set	String	Indicates the character set used by the database, such as utf8, gbk, and ascii.
  users	Array of objects	Each element in the list indicates an account associated with the database. For details, see Table 4.

  Table 4 users element structure description

  Name	Type	Description
  name	String	Indicates an account name.
  readonly	Boolean	Indicates the read-only permission. true: indicates the read-only permission. false: indicates the read and write permission.

• Example normal response

  {
      "databases": [
          {
              "name": "rds-test",
              "character_set": "utf8",
              "users": [
                  {
                      "name": "rds",
                      "readonly": false
                  }
              ]
          },
          {
              "name": "testdb1",
              "character_set": "utf8",
              "users": []
          },
          {
              "name": "tt",
              "character_set": "utf8",
              "users": []
          }
      ]
  }

• Abnormal response

  For details, see Abnormal Request Results.

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.