Renew an instance
Updated at：2025-10-20
This API allows you to renew a specified subscribed (prepaid) instance to extend its validity period.
- Renewal operations cannot be performed while instance configuration changes are in progress.
- If an instance has been suspended due to unpaid debt, it will automatically reboot upon successful renewal.
- The system supports simultaneous renewal of associated subscribed (prepaid) CDS/EIP/MKT products. Associated pay-as-you-go (postpaid) CDS/EIP/MKT products are not renewed together.
- This API operates asynchronously.
- Dedicated instances do not support renewal functionality.
- Renewals are processed on a monthly basis.
Request structure
Plain Text
1PUT /v{version}/instance/{instanceId}?{action}&relatedRenewFlag={relatedRenewFlag}&clientToken={clientToken} HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "billing":{
7 "reservation":{
8 "reservationLength": reservationLength
9 }
10 }
11
12}Request headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| instanceId | String | Yes | URL parameter | Virtual machine instance ID |
| action | String | Yes | Query | Parameter value for this API: purchaseReserved |
| clientToken | String | Yes | Query | Idempotence Token, which is an ASCII string with a length not exceeding 64 bits, see details in [ClientToken Idempotence ](BCC/API Reference/General Description.md#Idempotence). |
| relatedRenewFlag | String | No | Query | Set the instance's associated renewal flag, defaulting to an empty string. For optional flags, refer to [RelatedRenewFlag](BCC/API Reference/Appendix.md#RelatedRenewFlag)Note: The CDS disk associated with the instance will be renewed simultaneously. |
| billing | [Billing](BCC/API Reference/Appendix.md#Billing) | Yes | RequestBody | Order details |
| cdsCustomPeriod | [CdsCustomPeriod](BCC/API Reference/Appendix.md#CdsCustomPeriod) | No | RequestBody | For attaching disks, users can define a custom renewal period. The renewal period must be greater than or equal to the difference between the BCC's expiration time (post-renewal) and the current CDS expiration time, and can range from 1 to 60 months. If unspecified, it defaults to match the BCC's post-renewal expiration time. |
Response headers
No special headers are required beyond the standard ones.
Response parameters
| Parameter name | Types | Description |
|---|---|---|
| orderId | String | Order ID |
Error codes
| Error code | Error description | HTTP status code | Chinese explanation |
|---|---|---|---|
| BadRequest | Bad request parameters or illegal request. | 400 | Invalid request parameters |
| NoSuchObject | The specified object is not found or resource do not exist. | 404 | Resource does not exist |
| OperationDenied | Operation not available. | 409 | Operation not allowed |
Request example
Plain Text
1PUT /v2/instance/i-YufwpQAe?purchaseReserved&clientToken=be31b98c-5e41-4838-9830-9be700de5a20&relatedRenewFlag=CDS_EIP_MKT HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5{
6 "billing":{
7 "reservation":{
8 "reservationLength":1
9 }
10 }
11}Response example
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6{"orderId": "daeeb9f0cc8a4b61aa4a7dafd58630a2"}