DescribeKeyPairs - 查询密钥对列表--云服务器-火山引擎

文档中心

立即注册

导航

云服务器

DescribeKeyPairs - 查询密钥对列表

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

调用 DescribeKeyPairs 接口查询密钥对列表信息。

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeKeyPairs	要执行的操作，取值：DescribeKeyPairs。
Version	String	是	2020-04-01	API的版本，取值：2020-04-01。
KeyPairName	String	否	ssh-asfas	密钥对名称，支持模糊搜索。
KeyPairNames.N	Array of String	否	KeyPairNames.1=ssh_key_pair	密钥对名称，最多支持100个。参数 - N：表示密钥对的序号。多个密钥对之间用&分隔。
KeyPairIds.N	Array of String	否	KeyPairIds.1=kp-ybp0x6i30gep29******	密钥对ID，最多支持100个。参数 - N：表示密钥对ID的序号。多个密钥对ID之间用&分隔。
FingerPrint	String	否	4158f40dbc0814eb04f0dcac4e******	密钥对的指纹。根据RFC4716定义的公钥指纹格式，采用MD5信息摘要算法。
ProjectName	String	否	project_a	资源所属项目，一个资源只能归属于一个项目。只能包含字母、数字、下划线“_”、点“.”和中划线“-”。长度限制在64个字符以内。
NextToken	String	否	--	分页查询凭证，用于标记分页的位置，初次调用该接口时无需设置。下次查询时，取值为上一次API调用返回的NextToken参数值。
MaxResults	Integer	否	10	分页查询时设置的每页行数。最大值：500 默认值：10

返回参数

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

参数	类型	示例值	描述
KeyPairs	Array of KeyPairsForDescribeKeyPairs	--	密钥对信息。
NextToken	String	bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq******	本次调用返回的查询凭证值，返回为空表示该页为末页。

请求示例

GET /?Action=DescribeKeyPairs&Version=2020-04-01&MaxResults=1 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: ecs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202106111445100102252431000052****",
        "Action": "DescribeKeyPairs",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {
        "NextToken": "eWJwMHd3MzE2dmVwMjkyMnk******",
        "KeyPairs": [
            {
                "KeyPairName": "ssh_key_pair",
                "KeyPairId": "kp-ybp0x6i30gep29******",
                "Description": "",
                "FingerPrint": "6f3c737485f6836b124648db49******",
                "CreatedAt": "2022-05-20T11:24:16+08:00",
                "UpdatedAt": "2022-05-20T11:24:16+08:00",
                "ProjectName": "project_a"
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	LimitExceeded.MaximumKeyPairNames	You've reached the limit on the number of KeyPairNames that you can set.	指定的密钥对名称数量超过最大限制。
400	LimitExceeded.MaximumKeyPairIds	You've reached the limit on the number of KeyPairIds that you can set.	指定的密钥对ID数量超过最大限制。
400	InvalidArgument	The specified argument is invalid.	指定的参数不合法。
429	FlowLimitExceeded	You've reach the limit on request rate of resources.	您已超过资源请求限速。
500	InternalError	An internal error has occurred.	内部错误，请重试。如果多次尝试失败，请提交工单。