Help Center/ Data Replication Service/ API Reference/ APIs V5.0 (in OBT)/ Database Object Configuration/ Obtaining the Progress of Saving Objects
Updated on 2025-12-15 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining the Progress of Saving Objects

Function

This API is used to obtain the progress of saving objects.

Constraints

  • This API supports only the synchronization scenarios from Oracle to GaussDB Distributed, TaurusDB to Kafka, and MySQL to Kafka.
  • This API can be used only in certain regions. For details, see Endpoints.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permissions are required for calling this API.

URI

GET /v5/{project_id}/jobs/{job_id}/db-objects/saving-status

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

For details about how to obtain the project ID, see Obtaining a Project ID.

job_id

Yes

String

Task ID.
Table 2 Query parameters

Parameter

Mandatory

Type

Description

query_id

Yes

String

ID returned by the API for saving objects.

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.

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. The token is the value of X-Subject-Token in the response header.

X-Language

No

String

Request language type.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

id

String

Query result ID.

status

String

Query status.

Enumerated values:

  • pending
  • failed
  • success

job_id

String

Task ID.

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 progress of saving objects

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

Example Response

Status code: 200

OK

{
  "id" : "05ef2a25-a472-4144-b444-2e0a11eb5902",
  "status" : "success"
}

Status code: 400

Bad Request

{
  "error_code" : "DRS.10030015",
  "error_msg" : "Failed to update database object"
}

Status Code

Status Code

Description

200

OK

400

Bad Request

Error Code

For details, see Error Code.