DescribeKeyPairs_云服务器 ECS_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

请求速率为1000/60(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
ecs:DescribeKeyPairs
Get
KeyPair
acs:ecs:{#regionId}:{#accountId}:keypair/{#keypairName}
KeyPair
acs:ecs:{#regionId}:{#accountId}:keypair/*

请求参数

字段名称字段详情
RegionIdstring

密钥对所在的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
KeyPairNamestring

密钥对名称。支持正则表达式模糊搜索,使用*匹配子表达式,示例:展开详情

示例值:*SshKey*参考取值来源:
    CreateKeyPair
    DetachKeyPair
    AttachKeyPair
    ImportKeyPair
KeyPairFingerPrintstring

密钥对的指纹。根据 RFC 4716 定义的公钥指纹格式,采用 MD5 信息摘要算法。更多详情,请参见RFC 4716

示例值:ABC1234567参考取值来源:
    CreateKeyPair
    ImportKeyPair
PageNumberinteger<int32>

密钥对列表的页码。起始值:1。展开详情

示例值:1取值 >= 1
PageSizeinteger<int32>

分页查询时设置的每页行数。最大值:50。展开详情

示例值:10取值 <= 50
IncludePublicKeyboolean

是否在返回结果中包含 PublicKey。展开详情

示例值:false
ResourceGroupIdstring

密钥对所在的企业资源组 ID。使用该参数过滤资源时,资源数量不能超过 1000 个。展开详情

示例值:rg-amnhr7u7c7hj****参考取值来源:
    DescribeSecurityGroups
Tagarray<object>

标签列表。

子级条数 <= 20

返回参数

字段名称字段详情
PageSizeinteger<int32>

每页行数。

示例值:10
RequestIdstring

请求 ID。

示例值:473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumberinteger<int32>

当前页码。

示例值:1
TotalCountinteger<int32>

密钥对的总数。

示例值:1
KeyPairsobject

返回示例

变更历史

变更时间变更内容概要操作
2024-02-01
新增请求参数IncludePublicKey
变更返回参数