创建一对 SSH 密钥对。我们会为您保管密钥的公钥部分,并返回未加密的 PEM 编码的 PKCS#8 格式私钥。您需要自行妥善保管私钥部分。更多详情,请参阅 SSH 密钥对

描述

除了调用 CreateKeyPair 创建密钥对之外,您还可以使用第三方工具创建密钥对,然后上传(ImportKeyPair)到某一阿里云地域,其使用方法和我们为您创建的密钥对是一致的。

您在每个地域的密钥对数最高为 500 对。

请求参数

名称 类型 是否必需 描述
Action String 系统规定参数。取值:CreateKeyPair
RegionId String 密钥对所在的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。
KeyPairName String 密钥对名称。必须保持名称唯一性。
  • 长度为 [2, 128] 个字符。
  • 必须以大小字母或中文开头,可包含数字、小数点(.)、下划线(_)或者短横线(-)。
  • 支持所有的字符集编码格式。
  • 不能以 http:// 和 https:// 开头。

返回参数

名称 类型 描述
KeyPairName String 密钥对名称。
KeyPairFingerPrint String 密钥对的指纹。根据 RFC4716 定义的公钥指纹格式,采用 MD5 信息摘要算法。更多详情,请参阅 RFC4716
PrivateKeyBody String 密钥对的私钥。PEM PKCS#8 格式的私钥部分。更多详情,请参阅 OpenSSL PKCS#8

示例

请求示例
https://ecs.aliyuncs.com/?Action=CreateKeyPair
&RegionId=cn-qingdao
&KeyPairName=test
&<公共请求参数>
返回示例

XML 格式

<CreateKeyPairResponse>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
    <KeyPairName>test</KeyPairName>
    <KeyPairFingerPrint>89:f0:ba:62:ac:b8:aa:e1:61:5e:fd:81:69:86:6d:6b:f0:c0:5a:d7</KeyPairFingerPrint>
    <PrivateKeyBody>xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</PrivateKeyBody>
</CreateKeyPairResponse>
JSON 格式
{
    "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
    "KeyPairName": "test"
    "KeyPairFingerPrint": "89:f0:ba:62:ac:b8:aa:e1:61:5e:fd:81:69:86:6d:6b:f0:c0:5a:d7"
    "PrivateKeyBody": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

错误码

以下为本接口特有的错误码。更多错误码,请访问 API 错误中心

错误代码 错误信息 HTTP 状态码 说明
MissingParameter The input parameter “RegionId” that is mandatory for processing this request is not supplied. 400 您必须指定 RegionId参数。
InvalidKeyPairName.Malformed Specified Key Pair name is not valid. 400 指定的 KeyPairName不合法或者已重复。
QuotaExceed.KeyPair The key pair quota exceeds. 403 您在每个地域的密钥对个数不能超过 500 对。
InvalidRegionId.NotFound The specified RegionId does not exist. 404 指定的 RegionId 不存在。