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

Obtaining the Result for Querying Database Position

Function

This API is used to obtain the result for querying the database position.

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

GET /v5/{project_id}/jobs/{job_id}/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.
Table 2 Query parameters

Parameter

Mandatory

Type

Description

query_id

Yes

String

ID of the result for collecting database position information, which is returned by the API for collecting database position information.

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

job_id

String

Task ID.

status

String

Query status.

Enumerated values:

  • pending
  • failed
  • success

position

String

Position information.

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

Obtaining the result for querying database position

https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/db-position?query_id=0eacda0b-9422-4535-8b62-537d1833638b

Example Response

Status code: 200

OK

{
  "job_id" : "c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r",
  "position" : "mysql-bin.000277:805",
  "status" : "pending"
}

Status code: 400

Bad Request

{
  "error_code" : "DRS.10030014",
  "error_msg" : "Firstly, please the query object info."
}

Status Code

Status Code

Description

200

OK

400

Bad Request

Error Code

For details, see Error Code.

Parent topic: Task Operations