接口功能介绍
此接口提供用户查询SSH密钥对功能。系统会接收用户输入的查询条件，并返回符合条件的密钥对详细信息。用户可根据此接口的返回值了解对应条件下的密钥对信息。
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
接口约束
无
URI
POST /v4/ecs/keypair/details
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
| projectID | 否 | String | 企业项目ID，企业项目管理服务提供统一的云资源按企业项目管理，以及企业项目内的资源管理，成员管理。您可以通过查看创建企业项目了解如何创建企业项目 | 0 | |
| keyPairName | 否 | String | 密钥对名称。满足以下规则：只能由数字、字母、-组成，不能以数字和-开头、以-结尾，且长度为2-63字符. | KeyPair-a589 | |
| queryContent | 否 | String | 模糊匹配查询内容（匹配字段：keyPairName、keyPairID） | KeyPair-a589 | |
| pageNo | 否 | Integer | 页码，取值范围：正整数（≥1），注：默认值为1 | 1 | |
| pageSize | 否 | Integer | 每页记录数目，取值范围：[1, 50]，注：默认值为10 | 10 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为处理中或失败) | 800 | |
| errorCode | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| error | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| message | String | 失败时的错误信息，一般为英文描述 | SUCCESS | |
| description | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| currentCount | Integer | 当前页记录数目 | 1 | |
| totalCount | Integer | 总记录数 | 10 | |
| results | Array of Objects | 分页明细 | results |
表 results
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| publicKey | String | 密钥对的公钥 | ||
| keyPairName | String | 密钥对名称 | KeyPair-a589 | |
| fingerPrint | String | 密钥对的指纹，采用MD5信息摘要算法。 | ||
| keyPairID | String | 密钥对的ID | ba425a97-9ad9-2d45-e21a-770d2ebeb477 | |
| projectID | String | 企业项目ID | 0 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例1：查询华东1资源池下的所有密钥对
{
"regionID": "bb9fdb42056f11eda1610242ac110002"
}
示例2：查询华东1资源池下名称为"KeyPair-886"的密钥对
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"keyPairName": "KeyPair-886"
}
响应示例
{
"returnObj": {
"currentCount": 2,
"totalCount": 2,
"results": [
{
"publicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCb0cULeebedv3vGpIMVIVYcexr6llJOxdFdvT80yzNnxe1z84K/oTOtQ0WLkuiFqa3YjzT4jngRTvA20JlzIN3pS7AUkSKqzRPSVdXqj9j9GycpHy9gOD4aNHjH1pp7PTP4+ehq/3NY+O6MukyxDcD2NA15DH9zhCdAGoHsUttxBCawQxKxU8/PvS14zVb3pUH9xZ/UD+rvsC2Wx7DtzP3Mf+bGB5KK+4bSMdSFo3s3t1jf7jaQnJgH2L4KCNSObMpLVu1Qs+0W4T8GVK+TPkxItl8myR6A3EsES+ufIktUPcEHIw8O9mTBJGEmsm8bjEEVESHiyeautfo0y4tMZMH",
"fingerPrint": "dd:8e:69:f0:a1:5a:b6:d9:10:19:77:d7:35:b3:65:bf",
"keyPairName": "KeyPair-1031",
"keyPairID": "29b595fe-b3d0-49ea-f58c-817ff6a1de38",
"projectID": "0"
},
{
"publicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCaU1og24HtKf8QxA/Sl840ITVzl/mU7DJwwMmf5hLpRD89xANKPiGaLyxorrjLlSEQWpxLV1IqWsErFrZIx6bXdIrCuQjNSK8vty1jEma32Qn7wkV4G+w/BxD/cgyB/+fclHFOTGtaTNHStmHJ5numLNDTUqdAKLbSklCYzDAolbLoU4e7ietItjPl7K3NjZFCTLv9N7Wiiruu7dMB6sX4CCjFqb+MBeIXbhhwHlozVn6NzZmchtciUty+pJ4FdPKW+0DZ4JHgoenB0hpslOaVnO5H1vAIVhMP+jDnkVD9XkCC8+oUKtxkPe/7r8kqY56okr2xJWcLwriZnXjraYB/",
"fingerPrint": "14:1e:06:14:36:c2:28:42:ef:85:4b:32:ba:28:99:24",
"keyPairName": "test-for-delete",
"keyPairID": "cd3343de-f44a-088e-5b05-64eb83b3b2da",
"projectID": "0"
}
]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
