調用CreateKeyPair創建一對SSH密鑰對。系統會為您保管密鑰的公鑰部分，并返回未加密的PEM編碼的PKCS#8格式私鑰。您需要自行妥善保管私鑰部分。
接口說明
除了調用 CreateKeyPair 創建密鑰對之外，您還可以使用第三方工具創建密鑰對，然后上傳（ ImportKeyPair ）到某一阿里云地域，其使用方法和系統為您創建的密鑰對是一致的。
您在每個地域的密鑰對數最高為 500 對。更多信息，請參見使用限制。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀?。≧ead）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| ecs:CreateKeyPair | create | *KeyPair acs:ecs:{#regionId}:{#accountId}:keypair/* |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 密鑰對所在的地域 ID。您可以調用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
| KeyPairName | string | 是 | 密鑰對名稱。長度為 2~128 個英文或中文字符。必須以大小字母或中文開頭，不能以 | testKeyPairName |
| ResourceGroupId | string | 否 | SSH 密鑰對所在的企業資源組 ID。 | rg-bp67acfmxazb4p**** |
| Tag | array<object> | 否 | 標簽列表。 | |
| object | 否 | 標簽列表。 | ||
| Key | string | 否 | 密鑰對的標簽鍵。N 的取值范圍：1~20。一旦傳入該值，則不允許為空字符串。最多支持 128 個字符，不能以 | TestKey |
| Value | string | 否 | 密鑰對的標簽值。N 的取值范圍：1~20。一旦傳入該值，允許為空字符串。最多支持 128 個字符，不能以 acs:開頭，不能包含 http://或者 https://。 | TestValue |
返回參數
示例
正常返回示例
JSON格式
{
"PrivateKeyBody": "MIIEpAIBAAKCAQEAtReyMzLIcBH78EV2zj****",
"KeyPairName": "testKeyPairName",
"KeyPairId": "ssh-bp67acfmxazb4p****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"KeyPairFingerPrint": "89:f0:ba:62:ac:b8:aa:e1:61:5e:fd:81:69:86:6d:6b:f0:c0:5a:**"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | InvalidKeyPairName.Malformed | Specified Key Pair name is not valid. | 密鑰對名稱不合法。 |
| 400 | KeyPair.AlreadyExist | The key pair already exist. | 密鑰對已存在，請不要重復添加。 |
| 400 | Duplicate.TagKey | The Tag.N.Key contain duplicate key. | 標簽中存在重復的鍵，請保持鍵的唯一性。 |
| 400 | InvalidTagKey.Malformed | The specified Tag.n.Key is not valid. | 指定的標簽鍵參數有誤。 |
| 400 | InvalidTagValue.Malformed | The specified Tag.n.Value is not valid. | 指定的標簽值參數有誤。 |
| 403 | QuotaExceed.KeyPair | The key pair quota exceeds. | 密鑰對數量已達上限。 |
| 403 | QuotaExceed.Tags | %s | 標簽數超過可以配置的最大數量。%s為變量，將根據調用API的實際情況動態返回錯誤信息。 |
| 404 | InvalidRegionId.NotFound | The RegionId provided does not exist in our records. | 提供的RegionId不存在 |
| 404 | InvalidResourceGroup.NotFound | The ResourceGroup provided does not exist in our records. | 資源組并不在記錄中。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-12-17 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |