调用 ModifyKeyPairAttribute 修改密钥对描述信息。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ModifyKeyPairAttribute | 要执行的操作,取值:ModifyKeyPairAttribute。 |
Version | String | 是 | 2020-04-01 | API的版本,取值:2020-04-01。 |
ClientToken | String | 否 | 333456899ff**** | 保证请求幂等性。由客户端自动生成一个参数值,确保不同请求间该参数值唯一,避免当调用API超时或服务器内部错误时,客户端多次重试导致重复性操作。 |
Description | String | 是 | ssh_key_pair aaa | 密钥对的描述,默认值为空字符串。
|
KeyPairId | String | 否 | kp-ybqcopwrdwl8j1****** | 密钥对唯一ID。可以调用DescribeKeyPairs接口查询。
|
KeyPairName | String | 否 | ssh_key_pair | 密钥对名称。
|
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
KeyPairName | String | ssh_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" } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | IdempotentParameterMismatch | The 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. | 幂等参数不一致。 |
400 | InvalidClientToken.Malformed | The specified ClientToken is malformed. | 指定的ClientToken不合法。 |
400 | InvalidKeyPairDescription.Malformed | The specified KeyPairDescription is malformed. | 指定的密钥对描述不合法。 |
400 | MissingParameter.Description | The required parameter Description is not supplied. | 指定的参数Description不能为空。 |
400 | MissingParameter.KeyPairNameAndKeyPairId | The required parameters KeyPairName and KeyPairId are not supplied. | 密钥对名称和ID不能同时为空。 |
404 | InvalidKeyPair.NotFound | The specified KeyPair does not exist. | 指定的密钥对不存在。 |
412 | IdempotentProcessing | The request uses the same client token as a previous one that is still in process. | 先前的幂等请求仍在处理中,请稍后重试。 |
500 | InternalError | An internal error has occurred. | 内部错误,请重试。如果多次尝试失败,请提交工单。 |