更改密钥对描述
更新时间：2024-07-02
该接口用于更改密钥对描述，若用户提供的新的描述内容为空，则删除所操作密钥对的描述。
请求结构
PUT /v{version}/keypair/{keypairId}?{action} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string
{
"description" : newDescription
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| action | String | 是 | Query参数 | 对密钥对执行的操作，当前取值：updateDesc |
| keypairId | String | 是 | URL参数 | 待更改描述的密钥对id |
| description | String | 否 | RequestBody参数 | 新的密钥对描述 |
返回头域
除公共头域，无其它特殊头域。
返回参数
无
错误码
| 错误码 | 错误描述 | HTTP状态码 | 中文解释 |
|---|---|---|---|
| Keypair.KeypairNotExist | Keypair not exist. | 404 | 密钥对不存在 |
| Keypair.PublicKeyFormatInvalid | Public key format is invalid. | 400 | 密钥对描述非法 |
请求示例
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"
}返回示例
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