Help Center/ Data Replication Service/ API Reference/ APIs V5.0 (in OBT)/ Comparison Management/ Querying Details About a Health Comparison Task
Updated on 2024-05-27 GMT+08:00
View PDF
Share

Querying Details About a Health Comparison Task

Function

This API is used to query details about a health comparison task.

URI

GET /v5/{project_id}/jobs/{job_id}/health-compare-jobs/{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

id

String

ID of a comparison task.

type

String

Comparison type. object_comparison: object-level comparison. lines: row comparison. account: Account-level comparison.

start_time

String

Start time (UTC), for example, 2024-04-03T08:00:01Z.

end_time

String

End time (UTC), for example, 2024-04-03T08:00:01Z.

status

String

Status of a comparison task. The value can be:

  • RUNNING: The comparison task is in progress.
  • WAITING_FOR_RUNNING: The comparison task is waiting to be started.
  • SUCCESSFUL: The comparison task is complete.
  • FAILED: The comparison task fails.
  • CANCELLED: The comparison task is canceled.
  • TIMEOUT_INTERRUPT: The comparison task times out.
  • FULL_DOING: Full verification is in progress.
  • INCRE_DOING: Incremental verification is in progress.

job_name

String

Task name.

Status code: 400

Table 4 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 details about a health comparison task

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

Example Response

Status code: 200

OK

{
  "id" : "3bca29b5-419a-409d-a8d1-d892aa12bf53",
  "type" : "lines,object_comparison",
  "status" : "SUCCESSFUL",
  "start_time" : "2024-04-07T10:00:01Z",
  "end_time" : "2024-04-07T10:00:09Z",
  "job_name" : "DRS-7754"
}

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