有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

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

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

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

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

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

    如果是默认项目,直接填0就可以。
    示例值:0
  • PublicKey String 密钥对的公钥内容,OpenSSH RSA 格式。
    示例值:ssh-rsa XXXXXXXXXXXX== skey_45071
    TagSpecification.N Array of TagSpecification 标签描述列表。通过指定该参数可以同时绑定标签到密钥对。

    3. 输出参数

    参数名称 类型 描述
    KeyId String 密钥对ID。
    示例值:skey-4e5ty7i8
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 导入密钥对

    输入示例

    POST / HTTP/1.1
    Host: cvm.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: ImportKeyPair
    <公共请求参数>
    
    {
        "ProjectId": 0,
        "KeyName": "operation_key",
        "PublicKey": "ssh-rsa XXXXXXXXXXXX== skey_45071"
    }

    输出示例

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

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalServerError 操作内部错误。
    InvalidKeyPair.LimitExceeded 密钥对数量超过限制。
    InvalidKeyPairName.Duplicate 密钥对名称重复。
    InvalidKeyPairNameEmpty 密钥名称为空。
    InvalidKeyPairNameIncludeIllegalChar 密钥名称包含非法字符。密钥名称只支持英文、数字和下划线。
    InvalidKeyPairNameTooLong 密钥名称超过25个字符。
    InvalidParameterValue 参数取值错误。
    InvalidProjectId.NotFound 无效的项目ID,指定的项目ID不存在。
    InvalidPublicKey.Duplicate 无效密钥公钥。指定公钥已经存在。
    InvalidPublicKey.Malformed 无效密钥公钥。指定公钥格式错误,不符合OpenSSH RSA格式要求。
    LimitExceeded.TagResourceQuota 标签绑定的资源数量已达到配额限制。
    MissingParameter 缺少参数错误。