Querying Database Schemas

Function

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

• Before calling an API, you need to understand the API in Authentication.

Constraints

• This operation cannot be performed when the DB instance is in the abnormal or frozen state.
• The database schemas of read replicas cannot be queried.

URI

• URI format

  GET /v3/{project_id}/instances/{instance_id}/schema/detail?db_name={name}&page={page}&limit={limit}

Request

• Request parameters

  None

• URI example

  GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/schema/detail?db_name=rds_test&page=1&limit=10

Response

• Normal response

  Table 2 Parameter description

  Name	Type	Description
  database_schemas	Array of objects	Each element in the list indicates a database schema. For details, see Table 3.
  total_count	Integer	Indicates the total number of database schemas.

  Table 3 users element structure description

  Name	Type	Description
  schema_name	String	Indicates a schema name.
  owner	String	Indicates a schema owner.

• Example normal response

  {
    "database_schemas": [{
      "schema_name": "rds_user1",
      "owner": "root"
    }],
  "total_count": 1
  }

Status Code

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.