Updated on 2026-09-22 GMT+08:00

Comparing Parameter Templates

Function

This API is used to compare two parameter templates.

Constraints

This API supports the following instances:

GeminiDB Cassandra
GeminiDB Mongo
GeminiDB Influx instance with classic storage
GeminiDB Redis instance with classic storage

This API only compares parameter templates with the same node type, storage type, and DB engine.

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

gaussdbfornosql:configuration:compare

Read

-

-

nosql:param:list

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
gaussdbfornosql:configuration:compare	Read	-	-	nosql:param:list	-

URI

POST /v3/{project_id}/configurations/comparison

**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

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication. Constraints N/A Range N/A Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
source_configuration_id	Yes	String	Definition ID of the source parameter template to be compared. To obtain the value, see Obtaining Parameter Templates. Constraints N/A Range N/A Default Value N/A
target_configuration_id	Yes	String	Definition ID of the destination parameter template for comparison. To obtain the value, see Obtaining Parameter Templates. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
differences	Array of Table 5 objects	Definition Differences between parameters.

**Table 5** DiffDetails
Parameter	Type	Description
parameter_name	String	Definition Parameter name. Range N/A
source_value	String	Definition Parameter value in the source parameter template. Range N/A
target_value	String	Definition Parameter value in the destination parameter template. Range N/A

Example Requests

Comparing a source parameter template with the target parameter template

POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/comparison 

{ 
  "source_configuration_id" : "0764fdcd949b411ba76c2b762b80c212pr06", 
  "target_configuration_id" : "fa42c57bb62844e490052f2ff9d5a264pr06" 
}

Example Responses

Status code: 200

Accepted

{ 
  "differences" : [ { 
    "parameter_name" : "batch_size_fail_threshold_in_kb", 
    "source_value" : "1000", 
    "target_value" : "5000" 
  } ] 
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Parameter Configuration