edit-icon download-icon

CreateKeyPair

最終更新日: Mar 06, 2019

説明

2048 ビットの RSA 鍵ペアを作成します。 公開鍵を保持し、暗号化されていない PEM エンコードされた PKCS#8秘密鍵を返して保存します。 詳細は、SSH 鍵ペアを参照してください。

CreateKeyPairを呼び出すこととは別に、他のキーペアジェネレータを使用してキーペアを作成し、それを Alibaba Cloud リージョンの一つにアップロードすることもできます(ImportKeyPair)。

Alibaba Cloud の各リージョンでは、最大 500 のキーペアを作成できます。

リクエストパラメーター

名前 必須かどうか 解説
Action String Yes 操作インターフェイス名、システム規定のパラメーター。値: CreateKeyPair。
RegionId String Yes キーペアのリージョン ID。
KeyPairName String Yes キーペア名は[2, 128] 文字です。
  • 一意の名前にする必要があります。
  • すべての文字コードがサポートされます。
  • 特殊文字、数字、http://https:// から始まる名前は設定できません。
  • 数字、”.”、”_”、或は”-“ が使用可能です。
キーペア名はコンソール上に表示されます。

リターンパラメーター

名前 説明
KeyPairName String キーペアの名前。
KeyPairFingerPrint String キーペアの指紋。パブリックキーの指紋形式:RFC4716 中の MD5 の情報適用計算方法。ここ を参照してください。
PrivateKeyBody String キーペアのシークレットキー。まだ暗号化されていない PEM エンコーディングの PKCS #8 形式の RSA シークレットキー。ここ を参照してください。

リクエストの例

  1. https://ecs.aliyuncs.com/?Action=CreateKeyPair
  2. &RegionId=cn-qingdao
  3. &KeyPairName=test
  4. &<Common request parameters>

戻り値の例

XML 形式

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

JSON 形式

  1. {
  2. "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
  3. KeyPairName”:”test
  4. KeyPairFingerPrint”: 89:f0:ba:62:ac:b8:aa:e1:61:5e:fd:81:69:86:6d:6b:f0:c0:5a:d7
  5. PrivateKeyBody”: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
  6. }

エラーコード

このインタフェースに固有のエラーコードは次のとおりです。詳細については、API のエラー・センターを参照してください。

エラーコード 説明 HTTP ステータスコード 意味
MissingParameter このリクエストの処理に必須の入力パラメーターである RegionId が指定されていません。 400 RegionId の値がありません。 (または、ユーザーに本リージョンの利用が許可されていない可能性があります)。
InvalidKeyPairName.Malformed 指定されたキーペア名が無効です。 400 指定された KeyPairName の形式が無効であるか、或は他の名前と重複している可能性があります。
QuotaExceed.KeyPair キーペアのクォータが超過しました。 403 セキュリティグループの数が上限に達しました。
InvalidRegionId.NotFound 入力された RegionId がレコードに存在しません。 404 指定された RegionId が存在しません。