查询一个或多个SSH密钥对
接口功能介绍
此接口提供用户查询SSH密钥对功能。系统会接收用户输入的查询条件,并返回符合条件的密钥对详细信息。用户可根据此接口的返回值了解对应条件下的密钥对信息。
接口约束
- 当前页面接口为旧版 API,未来根据实际使用情况可能退役,推荐使用新版本接口,新版本接口更加规范,覆盖场景更全。
URI
POST /v4/ecs/keypair/describe
请求参数
请求头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 |
请求示例1
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b"
}
响应示例1
{
"returnObj": {
"currentCount": 10,
"totalCount": 12,
"totalPage": 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",
"name": "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",
"name": "test-for-delete",
"keyPairID": "cd3343de-f44a-088e-5b05-64eb83b3b2da",
"projectID": "0"
},
{
"publicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDWqatTj2UxMdta2ylW7UHpWCvC/kVWcyl/HYjDEsmgn8ZeYcip/BBB7DdhBlPfQRSs8zdA5ddG5ymDFOU/pYbLXxMoZR+cJzXS+I3PWuc4iVKXhDJPLCRJwM6cXldgutZJu3luL7hP2+MgTgE79sLhZu7krlJJpgOXxRST73eiBkD7kVNKqzSWWfDO5t2AdTaLVvJpoF8BqfHWXygSZXhBRrhhAMA6szqMvDZl+p7Sl48JX5h1a/VSpM2LrDXaooZIa1/KHDWxkIGFAf+pTpB5dCUGAZL7L5c8tfTi4yT9cRtVaHnYG1uILSGLICM8hSLq3RoA3+zaqZHPLdREa5k7
",
"fingerprint": "48:af:1c:0e:75:73:ea:25:0b:a6:6e:46:66:6b:6c:ae",
"name": "keypair-688",
"keyPairID": "2db70c5c-c552-bf78-04f9-87d8d29fa909",
"projectID": "0"
}
]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
请求示例2
请求头header
无
请求体body
{
"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
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
errorCode | 描述 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |
Ecs.RegionInfo.AccessFailed | 查询资源池失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.RegionInfo.DataDamaged | 查询资源池信息不符预期,请重试。如果多次尝试失败,请提交工单 |
Ecs.RegionInfo.Empty | 查询资源池信息为空或资源池不存在,请确认资源池ID是否有效 |
Openapi.KeypairWorkorder.AccessFailed | 查询密钥对信息失败,请重试。如果多次尝试失败,请提交工单 |