CreateKeyPair
更新时间:2024-12-04 11:03:06
PDF
创建 SSH 密钥对,每对密钥都可加载到任意多台云服务器中。
支持以下两种加密算法:
-
1024-位 DSS
-
2048-位 RSA (默认)
创建密钥对成功后,请及时从 API 返回结果中保存私钥, 因为我们不会保存用户的私钥数据。 公钥数据可以随时通过 DescribeKeyPairs 得到。
另外用户也可以通过已有公钥来创建 SSH 密钥。
请求参数
Parameter name | Type | Description | Required |
---|---|---|---|
keypair_name |
String |
密钥对名称 |
No |
mode |
String |
密钥创建方式,有效值为 system 和 user,默认为 system.
|
No |
encrypt_method |
String |
加密算法,有效值为 ssh-rsa,ssh-dss,ecdsa-sha2-nistp521 和 ssh-ed25519,默认为 ssh-rsa。只有当 mode = sytem 的时候才需要提供。 |
No |
public_key |
String |
SSH 公钥内容。只有当 mode = user 的时候才需要提供。 |
No |
zone |
String |
区域 ID,注意要小写 |
Yes |
除上述请求参数外,还包含公共参数。
返回数据
Name | Type | Description |
---|---|---|
action |
String |
响应动作 |
private_key |
String |
密钥对的私钥。
|
keypair_id |
String |
创建成功的密钥对 ID |
ret_code |
Integer |
执行成功与否,0 表示成功,其他值则为错误代码 |
请求示例
https://api.qingcloud.com/iaas/?action=CreateKeyPair
&mode=system
&keypair_name=demo_kp
&zone=pek3a
&COMMON_PARAMS
返回示例
{
"action":"CreateKeyPairResponse",
"private_key":"-----BEGIN DSA PRIVATE KEY-----....",
"keypair_id":"kp-z0goby7d",
"ret_code":0
}
请求示例
https://api.qingcloud.com/iaas/?action=CreateKeyPair
&mode=user
&keypair_name=demo_kp
&public_key=ssh-rsa%20AAAAB3...
&zone=pek3a
&COMMON_PARAMS
返回示例
{
"action":"CreateKeyPairResponse",
"private_key":"",
"keypair_id":"kp-z0goby7d",
"ret_code":0
}