Viewing Parameter Change History of an Instance

Function

This API is used to view change history of parameters of an instance.

URI

GET /v3/{project_id}/instances/{instance_id}/configuration-histories

**Table 1** Path parameters
Name	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region.
instance_id	Yes	String	DB instance ID.

**Table 2** Query parameters
Name	Mandatory	Type	Description
offset	No	Integer	The index offset. If offset is set to N, the resource query starts from the N+1 piece of data. The default value is 0, indicating that the query starts from the first piece of data. The value must be a positive number.
limit	No	Integer	Maximum records to be queried. The value ranges from 1 to 100. If this parameter is not transferred, the first 100 records are queried by default.

Request Parameters

**Table 3** Request header parameters
Name	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token obtained from IAM. For details, see Authentication.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Name	Type	Description
histories	Array of objects	Change history of parameters of an instance. For details, see Table 5.

**Table 5** ConfigurationModifyHistoryInfo
Name	Type	Description
parameter_name	String	The parameter name.
old_value	String	Value before modification.
new_value	String	New value.
update_result	String	Update result.
applied	Boolean	Whether the new value has been applied to the instance. true: indicates that the new value has been applied. false: indicates that the new value has not been applied.
updated_at	String	Modification time. 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, in the Beijing time zone, the time zone offset is shown as +0800.
applied_at	String	Application time. 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, in the Beijing time zone, the time zone offset is shown as +0800.

Status code: 400

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

Status code: 500

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

Status code: default

**Table 8** Response body parameters
Name	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

GET https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/c4e095105bc64797bc3be633ae7201eein12/configuration-histories?offset=0&limit=10

Example Response

{ 
  "histories" : [ { 
    "parameter_name" : "rateLimit.mbps", 
    "old_value" : "500", 
    "new_value" : "350", 
    "update_result" : "SUCCESS", 
    "applied" : true, 
    "updated_at" : "2022-06-07T09:25:45+0000", 
    "applied_at" : "2022-06-07T09:25:45+0000" 
  } ] 
}

SDK

Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.