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
|
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. |
|
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
|
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:
|
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
databases |
Array of ListGaussMysqlDatabaseInfo objects |
Database information list. |
|
total_count |
Integer |
Total number of databases. |
|
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. |
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
String |
Database username. |
|
host |
String |
Host IP address. |
|
readonly |
Boolean |
Whether the permission is read-only. Value:
|
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Status code: 500
|
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
