Updated on 2022-08-02 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.

URI

GET /v3/errors

Table 1 Query parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Specifies the number of failed source servers recorded on each page.

Minimum value: 0

Maximum value: 100

Default value: 50

offset

Yes

Integer

Specifies the offset.

Minimum value: 0

Maximum value: 65535

Default value: 0

migproject

No

String

Specifies 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

Specifies 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

Specifies 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

Specifies 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

Specifies the details of the failed source servers.

Table 4 MigrationErrors field description

Parameter

Type

Description

error_json

String

Specifies the error message in JSON format.

Minimum length: 0 characters

Maximum length: 255 characters

host_name

String

Specifies the host name 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

Specifies the source server name defined on the SMS console.

Minimum length: 0 characters

Maximum length: 255 characters

source_id

String

Specifies the source server ID.

Minimum length: 0 characters

Maximum length: 255 characters

source_ip

String

Specifies the IP address of the source server.

Minimum length: 0 characters

Maximum length: 255 characters

target_ip

String

Specifies the IP address of the target server.

Minimum length: 0 characters

Maximum length: 255 characters

Example Request

Query the list of source servers that failed to be migrated due to errors. Record 10 source servers on each page, and display the servers recorded on page 0.

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

Example Response

Status code: 200

OK

{
  "count" : 4,
  "migration_errors" : [ {
    "source_id" : "b5d13e46-fb5f-41da-952a-d7a38c1e47fd",
    "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" : "e7029ea3-fec8-49ca-9cae-9158af0d8419",
    "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" : "c4d1d596-24c2-49ec-9fcf-32e9d28f750d",
    "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" : "490d5aac-f8de-4479-811e-72ed30834be4",
    "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

OK

Error Codes

See Error Codes.