Help Center/ Data Replication Service/ API Reference/ APIs V3.0 (Deprecated)/ Public API Management/ Creating an Object-level Comparison Task
Updated on 2025-12-15 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Creating an Object-level Comparison Task

Function

This API is used to create an object-level comparison task.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions and Supported Actions.

URI

POST /v3/{project_id}/jobs/{job_id}/object/compare

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.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

The content type.

The default value is application/json.

X-Auth-Token

Yes

String

User token obtained from IAM.

X-Language

No

String

Request language type.

Default value: en-us

Enumerated values:

  • en-us
  • zh-cn
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

compare_task_num

No

Integer

Number of comparison task threads. This parameter is available only for tasks of cloudDataGuard-cassandra and cloudDataGuard-gausscassandra-to-gausscassandra.

Response Parameters

None

Example Request

Creating an object-level comparison task

https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/a2b4999c-0acf-45eb-843d-5c1cdb2jb201/object/compare

{
  "compare_task_num" : 2
}

Example Response

Status code: 202

OK

{ }

Status code: 400

Bad Request

{
  "error_code" : "DRS.10000024",
  "error_msg" : "Another operation is being performed on the migration task or the migration task is abnormal."
}

Status Code

Status Code

Description

202

OK

400

Bad Request

Error Code

For details, see Error Code.

Parent topic: Public API Management