Change the Key Pair Description
Last Updated：2020-09-21
- The interface is used to change the key pair description. If the new description content provided by the user is empty, delete the description of the operated virtual machine.
Request structure
PUT /v{version}/keypair/{keypairId}?updateDesc HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string
{
"description" : newDescription
} Request header
There are no special headers except the common header.
Request parameter
| Parameter name | Type | Required or not | Parameter position | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| keypairId | String | Yes | URL parameter | Key pair id of the description to be changed |
| description | String | No | RequestBody parameter | New key pair description |
Return header
There are no special headers except the common header.
Return parameter
None
Error code
| Error code | Error description | HTTP status code | Chinese explanation |
|---|---|---|---|
| Keypair.KeypairNotExist | Keypair not exist. | 404 | The key pair doesn't exist. |
| Keypair.PublicKeyFormatInvalid | Public key format is invalid. | 400 | The key pair description is invalid. |
Request example
PUT /v2/keypair/k-h4NDJPhY?updateDesc HTTP/1.1
Host: bcc.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
{
"description": "new description"
} Return example
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