Help Center/ Data Replication Service/ API Reference/ APIs V5.0 (in OBT)/ Task Operations/ Collecting Database Position Information
Updated on 2024-05-27 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Collecting Database Position Information

Function

This API is used to collect database position information.

Constraints

  • This API is available only for data synchronization from MySQL to GaussDB(DWS).
  • This API can be used only in certain regions. For details, see Endpoints.

URI

POST /v5/{project_id}/jobs/{job_id}/collect-db-position

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. 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
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

reset_position_time

Yes

String

Position in time to be set, in UTC time format. Example: 2023-09-19T07:00:00Z

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

id

String

Query result ID.

job_id

String

Task ID.

status

String

Query status.

Enumerated values:

  • pending
  • failed
  • success

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum length: 12

Maximum length: 12

error_msg

String

Error message.

Minimum length: 1

Maximum length: 512

Example Request

Collecting database position information (asynchronous calling)

https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/collect-position

{
  "reset_position_time" : "2023-09-19T07:00:00Z"
}

Example Response

Status code: 202

Accepted

{
  "id" : "0eacda0b-9422-4535-8b62-537d1833638b",
  "job_id": "177738d1-4eee-4fcb-a4e1-09aea79jb20i",
  "status" : "pending"
}

Status code: 400

Bad Request

{
  "error_code" : "DRS.10000010",
  "error_msg" : "Job does not exist, please check job id."
}

Status Code

Status Code

Description

202

Accepted

400

Bad Request

Error Code

For details, see Error Code.

Parent topic: Task Operations