Help Center/ Data Replication Service/ API Reference/ APIs V5.0 (in OBT)/ Database Object Configuration/ Submitting the Query of Database Object Information
Updated on 2024-10-25 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Submitting the Query of Database Object Information

Function

This API is used to submit the query of database object information. Example:

  • If type is set to source, table information in the source database is queried.
  • If table information in the source database changes, set type to source and is_refresh to true.
  • If the volume of the database table data that has been synchronized to the destination database is too large and data needs to be loaded to the cache, set type to synchronized.

Use the new API in Submitting the Query of Database Object Information for query.

Constraints

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

URI

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

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

offset

No

Integer

Offset, which is the position where the query starts. The value must be greater than or equal to 0.

limit

No

Integer

Number of items displayed per page.

type

Yes

String

Type of the object information to be queried. Values:

  • source: Query information about objects in the source database.
  • modified: Query information about the selected objects that are not delivered.
  • synchronized: Query information about synchronized (delivered) objects. This function is used when a task is in the full or incremental phase.

is_refresh

No

Boolean

Whether to forcibly refresh the query. Values:

  • true: indicating that data is queried from the source database again.
  • false: indicating that data is queried from the cache.

db_names

No

Array

A specified database.

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: 202

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

Querying information about the synchronized objects

https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/db-objects/collect?type=synchronized

Example Response

Status code: 202

OK

{
  "id" : "036ceb63-51f8-43fb-9164-82c17b2eadbc",
  "status" : "pending",
  "job_id" : "2fccbe0d-4e6b-4957-981a-edca4e2jb201"
}

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

OK

400

Bad Request

Error Code

For details, see Error Code.