Viewing Parameter Change History of an Instance
Function
This API is used to view change history of parameters of an instance.
URI
GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/configuration-histories
Name |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Project ID of a tenant in a region. Constraints N/A Range N/A Default Value N/A |
instance_id |
Yes |
String |
Definition DB instance ID. Constraints N/A Range N/A Default Value N/A |
Name |
Mandatory |
Type |
Description |
---|---|---|---|
entity_id |
No |
String |
Definition Instance ID, group ID, or node ID. To obtain the value, call the API for Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one. Constraints
Range N/A Default Value N/A |
offset |
No |
Integer |
Definition Index offset. If offset is set to N, the query starts from the N+1 piece of data. The default value is 0, which indicates that the query starts from the first piece of data. Constraints The value cannot be a negative number. Range N/A Default Value 0 |
limit |
No |
Integer |
Definition Maximum records to be queried. If this parameter is not transferred, the first 100 records are queried by default. Constraints N/A Range 1–100 Default Value 100 |
Request Parameters
Name |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition User token obtained from IAM. For details, see Authentication. Constraints N/A Range N/A Default Value N/A |
Response Parameters
Status code: 200
Name |
Type |
Description |
---|---|---|
histories |
Array of objects |
Definition Change history of parameters of an instance. For details, see Table 5. Range N/A |
Name |
Type |
Description |
---|---|---|
parameter_name |
String |
Definition The parameter name. Range N/A |
old_value |
String |
Definition Value before modification. Range N/A |
new_value |
String |
Definition New value. Range N/A |
update_result |
String |
Definition Update result. Range N/A |
applied |
Boolean |
Definition Whether the new value has been applied to the instance. Range
|
updated_at |
String |
Definition 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. Range N/A |
applied_at |
String |
Definition 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. Range N/A |
Example Request
https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/c4e095105bc64797bc3be633ae7201eein02/configuration-histories?entity_id=c4e095105bc64797bc3be633ae7201eein02&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.
Status Code
For more information, see Status Code.
Error Code
For more information, see Error Code.
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