Modifying the Specifications of an ECS¶
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 Task Execution Status to query the job status. The SUCCESS status indicates that the modification is successful.
An ECS flavor cannot be changed to certain flavors. For details, see Querying the Target Flavors to Which an ECS Flavor Can Be Changed.
Constraints¶
You can modify the ECS specifications only when the ECS is stopped.
URI¶
POST /v1/{project_id}/cloudservers/{server_id}/resize
Table 1 describes the parameters in the URI.
Parameter | Mandatory | Description |
|---|---|---|
project_id | Yes | Specifies the project ID. |
server_id | Yes | Specifies the ECS ID. |
Request¶
Table 2 describes the request parameters.
Parameter | Mandatory | Type | Description |
|---|---|---|---|
resize | Yes | Object | Specifies the operation to modify ECS specifications. For details, see Table 3. |
dry_run | No | Boolean | Specifies whether to only check the request and not modify the ECS specifications. true: The request is sent and the ECS specifications are not modified. Check items include mandatory parameters and request format.
false: The request is sent and the ECS specifications will be modified after the check is passed. |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
flavorRef | Yes | String | Specifies the flavor ID of the ECS after the modification. |
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¶
Error Codes¶
See Error Codes.