Updated on 2025-11-11 GMT+08:00

Listing Failed Source Servers

Function

This API is used to query the list of source servers that failed to be migrated and the reported error messages.

Calling Method

For details, see Calling APIs.

Authorization

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

  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • If you are using identity policy-based authorization, the permission listed below is required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    sms:server:listErrors

    List

    template *

    -

    • server:queryServer

    -

URI

GET /v3/errors

Table 1 Query parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

The number of failed source servers recorded on each page.

Range

0 to 100

Default Value

50

offset

Yes

Integer

The offset.

Range

0 to 65535

Default Value

0

migproject

No

String

The ID of the migration project within which the failed source servers will be queried. If this parameter is specified, only the failed source servers in migration tasks under the project are queried.

enterprise_project_id

No

String

The ID of the enterprise project to be queried.

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.

Response

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

count

Integer

The number of source servers that failed to be migrated due to errors.

Range

0 to 2147483647

migration_errors

Array of MigrationErrors objects

The details of failed source servers.

Table 4 MigrationErrors

Parameter

Type

Description

error_json

String

The error message in JSON format.

host_name

String

The hostname of the source server, which is obtained from the user system and may be empty.

name

String

The source server name in SMS.

source_id

String

The source server ID.

source_ip

String

The IP address of the source server.

target_ip

String

The IP address of the target server.

Status code: 403

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

The error code.

error_msg

String

The error message.

encoded_authorization_message

String

The encrypted authorization information.

error_param

Array of strings

Invalid parameters.

details

Array of details objects

The error details.

Table 6 details field description

Parameter

Type

Description

error_code

String

The SMS error code.

error_msg

String

The SMS error message.

Example Request

This example lists all failed source servers with 10 records on one page and navigates to page 0.

GET https://{endpoint}/v3/errors?limit=10&offset=0

Example Response

Status code: 200

The list of failed source servers was obtained.

{
  "count" : 4,
  "migration_errors" : [ {
    "source_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
    "source_ip" : "192.168.0.235",
    "target_ip" : null,
    "name" : "sms-ubuntu",
    "host_name" : null,
    "error_json" : "{\"error_code\":\"SMS.1302\",\"error_param\":\"[\\\"/\\\", \\\"/mnt/vdb1\\\"]\"}"
  }, {
    "source_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
    "source_ip" : "192.168.0.163",
    "target_ip" : null,
    "name" : "sms-win08",
    "host_name" : "sms-win08",
    "error_json" : "{\"error_param\":\"[\\\"192.168.0.1\\\"]\",\"error_code\":\"SMS.2802\"}"
  }, {
    "source_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
    "source_ip" : "192.168.0.154",
    "target_ip" : null,
    "name" : "sms-win16",
    "host_name" : "sms-win16",
    "error_json" : "{\"error_code\":\"SMS.1114\",\"error_param\":\"[]\"}"
  }, {
    "source_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
    "source_ip" : "192.168.77.77",
    "target_ip" : null,
    "name" : "sms-centos",
    "host_name" : null,
    "error_json" : "{\"error_code\":\"SMS.3805\",\"error_param\":\"[]\"}"
  } ]
}

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 sample code is as follows.

 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 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.*;


public class ListErrorServersSolution {

    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();
        ListErrorServersRequest request = new ListErrorServersRequest();
        try {
            ListErrorServersResponse response = client.listErrorServers(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());
        }
    }
}
 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
# 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 = ListErrorServersRequest()
        response = client.list_error_servers(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 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
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.ListErrorServersRequest{}
	response, err := client.ListErrorServers(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

Status Codes

Status Code

Description

200

The list of failed source servers was obtained.

403

Authentication failed.

Error Codes

For details, see Error Codes.