Updated on 2024-09-04 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 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 value: 0

Maximum value: 100

Default value: 50

offset

Yes

Integer

The offset.

Minimum value: 0

Maximum value: 65535

Default value: 0

migproject

No

String

The ID of the migration project in 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.

Minimum length: 0 characters

Maximum length: 255 characters

enterprise_project_id

No

String

The ID of the enterprise project to be queried.

Minimum length: 0 characters

Maximum length: 255 characters

Request

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

The user token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Minimum length: 1 character

Maximum length: 16,384 characters

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.

Minimum value: 0

Maximum value: 2147483647

migration_errors

Array of MigrationErrors objects

The details of the failed source servers.

Array length: 0 to 65,535 characters

Table 4 MigrationErrors field description

Parameter

Type

Description

error_json

String

The error message in JSON format.

Minimum length: 0 characters

Maximum length: 255 characters

host_name

String

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

Minimum length: 0 characters

Maximum length: 255 characters

name

String

The source server name defined on the SMS console.

Minimum length: 0 characters

Maximum length: 255 characters

source_id

String

The source server ID.

Minimum length: 0 characters

Maximum length: 255 characters

source_ip

String

The IP address of the source server.

Minimum length: 0 characters

Maximum length: 255 characters

target_ip

String

The IP address of the target server.

Minimum length: 0 characters

Maximum length: 255 characters

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

OK

{
  "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 Codes

Status Code

Description

200

Response returned.

Error Codes

For details, see Error Codes.