Obtaining Details About a Parameter Template

Function

This API is used to obtain parameter details of a specified parameter template. Before calling this API:

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

Constraints

This API is only available for cluster TaurusDB instances (dedicated edition).

URI

GET /v3/{project_id}/configurations/{configuration_id}

**Table 1** URI parameters
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
configuration_id	Yes	String	Definition Parameter template ID. Constraints N/A Range To obtain this value, see Querying Parameter Templates. Default Value N/A

Request Parameters

**Table 2** Request header 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 en-us zh-cn Default Value en-us

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
configurations	ConfigurationSummary2 object	Definition Parameter template information.
parameter_values	Map<String,String>	Definition Mapping between parameter names and parameter values. You can specify parameter values based on a default parameter template.

**Table 4** ConfigurationSummary2
Parameter	Type	Description
id	String	Definition Parameter template ID. Range The value contains 36 characters, starting with a UUID and ending with pr07. Only letters and digits are allowed.
name	String	Definition Parameter template name. Range The value is the same as the parameter template name in the request.
description	String	Definition Parameter template description. Range The value is the same as the parameter template description in the request.
datastore	DatastoreResult object	Definition Database object.
created	String	Definition 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. Range N/A
updated	String	Definition 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. Range N/A

**Table 5** DatastoreResult
Parameter	Type	Description
type	String	Definition DB engine. Constraints N/A Range Only gaussdb-mysql is supported. Default Value N/A
version	String	Definition Database version. For details about how to obtain the version, see the name field returned in Querying Version Information About a DB Engine. Constraints N/A Range N/A Default Value N/A

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

Obtaining details about a parameter template

GET https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/configurations/7a8d539ba30f43adaf1b16d08b1df4bdpr07

Example Response

Status code: 200

Success.

{
  "configurations" : {
    "id" : "887ea0d1bb0843c49e8d8e5a09a95652pr07",
    "name" : "myparameter",
    "description" : "parameter1",
    "datastore" : {
      "type" : "gaussdb-mysql",
      "version" : "8.0"
    },
    "created" : "2022-05-15T11:53:34+0000",
    "updated" : "2022-05-15T11:53:34+0000"
  },
  "parameter_values" : {
    "binlog_rows_query_log_events" : "OFF",
    "mount_vip_when_failover" : "ON",
    "log-bin" : "ON",
    "gtid_mode" : "ON",
    "enforce_gtid_consistency" : "ON",
    "innodb_online_alter_log_max_size" : "134217728",
    "binlog_gtid_simple_recovery" : "ON",
    "max_user_connections" : "10"
  }
}