Querying Task Parameter Configuration List

Function

This API is used to query task parameter configuration list.

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}/configurations

**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.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	String	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	String	Number of items displayed per page. The default value is 10. The value ranges from 1 to 1000.
name	No	String	Query by parameter name.

Request Parameters

**Table 3** 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 4** Response body parameters
Parameter	Type	Description
count	Integer	Total number.
parameter_config_list	Array of objects	Task parameter list. For details, see Table 5.

**Table 5** Data structure description of field **parameter_config_list**
Parameter	Type	Description
name	String	Parameter name.
value	String	Parameter value.
default_value	String	Default parameter value.
value_range	String	Parameter value range. If the parameter type is Integer, the value is 0 or 1. If the parameter type is Boolean, the value is true or false.
is_need_restart	Boolean	Whether a restart is required. The default value is true. The value false indicates that a restart is not required. The value true indicates that a restart is required.
description	String	Parameter description. Only the parameter description in English is supported.
created_at	String	Creation time, for example, 2023-01-20T07:18:26Z.
updated_at	String	Update time, for example, 2023-03-01T09:42:02Z.

Example Request

Querying task parameter configuration list

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

Example Response

Status code: 200

Task parameter configuration list

{ 
  "count" : 0, 
  "parameter_config_list" : [ { 
    "name" : "applier_thread_num", 
    "value" : "20", 
    "default_value" : "10", 
    "value_range" : "1-512", 
    "is_need_restart" : true, 
    "description" : "The number of threads that write data to the target database during the full stage", 
    "created_at" : "2020-09-01T18:50:20Z", 
    "updated_at" : "2020-09-01T18:50:20Z" 
  }, { 
    "name" : "read_task_num", 
    "value" : "20", 
    "default_value" : "10", 
    "value_range" : "1-512", 
    "is_need_restart" : true, 
    "description" : "The number of threads reading data from the source database during the full volume stage", 
    "created_at" : "2020-09-01T18:50:20Z", 
    "updated_at" : "2020-09-01T18:50:20Z" 
  } ] 
}