接口功能介绍
此接口用来创建一对SSH密钥对。系统会为您保管密钥的公钥部分，并返回未加密私钥。您需要自行妥善保管私钥部分。
接口约束
- 当前页面接口为旧版 API，未来根据实际使用情况可能退役，推荐使用新版本接口，新版本接口更加规范，覆盖场景更全。
URI
POST /v4/ecs/keypair/create
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以调用查询账户启用的资源池信息查看最新的天翼云资源池列表 | bb9fdb42056f11eda1610242ac110002 | |
| name | 是 | String | 密钥对名称。只能由数字、字母、-组成,不能以数字和-开头、以-结尾,且长度为2-63字符 | KeyPair-a589 | |
| projectID | 否 | String | 企业项目ID | 0 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为处理中失败) | 800 | |
| errorCode | String | 业务细分码，为product.module.code三段式码，详见错误码说明 | ||
| message | String | 失败时的错误信息 | ||
| description | String | 失败时的错误描述 | ||
| returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| publicKey | String | 密钥对的公钥 | ||
| privateKey | String | 密钥对的私钥 | ||
| name | String | 密钥对名称 | KeyPair-a589 | |
| fingerprint | String | 密钥对的指纹，采用MD5信息摘要算法。 | 1f:91:df:f6:04:1f:89:b3:40:12:ef:07:f4:1e:c0:c3 | |
| keyPairID | String | 密钥对的ID | ba425a97-9ad9-2d45-e21a-770d2ebeb477 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"name": "keypair-668"
}
响应示例
{
"returnObj": {
"publicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAjUnAnTid4wmVtajSmElMtH03OvOyY81ybfswbUu9Gt83DVVzDnwb3rcQW1us8SeKm/gRINkgdrRAgfXAmTKR7AorYtWWc/tzb6kcDpL2E8Qk+n6cyFAxXNoX2vXBr4kC9wz1uwjGyxoSlpHLIpscfI0Ef652gMlSyfODehAJHj3JPMr8pvtPIUqsZI3JOGTUzxaA2JVC0LxQegphYYf2TxGd9GLRUv1p/0BUAPCMg1NaITXNVEj3A11hk1nrFoJMmvIwIUkLmRuQcxuNAdxeLB7GXXVjKpnKIJL4L64dyA9GWa3Gb7gCJyRaBc5UhK4hT57wmukCrldHHtdF1IJr\n",
"privateKey": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEAwI1JwJ04neMJlbWo0phJTLR9NzrzsmPNcm37MG1LvRrfNw1V\ncw58G963EFtbrPEnipv4ESDZIHa0QIH1wJkykewKK2LVlnP7c2+pHA6S9hPEJPp+\nnMhQMVzaF9r1wa+JAvcM9bsIxssaEpaRyyKbHHyNBH+udoDJUsnzg3oQCR49yTzK\n/Kb7TyFKrGSNyThk1M8WgNiVQtC8UHoKYWGH9k8RnfRi0VL9af9AVADwjINTWiE1\nzVRI9wNdYZNZ6xaCTJryMCFJC5kbkHMbjQHcXiwexl11YyqZyiCS+C+uHcgPRlmt\nxm+4AickWgXOVISuIU+e8JrpAq5XRx7XRdSCawIDAQABAoIBAEOKS7BwdYeMN7R3\nv/v+xtdNCA7zcr/EGjBlO5LFA6gVYO6ikrKFBiuQd44ZPZLwE/qesujvKLomaRun\nelhQZFii/v4w8NKRZEYdiKf6xLnkPQzrgLXl3ZszAp0ThNinhduwZK9dJ7rzSvXy\nMrmaLeZUGfLWBpAypGuRwwT/L9jCUs9LngP2aksfRVM2pP4YGlVgV73riDFsDq0I\ndbOSghW/AQIa7jHO1Jl4oJDiH+pEYv9VARXlqZWIMzdaB15XRp4tLOVyouG8HTZD\nqFSmptWbUBQFO+5gA6XsMAN6+KbYQlB7W8iPd+ysPBjohu/Gv62cs1DmssQWhBOT\nsiMZRoECgYEA0bMcRHRTWgzFKungriYSAkdqWwWIhpsPQXPPnPX3L/NQHvPrpqIq\n1K60S+F3JLEmz46PpCHxNY38iF/jROkOb6uwO5m/kxMjqPzeO13PgCUyfOsj5Z9L\nN9dK/e8vncW7EF2MqV7VYgbUsjr9rGAJGqKrkq6HaXjqI9/GpndZ6NsCgYEA6xDu\nzHkK/xku0Rw6o6vpwSY99zxg9fd9DsihT06MRMPz3r2APvXFgnyD57w68VwBAV7g\n/PIu1JD2ss0Q+00mQ3puqnEltH8Vu2zzjKi6DMvFfvDFHx1/aQJ4ry/Pa1RBGbea\nxHvKQsgBJILZoSCnDuFZKE25efvJi1tR5AZBebECgYEAgSJRV/5ijeOrT3/y8otT\nL8AWyLKhnnLCdEYDJd96NzcYsdb32QeoZIypTskre5b0FYDvB943Egm756dU50y1\nrSMHRcyqYsG4hgoiOGDOtVUywCZ1VqQ/x8V20uWGZxwq1Csnwe06bkFSnech7BK/\nyH1ANvXvQY5KcYkOZdi9r10CgYEAvLxfv/UAC0qg+Gz9+CQ0D00xO61S/Kq10oTs\nX8zleuEKkbD9o4+aAecP0aSkft4sQHl5lB6v0ySBr5ZPKDcNnehTqq4mZAIV5OLZ\nufpPR67k58NRwmXgwuOlGqP8mmSP0KJGtbPe9je4EySssF6TQ7NT7rRZU8QCUs4D\ntl3/fEECgYBvSgT8YgB/wqPMs8513i1i4Eycyc97cLfZENJ6YE/NsXYyIHByd5jP\nsCs16TQMJvdyuF6xZsM7Ni5pX28nIpTYKgOZv3ul5dHY5RsKyMizSbSvdoNQxtq2\n774HlNuBMjAiLseT1fwzkA6m1+ikd/4Vx6GGCIAH/fgYFtJiQd99Kw==\n-----END RSA PRIVATE KEY-----\n",
"name": "keypair-668",
"fingerprint": "1f: 91: df: f6: 04: 1f: 89: b3: 40: 12: ef: 07: f4: 1e: c0: c3",
"keyPairID": "ba425a97-9ad9-2d45-e21a-770d2ebeb477"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
