Querying Databases

Function

This API is used to query databases of a GaussDB(for MySQL) instance. Before calling this API:

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

URI

GET /v3/{project_id}/instances/{instance_id}/databases

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Explanation: Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints: None Value range: The value can contain 32 characters. Only letters and digits are allowed. Default value: None
instance_id	Yes	String	Explanation: Instance ID, which uniquely identifies an instance. Constraints: None Value range: The value can contain 36 characters with a suffix of in07. Only letters and digits are allowed. Default value: None

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Explanation: Index offset. The query starts from the next piece of data indexed by this parameter. Constraints: The value must be an integer and cannot be a negative number. Value range: ≥0 Default value: 0
limit	No	Integer	Explanation: Number of records to be queried. Constraints: The value must be an integer and cannot be a negative number. Value range: 1–100 Default value: 100
name	No	String	Explanation: Database name. Constraints: None Value range: None Default value: None
charset	No	String	Explanation: Character set used by the database. To obtain this value, see Querying Available Database Character Sets. Constraints: None Value range: None Default value: None

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Explanation: User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the token value. Constraints: None Value range: None Default value: None
X-Language	No	String	Explanation: Request language type. Constraints: None Value range: en-us zh-cn Default value: en-us

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
databases	Array of ListGaussMysqlDatabaseInfo objects	Explanation: Database list.
total_count	Integer	Explanation: Total number of databases. Value range: ≥0

**Table 5** ListGaussMysqlDatabaseInfo
Parameter	Type	Description
name	String	Explanation: Database name. Value range: None
charset	String	Explanation: Character set used by the database. Value range: None
comment	String	Explanation: Database remarks. Value range: None
users	Array of GaussMySqlDatabaseInfo objects	Explanation: List of authorized database users.

**Table 6** GaussMySqlDatabaseInfo
Parameter	Type	Description
name	String	Explanation: Database username. Value range: None
host	String	Explanation: Host IP address. Value range: None
readonly	Boolean	Explanation: Whether the permission is read-only. Value range: true: read-only false: read/write

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Querying databases

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a23fb62bd61e4e9e9636fd2225f395bein07/databases?offset=0&limit=100&charset=utf8mb4&name=test

Example Response

Status code: 200

Success.

{
  "databases" : [ {
    "name" : "test",
    "charset" : "utf8mb4",
    "comment" : "database_comment",
    "users" : [ {
      "name" : "gaussdb-mysql-instance1",
      "host" : "127.0.0.1",
      "readonly" : false
    } ]
  } ],
  "total_count" : 1
}