Querying Parameter Templates¶
Function¶
This API is used to obtain parameter templates, including all databases' default and custom parameter templates. Before calling this API:
Learn how to authorize and authenticate it.
Obtain the required region and endpoint.
URI¶
URI format
GET https://{endpoint}/mysql/v3/{project_id}/configurations?offset={offset}&limit={limit}
URI example
Parameter description
Table 1 Parameter description¶ Name
Mandatory
Type
Description
project_id
Yes
String
Project ID of a tenant in a region.
To obtain this value, see Obtaining a Project ID.
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. |
X-Language | No | String | Language. |
Content-Type | Yes | String | MIME type of the request body. You are advised to use the default value application/json. For APIs used to upload objects or images, the value can vary depending on the flow type. |
Response Parameters¶
Status code: 200
Parameter | Type | Description |
|---|---|---|
configurations | Array of ConfigurationSummary objects | Parameter template information. |
total_count | Integer | Total number of parameter templates. |
Parameter | Type | Description |
|---|---|---|
id | String | Parameter template ID. |
name | String | Parameter template name. |
description | String | Parameter template description. |
datastore_version_name | String | DB version name. |
datastore_name | String | DB name. |
created | String | Creation time in the "yyyy-MM-ddTHH:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. |
updated | String | Update time in the "yyyy-MM-ddTHH:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. |
user_defined | Boolean | Whether the parameter template is a custom template.
|
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¶
GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/configurations
Example Response¶
Status code: 200
Success.
{
"total_count" : 1,
"configurations" : [ {
"id" : "887ea0d1bb0843c49e8d8e5a09a95652pr07",
"name" : "configuration_test",
"description" : "configuration_test",
"datastore_version_name" : "8.0",
"datastore_name" : "GaussDB(for MySQL)",
"created" : "2019-05-15T11:53:34+0000",
"updated" : "2019-05-15T11:53:34+0000",
"user_defined" : true
}, {
"id" : "3bc1e9cc0d34404b9225ed7a58fb284epr07",
"name" : "Default-TaurusDB V2.0",
"description" : "Default parameter template for TaurusDB",
"datastore_version_name" : "8.0",
"datastore_name" : "GaussDB(for MySQL)",
"created" : "2019-05-27T03:38:51+0000",
"updated" : "2019-05-27T03:38:51+0000",
"user_defined" : false
} ]
}
Status Code¶
For details, see Status Codes.
Error Code¶
For details, see Error Codes.