导入密钥对

最近更新时间:2018-10-12 16:02:56

1. 接口描述

接口请求域名: cvm.tencentcloudapi.com 。

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

  • 本接口的功能是将密钥对导入到用户账户,并不会自动绑定到实例。如需绑定可以使用AssociasteInstancesKeyPair接口。
  • 需指定密钥对名称以及该密钥对的公钥文本。
  • 如果用户只有私钥,可以通过 SSL 工具将私钥转换成公钥后再导入。

默认接口请求频率限制:10次/每秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi )时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cvm.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ImportKeyPair
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
KeyName String 密钥对名称,可由数字,字母和下划线组成,长度不超过25个字符。
ProjectId Integer 密钥对创建后所属的项目ID。

可以通过以下方式获取项目ID:
  • 通过项目列表查询项目ID。
  • 通过调用接口 DescribeProject,取返回信息中的 projectId 获取项目ID。

    如果是默认项目,直接填0就可以。
  • PublicKey String 密钥对的公钥内容,OpenSSH RSA 格式。

    3. 输出参数

    参数名称 类型 描述
    KeyId String 密钥对ID。
    RequestId String 唯一请求ID,每次请求都会返回。定位问题时需要提供该次请求的RequestId。

    4. 示例

    示例1 导入秘钥对

    输入示例

    https://cvm.tencentcloudapi.com/?Action=ImportKeyPair
    &keyName=operation_key
    &ProjectId=0
    &PublicKey=ssh-rsa XXXXXXXXXXXX== skey_45071
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "KeyId": "skey-4e5ty7i8",
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
      }
    }

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、 SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

    云 API 3.0 提供了配套的开发工具集( SDK ),支持多种编程语言,能更方便的调用 API 。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

    错误码 描述
    InternalServerError 操作内部错误。
    InvalidKeyPair.LimitExceeded 密钥对数量超过限制。
    InvalidKeyPairName.Duplicate 密钥对名称重复。
    InvalidKeyPairNameEmpty 密钥名称为空。
    InvalidKeyPairNameIncludeIllegalChar 密钥名称包含非法字符。密钥名称只支持英文、数字和下划线。
    InvalidKeyPairNameTooLong 密钥名称超过25个字符。
    InvalidParameterValue 无效参数值。参数值格式错误或者参数值不被支持等。
    InvalidPublicKey.Duplicate 无效密钥公钥。指定公钥已经存在。
    InvalidPublicKey.Malformed 无效密钥公钥。指定公钥格式错误,不符合OpenSSH RSA格式要求。
    MissingParameter 参数缺失。请求没有带必选参数。

    如果有其他疑问,你也可以通过提问形式与我们联系探讨