更新时间：2026-05-20 GMT+08:00
更新SSH密钥对描述 - UpdateKeypairDescription
功能介绍
更新SSH密钥对描述
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
kps:SSHKeyPair:update
Write
SSHKeyPair *
-
kps:domainKeypairs:update
-
URI
PUT /v3/{project_id}/keypairs/{keypair_name}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释： 项目ID。可参考获取项目ID获取。 约束限制： 不涉及 取值范围： 以IAM服务接口返回值为准，字符长度32-32 默认取值： 不涉及 |
| keypair_name | 是 | String | 参数解释： 密钥对名称 约束限制： 密钥对名称由英文字母、数字、下划线、中划线组成，长度不能超过255个字节 取值范围： 不涉及 默认取值： 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释： 用户Token。通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值） 约束限制： 不涉及 取值范围： IAM服务查询用户Token接口为准 默认取值： 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| keypair | 是 | UpdateKeypairDescriptionReq object | 参数解释： 更新SSH密钥对描述消息体 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
响应参数
状态码：200
OK
无
请求示例
{
"keypair" : {
"description" : "description"
}
} 响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
错误码
请参见错误码。
