Querying Details About a Parameter Template

Function

This API is used to query details about a parameter template based on the parameter template ID. Before calling this API:

Learn how to authenticate this API.
Obtain the required region and endpoint.

URI

GET https://{Endpoint}/v3/{project_id}/configurations/{config_id}

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Explanation: Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID. Restrictions: None Value range: The value can contain 32 characters. Only letters and digits are allowed. Default value: None
config_id	Yes	String	Parameter template ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. You can obtain the token by calling the IAM API used to obtain a user token. After the request is processed, the value of X-Subject-Token in the message header is the token value.
X-Language	No	String	Language. Default value: en-us Values: zh-cn en-us

Response Parameters

**Table 3** Parameter description
Parameter	Type	Description
id	String	Parameter template ID.
name	String	Parameter template name.
description	String	Parameter template description.
engine_version	String	Engine version.
instance_mode	String	Deployment model. Value: ha: primary/standby independent: independent
created_at	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. For example, in the Beijing time zone, the offset is +0800.
updated_at	String	Modification 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. For example, in the Beijing time zone, the offset is +0800.
configuration_parameters	Array of objects	Parameter details. For details about the parameters, see Table 4.

**Table 4** configuration_parameters field data structure description
Parameter	Type	Description
name	String	Name of a specific parameter.
value	String	Value of a specific parameter.
need_restart	Boolean	Whether the instance needs to be rebooted. true: Instance needs to be rebooted. false: Instance does not need to be rebooted.
readonly	Boolean	Whether the parameter is read-only. true: read only false: editable
value_range	String	Parameter value range.
data_type	String	Parameter type. The value can be string, integer, boolean, list, all, or float.
description	String	Parameter description.

Example Request

Querying details about a parameter template

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/configurations/3ca44134a16d4bbab8eb701e025b19f7pr14

Example Response

Parameter template details queried.

{
         "id": "3ca44134a16d4bbab8eb701e025b19f7pr14",
         "name": "GaussDB_2b87a799-515",
         "description": "ParamGroup for instance.",
          "engine_version": "2.3",
          "instance_mode": "ha",
          "created_at": "2022-08-05T08:15:07+0800",
          "updated_at": "2022-08-09T03:06:52+0800",
          "configuration_parameters": [
                {
                     "name": "audit_system_object",
                     "value": "12294",
                     "need_restart": false,
                     "readonly": false,
                     "value_range": "1-65536",
                     "data_type": "integer",
                     "description": "This parameter determines whether to audit the CREATE, DROP, and ALTER operations on GaussDB Kernel database objects. GaussDB Kernel database objects include DATABASE, USER, SCHEMA, and TABLE. You can change the value of this parameter to audit only the operations on required database objects. In scenarios where a standby node is forcibly elected as primary, you are advised to set audit_system_object to the maximum value and audit all DDL objects. Improper modification of this parameter will cause loss of DDL audit logs. Contact the customer service to change the parameter value."
                  }
           ]
}