1. 接口描述
接口请求域名： lighthouse.tencentcloudapi.com 。
本接口（ImportKeyPair）用于导入用户指定密钥对。
默认接口请求频率限制：10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ImportKeyPair。 |
| Version | 是 | String | 公共参数，本接口取值：2020-03-24。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| KeyName | 是 | String | 密钥对名称，可由数字，字母和下划线组成，长度不超过 25 个字符。 示例值：test_import |
| PublicKey | 是 | String | 密钥对的公钥内容， OpenSSH RSA 格式。 示例值：<公钥内容> |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| KeyId | String | 密钥对 ID。 示例值：lhkp-2xsmy15f |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 导入密钥对
输入示例
https://lighthouse.tencentcloudapi.com/?Action=ImportKeyPair
&KeyName=test_import
&PublicKey=<公钥内容>
&<公共请求参数>输出示例
{
"Response": {
"KeyId": "lhkp-2xsmy15f",
"RequestId": "87e6cf6c-1734-497e-aed5-9e12afa7237a"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.CreateKeyPairFailed | 对密钥对的创建操作失败。 |
| FailedOperation.DeleteKeyPairFailed | 对密钥对的删除操作失败。 |
| FailedOperation.ImportKeyPairFailed | 对密钥对的导入操作失败。 |
| InvalidParameterValue.DuplicateParameterValue | 参数 KeyName 已经存在且重复。 |
| InvalidParameterValue.InvalidKeyPairNameEmpty | 参数值非法。 |
| InvalidParameterValue.InvalidKeyPairNameTooLong | 参数长度非法。 |
| InvalidParameterValue.KeyPairPublicKeyDuplicated | 该密钥对中的公钥在系统中已存在，无法重复使用 。 |
| InvalidParameterValue.KeyPairPublicKeyMalformed | 指定的公钥格式错误。 |
| LimitExceeded.KeyPairLimitExceeded | 超过密钥对配额。 |
| UnauthorizedOperation.NoPermission | 无权限。 |