Help Center> Data Replication Service> API Reference> APIs V5.0 (in OBT)> Comparison Management> Obtaining the Overview of an Object-Level Health Comparison
Updated on 2024-05-27 GMT+08:00
View PDF

Obtaining the Overview of an Object-Level Health Comparison

Function

This API is used to obtain the overview of an object-level health comparison.

URI

GET /v5/{project_id}/jobs/{job_id}/health-compare-jobs/object/{compare_job_id}

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.

compare_job_id

Yes

String

ID of a comparison task.

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

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

compare_result

Array of objects

Result of an object-level health comparison.

For details, see Table 4.
Table 4 compare_result parameters

Parameter

Type

Description

type

String

Object type. The value can be:

  • DB: indicates a database.
  • TABLE: indicates a table.
  • VIEW: indicates a view.
  • EVENT: indicates an event.
  • ROUTINE: indicates a stored procedure and function.
  • INDEX: indicates an index.
  • TRIGGER: indicates a trigger.
  • SYNONYM: indicates a synonym.
  • FUNCTION: indicates a function.
  • PROCEDURE: indicates a stored procedure.
  • TYPE: indicates a user-defined type.
  • RULE: indicates a rule.
  • DEFAULT_TYPE: indicates a default value.
  • PLAN_GUIDE: indicates an execution plan.
  • CONSTRAINT: indicates a constraint.
  • FILE_GROUP: indicates a file group.
  • PARTITION_FUNCTION: indicates a partition function.
  • PARTITION_SCHEME: indicates a partition scheme.
  • TABLE_COLLATION: indicates table collation.
  • EXTENSIONS: indicates a plug-in.

source_count

Long

Number of source objects.

target_count

Long

Number of destination objects.

status

Integer

Comparison result.

  • 0: The data in the source database is inconsistent with that in the destination database.
  • 2: The data in the source database is consistent with that in the destination database.
  • 3: The comparison is not completed.

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 overview of an object-level health comparison

https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/163b98e8-6088-46c3-8b86-c18fea6jb502/health-compare-jobs/object/118d1bdc-b3c8-48a0-af77-3400da6e9291

Example Response

Status code: 200

OK

{
  "compare_result" : [ {
    "type" : "DB",
    "status" : 2,
    "source_count" : 1,
    "target_count" : 1
  }, {
    "type" : "INDEX",
    "status" : 2,
    "source_count" : 2,
    "target_count" : 2
  }, {
    "type" : "TABLE",
    "status" : 2,
    "source_count" : 2,
    "target_count" : 2
  }, {
    "type" : "TABLE_COLLATION",
    "status" : 2,
    "source_count" : 2,
    "target_count" : 2
  } ]
}

Status code: 400

Bad Request

{
  "error_code" : "DRS.10000001",
  "error_msg" : "Failed."
}

Status Code

Status Code

Description

200

OK

400

Bad Request

Error Code

For details, see Error Code.

Parent topic: Comparison Management