Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Parameter Configuration/ Obtaining the Differences of Two Parameter Templates
Updated on 2025-08-11 GMT+08:00
View PDF
Share

Obtaining the Differences of Two Parameter Templates

Function

This API is used to obtain the differences of two parameter templates. Before calling this API:

URI

POST /v3/{project_id}/configurations/comparison

Table 1 Parameter description

Name

Mandatory

Description

project_id

Yes

Definition

Project ID of a tenant in a region.

To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 32 characters. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 Parameter description

Name

Mandatory

Type

Description

source_id

Yes

String

Definition

ID of the source parameter template to be compared.

Constraints

N/A

Range

The value can contain 36 characters. Only letters and digits are allowed.

Default Value

N/A

target_id

Yes

String

Definition

ID of the target parameter template to be compared. The deployment model of the target parameter template must be the same as that of the source parameter template.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Table 3 Parameter description

Parameter

Type

Description

differences

Array of objects

Definition

Differences between parameter templates.

For details, see Table 4.
Table 4 differences field data structure description

Parameter

Type

Description

name

String

Definition

Parameter name.

Range

N/A

source_value

String

Definition

Parameter value of the source parameter template.

Range

N/A

target_value

String

Definition

Parameter value of the target parameter template.

Range

N/A

Example Request

Obtaining the differences of two parameter templates 
POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/configurations/comparison
{
  "source_id" : "3e9f722f27c9477089bdf576b33f9d8epr14", 
  "target_id" : "a51fcdde022a4ea8a016a3c4671644f4pr14"
}

Example Response

Differences of two parameter templates queried. 
{
  "differences" : [ { 
    "name" : "audit_system_object", 
    "source_value" : "12289", 
    "target_value" : "12295" 
  } ]
}

Status Codes

Error Codes

For details, see Error Codes.

Parent topic: Parameter Configuration