Modify instance description
Updated at：2025-10-20
This API is used to modify the description information of a specified BCC instance;
This API can only be called for instances that are either Running or Stopped. If not, a 409 error will be returned.
Request structure
Plain Text
1PUT /v{version}/instance/{instanceId}?{action} HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization string
4{
5 "desc": desc
6}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 | Specified instance ID |
| desc | String | Yes | Request Body parameters | Instance description information |
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 |
| 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?modifyDesc HTTP/1.1
2Host: bcc.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5{
6 "desc": "example"
7}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