Help Center/Server Migration Service/API Reference/API/Task Management/Uploading Consistency Verification Results
Updated on 2026-01-27 GMT+08:00
View PDF

Uploading Consistency Verification Results

Function

This API is called by the Agent to upload the consistency verification results of a task.

Calling Method

For details, see Calling APIs.

URI

POST /v3/tasks/{task_id}/consistency-result

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

task_id

Yes

String

Task ID.

Minimum: 1

Maximum: 36

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. The token can be obtained by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token.

Minimum: 1

Maximum: 16384

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

consistency_result

No

Array of ConsistencyResult objects

The consistency verification results.

Array Length: 0 - 30

Table 4 ConsistencyResult

Parameter

Mandatory

Type

Description

dir_check

Yes

String

The directory verified.

Minimum: 0

Maximum: 1024

num_total_files

Yes

Integer

The total number of files verified.

Minimum: 0

Maximum: 1000000

num_different_files

Yes

Integer

The number of inconsistent files.

Minimum: 0

Maximum: 1000000

num_target_miss_files

Yes

Integer

The number of files missing at the target.

Minimum: 0

Maximum: 1000000

num_target_more_files

Yes

Integer

The number of files redundant at the target.

Minimum: 0

Maximum: 1000000

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

-

String

The consistency verification results were updated.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

The error code.

Minimum: 0

Maximum: 255

error_msg

String

The error message.

Minimum: 0

Maximum: 1024

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

The error code.

Minimum: 0

Maximum: 255

error_msg

String

The error message.

Minimum: 0

Maximum: 255

encoded_authorization_message

String

The encrypted authorization information.

Minimum: 0

Maximum: 65535

error_param

Array of strings

Error parameters.

Minimum: 0

Maximum: 65535

Array Length: 1 - 20

details

Array of details objects

The error details.

Array Length: 1 - 20

Table 8 details

Parameter

Type

Description

error_code

String

The SMS error code.

Minimum: 0

Maximum: 65535

error_msg

String

The SMS error message.

Minimum: 0

Maximum: 65535

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

The error code.

Minimum: 0

Maximum: 255

error_msg

String

The error message.

Minimum: 0

Maximum: 1024

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

The error code.

Minimum: 0

Maximum: 255

error_msg

String

The error message.

Minimum: 0

Maximum: 1024

Example Requests

This example updates the brief consistency verification results of the task whose ID is 137224b7-8d7c-4919-b33e-ed159778xxxx.

POST https://{endpoint}/v3/137224b7-8d7c-4919-b33e-ed159778xxxx/consistency-result

{
  "consistency_result" : [ {
    "dir_check" : "/root/data",
    "num_total_files" : 1235,
    "num_different_files" : 12,
    "num_target_miss_files" : 12,
    "num_target_more_files" : 12
  }, {
    "dir_check" : "/var",
    "num_total_files" : 1235,
    "num_different_files" : 12,
    "num_target_miss_files" : 12,
    "num_target_more_files" : 12
  } ]
}

Example Responses

Status code: 200

The consistency verification results were updated.

{ }

Status code: 403

Authentication failed.

{
  "error_code" : "SMS.9004",
  "error_msg" : "The current account does not have the permission to execute policy. You do not have permission to perform action XXX on resource XXX.",
  "encoded_authorization_message" : "XXXXXX",
  "error_param" : [ "You do not have permission to perform action XXX on resource XXX." ],
  "details" : [ {
    "error_code" : "SMS.9004",
    "error_msg" : "You do not have permission to perform action XXX on resource XXX."
  } ]
}

Status Codes

Status Code

Description

200

The consistency verification results were updated.

400

The request parameters were missing.

403

Authentication failed.

404

The task was not found.

500

Uploading the brief consistency verification results failed.

Error Codes

See Error Codes.

Parent topic:Task Management