Function

An ECS deployed on a DeH can be migrated to another DeH.
An ECS deployed on a DeH can be migrated to a public resource pool.
An ECS deployed in a public resource pool can be migrated to a DeH.

This API is an asynchronous API. After the cold migration request is successfully delivered, a job ID is returned. This does not mean the cold migration is complete. You need to call the API by referring to Querying Job Execution Status to query the job status. The SUCCESS status indicates that the cold migration is successful.

If the migration does not cross NUMA nodes, the migration may fail due to insufficient resources on a single NUMA node.

Constraints

Currently, this API applies only to dedicated hosts.
Only a stopped ECS can be cold migrated.
Existing constraints of the native cold migration API are inherited.

URI

POST /v1/{project_id}/cloudservers/{server_id}/migrate

Table 1 describes the parameters in the URI.

**Table 1** Parameter description
Parameter	Mandatory	Description
project_id	Yes	Specifies the project ID.
server_id	Yes	Specifies the ECS ID.

Request

Table 2 describes the request parameters.

**Table 2** Request parameters
Parameter	Mandatory	Type	Description
migrate	Yes	Object	Definition Specifies the ECS to be migrated. For details, see Table 3. This parameter is null when you migrate an ECS from a dedicated host to a public resource pool. Constraints N/A Range N/A Default Value N/A

**Table 3** **migrate** field description
Parameter	Mandatory	Type	Description
dedicated_host_id	No	String	Definition Specifies the DeH ID. Constraints This parameter takes effect when an ECS is migrated from a public resource pool to a DeH or between DeHs. Range N/A Default Value N/A

Response

Table 4 describes the response parameters.

**Table 4** Response parameters
Parameter	Type	Description
job_id	String	Definition Specifies the job ID returned after a job is delivered. The job ID can be used to query the job execution progress. For details about how to query the job execution status based on job_id, see Job Status Management. Range N/A

For details about abnormal responses, see Responses (Jobs).

Example Request

Migrate the ECS from the public resource pool to the DeH whose ID is 459a2b9d-804a-4745-ab19-a113bb1b4ddc.

POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/migrate

{
    "migrate": {
        "dedicated_host_id": "459a2b9d-804a-4745-ab19-a113bb1b4ddc"
    }
}

Example Response

{    
    "job_id": "ff80808288d41e1b018990260955686a" 
}

Returned Values

See Returned Values for General Requests.

Error Codes

See Error Codes.

Cold Migrating an ECS