Modify the Instance Description
Last Updated：2020-07-20
Change the description information of specified virtual machine.
This API can be called only when the instance is in the Running or Stopped status. Otherwise, it prompts an error 409.
Request Structure
PUT /v{version}/instance/{instanceId}?modifyDesc HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string
{
"desc": desc
}Request Header Field
There are no other special header fields except the public header field.
Request Parameters
| Parameter Name | Type | Required | Parameter Position | Description | |
|---|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number | |
| instanceId | String | Yes | URL parameter | Specified instance ID | |
| desc | String | Yes | Request Body Parameter | Description information of instances |
Return Header Field
There are no other special header fields except the common header field.
Return Parameter
No specific parameters are returned.
Request Instance
PUT /v2/instance/i-YufwpQAe?modifyDesc HTTP/1.1
Host: bcc.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
{
"desc": "example"
}Return Instance
HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2014 06:42:19 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS