Querying the List of Instance Parameter Modification Records
Function
This API is used to query the parameter modification record list of an instance by keyword.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/instances/{instance_id}/config-histories
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details, see Obtaining a Project ID. |
instance_id |
Yes |
String |
Instance ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
offset |
No |
Integer |
Offset, which is the position where the query starts. The value must be no less than 0. |
limit |
No |
Integer |
Number of records displayed on each page. The minimum value is 1. The maximum value is 1000*. If this parameter is not specified, 10 records are displayed on each page by default. |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
history_num |
Integer |
Number of instance parameter modification records. |
histories |
Array of HistoryInfo objects |
Details of instance parameter modification records. |
Parameter |
Type |
Description |
---|---|---|
history_id |
String |
Modification record ID. |
type |
String |
Modification type. |
created_at |
String |
Modification time. |
status |
String |
Modification status. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Parameter description: Error message. Value range: N/A. |
error_code |
String |
Parameter description: Error code. Value range: For details, see Error Codes. |
error_ext_msg |
String |
Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Parameter description: Error message. Value range: N/A. |
error_code |
String |
Parameter description: Error code. Value range: For details, see Error Codes. |
error_ext_msg |
String |
Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A. |
Example Requests
GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/config-histories?offset=0&limit=10
Example Responses
Status code: 200
List of instance parameter modification records queried successfully.
{ "history_num" : 1, "histories" : [ { "history_id" : "4ae8507f-7992-40e2-9928-41ccf1db4bdc", "type" : "config_param", "created_at" : "2022-10-20T03:37:44.636Z", "status" : "SUCCESS" } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
List of instance parameter modification records queried successfully. |
400 |
Invalid request. |
500 |
Internal service error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.