You need to enable JavaScript to run this app.
导航
云服务器
  • 文档首页
    • /
  • 云服务器

ModifyKeyPairAttribute

最近更新时间：2023.11.20 10:48:36

首次发布时间：2022.07.01 09:09:04

我的收藏

调用 ModifyKeyPairAttribute 接口修改密钥对描述信息。

调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

名称类型是否必填示例值描述
ActionString是ModifyKeyPairAttribute要执行的操作，取值：ModifyKeyPairAttribute。
VersionString是2020-04-01API的版本，取值：2020-04-01。

KeyPairName

String

否

ssh_key_pair

密钥对名称。

  • KeyPairName与KeyPairId不允许同时为空。
  • 如果同时设置了KeyPairName与KeyPairId，则优先生效KeyPairId。

KeyPairId

String

否

kp-ybqcopwrdwl8j1******

密钥对唯一ID，可以调用DescribeKeyPairs接口查询。

  • KeyPairName与KeyPairId不允许同时为空。

  • 如果同时设置了KeyPairName与KeyPairId，则优先生效KeyPairId。

DescriptionString是ssh_key_pair aaa待修改的密钥对描述信息。

ClientToken

String

否

333456899ff****

保证请求幂等性。由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。
取值：仅支持ASCII字符，且不能超过64个字符。

返回数据

名称类型示例值描述
KeyPairNameStringssh_key_pair密钥对名称。

请求示例

GET /?Action=ModifyKeyPairAttribute&Version=2020-04-01&KeyPairName=ssh_key_pair&Description=ssh_key_test_description HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: ecs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202106111445100102252431000052****",
        "Action": "ModifyKeyPairAttribute",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {
        "KeyPairName": "ssh_key_pair"
    }
}

错误码

HttpCode错误码错误信息描述
400MissingParameter.KeyPairNameAndKeyPairIdThe required parameters KeyPairName and KeyPairId are not supplied.密钥对名称与密钥对ID不允许同时为空。

400

MissingParameter.Description

The required parameter Description is not supplied.

指定的参数Description不能为空。

400

InvalidKeyPairDescription.Malformed

The specified KeyPairDescription is malformed.

指定的密钥对描述不合法。

400IdempotentParameterMismatchThe request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.幂等参数不一致。
400InvalidClientToken.MalformedThe specified ClientToken is malformed.指定的ClientToken不合法。
404InvalidKeyPair.NotFoundThe specified KeyPair does not exist.指定的密钥对不存在。
412IdempotentProcessingThe request uses the same client token as a previous one that is still in process.先前的幂等请求仍在处理中，请稍后重试。
500InternalErrorAn internal error has occurred.内部错误，请重试。如果多次尝试失败，请提交工单。