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.

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. Minimum: 0 Maximum: 100 Default: 50
offset	Yes	Integer	The offset. Minimum: 0 Maximum: 65535 Default: 0
enterprise_project_id	No	String	The ID of the enterprise project to be queried. Minimum: 0 Maximum: 255

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

Response Parameters

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. Minimum: 0 Maximum: 2147483647
migration_errors	Array of MigrationErrors objects	The details of failed source servers. Array Length: 0 - 65535

**Table 4** MigrationErrors
Parameter	Type	Description
error_json	String	The error message in JSON format. Minimum: 0 Maximum: 255
host_name	String	The hostname of the source server, which is obtained from the user system and may be empty. Minimum: 0 Maximum: 255
name	String	The source server name in SMS. Minimum: 0 Maximum: 255
source_id	String	The source server ID. Minimum: 0 Maximum: 255
source_ip	String	The IP address of the source server. Minimum: 0 Maximum: 255
target_ip	String	The IP address of the target server. Minimum: 0 Maximum: 255

Status code: 403

**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: 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 6** 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

Example Requests

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 Responses

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