CreateKeyPair - Elastic Compute Service - Alibaba Cloud ドキュメントセンター

操作説明

CreateKeyPair を呼び出してキーペアを作成するだけでなく、サードパーティツールを使用してキーペアを作成し、リージョンにアップロード ( ImportKeyPair ) することもできます。サードパーティツールで作成したキーペアの使用方法は、システムで作成したキーペアと同じです。

各リージョンで最大 500 個のキーペアを保持できます。詳細については、使用制限を参照してください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

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 のタグキー。N の有効な値: 1～20。タグキーは空文字列にできません。タグキーは最大 128 文字で、`aliyun` または `acs:` で始めることはできません。タグキーに `http://` または `https://` を含めることはできません。	TestKey
Value	string	任意	キーペアのタグ N のタグ値。N の有効な値: 1～20。タグ値は空文字列にできます。タグ値は最大 128 文字で、acs: で始めることはできません。タグ値に http:// または https:// を含めることはできません。	TestValue

レスポンスフィールド

フィールド	型	説明	例
	object
PrivateKeyBody	string	キーペアの秘密鍵。秘密鍵は PKCS#8 初期化で PEM エンコードされています。	MIIEpAIBAAKCAQEAtReyMzLIcBH78EV2zj****
KeyPairName	string	キーペアの名前	testKeyPairName
KeyPairId	string	SSH キーペアの ID。	ssh-bp67acfmxazb4p****
RequestId	string	リクエスト ID	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
KeyPairFingerPrint	string	キーペアの指紋。公開鍵の指紋フォーマットは RFC 4716 で定義されており、MD5 メッセージダイジェストアルゴリズムを使用します。詳細については、RFC 4716 を参照してください。	89:f0:ba:62:ac:b8:aa:e1:61:5e:fd:81:69:86:6d:6b:f0:c0:5a:**

例

成功レスポンス

JSONJSON

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

エラーレスポンス

JSONJSON

{
    "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 ステータスコード	エラーコード	エラーメッセージ
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.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。