Viewing Parameter Change History

Function

This API is used to view the parameter change history. Before calling this API:

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

URI

GET /v3/{project_id}/configurations/{configuration_id}/modify-history

**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 can contain 32 characters. Only letters and digits are allowed. Default value: N/A
configuration_id	Yes	String	Definition: Parameter template ID. Constraints: It must be the ID of the parameter template corresponding to the instance. Range: To obtain this value, see Querying Details of a DB Instance. After the request is processed, this parameter value is the value of configuration_id in the response body. Default value: N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Definition: Index offset. The query starts from the next piece of data indexed by this parameter. Constraints: The value cannot be a negative number. Range: ≥ 0 Default value: 0
limit	No	Integer	Definition: Number of records to be queried. Constraints: The value cannot be a negative number. Range: 1–100 Default value: 100

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition: User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints: N/A Range: N/A Default value: N/A
X-Language	No	String	Definition: Request language type. Constraints: N/A Range: en-us zh-cn Default value: en-us

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_count	Integer	Definition: Total number of modified parameters. Range: N/A
histories	Array of ParamGroupHistoryResponse objects	Definition: Change history of the parameter template.

**Table 5** ParamGroupHistoryResponse
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: Update results. Range: N/A
is_applied	Boolean	Definition: Whether the changed template is applied. Range: true: The changed template is applied. false: The changed template is not applied.
updated	String	Definition: Time when the template was modified. The format is yyyy-mm-ddThh:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, if the time zone offset is one hour, the value of Z is +0100. Range: N/A
applied	String	Definition: Time when the template was applied. The format is yyyy-mm-ddThh:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, if the time zone offset is one hour, the value of Z is +0100. Range: N/A

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Viewing parameter change history

GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/configurations/7625c6a12d884be1891c61d921e0e114pr07/modify-history

Example Response

Status code: 200

Success.

{
  "total_count" : 2,
  "histories" : [ {
    "parameter_name" : "binlog_rows_query_log_events",
    "old_value" : false,
    "new_value" : true,
    "update_result" : "SUCCESS",
    "is_applied" : true,
    "updated" : "2023-07-10T02:14:28+0000",
    "applied" : "2023-07-10T02:14:28+0000"
  }, {
    "parameter_name" : "block_encryption_mode",
    "old_value" : "aes-256-cbc",
    "new_value" : "aes-128-cfb1",
    "update_result" : "SUCCESS",
    "is_applied" : true,
    "updated" : "2023-07-10T02:14:28+0000",
    "applied" : "2023-07-10T02:14:28+0000"
  } ]
}