接口说明
将公钥导入系统。
注意事项:
-
每个地域密钥对数量最多为500对。
-
密钥对名称,支持英文字母、数字组合,长度为5~128位。
-
导入的公钥,支持英文、"-"、"/"、"+"、"="、"@"、"."、"_"、数字、空格的组合,需以ssh-rsa开始。
-
本接口的功能是将密钥对导入到用户账户,并不会自动绑定到实例。
URL
POST https://ecloud.10086.cn/api/openapi-instance/v4/key-pair/import
请求参数
Body
|
参数名称
|
类型
|
必填
|
描述
|
|
instanceImportKeyPairReq
|
InstanceCreateKeyPairReq
|
是
|
instanceImportKeyPairReq |
|
keyPairName
|
string
|
是
|
密钥名称,5-128位的英文、数字的组合。 |
|
zoneId
|
string
|
否
|
可用区,可通过查询属地地域可用区信息接口获取。 |
|
publicKey
|
string
|
是
|
导入的公钥,支持英文、"-"、"/"、"+"、"="、"@"、"."、"_"、数字、空格的组合,需以ssh-rsa开始。 |
|
tags
|
<Tag> array
|
否
|
标签,可通过查询用户标签列表接口获取。 |
|
key
|
string
|
是
|
标签键,仅支持中英文、数字、中划线、下划线,长度1-127位之间,不能以ecloud开头。 |
|
value
|
string
|
是
|
标签值,仅支持数字、中英文、中划线、下划线,长度在1~255位之间,不能以ecloud开头。 |
请求示例
POST https://ecloud.10086.cn/api/openapi-instance/v4/key-pair/import
{
"keyPairName":"testKeypair",
"publicKey":"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDrO2clev+FgjH7SPih1Uqmh2nd1Yt2Rq3BYplug7QqMHq2uFMhSdIZkejyUq4H00xNI+GJF9nEGrBMlfWVpD2kIWXSKgJHKVJf34rrQbziEHVP8j7Lc0epnDDqmR12Oj51TzwEY93yzaF2tAVKGEUdJ5ppJMWQeKf7ifDHeaq3NzIpz1ITRyO8i+iggiNq9d6t1mFBe5s0aFzH7hpmuQZ//QZNWaErKiqYRkp6rrhWF8OptRhaXCRuN8gEynhiMbEHInS0ivrHSwK/FyDOiuexk7ovR+BIUZivyTPd3LfIybeIwVwI7nqkobT1zb9EC074rp/38MmluOpmGNk255yH",
"zoneId":"cn-jiangsu-1b"
}
返回参数
返回码:200
OK
|
参数名称
|
类型
|
描述
|
|
body
|
InstanceImportKeyPairResp
|
请求成功时返回的数据。 |
|
createdTime
|
string(date-time)
|
密钥对创建时间。 |
|
keyPairFingerPrint
|
string
|
密钥对的指纹。 |
|
keyPairId
|
string
|
密钥对ID。 |
|
keyPairName
|
string
|
密钥对名称。 |
|
modifiedTime
|
string(date-time)
|
密钥对修改时间。 |
|
publicKey
|
string
|
公钥。 |
|
status
|
string
|
密钥对状态。值为1:密钥正常。 |
|
type
|
string
|
密钥类型。 |
|
zoneId
|
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-5dcb336c816e41d8851c1fdc543a4025",
"state":"OK",
"body":{
"createdTime":"2025-09-08 13:24:59",
"keyPairFingerPrint":"2b:89:d1:43:d1:2a:b0:d6:17:d3:99:8b:78:f8:08:d4",
"keyPairId":"06108e00a87f40e0ba66d8037baccb0b",
"modifiedTime":"2025-09-08 13:24:59",
"keyPairName":"testTestKeyPair",
"publicKey":"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCm0vAIAzOCzQIt850e/zEqFX4bRbdNDmDdDcQAtnKCnvhaLzyE+wX7sYVXmP2RKsOP2/L0ApUWd00BaIlIZPxC8/PnXhisPfOCnaBKOFR8u2B3YHZ75Md0+M0nReTyYugYPucUVfQcpRbo7yNFfZ7Uh1NjooQPLqWihAmesj5y0Q== phpseclib-generated-key",
"zoneId":"cn-jiangsu-1a",
"status":"1",
"type":"ssh"
}
}