Obtaining Consistency Verification Results

Function

This API is used to obtain the brief consistency verification results of a task.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
task_id	Yes	String	The task ID. Minimum length: 0 characters Maximum length: 255 characters

Request

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	The user token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. Minimum length: 1 character Maximum length: 16,384 characters

Response

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
consistency_result	Array of ConsistencyResult objects	The verification results. Array length: 0 to 10 characters
finished_time	Long	The verification completion time. Minimum value: 0 Maximum value: 100000000000

**Table 4** **ConsistencyResult** field description
Parameter	Type	Description
dir_check	String	The directory verified. Minimum length: 0 characters Maximum length: 1,024 characters
num_total_files	Integer	The total number of files verified. Minimum value: 0 Maximum value: 100000
num_different_files	Integer	The number of files inconsistent. Minimum value: 0 Maximum value: 100000
num_target_miss_files	Integer	The number of files missing at the target. Minimum value: 0 Maximum value: 100000
num_target_more_files	Integer	The number of files redundant at the target. Minimum value: 0 Maximum value: 100000

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	The error code. Minimum length: 0 characters Maximum length: 255 characters
error_msg	String	The error message. Minimum length: 0 characters Maximum length: 1,024 characters

Status code: 404

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	The error code. Minimum length: 0 characters Maximum length: 255 characters
error_msg	String	The error message. Minimum length: 0 characters Maximum length: 1,024 characters

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	The error code. Minimum length: 0 characters Maximum length: 255 characters
error_msg	String	The error message. Minimum length: 0 characters Maximum length: 1,024 characters

Example Request

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

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

Example Response

Status code: 200

The brief consistency verification results are obtained.

{
  "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
  } ],
  "finished_time" : "1598435801422"
}

Status Codes

Status Code	Description
200	The brief consistency verification results were obtained.
400	The request parameters are missing.
404	The task was not found.
500	The brief consistency verification results were not obtained.