Modify Custom Image Name
Updated at：2025-10-20
This API allows you to update the name of a custom image.
Request structure
Plain Text
1PUT /v{version}/image/rename?clientToken={clientToken} HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "name" : imageName,
7 "imageId" : imageId
8}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 | No | Query | Idempotence Token, which is an ASCII string with a length not exceeding 64 bits. For details, see the [Idempotence](BCC/API Reference/General Description.md#Idempotence). |
| name | String | Yes | Request Body parameters | Name of custom image to be created, which supports uppercase and lowercase letters, numbers, Chinese characters, and -_/special characters, starting with a letter and a length of 1-65. |
| imageId | String | Yes | Request Body parameters | ID of the custom image |
Response headers
No special headers are required beyond the standard ones.
Error codes
| Error code | Error description | HTTP status code | Chinese explanation |
|---|---|---|---|
| Image.ImageNameInvalid | Image name is invalid. | 400 | The image name is incorrect |
| BadRequest | Bad request parameters or illegal request. | 400 | Invalid request parameters |
Request example
Plain Text
1PUT /v2/image/rename?clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849 HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5{
6 "name" : "newName",
7 "imageId":"m-1849ef6b"
8}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