Renew a disk
Updated at:2025-10-20
This API is used to renew a specified disk and extend its expiration date.
- Renewal operations cannot be carried out during disk scaling.
- This API is asynchronous.
- Renewal to the expiration time of the mounted BCC instance is only allowed if the disk’s expiration time is earlier than that of the mounted BCC instance
Request structure
Plain Text
1PUT /v2/volume/{volumeId}?{action}&clientToken={clientToken} HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization string
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 |
| volumeId | String | Yes | URL parameter | Disk 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). |
| billing | [Billing](BCC/API Reference/Appendix.md#Billing) | Yes | RequestBody | Specify a custom renewal duration in months. If left empty, it aligns with the expiration time of the mounted BCC. Ensure the custom duration exceeds (BCC expiration time - current CDS expiration); otherwise, renewal will fail. Supported durations range from 1 to 60 months. |
| instanceId | String | No | RequestBody | ID of the prepaid BCC instance to which the unattached disk is expected to be mounted. This parameter is mandatory when the disk is in an unmounted status, and optional or can be the ID of the currently attached instance when the disk is attached |
Response headers
No special headers are required beyond the standard ones.
Response parameters
There are no special response parameters
Error codes
| Error code | Error description | HTTP status code | Chinese explanation |
|---|---|---|---|
| BadRequest | Bad request parameters or illegal request. | 400 | Invalid request parameters |
| SnapshotOperationForbidden | snapshot operation forbidden. | 403 | Snapshot operation: deny |
| 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/volume/v-3zmCcxbR?purchaseReserved&clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
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
