Enable auto-renewal
Updated at:2025-10-20
This API allows you to enable auto-renewal for a specified disk.
- Note: Auto-renewal is only supported for data disks.
- Note: Auto-renewal cannot be performed for disks with an expired status.
- Asynchronous API; the disk expiration time can be queried through the [Query Disk Details](#Query disk details) API.
Request structure
Plain Text
1POST /v{version}/volume/autoRenew HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: ${authorization-string}
4
5{
6 "volumeId" : volumeId,
7 "renewTimeUnit" : renewTimeUnit,
8 "renewTime" : renewTime
9}
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 |
| clientToken | String | Yes | Query | Idempotence Token, which is an ASCII string with a length not exceeding 64 bits. For details, see the [Link](#ClientToken Idempotency Support) |
| volumeId | String | Yes | RequestBody | Disk ID |
| renewTimeUnit | String | Yes | RequestBody | Monthly or yearly payment. "month" for monthly, "year" for yearly; only monthly payment supported currently |
| renewTime | int | Yes | RequestBody | Auto-renewal period: 1-9 for monthly renewal, 1-3 for yearly renewal |
Response headers
No special headers are required beyond the standard ones.
Response parameters
There are no special response parameters
Request example
Plain Text
1POST /v2/volume/autoRenew HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: ${authoriazion-string}
4
5{
6 "volumeId" : "v-****",
7 "renewTimeUnit" : "month",
8 "renewTime" : 3
9}
Response example
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: ${request-id}
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
