Querying Parameter Templates

Function

This API is used to query 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

GET /v3/{project_id}/configurations

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Explanation: Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints: None Value range: The value can contain 32 characters. Only letters and digits are allowed. Default value: None

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Explanation: 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. Value range: ≥0 Default value: 0
limit	No	Integer	Explanation: Number of records to be queried. Constraints: The value must be an integer and cannot be a negative number. Value range: 1–100 Default value: 100

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Explanation: User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the token value. Constraints: None Value range: None Default value: None
X-Language	No	String	Explanation: Request language type. Constraints: None Value range: en-us zh-cn Default value: en-us

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
configurations	Array of ConfigurationSummary objects	Explanation: Parameter template information.
total_count	Integer	Explanation: Total number of parameter templates. Value range: ≥0

**Table 5** ConfigurationSummary
Parameter	Type	Description
id	String	Explanation: Parameter template ID. Value range: The value can contain 36 characters, starting with a UUID and ending with pr07. Only letters and digits are allowed.
name	String	Explanation: Parameter template name. Value range: None
datastore_version_name	String	Explanation: DB version. Value range: 8.0
datastore_name	String	Explanation: Database name. Value range: GaussDB(for MySQL)
created	String	Explanation: Time when the parameter template was created. The format is "yyyy-MM-ddTHH:mm:ssZ". T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, if the time zone offset is one hour, the value of Z is +0100. Value range: None
updated	String	Explanation: Time when the parameter template was updated. The format is "yyyy-MM-ddTHH:mm:ssZ". T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, if the time zone offset is one hour, the value of Z is +0100. Value range: None
user_defined	Boolean	Explanation: Whether the parameter template is a custom template. Value range: false: The parameter template is a default template. true: The parameter template is a custom template.
description	String	Explanation: Parameter template description. Value range: None

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Querying parameter templates

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/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-GaussDBforMySQL",
    "description" : "Default parameter template for GaussDBforMySQL",
    "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
  } ]
}