Updated on 2025-09-04 GMT+08:00

Comparing Parameter Templates

Function

This API is used to compare two parameter templates.

Constraints

This API supports the following instance types:

  • 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.

URI

POST https://{Endpoint}/v3/{project_id}/configurations/comparison

Table 1 URI parameter

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:

N/A

Values:

N/A

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Explanation:

User token

Constraints:

N/A

Values:

N/A

Default value:

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

source_configuration_id

Yes

String

Explanation:

ID of the source parameter template to be compared.

Constraints:

N/A

Values:

N/A

Default value:

N/A

target_configuration_id

Yes

String

Explanation:

ID of the destination parameter template for comparison.

Constraints:

N/A

Values:

N/A

Default value:

N/A

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

differences

Array of Table 5 objects

Explanation:

Differences between parameters.

Values:

N/A

Table 5 DiffDetails

Parameter

Type

Description

parameter_name

String

Explanation:

Parameter name.

Values:

N/A

source_value

String

Explanation:

Parameter value in the source parameter template.

Values:

N/A

target_value

String

Explanation:

Parameter value in the destination parameter template.

Values:

N/A

Example Request

  • URI example
    POST https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/comparison 
  • Comparing a source parameter template with the target parameter template
    { 
      "source_configuration_id" : "0764fdcd949b411ba76c2b762b80c212pr06", 
      "target_configuration_id" : "fa42c57bb62844e490052f2ff9d5a264pr06" 
    }

Example Response

Status code: 202

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.