建立一對 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 不存在。