調(diào)用CreateKeyPair創(chuàng)建一對(duì)SSH密鑰對(duì)。系統(tǒng)會(huì)為您保管密鑰的公鑰部分，并返回未加密的PEM編碼的PKCS#8格式私鑰。您需要自行妥善保管私鑰部分。
接口說(shuō)明
除了調(diào)用 CreateKeyPair 創(chuàng)建密鑰對(duì)之外，您還可以使用第三方工具創(chuàng)建密鑰對(duì)，然后上傳（ ImportKeyPair ）到某一阿里云地域，其使用方法和系統(tǒng)為您創(chuàng)建的密鑰對(duì)是一致的。
您在每個(gè)地域的密鑰對(duì)數(shù)最高為 500 對(duì)。更多信息，請(qǐng)參見使用限制。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語(yǔ)句的Action元素中使用，用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問級(jí)別：是指每個(gè)操作的訪問級(jí)別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說(shuō)明如下：
- 對(duì)于必選的資源類型，用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| ecs:CreateKeyPair | create | *KeyPair acs:ecs:{#regionId}:{#accountId}:keypair/* |
| 無(wú) |
請(qǐng)求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 密鑰對(duì)所在的地域 ID。您可以調(diào)用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
| KeyPairName | string | 是 | 密鑰對(duì)名稱。長(zhǎng)度為 2~128 個(gè)英文或中文字符。必須以大小字母或中文開頭，不能以 | testKeyPairName |
| ResourceGroupId | string | 否 | SSH 密鑰對(duì)所在的企業(yè)資源組 ID。 | rg-bp67acfmxazb4p**** |
| Tag | array<object> | 否 | 標(biāo)簽列表。 | |
| object | 否 | 標(biāo)簽列表。 | ||
| Key | string | 否 | 密鑰對(duì)的標(biāo)簽鍵。N 的取值范圍：1~20。一旦傳入該值，則不允許為空字符串。最多支持 128 個(gè)字符，不能以 | TestKey |
| Value | string | 否 | 密鑰對(duì)的標(biāo)簽值。N 的取值范圍：1~20。一旦傳入該值，允許為空字符串。最多支持 128 個(gè)字符，不能以 acs:開頭，不能包含 http://或者 https://。 | TestValue |
返回參數(shù)
示例
正常返回示例
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:**"
}錯(cuò)誤碼
| HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
|---|---|---|---|
| 400 | InvalidKeyPairName.Malformed | Specified Key Pair name is not valid. | 密鑰對(duì)名稱不合法。 |
| 400 | KeyPair.AlreadyExist | The key pair already exist. | 密鑰對(duì)已存在，請(qǐng)不要重復(fù)添加。 |
| 400 | Duplicate.TagKey | The Tag.N.Key contain duplicate key. | 標(biāo)簽中存在重復(fù)的鍵，請(qǐng)保持鍵的唯一性。 |
| 400 | InvalidTagKey.Malformed | The specified Tag.n.Key is not valid. | 指定的標(biāo)簽鍵參數(shù)有誤。 |
| 400 | InvalidTagValue.Malformed | The specified Tag.n.Value is not valid. | 指定的標(biāo)簽值參數(shù)有誤。 |
| 403 | QuotaExceed.KeyPair | The key pair quota exceeds. | 密鑰對(duì)數(shù)量已達(dá)上限。 |
| 403 | QuotaExceed.Tags | %s | 標(biāo)簽數(shù)超過可以配置的最大數(shù)量。%s為變量，將根據(jù)調(diào)用API的實(shí)際情況動(dòng)態(tài)返回錯(cuò)誤信息。 |
| 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. | 資源組并不在記錄中。 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-12-17 | OpenAPI 描述信息更新、OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |