Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Parameter Configuration/ Querying Change History of a Parameter Template
Updated on 2024-08-20 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 https://{Endpoint}/v3/{project_id}/configurations/{config_id}/histories

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.

offset

No

Integer

Index offset. If offset is set to N, the resource query starts from the N+1 data entry. The default value is 0, indicating that the query starts from the first data entry. The value cannot be a negative number. For example, if this parameter is set to 0 and limit is set to 10, only the 1st to 10th records are displayed.

limit

No

Integer

Number of records to be queried. The default value is 100. The value cannot be a negative number. The minimum value is 1 and the maximum value is 100. For example, if this parameter is set to 10, a maximum of 10 records can be displayed.

Request Parameters

None

Response Parameters

Table 2 Parameter description

Parameter

Type

Description

histories

Array of objects

Parameter template information. For details, see Table 3.

total_count

Integer

Total number of records.

Table 3 histories field data structure description

Parameter

Type

Description

parameter_name

String

Parameter name.

old_value

String

Old parameter value.

new_value

String

New parameter value.

update_result

String

Change status.

  • SUCCESS
  • FAILED

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.

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 Code

Error Code

For details, see Error Codes.