Help Center/ Data Replication Service/ API Reference/ APIs V5.0 (in OBT)/ Comparison Management/ Querying the Health Comparison List
Updated on 2023-10-24 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Health Comparison List

Function

This API is used to query the health comparison list.

Constraints

This API can be used only in certain regions. For details, see Endpoints.

URI

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

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

status

No

String

Status. If this parameter is not specified, all statuses are queried.

  • WAITING_FOR_RUNNING: The comparison task is waiting to be started.
  • RUNNING: The comparison task is in progress.
  • SUCCESSFUL: The comparison task is complete.
  • FAILED: The comparison task failed.
  • 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.

Enumerated values:

  • WAITING_FOR_RUNNING
  • RUNNING
  • SUCCESSFUL
  • FAILED
  • CANCELLED
  • TIMEOUT_INTERRUPT
  • FULL_DOING
  • INCRE_DOING

limit

No

String

Number of items displayed per page. The default value is 10. The value ranges from 1 to 1000.

Minimum value: 1

Maximum value: 1000

Default value: 10

offset

No

String

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

Default value: 0

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

Table 4 Response body parameters

Parameter

Type

Description

count

Integer

Total number.

compare_jobs

Array of objects

List of health comparison tasks.

For details, see Table 5.
Table 5 compare_jobs parameters

Parameter

Type

Description

id

String

Task ID.

type

String

Comparison type.

start_time

String

Comparison start time.

end_time

String

Comparison end time.

status

String

Status.

  • WAITING_FOR_RUNNING: The comparison task is waiting to be started.
  • RUNNING: The comparison task is in progress.
  • SUCCESSFUL: The comparison task is complete.
  • FAILED: The comparison task failed.
  • 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.

compute_type

String

Compute resource of a comparison task.

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

Querying the health comparison list

https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/163b98e8-6088-46c3-8b86-c18fea6jb502/health-compare-jobs?offset=1&limit=10

Example Response

Status code: 200

OK 
{
  "count": 1,
  "compare_jobs": [
    {
      "id": "cd05434c-ad91-479c-a8d3-d90d58eccc43",
      "type": "lines,account,object_comparison",
      "status": "SUCCESSFUL",
      "start_time": "1686038400512",
      "end_time": "1686038408711",
      "compute_type": "drs"
    }
  ]
}

Status code: 400

Bad Request

{
  "error_code": "DRS.M05003",
  "error_msg": "Task information not found."
}

Error Code

For details, see Error Code.

Parent topic: Comparison Management