Viewing Parameter Change History of a Specified DB Instance

API Description

This API is used to view change history of parameters of a specified DB instance.

URI

URI format
GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/configuration-histories

**Table 1** Path parameters
Parameter	Type	IN	Mandatory	Description
project_id	string	path	Yes	Project ID of a tenant in a region. Obtain the project ID by following the instructions in Obtaining a Project ID.
instance_id	string	path	Yes	Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one.

Request Parameters

**Table 2** Request header parameters
Parameter	Type	IN	Mandatory	Description
X-Auth-Token	string	header	Yes	User token

**Table 3** Query parameters
Parameter	Type	Mandatory	Description
offset	Integer	No	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	Integer	No	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.
entity_id	String	Yes	Instance ID, group ID, or node ID. You can call the API used for querying instances and details to obtain the value. If you do not have an instance, you can call the API used for creating a DB instance. If the DB instance type is cluster and the shard or config parameter template is obtained, the value is the group ID. If the parameter template of the mongos node is obtained, the value is the node ID. If the DB instance type is replica set, the value is the instance ID. If the parameter template of a read replica is obtained, the value is the read replica ID.

Example request
None

Response Parameters

Parameter description

**Table 4** Response body parameters
Parameter	Type	Description
histories	Array of Table 5 objects	Change history of parameters of an instance.

**Table 5** ConfigurationModifyHistoryInfo
Parameter	Type	Description
parameter_name	String	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.
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.
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.

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" 
  } ] 
}