ImportKeyPair

1. 接口描述

本接口(ImportKeyPair)用于导入密钥对,登录 Linux 实例。

注意事项

  • 本接口的功能是将密钥对导入到用户账户,可用于后续的实例创建。

  • 需指定密钥对名称以及该密钥对的公钥文本。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称必选类型描述

keyName

String

密钥对名称。

可由数字,大小写字母和-组成,长度不超过32个字符。 不能和账号下其他的密钥对重名

示例值:my_key, my-key

publicKey

String

密钥对的公钥内容,OpenSSH 格式。 公钥内容至多传5个公钥,通过分隔。 示例值:ssh-rsa XXXXXXXXXXXX key

keyDescription

String

密钥对描述信息。 不超过255个字符。

3. 响应结果

参数名称类型描述

requestId

String

唯一请求 ID。

每次请求都会返回。定位问题时需要提供该次请求的 requestId。

keyId

String

镜像ID。

4. 代码示例

  1. 导入一个密钥对。

POST /api/v2/vm HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: ImportKeyPair
<Common Request Params>

Request:
{
    "KeyName": "my-key",
    "PublicKey": "ssh-rsa XXXXXXXXXXXX== example"
}

Response:
{
  "requestId": "T69E37B61-4E39-4461-A2BB-205F847D1D60",
  "response": {
    "requestId": "T69E37B61-4E39-4461-A2BB-205F847D1D60",
    "keyId": "key-xxxxx"
  }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集(SDK),未来会陆续支持更多开发语言,方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码,其他错误码见公共错误码

HTTP状态码错误码说明

400

INVALID_KEY_NAME_MALFORMED

名称格式错误

400

INVALID_PUBLIC_KEY_MALFORMED

公钥格式错误

400

INVALID_KEY_PAIR_EXCEED_LIMIT

超出配额限制

409

INVALID_KEY_PAIR_NAME_EXIST

密钥对名称已存在

最后更新于