1)接口功能介绍
导入由其他工具产生的RSA密钥对的公钥部分。
2)接口约束
确保导入密钥对内容的合法性,如果不按照要求的格式则无法上传。
3)URI
POST /v1/importKeyPair。
4)请求参数
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
name | 是 | String | 密钥对名称。1. 只能包含字母、数字、下划线(_)、中划线(-)、点(.)2. 必须以字母开头 3. 必须以字母或数字结尾 4. 长度小于64字符 | test-ssh-xxx | |
content | 是 | String | SSH密钥对内容,SSH密钥对公钥部分,格式需要符合SSH或IETF规范 | ssh-rsa xxx | |
description | 否 | String | SSH密钥对描述 | test |
5)响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
requestId | 是 | String | 请求id | b84233d3-0796-xxx | |
status | 是 | Object | 应答状态 | status | |
data | 是 | Object | 返回数据 | data |
表 status
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
message | 是 | String | 状态描述 | Success | |
code | 是 | String | 状态码 | Success |
表 data
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
keyPairId | 是 | String | SSH密钥对ID | 28 |
6)请求示例
请求体body
{
"name": "apitest1",
"content": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDF7mLqBrPaF1Ier009Xh6i5A7Jyfei9txvUVMd5q+jFSXMtGdC2vqSrti5r9v+eCx5nVtx9QfwFTZ7sFulMSe7GAP2TSuNv/7JbJVctRQ0fUV/BMoLuUyb5zdAZLIiVspIMdV8+s/ZXpXJ3VDeNl0eBNmSeQtSHF7MaSyP0l+ECE3CdIEU51YWV6SlibrSNVljxYp98ojW9CDp+N6wRN+SYbRZOrFTlNhkFF1UvlU7rOG8ewuDr2fIBDQuiTYXezkMVwtfIY5Q3BQoZJgCdLjzvINsYKw0h3HQ3Hub5WOvxBjtP2hjZ+K3Eyi1islPMYP8Y7ORK40ygzOioz9mvSNn",
"description": "test"
}
7)响应示例
{
"data": {
"keyPairId": "17"
},
"requestId": "197bf7d5-57d4-4095-9ee6-3e856fcd282e",
"status": {
"code": "Success",
"message": "Success"
}
}
8)状态码
状态码 | 描述 |
---|---|
Success | 表示请求成功。 |