ModifyKeyPairAttribute - 修改密钥对信息--云服务器-火山引擎

文档中心

立即注册

导航

云服务器

ModifyKeyPairAttribute - 修改密钥对信息

最近更新时间：2024.05.21 10:23:56首次发布时间：2022.07.01 09:09:04

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

调试

API Explorer

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

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	ModifyKeyPairAttribute	要执行的操作，取值：ModifyKeyPairAttribute。
Version	String	是	2020-04-01	API的版本，取值：2020-04-01。
ClientToken	String	否	333456899ff****	保证请求幂等性。由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。取值：仅支持ASCII字符，且不能超过64个字符。
Description	String	是	ssh_key_pair aaa	密钥对的描述，默认值为空字符串。必须以字母或中文开头。只能包含中文、字母、数字、点“.”、空格、下划线“_”、中划线“-”、等号“=”、英文逗号“,”、中文逗号“，”和中文句号“。” 长度限制在255个字符以内。传入空字符串时，将清空原有描述信息。
KeyPairId	String	否	kp-ybqcopwrdwl8j1******	密钥对唯一ID。可以调用DescribeKeyPairs接口查询。 `KeyPairName`与`KeyPairId`不允许同时为空。如果同时设置了`KeyPairName`与`KeyPairId`，则优先生效`KeyPairId`。
KeyPairName	String	否	ssh_key_pair	密钥对名称。 `KeyPairName`与`KeyPairId`不允许同时为空。如果同时设置了`KeyPairName`与`KeyPairId`，则优先生效`KeyPairId`。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
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.	内部错误，请重试。如果多次尝试失败，请提交工单。