Querying Task Parameter Change History

Function

This API is used to query the parameter change history of a task.

Constraints

This API is available only for real-time synchronization tasks from MySQL to MySQL, MySQL to PostgreSQL, MySQL to GaussDB Distributed, MySQL to GaussDB Primary/Standby, MySQL to GaussDB(DWS), MySQL to GaussDB(for MySQL), MySQL to Kafka, MySQL to CSS/ES, and MySQL to Oracle.
This API is used for real-time synchronization tasks in the Configuration, Full, Incremental, Full failed, Incremental failed, or Paused state.

URI

GET /v5/{project_id}/jobs/{job_id}/configuration-histories

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region. For details, see Obtaining a Project ID.
job_id	Yes	String	Task ID.

Query parameters

Parameter	Mandatory	Type	Description
offset	No	Integer	Offset, which is the position where the query starts. The value must be greater than or equal to 0. The default value is 0.
limit	No	Integer	Number of items displayed per page. The default value is 10. The value ranges from 1 to 1000.
begin_time	No	String	Start time in UTC format, for example, 2020-09-01T18:50:20Z.
end_time	No	String	End time in UTC format, for example, 2020-09-01T19:50:20Z.
name	No	String	Parameter name.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	MIME type of the request body. Use the default value application/json. For APIs used to upload objects or images, the value varies depending on the flow type. The default value is application/json.
X-Auth-Token	Yes	String	User token obtained from IAM. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a request is processed, the value of X-Subject-Token in the header is the token value.
X-Language	No	String	Request language type. Default value: en-us Enumerated values: en-us zh-cn

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
count	Integer	Total number of historical records.
parameter_history_config_list	Array of objects	Change history list of task parameters. For details, see Table 4.

**Table 4** Data structure description of field **parameter_history_config_list**
Parameter	Type	Description
name	String	Parameter name.
old_value	String	Old parameter value.
new_value	String	New parameter value.
is_update_success	Boolean	Update result. true: The operation is successful. false: The operation failed.
is_applied	Boolean	Whether the new value has been applied. true: The new value has been applied. false: The new value has not been applied.
update_time	String	Time when a parameter is changed.
apply_time	String	Time when the new value is applied.

Example Request

Querying the parameter change history of a task.

https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/configuration-histories?offset={offset}&limit={limit}&begin_time={begin_time}&end_time={end_time}

Example Response

Status code: 200

Task parameter change history list

{ 
  "count" : 0, 
  "parameter_history_config_list" : [ { 
    "name" : "strapplier_thread_numing", 
    "old_value" : "10", 
    "new_value" : "20", 
    "is_update_success" : true, 
    "is_applied" : "true", 
    "update_time" : "2020-09-01T18:50:20Z", 
    "apply_time" : "2020-09-01T18:50:20Z" 
  } ] 
}