Obtaining a Parameter Template List¶
Function¶
This API is used to obtain the parameter template list, including default parameter templates of all databases and those created by users.
Before calling an API, you need to understand the API in Authentication.
Before calling this API, obtain the required region and endpoint.
Constraints¶
The following DB engines are supported: MySQL, PostgreSQL, and Microsoft SQL Server.
For Microsoft SQL Server, only the following editions are supported: Microsoft SQL Server 2014 SE, 2016 SE, and 2016 EE.
URI¶
URI format
GET https://{Endpoint}/v3/{project_id}/configurations
Parameter description
Table 1 Parameter description¶ Name
Mandatory
Description
project_id
Yes
Specifies the project ID of a tenant in a region.
For details about how to obtain the project ID, see Obtaining a Project ID.
Request¶
GET https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/configurations
Response¶
Normal response
Table 2 Parameter description¶ Name
Type
Description
configurations
Array of objects
Indicates the parameter template list.
For details, see Table 3.
Table 3 configurations field data structure description¶ Name
Type
Description
id
String
Indicates the parameter template ID.
name
String
Indicates the parameter template name.
description
String
Indicates the parameter template description.
datastore_version_name
String
Indicates the database version name.
datastore_name
String
Indicates the database name.
created
String
Indicates the creation time in the following format: yyyy-MM-ddTHH:mm:ssZ.
T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset.
updated
String
Indicates the update time in the following format: yyyy-MM-ddTHH:mm:ssZ.
T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset.
user_defined
Boolean
Indicates whether the parameter template is created by users.
false: The parameter template is a default parameter template.
true: The parameter template is a custom template.
Example normal response
{ "configurations": [{ "id": "887ea0d1bb0843c49e8d8e5a09a95652pr01", "name": "configuration_test", "description": "configuration_test", "datastore_version_name": "5.6", "datastore_name": "mysql", "created": "2019-05-15T11:53:34+0000", "updated": "2019-05-15T11:53:34+0000", "user_defined": true }, { "id": "3bc1e9cc0d34404b9225ed7a58fb284epr01", "name": "Default-MySQL-5.7", "description": "Default parameter group for MySQL 5.7", "datastore_version_name": "5.7", "datastore_name": "mysql", "created": "2019-05-27T03:38:51+0000", "updated": "2019-05-27T03:38:51+0000", "user_defined": false } ] }Abnormal response
For details, see Abnormal Request Results.
Status Code¶
Normal
200
Abnormal
For details, see Status Codes.
Error Code¶
For details, see Error Codes.