导入密钥

最近更新时间:2019-12-03 14:31:17

说明:

当前页面接口为旧版 API,未来可能停止维护,目前不展示在左侧导航。云服务器 API 3.0 版本接口定义更加规范,访问时延下降显著,建议使用 云服务器 API 3.0

1. 接口描述

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

接口请求域名:cvm.api.qcloud.com

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

2. 输入参数

以下请求参数列表仅列出了接口请求参数,其它参数见公共请求参数页面。

参数名称 是否必选 类型 描述
keyName String 密钥名称。
pubKey String 密钥的公钥内容,OpenSSH格式。

3. 输出参数

参数名称 类型 描述
code Int 公共错误码。0表示成功,其他值表示失败。
message String 模块错误信息描述,与接口相关。
keyId String 密钥ID。

4. 示例

输入

  https://cvm.api.qcloud.com/v2/index.php?Action=ImportKeyPair
  &keyName=operation_key
  &pubKey=ssh-rsa XXXXXXXXXXXX== skey_45071
  &<公共请求参数>

输出

{
    "code": 0,
    "message": "",
    "keyId":"skey-xxxx"
}