Help Center/ Server Migration Service/ API Reference/ APIs V3.0/ Task Management/ Uploading Consistency Verification Results
Updated on 2024-09-26 GMT+08:00

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

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

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

consistency_result

Yes

Array of ConsistencyResult objects

The verification results.

Array length: 0 to 10 characters

finished_time

No

Long

The verification completion time.

Minimum value: 0

Maximum value: 100000000000

Table 4 ConsistencyResult

Parameter

Mandatory

Type

Description

dir_check

Yes

String

The directory verified.

Minimum length: 0 characters

Maximum length: 1,024 characters

num_total_files

Yes

Integer

The total number of files verified.

Minimum value: 0

Maximum value: 100000

num_different_files

Yes

Integer

The number of files inconsistent.

Minimum value: 0

Maximum value: 100000

num_target_miss_files

Yes

Integer

The number of files missing at the target.

Minimum value: 0

Maximum value: 100000

num_target_more_files

Yes

Integer

The number of files redundant at the target.

Minimum value: 0

Maximum value: 100000

Response

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 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 Response

Status code: 200

The brief consistency verification results were updated.

{ }

SDK Sample Code

The sample code is as follows.

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.GlobalCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.sms.v3.region.SmsRegion;
import com.huaweicloud.sdk.sms.v3.*;
import com.huaweicloud.sdk.sms.v3.model.*;

import java.util.List;
import java.util.ArrayList;

public class UpdateConsistencyResultSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        SmsClient client = SmsClient.newBuilder()
                .withCredential(auth)
                .withRegion(SmsRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateConsistencyResultRequest request = new UpdateConsistencyResultRequest();
        ConsistencyResultRequestBody body = new ConsistencyResultRequestBody();
        List<ConsistencyResult> listbodyConsistencyResult = new ArrayList<>();
        listbodyConsistencyResult.add(
            new ConsistencyResult()
                .withDirCheck("/root/data")
                .withNumTotalFiles(1235)
                .withNumDifferentFiles(12)
                .withNumTargetMissFiles(12)
                .withNumTargetMoreFiles(12)
        );
        listbodyConsistencyResult.add(
            new ConsistencyResult()
                .withDirCheck("/var")
                .withNumTotalFiles(1235)
                .withNumDifferentFiles(12)
                .withNumTargetMissFiles(12)
                .withNumTargetMoreFiles(12)
        );
        body.withConsistencyResult(listbodyConsistencyResult);
        request.withBody(body);
        try {
            UpdateConsistencyResultResponse response = client.updateConsistencyResult(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdksms.v3.region.sms_region import SmsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksms.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = GlobalCredentials(ak, sk)

    client = SmsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SmsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateConsistencyResultRequest()
        listConsistencyResultbody = [
            ConsistencyResult(
                dir_check="/root/data",
                num_total_files=1235,
                num_different_files=12,
                num_target_miss_files=12,
                num_target_more_files=12
            ),
            ConsistencyResult(
                dir_check="/var",
                num_total_files=1235,
                num_different_files=12,
                num_target_miss_files=12,
                num_target_more_files=12
            )
        ]
        request.body = ConsistencyResultRequestBody(
            consistency_result=listConsistencyResultbody
        )
        response = client.update_consistency_result(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    sms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := sms.NewSmsClient(
        sms.SmsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateConsistencyResultRequest{}
	var listConsistencyResultbody = []model.ConsistencyResult{
        {
            DirCheck: "/root/data",
            NumTotalFiles: int32(1235),
            NumDifferentFiles: int32(12),
            NumTargetMissFiles: int32(12),
            NumTargetMoreFiles: int32(12),
        },
        {
            DirCheck: "/var",
            NumTotalFiles: int32(1235),
            NumDifferentFiles: int32(12),
            NumTargetMissFiles: int32(12),
            NumTargetMoreFiles: int32(12),
        },
    }
	request.Body = &model.ConsistencyResultRequestBody{
		ConsistencyResult: listConsistencyResultbody,
	}
	response, err := client.UpdateConsistencyResult(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For more SDK sample code of programming languages, visit API Explorer and click the Sample Code tab. Example code can be automatically generated.

Status Codes

Status Code

Description

200

The brief consistency verification results were updated.

400

The request parameters are missing.

404

The task was not found.

500

The brief consistency verification results were not uploaded.

Error Codes

For details, see Error Codes.