Querying Version Information About a DB Engine
Function
This API is used to query the version information of a specified DB engine. Before calling this API:
- Learn how to authorize and authenticate it.
- Obtain the required region and endpoint.
URI
GET /v3/{project_id}/datastores/{database_name}
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 can contain 32 characters. Only letters and digits are allowed. Default value: N/A |
database_name |
Yes |
String |
Definition: DB engine. Constraints: N/A Range: gaussdb-mysql Default value: N/A |
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 |
---|---|---|
datastores |
Array of MysqlEngineVersionInfo objects |
Definition: DB versions. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition: DB version ID. The value is unique. Range: N/A |
name |
String |
Definition: DB version number. Only the two-number major version is returned. Range: N/A |
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 version information about a TaurusDB instance
GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/datastores/gaussdb-mysql
Example Response
Status code: 200
Success.
{ "datastores" : [ { "id" : "87620726-6802-46c0-9028-a8785e1f1921", "name" : "8.0" } ] }
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.