Updated on 2023-10-18 GMT+08:00

Obtaining Details About a Parameter Template

Function

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

Constraints

This API is available only for GaussDB(for MySQL) primary/standby instances (dedicated edition).

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

configuration_id

Yes

String

Parameter template ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

If the following response body is returned for calling the API used to obtain a user token, the request is successful.

After the request is processed, the value of X-Subject-Token in the message header is the token value.

X-Language

No

String

Request language type. The default value is en-us.

Value:

  • en-us
  • zh-cn

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

configurations

ConfigurationSummary2 object

Parameter template information.

parameter_values

Map<String,String>

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

Parameter template ID.

name

String

Parameter template name.

description

String

Parameter template description.

datastore

DatastoreResult object

Database object.

created

String

Creation time in the "yyyy-MM-ddTHH:mm:ssZ" format.

T is the separator between calendar and 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 calendar and hourly notation of time. Z indicates the time zone offset.

Table 5 DatastoreResult

Parameter

Type

Description

type

String

DB engine. Currently, only gaussdb-mysql is supported.

version

String

DB version. To obtain details about supported DB engine versions, call the API for querying the DB engine versions.

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"
  }
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.