创建和导入密钥对 - CreateKeypair
功能介绍
创建SSH密钥,或把公钥导入系统,生成密钥对。
创建SSH密钥成功后,请把响应数据中的私钥内容保存到本地文件,用户使用该私钥登录边缘实例。为保证边缘实例安全,私钥数据只能读取一次,请妥善保管。
接口约束
-
当前支持的加解密算法为:
SSH-2 (RSA,1024)
SSH-2 (RSA,2048)
SSH-2 (RSA,4096)
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /v1/os-keypairs
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
密钥对名称。 新创建的密钥名称不能和已有密钥名称相同。 |
|
public_key |
否 |
String |
导入的公钥信息。 建议导入的公钥长度不大于1024字节。
说明:
长度超过1024字节会导致边缘实例注入该密钥失败。
|
响应参数
状态码:201
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
密钥对名称。 |
|
public_key |
String |
公钥。 |
|
private_key |
String |
私钥。 |
|
user_id |
String |
用户ID。 |
|
fingerprint |
String |
指纹。 |
请求示例
导入密钥对,密钥对名称为PK并导入公钥信息
POST https://{endpoint}/v1/os-keypairs
{
"name" : "PK",
"public_key" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC4uGmCeHNac9ToRtbaGIB02iCakFNk76XYsTiHDtRdIVBobTFxCE9Up9RqRAFtgpzSNBeZT6U6u3PoAV3VMjE0ZNg1Uex10lXLVU3PWfORzQG4M3lXnpqjwojlhqIg+Q88iPeyrgMawiR5If2kQ6xAkPI+4Yyc2JQn2HqV2LxE/rV42JpYEXpilveHW4urfDl9azDe3v9fmAOXq7dXzdGDCTiNMWzxj7B0jnuBiTkGxd9yTErip019O87bAdzrpSD5AZgmeHmW7LAG8GpE820xiiTIGrNONfojGdVzicc88OF/Y4r/GhCBpLC79jKa6dxnwHs4a8+u/ynuafZxvBrH Generated-by-Nova\n"
}
响应示例
状态码:201
Created
{
"name" : "PK",
"public_key" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC4uGmCeHNac9ToRtbaGIB02iCakFNk76XYsTiHDtRdIVBobTFxCE9Up9RqRAFtgpzSNBeZT6U6u3PoAV3VMjE0ZNg1Uex10lXLVU3PWfORzQG4M3lXnpqjwojlhqIg+Q88iPeyrgMawiR5If2kQ6xAkPI+4Yyc2JQn2HqV2LxE/rV42JpYEXpilveHW4urfDl9azDe3v9fmAOXq7dXzdGDCTiNMWzxj7B0jnuBiTkGxd9yTErip019O87bAdzrpSD5AZgmeHmW7LAG8GpE820xiiTIGrNONfojGdVzicc88OF/Y4r/GhCBpLC79jKa6dxnwHs4a8+u/ynuafZxvBrH Generated-by-Nova",
"private_key" : "******",
"user_id" : "dc36c78ad96f42e394f3221bf7c17166",
"fingerprint" : "SHA256:vqILnOoQ+aRoQLylIwFcCAxETrLqvUBJEznlGqndwNY"
}
状态码
|
状态码 |
描述 |
|---|---|
|
201 |
Created |
错误码
请参见错误码。