创建密钥对

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

1. 接口描述

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

本接口 (CreateKeyPair) 用于创建一个 OpenSSH RSA 密钥对,可以用于登录 Linux 实例。

  • 开发者只需指定密钥对名称,即可由系统自动创建密钥对,并返回所生成的密钥对的 ID 及其公钥、私钥的内容。
  • 密钥对名称不能和已经存在的密钥对的名称重复。
  • 私钥的内容可以保存到文件中作为 SSH 的一种认证方式。
  • 腾讯云不会保存用户的私钥,请妥善保管。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateKeyPair
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
KeyName String 密钥对名称,可由数字,字母和下划线组成,长度不超过25个字符。
ProjectId Integer 密钥对创建后所属的项目ID。
可以通过以下方式获取项目ID:
  • 通过项目列表查询项目ID。
  • 通过调用接口DescribeProject,取返回信息中的projectId获取项目ID。
  • 3. 输出参数

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

    4. 示例

    示例1 创建密钥对

    输入示例

    https://cvm.tencentcloudapi.com/?Action=CreateKeyPair
    &KeyName=Tencent
    &ProjectId=0
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "KeyPair": {
          "KeyId": "skey-mv9yzyjj",
          "KeyName": "Tencent",
          "PrivateKey": "-----BEGIN RSA PRIVATE KEY-----\nMIICXgIBAAKBgQDP0Yw2T4itUKOJQIK69c1Asy1UO88cxEbujR5Jbr0e/Ey1v4ZK\nAUzDnsBnFlf4hKPA1YvMB8RBYj4GcLtM7PrKnBNNram8rgl73X/klOO8oqKv+J/X\nUA7KHH1Y6wcn1RTRTMdDHbGhW1q/UpfeylNTbf+wEIWhEfaL5FKQm4hqCwIDAQAB\nAoGBAJEvSu5SaCD02hs0F2C4Aln2E2/qjMoDEa7spcEVfUhdaNX8ZLvk5pUvnikm\nwfSb7a71QUIcFu66zKxBK4kVcirBRCR8nTAQbQ6AhXQYP+y6ihZ9Z/g6BBEeqCpV\nuGPmKnhdxdJ8Al2huEZKJFUQhKM8XdP7dqn6yFDm0L2sTK6RAkEA9IbhP4/2CVSC\n6d8j5nj3ejPx25R3wc4G+st1tZn1O/TRqUknbVEvsxZC63bRjHiw086QIWr61L8f\nqQBLZ58DMwJBANmRv3aHVxv5sMlV0F3hD5ZgWEDIIjxD7oiBzU1rqvF6OpTQc1cF\nrnwxAXDtYYJ75B8qQEL1ph/zIE5YW0hlfckCQQCyVTwpUyCopU3kqqxQBaDXKtMU\nxS6h1VQZzBDIpMPJOj8+Ku/qNe+HuJCNkVY6EDtF/bv340GTrt+0LVbQ95MpAkEA\nxcvwUdTXB9LnuxKuHTsoDaFHepW4MivcJvRC7njM7z4dFf+wbFP4/mUbF0xoUtVJ\nXl/uDjH/tpo1K6S+UEIcqQJAfLQywCQdZ/qOJn0PwxiOhwniikSnZuZPNSw8T+kg\n/oxijESOLAJBnt3S/g+D530Enjitvfc9mEB7mh0VmwWvPg==\n-----END RSA PRIVATE KEY-----\n",
          "ProjectId": 0,
          "PublicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDP0Yw2T4itUKOJQIK69c1Asy1UO88cxEbujR5Jbr0e/Ey1v4ZKAUzDnsBnFlf4hKPA1YvMB8RBYj4GcLtM7PrKnBNNram8rgl73X/klOO8oqKv+J/XUA7KHH1Y6wcn1RTRTMdDHbGhW1q/UpfeylNTbf+wEIWhEfaL5FKQm4hqCw== skey_112168"
        },
        "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 无效参数值。参数值格式错误或者参数值不被支持等。
    InvalidProjectId.NotFound 无效的项目ID,指定的项目ID不存在。
    MissingParameter 参数缺失。请求没有带必选参数。

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