Help Center/ Elastic Cloud Server/ API Reference/ APIs (Recommended)/ Status Management/ Modifying the Specifications of an ECS (Pay-per-Use)
Updated on 2025-09-19 GMT+08:00
View PDF

Modifying the Specifications of an ECS (Pay-per-Use)

Function

ECS specifications can be modified, for example, upgrading the vCPUs and memory, to meet service requirements. This API is used to modify ECS specifications.

This API is an asynchronous API. After the specifications modification request is successfully delivered, a job ID is returned. This does not mean the modification 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 modification is successful.

Constraints

  • You can modify the ECS specifications only when the ECS is stopped.
  • This API cannot be used to modify the specifications of a yearly/monthly ECS. For details about how to modify the specifications of a yearly/monthly ECS, see Modifying the Specifications of an ECS.
  • Spot ECSs do not support specifications modification.

URI

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

Table 1 describes the parameters in the URI.
Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Specifies the project ID.

For details about how to obtain the ID, see Obtaining a Project ID.

server_id

Yes

Specifies the ECS ID.

Request

Table 2 describes the request parameters.
Table 2 Request parameters

Parameter

Mandatory

Type

Description

resize

Yes

Object

Definition

Specifies the operation to modify ECS specifications. For details, see Table 3.

Constraints

N/A

Range

N/A

Default Value

N/A

dry_run

No

Boolean

Definition

Specifies whether to check the request. If this parameter is set to true, no instance is created.

Constraints

N/A

Range

  • true: Check the request. Check items include the mandatory parameters and request format.
    • If the check fails, the system returns an error.
    • If the check is successful, the system returns status code 202.
  • false: Do not check the request.

Default Value

false
Table 3 resize field description

Parameter

Mandatory

Type

Description

flavorRef

Yes

String

Definition

Specifies the flavor ID of the ECS after the modification.

You can view Querying the Target ECS Flavors to Which a Flavor Can Be Changed to query the target flavors to which a specified ECS flavor can be changed.

Constraints

N/A

Range

N/A

Default Value

N/A

mode

No

String

Definition

Species whether specifications can be modified at ECS runtime.

Constraints

N/A

Range

If the parameter value is withStopServer, the modification process is as follows: The system automatically stops the ECS, modifies ECS specifications, and starts the ECS after the modification is complete.

Default Value

N/A

Response

See Responses (Task).

Example Request

Change the ECS flavor to c3.15xlarge.2.

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

{
    "resize": {
        "flavorRef": "c3.15xlarge.2"
    }
}

Example Response

{      
    "job_id": "ff80808288d41e1b018990260955686a" 
}

Returned Values

See Returned Values for General Requests.

Error Codes

See Error Codes.

Parent topic: Status Management