更新时间：2025-10-16 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 |
|
keypair_name |
是 |
String |
密钥对名称 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
keypair |
是 |
UpdateKeypairDescriptionReq object |
更新SSH密钥对描述消息体 |
响应参数
状态码：200
OK
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
{
"keypair" : {
"description" : "description"
}
}
响应示例
状态码：400
Error response
{
"error_code" : "KPS.XXX",
"error_msg" : "XXX"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Error response |
错误码
请参见错误码。
