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.

URI

GET /v2/{project_id}/instances/{instance_id}/config-histories

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. For details, see Obtaining a Project ID. Constraints: N/A Range: N/A Default Value: N/A
instance_id	Yes	String	Definition: Instance ID. It can be viewed on the instance details page on the DCS console. Constraints: N/A Range: N/A Default Value: N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Definition: Offset, which indicates that the generated list is displayed from this offset. For example, if the offset is 3, the generated list is displayed from the fourth record. Constraints: N/A Range: ≥ 0 Default Value: 0
limit	No	Integer	Definition: Number of records displayed on each page. Constraints: N/A Range: 1–1000 Default Value: 10

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
history_num	Integer	Definition: Number of instance parameter modification records. Range: N/A
histories	Array of HistoryInfo objects	Definition: Details of instance parameter modification records.

**Table 4** HistoryInfo
Parameter	Type	Description
history_id	String	Definition: Modification record ID. Range: N/A
type	String	Definition: Modification type. Range: config_param: instance configuration parameters
created_at	String	Definition: Modification time. Range: N/A
status	String	Definition: Modification status. Range: SUCCESS: The instance parameter is modified successfully. FAILURE: The instance parameter fails to be modified. EXECUTING: The instance parameter is being modified.

Status code: 400

**Table 5** Response body parameters
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

**Table 6** Response body parameters
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

Definition:

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	Definition: List of instance parameter modification records queried successfully.
400	Definition: Invalid request.
500	Definition: Internal service error.

Status Code

Description

200

Definition:

List of instance parameter modification records queried successfully.

400

Definition:

Invalid request.

500

Definition:

Internal service error.