接口功能介绍
此接口提供用户查询SSH密钥对功能。系统会接收用户输入的查询条件，并返回符合条件的密钥对详细信息。用户可根据此接口的返回值了解对应条件下的密钥对信息。
接口约束
- 当前页面接口为旧版 API，未来根据实际使用情况可能退役，推荐使用新版本接口，新版本接口更加规范，覆盖场景更全。
URI
POST /v4/ecs/keypair/describe
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以调用regionID查看最新的天翼云资源池列表 | 4cf2962d-e92c-4c00-9181-cfbb2218636c | |
| projectID | 否 | String | 企业项目ID | 0 | |
| name | 否 | String | 密钥对名称。 | KeyPair-a589 | |
| pageNo | 否 | Integer | 页码，取值范围：大于等于1，默认值为1 | 1 | |
| pageSize | 否 | Integer | 每页记录数目，取值范围:[1~50]，默认值为10，单页最大记录不超过50 | 10 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为处理中或失败) | 800 | |
| errorCode | String | 业务细分码，为product.module.code三段式码，详见错误码说明 | ||
| message | String | 失败时的错误信息 | ||
| description | String | 失败时的错误描述 | ||
| returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| currentCount | Integer | 当前页记录数目 | 1 | |
| totalCount | Integer | 总记录数 | 10 | |
| totalPage | Integer | 总页数 | 1 | |
| results | Array of Objects | 分页明细 | results |
表 results
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| publicKey | String | 密钥对的公钥 | dd:8e:69:f0:a1:5a:b6:d9:10:19:77:d7:35:b3:65:bf | |
| name | String | 密钥对名称 | KeyPair-a589 | |
| fingerprint | String | 密钥对的指纹，采用MD5信息摘要算法。 | ||
| keyPairID | String | 密钥对的ID | ba425a97-9ad9-2d45-e21a-770d2ebeb477 | |
| projectID | String | 资源所属企业项目ID | 0 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例1：查询资源池下所有的密钥对
{
"regionID": "81f7728662dd11ec810800155d307d5b"
}
示例2：查询指定的密钥对的信息
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"name":"keytest-666"
}
响应示例
{
"returnObj": {
"currentCount": 1,
"totalCount": 1,
"totalPage": 1,
"results": [
{
"publicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDdtJ0fICu6OeEj3TXRQcX9elqMCjjsweY6aVRG8yXBvyK6WQgC0+llom85Bsonm2o2R9ThX5pKuR77NMk+ERWZwdvTIpYWZ2L0cUtHSdRYg06Q5qBJ0avbmnNHVnPSr/4n31ImPWFTSLll1fdUiNe+Cb9J1YiUtvF584DoCyeLrPmgZA2oO7gLucyYGpgb25v9kccEI1HnvVPvrTkkUVKRIgLr5ZCAuBXmef5qPJLjQED04qJPR3qD8DbAcWjOvC4NEJx01ZoBnU/qHr4qXUT/uhCc3IGcy8vEr9Lgyn8h7KmsFMYAM+R24uvuuifAbEmw4j9BasK+qBs1loOmWro/
",
"fingerprint": "e6:ef:5c:05:94:a8:d8:82:6e:b0:d3:57:cc:26:cb:8d",
"name": "keypair-666",
"keyPairID": "ba425a97-9ad9-2d45-e21a-770d2ebeb477",
"projectID": "0"
}
]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
