CreateKeyPair

介面說明

除了呼叫 CreateKeyPair 建立金鑰對之外，您還可以使用第三方工具建立金鑰對，然後上傳（ ImportKeyPair ）到某一阿里雲地域，其使用方法和系統為您建立的金鑰對是一致的。

您在每個地域的金鑰對數最高為 500 對。更多資訊，請參見使用限制。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ecs:CreateKeyPair

create

*KeyPair

acs:ecs:{#regionId}:{#accountId}:keypair/*

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	金鑰對所在的地域 ID。您可以呼叫 DescribeRegions 查看最新的阿里雲地域列表。	cn-hangzhou
KeyPairName	string	是	金鑰對名稱。長度為 2~128 個英文或中文字元。必須以大小字母或中文開頭，不能以 `http://` 或 `https://` 開頭。可以包含數字、半形冒號（:）、底線（_）或者短劃線（-）。	testKeyPairName
ResourceGroupId	string	否	SSH 金鑰對所在的企業資源群組 ID。	rg-bp67acfmxazb4p****
Tag	array<object>	否	標籤列表。
	object	否	標籤列表。
Key	string	否	金鑰對的標籤鍵。N 的取值範圍：1~20。一旦傳入該值，則不允許為空字串。最多支援 128 個字元，不能以 `aliyun` 或 `acs:` 開頭，不能包含 `http://` 或者 `https://`。	TestKey
Value	string	否	金鑰對的標籤值。N 的取值範圍：1~20。一旦傳入該值，允許為空字串。最多支援 128 個字元，不能以 acs: 開頭，不能包含 http:// 或者 https://。	TestValue

返回參數

名稱	類型	描述	樣本值
	object
PrivateKeyBody	string	金鑰對的私鑰。PEM 編碼的 PKCS#8 格式的私鑰部分。	MIIEpAIBAAKCAQEAtReyMzLIcBH78EV2zj****
KeyPairName	string	金鑰對名稱。	testKeyPairName
KeyPairId	string	SSH 金鑰對的 ID。	ssh-bp67acfmxazb4p****
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
KeyPairFingerPrint	string	金鑰對的指紋。根據 RFC4716 定義的公鑰指紋格式，採用 MD5 資訊摘要演算法。更多資訊，請參見 RFC4716 。	89:f0:ba:62:ac:b8:aa:e1:61:5e:fd:81:69:86:6d:6b:f0:c0:5a:**

樣本

正常返回樣本

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:**"
}

異常返回樣本

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"
}

錯誤碼

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
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.
404	InvalidResourceGroup.NotFound	The ResourceGroup provided does not exist in our records.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。