Updated on 2023-10-18 GMT+08:00

Querying Databases

Function

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

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID.

Table 2 Query parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Index offset. If offset is set to N, the resource query starts from the N+1 piece of data. The value is 0 by default, indicating that the query starts from the first piece of data. The value cannot be a negative number.

limit

No

Integer

Number of records to be queried. The default value is 100. The value must be a positive integer. The minimum value is 1 and the maximum value is 100.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

If the following response body is returned for calling the API used to obtain a user token, the request is successful.

After the request is processed, the value of X-Subject-Token in the message header is the token value.

X-Language

No

String

Request language type. The default value is en-us.

Value:

  • en-us
  • zh-cn

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

databases

Array of ListGaussMysqlDatabaseInfo objects

Database information list.

total_count

Integer

Total number of databases.

Table 5 ListGaussMysqlDatabaseInfo

Parameter

Type

Description

name

String

Database name.

charset

String

Database character set, for example, utf8mb4 or gbk.

users

Array of GaussMySqlDatabaseInfo objects

List of authorized database users.

Table 6 GaussMySqlDatabaseInfo

Parameter

Type

Description

name

String

Database username.

host

String

Host IP address.

readonly

Boolean

Whether the permission is read-only.

Value:

  • 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

Example Response

Status code: 200

Success.

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

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.