导入密钥对

接口说明

本接口用于导入密钥。
说明:

  1. 每个资源池密钥对数量最多为500对。
  2. 导入的公钥,支持英文、"-"、"/"、"+"、"="、"@"、"."、"_"、数字、空格的组合,需以ssh-rsa开始。
  3. 本接口的功能是将密钥对导入到用户账户,并不会自动绑定到实例。

推荐使用API Explorer调试

API Explorer支持接口在线可视化调用,同时自动生成动态代码示例,搭配OpenAPI SDK无需计算签名实现接口快速集成。

URL

POST https://ecloud.10086.cn/api/openapi-ecs/customer/v3/keypair/input

请求参数

Body

参数名称
类型
必填
描述
inputKeypairReq
密钥导入请求体
是

密钥对导入请求体。

name
string
是

密钥对名称,支持英文字母、数字组合,长度为5~128位。

publicKey
string
是

公钥。

region
string
否

可用区。

请求示例

POST https://ecloud.10086.cn/api/openapi-ecs/customer/v3/keypair/input
{
	"body":{
		"name":"testKeyPair",
		"publicKey":"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDrO2clev+FgjH7SPih1Uqmh2nd1Yt2Rq3BYplug7QqMHq2uFMhSdIZkejyUq4H00xNI+GJF9nEGrBMlfWVpD2kIWXSKgJHKVJf34rrQbziEHVP8j7Lc0epnDDqmR12Oj51TzwEY93yzaF2tAVKGEUdJ5ppJMWQeKf7ifDHeaq3NzIpz1ITRyO8i+iggiNq9d6t1mFBe5s0aFzH7hpmuQZ//QZNWaErKiqYRkp6rrhWF8OptRhaXCRuN8gEynhiMbEHInS0ivrHSwK/FyDOiuexk7ovR+BIUZivyTPd3LfIybeIwVwI7nqkobT1zb9EC074rp/38MmluOpmGNk255yH",
		"region":"N0531-SD-JNSC01"
	}
}

返回参数

返回码:200
OK
参数名称
类型
描述
body
密钥对详情返回体

请求成功时返回的数据

createdTime
string(date-time)

密钥对创建时间

fingerPrint
string

密钥对指纹

id
string

密钥对ID

modifiedTime
string(date-time)

密钥对修改时间

name
string

密钥对名称

privateKey
string

密钥对私钥,为空则不显示

publicKey
string

公钥,为空则不显示

region
string

密钥对可用区

status
string

密钥对状态

type
string

密钥对类型

errorCode
string

统一错误码

errorMessage
string

页面国际化错误提示

errorParams
<string> array

统一错误码的自定义参数

requestId
string

每个请求的序列号

state
enum(OK,ERROR,EXCEPTION,ALARM,FORBIDDEN)

返回状态码,返回正常:OK,返回错误:ERROR,返回异常:EXCEPTION,需要告警实现的:ALARM,禁止访问:FORBIDDEN

返回示例

返回码:200
OK
{
	"requestId":"reqId-519f5c0444baf7a921411-eafbe672-1",
	"state":"OK",
	"body":{
		"id":"57b0f9f5882040adb8fa2664d8d79d1e",
		"name":"test1234",
		"type":"ssh",
		"fingerPrint":"f2:63:a7:bb:6d:19:9a:a6:5d:db:03:91:8d:77:18:ec",
		"status":"1",
		"createdTime":"2024-06-25 17:43:36",
		"modifiedTime":"2024-06-25 17:43:36",
		"region":"SZJD",
		"publicKey":"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDrO2clev+FgjH7SPih1Uqmh2nd1Yt2Rq3BYplug7QqMHq2uFMhSdIZkejyUq4H00xNI+GJF9nEGrBMlfWVpD2kIWXSKgJHKVJf34rrQbziEHVP8j7Lc0epnDDqmR12Oj51TzwEY93yzaF2tAVKGEUdJ5ppJMWQeKf7ifDHeaq3NzIpz1ITRyO8i+iggiNq9d6t1mFBe5s0aFzH7hpmuQZ//QZNWaErKiqYRkp6rrhWF8OptRhaXCRuN8gEynhiMbEHInS0ivrHSwK/FyDOiuexk7ovR+BIUZivyTPd3LfIybeIwVwI7nqkobT1zb9EC074rp/38MmluOpmGNk255yH"
	}
}
本文档内容整理自移动云官方帮助中心(查看原文),仅供参考。