Querying Databases
Function
This API is used to query databases of a TaurusDB 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 |
Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A |
|
instance_id |
Yes |
String |
Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
offset |
No |
Integer |
Definition 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. Range ≥ 0 Default Value 0 |
|
limit |
No |
Integer |
Definition Number of records to be queried. Constraints The value must be an integer and cannot be a negative number. Range 1–100 Default Value 100 |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A |
|
X-Language |
No |
String |
Definition Request language type. Constraints N/A Range
Default Value en-us |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
databases |
Array of ListGaussMysqlDatabaseInfo objects |
Definition Database list. |
|
total_count |
Integer |
Definition Total number of databases. Range ≥ 0 |
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
String |
Definition Database name. Range N/A |
|
charset |
String |
Definition Character set used by the database. Range N/A |
|
users |
Array of GaussMySqlDatabaseInfo objects |
Definition List of authorized database users. |
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
String |
Definition Database username. Range N/A |
|
host |
String |
Definition Host IP address. Range N/A |
|
readonly |
Boolean |
Definition Whether the permission is read-only. Range
|
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.
