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

Obtaining the Data Filtering Verification Result

Function

This API is used to obtain the data filtering verification result.

URI

GET /v5/{project_id}/job/{job_id}/data-filtering/result

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 data filtering verification request

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

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

success_count

Long

Number of data filtering rules that are successfully verified.

failed_count

Long

Number of data filtering rules that fail to be verified.

db_object_filtering_result

Array of objects

Verification result of the database table filtering rules.

For details, see Table 5.
Table 5 Data structure description of field db_object_filtering_result

Parameter

Type

Description

db_name

String

Database name.

schema_name

String

Schema name.

table_name

String

Table name.

is_success

Boolean

Data filtering verification result.

message

String

If is_success is set to false, a message is returned, indicating the verification failure cause.

source

String

Comparison source.

  • job: indicates the data filtering during synchronization.
  • compare: indicates the data filtering during comparison.

Enumerated values:

  • job
  • compare

target_result

String

Indicates the result for verifying the comparison condition filtering on the destination database.

source_result

String

Indicates the result for verifying the comparison condition filtering on the source database.

target_message

String

Indicates the cause of the failure to verify the comparison condition filtering on the destination database.

source_message

String

Indicates the cause of the failure to verify the comparison condition filtering on the source database.

Status code: 400

Table 6 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 data filtering verification result

GET https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/job/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/data-filtering/result?query_id=0eacda0b-9422-4535-8b62-537d1833638b

Example Response

Status code: 200

OK

{
    "db_object_filtering_result" : [ {
    "db_name" : "testDb",
    "schema_name" : "testSchema",
    "table_name" : "testTable",
    "is_success" : true,
    "message" : null
  }, {
    "db_name" : "testDb",
    "schema_name" : "testSchema",
    "table_name" : "testTable",
    "is_success" : false,
    "message" : "DATA_TRANSFORMATION_ALREADY_EXISTED"
  } ],
  "success_count" : 1,
  "failed_count" : 1
}

Status code: 400

Bad Request

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

Status Code

Status Code

Description

200

OK

400

Bad Request

Error Code

For details, see Error Code.

Parent topic: Data Processing