租户端 计算 云服务器（CVM） 密钥相关接口 ImportKeyPair

ImportKeyPair

最近更新时间: 2024-12-21 13:01:32

1. 接口描述

接口请求域名： cvm.api3.gsesgpucloud.com。

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

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

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

接口更新时间：2020-05-18 12:15:05。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：ImportKeyPair
Version 是 否 String 公共参数，本接口取值：2017-03-12
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
KeyName 是 否 String 密钥对名称，可由数字，字母和下划线组成，长度不超过25个字符。
示例值： operation_key
ProjectId 是 否 Int64 密钥对创建后所属的项目ID。

可以通过以下方式获取项目ID：
  • 通过项目列表查询项目ID。
  • 通过调用接口 DescribeProjects，取返回信息中的 projectId  获取项目ID。
    示例值： 0
    		•
    PublicKey 是 否 String 密钥对的公钥内容，OpenSSH RSA 格式。
    示例值： ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC0ran+u+y09bSSoAbHBhJm2ivci0uwTif+/MqoGj5odBuGcDHGIBE7Th74ITXtbuqEXxdOSROi7DOVaTZa1MYe6qKGPAi5/8jlV8c9CKCezXr99A2Dps/eVPVn4yO2NhSXbr0U/voRxTqNprP0YLo25y1lVnN0vg0CfWL8DDYh6DkMMVufGikA7WVPdsHomTLlSPdlSLvCRZPHC7eBhkrznO0rnfM+cJY2fqqSrdI1kqtDRJNpNvPLaRnJsc3uoot2nGqrGD6yiwx2tvdLAqgQT5tASfvtTc3CTMMJRGIqm+CdG2S1y0VlMDmm9XHeVBmZuX5YDJPNGIOcBI2Cgrj5 skey-mk5eqeu6

    3. 输出参数

    参数名称 类型 描述
    KeyId String 密钥对ID。
    示例值： skey-4e5ty7i8
    RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 错误码

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

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