> For the complete documentation index, see [llms.txt](https://docs.console.zenlayer.com/api-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.console.zenlayer.com/api-reference/cn/security/ccs/key-pair/importkeypair.md).

# ImportKeyPair

## 1. 接口描述

本接口(ImportKeyPair)用于导入公钥到密钥对。

{% hint style="info" %}
**注意事项**

* 本接口的功能是将密钥对导入到用户账户，可用于后续的实例创建。
* 需指定密钥对名称以及该密钥对的公钥文本。
  {% endhint %}

## 2. 请求参数

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

| 参数名称           | 必选 | 类型     | 描述                                                                                                         |
| -------------- | -- | ------ | ---------------------------------------------------------------------------------------------------------- |
| keyName        | 是  | String | <p>密钥对名称。</p><p>可由数字，大小写字母和-组成，长度不超过32个字符，不能和账号下其他的密钥对重名。</p><p>示例值：my\_key, my-key。</p>                   |
| publicKey      | 是  | String | <p>密钥对的公钥内容，OpenSSH 格式。</p><p>公钥内容至多传5个公钥，通过换行(<code>\n</code>)分隔。</p><p>示例值：ssh-rsa XXXXXXXXXXXX key。</p> |
| keyDescription | 否  | String | <p>密钥对描述信息。</p><p>不超过255个字符。</p>                                                                           |

## 3. 响应结果

| 参数名称      | 类型     | 描述                                                       |
| --------- | ------ | -------------------------------------------------------- |
| requestId | String | <p>唯一请求 ID。</p><p>每次请求都会返回。定位问题时需要提供该次请求的 requestId。</p> |
| keyId     | String | 密钥对ID。                                                   |

## 4. 代码示例

{% tabs %}
{% tab title="示例" %}
**1. 导入一个密钥对。**

```json
POST /api/v2/ccs 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"
  }
}
```

{% endtab %}
{% endtabs %}

## 5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的[开发工具集（SDK）](/api-reference/cn/api-introduction/toolkit.md)，未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

## 6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见[公共错误码](/api-reference/cn/api-introduction/instruction/commonerrorcode.md)

| HTTP状态码 | 错误码                                 | 说明           |
| ------- | ----------------------------------- | ------------ |
| 400     | INVALID\_KEY\_PAIR\_ALGORITHM       | 密钥对加密算法不支持。  |
| 400     | INVALID\_KEY\_PAIR\_EXCEED\_LIMIT   | 密钥对数量超出配额限制。 |
| 400     | INVALID\_KEY\_PAIR\_MALFORMED       | 名称格式错误。      |
| 409     | INVALID\_KEY\_PAIR\_NAME\_EXIST     | 密钥对名称已存在。    |
| 400     | INVALID\_PUBLIC\_KEY\_EXCEED\_LIMIT | 公钥数量超过限制。    |