Querying Incremental Component Details

Function

This API is used to query details about incremental components for an incremental or full+incremental task. For details, see Querying the Synchronization Progress.

Constraints

This API is available only for data synchronization scenarios from Oracle to GaussDB Distributed, from Oracle to GaussDB Primary/Standby, from GaussDB Distributed to GaussDB Distributed, from GaussDB Distributed to MySQL, from GaussDB Distributed to GaussDB Primary/Standby, from GaussDB Distributed to GaussDB(DWS), GaussDB Distributed to Oracle, GaussDB Primary/Standby to GaussDB Primary/Standby, from GaussDB Primary/Standby to GaussDB Distributed, from GaussDB Primary/Standby to GaussDB(DWS), from GaussDB Primary/Standby to Oracle, from Oracle to GaussDB(DWS), and from Oracle to MySQL.
This API can be used only in certain regions. For details, see Endpoints.

URI

GET /v5/{project_id}/jobs/{job_id}/increment-components-detail

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

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. 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
update_time	String	Update time.
increment_components_list	Array of objects	Incremental component details. For details, see Table 4.

**Table 4** increment_components_list parameters
Parameter	Type	Description
type	String	Component type. The value can be: capture: capture component. apply: replay component. Enumerated values: capture apply
status	String	Status. STOPPED: The component is stopped. STARTED: The component is in progress. STOPPING: The component is being stopped. STARTING: The component is being started.
start_time	String	Start time.
start_point	String	Start position.
current_point	String	Current position.
resolution_time	String	Parsing time.
delay	String	Delay, in seconds.

Example Request

Querying the incremental component details

https://{enpoint}/v5/246765b9f59445c3919fce121ea801f4/jobs/429b9210-118d-4711-87cb-be8e2dejb201/increment-components-detail

Example Response

Status code: 200

{
  "increment_components_list" : [ {
    "type" : "capture",
    "status" : "STARTED",
    "start_time" : "2023-07-19T03:09:25Z",
    "start_point" : "0;0|0",
    "current_point" : "0;0|0",
    "resolution_time" : "2023-07-19T03:09:25Z",
    "delay" : "2"
  }, {
    "type" : "apply",
    "status" : "STARTED",
    "start_time" : "2023-07-19T03:09:25Z",
    "start_point" : "-1",
    "current_point" : "0;0|0",
    "resolution_time" : "2023-07-19T03:09:25Z",
    "delay" : "3"
  } ],
  "update_time" : "2023-07-19T03:09:25Z"
}