Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Parameter Configuration/ Querying Change History of a Parameter Template
Updated on 2025-08-11 GMT+08:00

Querying Change History of a Parameter Template

Function

This API is used to query the change history of a parameter template. Before calling this API:

URI

GET /v3/{project_id}/configurations/{config_id}/histories

Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

config_id

Yes

String

Definition

Parameter template ID.

Constraints

N/A

Range

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

Default Value

N/A

offset

No

Integer

Definition

Index offset. The query starts from the next piece of data indexed by this parameter. For example, if this parameter is set to 0 and limit is set to 10, only the 1st to 10th data records are displayed.

Constraints

N/A

Range

[0,2^31-1]

Default Value

0: The query starts from the first data record.

limit

No

Integer

Definition

Number of records returned by a query. For example, if this parameter is set to 10, a maximum of 10 records can be displayed.

Constraints

N/A

Range

[1, 100]

Default Value

100

Request Parameters

None

Response Parameters

Table 2 Parameter description

Parameter

Type

Description

histories

Array of objects

Definition

Parameter template information. For details, see Table 3.

total_count

Integer

Definition

Total number of records.

Range

N/A

Table 3 histories field data structure description

Parameter

Type

Description

parameter_name

String

Definition

Parameter name.

Range

N/A

old_value

String

Definition

Old parameter value.

Range

N/A

new_value

String

Definition

New parameter value.

Range

N/A

update_result

String

Definition

Change status.

Range

  • SUCCESS
  • FAILED

updated_at

String

Definition

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.

Range

N/A

Example Request

Querying the change history of a parameter template

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

Example Response

Change history of the parameter template queried.

{ 
   "histories" : [ { 
     "parameter_name" : "audit_system_object", 
     "old_value" : "12295", 
     "new_value" : "12298", 
     "update_result" : "SUCCESS", 
     "updated_at" : "2022-08-09T03:06:52+0800" 
   } ], 
   "total_count" : 1 
 }

Status Codes

Error Codes

For details, see Error Codes.