Querying Change History of Instance Parameters
Function
This API is used to query parameter change history of a DB instance.
- Before calling this API, learn how to authenticate it.
- Before calling this API, learn about request header parameters.
Constraints
- The following DB engines are supported: MySQL, PostgreSQL, and Microsoft SQL Server.
URI
- URI format
GET /v3/{project_id}/instances/{instance_id}/configuration-histories?offset={offset}&limit={limit}&start_time={start_time}&end_time={end_time}¶m_name={param_name}
- Parameter description
Table 1 Parameters 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
N/A
Default Value
N/A
instance_id
Yes
String
Definition
Instance ID.
Constraints
N/A
Range
N/A
Default Value
N/A
offset
No
Integer
Definition
Pagination parameter.
Constraints
N/A
Range
N/A
Default Value
0
limit
No
Integer
Definition
Pagination parameter.
Constraints
N/A
Range
N/A
Default Value
10
start_time
No
String
Definition
Start time.
Constraints
N/A
Range
The value is in the "yyyy-mm-ddThh:mm:ssZ" format. 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.
Default Value
The default value is seven days before the current time.
end_time
No
String
Definition
End time.
Constraints
N/A
Range
The value is in the "yyyy-mm-ddThh:mm:ssZ" format. 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.
Default Value
The default value is the current time.
param_name
No
String
Definition
Parameter name.
Constraints
N/A
Range
N/A
Default Value
N/A
Request
Response
- Normal response
Table 2 Parameters Parameter
Type
Description
total_count
Integer
Definition
Total number of historical records.
Range
N/A
histories
Array of objects
Definition
Parameter change history list.
For details, see Table 3.
Table 3 histories 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
Update result. Valid Value:
Range
- SUCCESS
- FAILED
applied
Boolean
Definition
Whether the new value has been applied to the instance.
Range
- true: indicates that the new value has been applied.
- false: indicates that the new value has not been applied.
update_time
String
Definition
Time when the value is updated.
Range
N/A
apply_time
String
Definition
Time when the new value is applied to the instance.
Range
N/A
- Example normal response
{ "total_count" : 3, "histories" : [ { "parameter_name" : "fill factor (%)", "old_value" : "0", "new_value" : "2", "update_result" : "SUCCESS", "applied" : true, "update_time" : "2022-10-29T09:39:21+0000", "apply_time" : "2022-10-31T01:46:29+0000" }, { "parameter_name" : "remote login timeout (s)", "old_value" : "10", "new_value" : "20", "update_result" : "SUCCESS", "applied" : true, "update_time" : "2022-10-29T09:38:36+0000", "apply_time" : "2022-10-29T09:38:36+0000" }, { "parameter_name" : "remote query timeout (s)", "old_value" : "600", "new_value" : "601", "update_result" : "SUCCESS", "applied" : true, "update_time" : "2022-10-29T09:40:30+0000", "apply_time" : "2022-10-29T09:40:30+0000" } ] }
- Abnormal response
For details, see Abnormal Request Results.
Status Code
- Normal
- Abnormal
For details, see Status Codes.
Error Code
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot