1)接口功能介绍
创建一对SSH密钥对。
2)接口约束
无。
3)URI
POST /v1/createKeyPair。
4)请求参数
请求体Body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
keyPairName | 是 | String | 密钥对名称。1、只能包含字母、数字、下划线(_)、中划线(-)、点(.) 2、必须以字母开头 3、必须以字母或数字结尾 4、长度小于64字符 | ssh-test |
5)响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
requestId | 是 | String | 请求id | b84233d3-0796-xxx | |
status | 是 | Object | 应答状态 | status | |
data | 是 | Object | 返回数据 | data |
表 status
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
message | 是 | string | 状态描述 | Success | |
code | 是 | string | 状态码 | Success |
表 data
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
publicSshKey | 是 | String | 密钥对的指纹 | ssh-rsa AAAAB3NzaC1yc2EAAAADAQA...... | |
keyPairName | 是 | String | 密钥对名称 | test-ssh-xxx | |
keyPairId | 是 | String | SSH密钥对的ID | 100 | |
privateKeyBody | 是 | String | 密钥对的私钥 | -----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAz5EFztQ9yN5xxx......\n-----END RSA PRIVATE KEY----- |
6)请求示例
请求体body
{
"keyPairName": "test-ssh-xxx"
}
7)响应示例
{
"status": {
"message": "Success",
"code": "Success"
},
"data": {
"publicSshKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC+vrpARbFaIsC3e2btbenj0GjHUHelZfNsIoYTlY/Z3yKbX7Mlv+DzSw1wdmDTT2riufnHEszbNp9f8JtCNUVBiugGrrrVJk6oRWFA2DA0FXYuUHpKU20yRz6QRKvQnGQU+Z4o7h4R3aMPFHUpLwmEZb2c94whc/3qD9oI907LRkLybZBz3lUKEdzSFpNMauA2CCmzECI4cX4bFQXr4RGJH/RJRL71MxiiJb2ki13b1w1sC0Ku3jC0tBLRqNzQKXQgUQHBROVvZGtTBOcoSiuvnA5Rb0ZLaT592I9rNj1GYE3673DQZFS6i7FSIbuGO5mvBSVdGqPLtcJXqlTyJQGp\n",
"keyPairId": "110",
"privateKeyBody": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAvr66QEWxWiLAt3tm7W3p49Box1B3pWXzbCKGE5WP2d8im1+z\nJb/g80sNcHZg009q4rn5xxLM2zafX/CbQjVFQYroBq661SZOqEVhQNgwNBV2LlB6\nSlNtMkc+kESr0JxkFPmeKO4eEd2jDxR1KS8JhGW9nPeMIXP96g/aCPdOy0ZC8m2Q\nc95VChHc0haTTGrgNggpsxAiOHF+GxUF6+ERiR/0SUS+9TMYoiW9pItd29cNbAtC\nrt4wtLQS0ajc0Cl0IFEBwUTlb2RrUwTnKEorr5wOUW9GS2k+fdiPazY9RmBN+u9w\n0GRUuouxUiG7hjuZrwUlXRqjy7XCV6pU8iUBqQIDAQABAoIBAByMjXHrPHVCOFf+\nB1TIG7a2TchvOckurjVkIW8y9nnklNhuhXDD/FZNyHApt6pI+7V9om3yWWkCDu6c\nI5DQSlJaCQpfAqW+ew1ifQDomqZhA/RApV0UiYZ59VpAfPrXPX+KMOrtYODJrIso\nQ7TrTmBbnfqtbnLfWoS65KZs5YU094lI7YMv4HeOdD2Kby1w9huSCMRsI8uhuZYI\ntfPvu13l0gZP2hsDrN44PWASWsWROuWfgY3w3UC4CK0HIOUNXpVgbo2v0XEPjzvQ\ner1b9reQfJZmB2qSbP6wOGwpGT86Hdj+zAOgAQ69hjzfuacQH5gYSdIhHtmB4TEE\nnRbNeQUCgYEA8iK7ahFIR9C5KfpHp45O5bjLp8OI9JKhXpm+Ua81JiQCV3bXO3Nl\ngD7T7eA0wVYOA4GfdUv0UBNpLpknquB9W4LeI57y0w9ybeZYXNUJS+3Asn8CcFyB\nC6UszGvpX3ceuTwvwVepDlqerMN/KN3RpuxOtTL2Fr/NFClI7XC52sMCgYEAyaqz\nxfls2ecwxfJ9SsvpaVDJdOaNdl0xhFR3uA58SCidUIGuq7PC5eCJitvcMAHU0rik\nCjXUoNSEMYXW7jtnNKbD9R+syWgWhScntfCijwVXnA2nEPPKo+2Yp5wqJRN31nv4\n10LCaHdLfrAKxTdVwctNV32bdMjedSieKKZH8yMCgYEAz3rddvTaJ9d9Yq/4iGYT\nyxq/P8D4cQHYTrSU9W+ZrlX6v7Gwmlu2ZN7xQIr3CZfQqEaBOcRc0+TeIzTPXcfB\nAxIvgPxpfFtnJS7VFq7hqXNPxGO61kcduLnPmlb5gXkUFYuyLA0OaqNSBh36ryzr\nwgoJI5FId5Pgid8ag4MtbnsCgYB7C7eCvOxIjAI7VPhTkdVJ1+wDcsSviq8y0aL2\nX4g/MuDBhU7BHv506iqh2gIgHI3xQI1+WVfyBZje6o24b/BJtNLtljUD8omDFt/o\n5/kXkKfi5IWiF0319XtmESe51YYSDTRIi0g5G0ip9NmteVTO2K/JCS+38vOgwna1\n0LcnxwKBgGx7tfMMYrE9UUBUooSZepcNiviaUtwY/rVthBJyxaoGbLDTrWqTl+c8\nX4axFsETwTVH5FD6jATIXOzzaH6cUi3wflsaX4PrVnFvddelxS/tPHStqA3/ixaA\nG3a+OJll2wasJ9uXxPjmFpTV4vHGZAH+KR9CbvQEMiH5Qh4v8gOe\n-----END RSA PRIVATE KEY-----\n",
"keyPairName": "test-ssh-xxx"
},
"requestId": "202ceed8-6a4a-4a52-815d-dd034facb211"
}
8)状态码
状态码 | 描述 |
---|---|
Success | 表示请求成功。 |