Help Center/ Server Migration Service/ API Reference/ API/ Task Management/ Obtaining Consistency Verification Results in Batches
Updated on 2026-01-28 GMT+08:00

Obtaining Consistency Verification Results in Batches

Function

This API is used to export consistency verification results in batches.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    sms:server:getBatchConsistencyResults

    Read

    server *

    -

    sms:server:queryServer

    -

URI

POST /v3/tasks/consistency-results/export

Request Parameters

Table 1 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.

X-Language

No

String

The preferred language. Select English.

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

task_info

Yes

Array of BatchConsistencyReq objects

All task information.

Array Length: 1 - 200

Table 3 BatchConsistencyReq

Parameter

Mandatory

Type

Description

task_id

No

String

The task ID.

Minimum: 1

Maximum: 36

source_id

No

String

The source server ID.

Minimum: 0

Maximum: 255

source_name

No

String

The source server name.

Minimum: 0

Maximum: 255

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

-

String

OK

Status code: 400

Table 5 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 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: 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 7 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 8 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

Task information

source_id: specifies the source server ID.

task_id: specifies the task ID.

source_name: specifies the source server name.

POST https://{endpoint}/v3/tasks/consistency-results/export

{
  "task_info" : [ {
    "source_id" : "31806fb2-95bd-421f-ae35-b81b750dxxxx",
    "task_id" : "05a41be9-3ffe-4cc6-8d66-07359039xxxx",
    "source_name" : "ecsxxx"
  } ]
}

Example Responses

Status code: 200

OK

{ }

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."
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

Task information

source_id: specifies the source server ID.

task_id: specifies the task ID.

source_name: specifies the source server name.

 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
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 ExportConsistencyResultsSolution {

    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();
        ExportConsistencyResultsRequest request = new ExportConsistencyResultsRequest();
        BatchGetConsistencyResultReq body = new BatchGetConsistencyResultReq();
        List<BatchConsistencyReq> listbodyTaskInfo = new ArrayList<>();
        listbodyTaskInfo.add(
            new BatchConsistencyReq()
                .withTaskId("05a41be9-3ffe-4cc6-8d66-07359039xxxx")
                .withSourceId("31806fb2-95bd-421f-ae35-b81b750dxxxx")
                .withSourceName("ecsxxx")
        );
        body.withTaskInfo(listbodyTaskInfo);
        request.withBody(body);
        try {
            ExportConsistencyResultsResponse response = client.exportConsistencyResults(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());
        }
    }
}

Task information

source_id: specifies the source server ID.

task_id: specifies the task ID.

source_name: specifies the source server name.

 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
# 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 = ExportConsistencyResultsRequest()
        listTaskInfobody = [
            BatchConsistencyReq(
                task_id="05a41be9-3ffe-4cc6-8d66-07359039xxxx",
                source_id="31806fb2-95bd-421f-ae35-b81b750dxxxx",
                source_name="ecsxxx"
            )
        ]
        request.body = BatchGetConsistencyResultReq(
            task_info=listTaskInfobody
        )
        response = client.export_consistency_results(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Task information

source_id: specifies the source server ID.

task_id: specifies the task ID.

source_name: specifies the source server name.

 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
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.ExportConsistencyResultsRequest{}
	var listTaskInfobody = []model.BatchConsistencyReq{
        {
            TaskId: "05a41be9-3ffe-4cc6-8d66-07359039xxxx",
            SourceId: "31806fb2-95bd-421f-ae35-b81b750dxxxx",
            SourceName: "ecsxxx",
        },
    }
	request.Body = &model.BatchGetConsistencyResultReq{
		TaskInfo: listTaskInfobody,
	}
	response, err := client.ExportConsistencyResults(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

OK

400

Bad Request

403

Authentication failed.

404

Not Found

Error Codes

See Error Codes.