1)接口功能介绍
查询ssh密钥对。
2)接口约束
确定查询接口的正确与参数的合法性,必须创建密钥后才能够查询到数据。
3)URI
GET /v1/describeKeyPairs。
4)请求参数
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
keyPairId | 否 | String | SSH密钥对ID。与keyword同时指定时以keyPairId为准,同时未指定时返回所有结果 | 100 | |
keyword | 否 | String | 通过关键字查询,查询逻辑为密钥对名称是否包含该关键字,与keyPairId同时指定时以keyPairId为准,同时未指定时返回所有结果 | test | |
page | 否 | Integer | 当前页数,不填默认为1 | 1 | |
perPageNum | 否 | Integer | 每页显示的记录条数,不填默认为10 | 10 |
5)响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
requestId | 是 | String | 请求id | b84233d3-0796-xxx | |
status | 是 | Object | 应答状态 | status | |
data | 是 | Object | 返回数据 | data |
表 status
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
message | 是 | String | 状态描述 | Success | |
code | 是 | String | 状态码 | Success |
表 data
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
totalPage | 是 | Integer | 总页数 | 1 | |
totalRecord | 是 | Integer | 记录总个数 | 1 | |
page | 是 | Integer | 当前页数 | 1 | |
perPageNum | 是 | Integer | 每页显示的记录条数 | 10 | |
keyPairInfos | 是 | Object | SSH密钥对信息列表 | keyPairInfos |
表keyPairInfos
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
keyPairId | 是 | String | 密钥对ID | 12 | |
name | 是 | String | 密钥名称 | test-ssh-name | |
description | 否 | String | 密钥描述 | test desc | |
content | 是 | String | 密钥内容 | ssh rsa xxx | |
createTime | 是 | String | 密钥创建时间(Unix时间戳,秒) | 1611734844 | |
updateTime | 是 | String | 密钥更新时间(Unix时间戳,秒) | 1611734844 |
6)请求示例
GET https://{host}/v1/describeKeyPairs?keyPairId=111&keyword=&page=1&perPageNum=10
7)响应示例
{
"status": {
"message": "Success",
"code": "Success"
},
"data": {
"totalRecord": 1,
"totalPage": 1,
"keyPairInfos": [
{
"updateTime": "1669681168",
"description": "",
"keyPairId": "111",
"content": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDmVA04UtPgXKGRizZpzrtFongigH/Qa8iBMNq6jG5sVCn3g6pYeuCgJDuqDnwN7+UP4Mh4IPTyo4n+hxS2l7mvuJhthxzAhQDqm6d7goVSDHCMbPDasev9CmHNa7gtYVjNdDWlBuqxVjI3MXzMqjGfUd3hMgNS8iYyuTuWZtXEuACiy9z0G6Oglpr0MtroP5ACGt7oIPF4i1S0UekQCGz2yJyas9KX2o9F5kNtJJZNxo5zj6BuTwx7fhXbYwNstvVEjtt3YFWHNBRKRU+MJ8sXDdo0jGH3IoJlkfdzc5U2UI7u2Ma64+Pj5zy71dIocRWrszFTFK/NZRwjDVhLRKVt\n",
"createTime": "1669681168",
"name": "test-ssh-1128"
}
],
"page": 1,
"perPageNum": 5
},
"requestId": "795137e8-969c-4299-98aa-ed66c47ab170"
}
8)状态码
状态码 | 描述 |
---|---|
Success | 表示请求成功。 |