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

1 つ以上の Linux インスタンスに SSH キーペアをアタッチします。

操作説明

操作の説明

この操作を呼び出す際は、以下の点に注意してください。

Windows インスタンスは SSH キーペアをサポートしていません。
SSH キーペアをアタッチすると、ユーザー名とパスワードによる認証は無効になります。
インスタンスが 実行中 状態の場合、SSH キーペアの効果を適用するには、 RebootInstance を呼び出してインスタンスを再起動します。
インスタンスが停止状態の場合、SSH キーペアの効果を適用するには、 StartInstance を呼び出してインスタンスを起動します。
インスタンスにすでに SSH キーペアがアタッチされている場合、新しい SSH キーペアが元のキーペアに自動的に置き換わります。
これはバッチ操作であり、部分的な成功をサポートしています。HTTP 200 の応答は、リクエストが処理されたことのみを示しており、すべてのインスタンスが正常にアタッチされたことを示すものではありません。各インスタンスの結果を確認するには、FailCount の値と、Results.Result[] の各要素の Code および Success フィールドを確認します。
- リクエストレベルのエラー: 無効なパラメーター、存在しないキーペア、または 50 を超えるインスタンスなどのエラーは、バッチ実行前にブロックされます。エラーは 200 以外の HTTP 状態コードで応答の最上位レベルで返され、バッチリクエスト全体が失敗します。
- インスタンスレベルのエラー: Windows インスタンス、サポートされていないインスタンス状態、またはサポートされていないインスタンスタイプなどのエラーは、対応するインスタンスにのみ影響します。エラーコードは対応する Results.Result[] 要素に記録され、全体的なリクエストは引き続き HTTP 200 を返します。

今すぐお試しください

この 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:AttachKeyPair

update

*Instance。

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

*KeyPair。

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	SSH キーペアのリージョン ID。 DescribeRegions を呼び出して、最新のリージョンリストを取得できます。	cn-hangzhou
KeyPairName	string	必須	SSH キーペアの名前。	testKeyPairName
InstanceIds	string	必須	SSH キーペアをアタッチするインスタンスの ID。値は、最大 50 個のインスタンス ID で構成される JSON 配列として指定できます。ID はコンマ (,) で区切ります。	["i-bp1gtjxuuvwj17zr**", "i-bp17b7zrsbjwvmfy", … "i-bp1h6jmbefj1ytos**"]

レスポンスフィールド

フィールド	型	説明	例
	object
KeyPairName	string	キーペアの名前。	testKeyPairName
RequestId	string	リクエスト ID	473469C7-AA6F-4DC5-B3DB-A3*****83E
TotalCount	string	キーペアがアタッチされているインスタンスの総数。	2
FailCount	string	キーペアのアタッチに失敗したインスタンスの数。	1
Results	object
Result	array<object>	各インスタンスにキーペアがアタッチされているかどうかを示す結果のコレクション。
	object	結果。
Code	string	操作の状態コード。値が 200 の場合、操作が成功したことを示します。	200
Message	string	操作のメッセージ。Code が 200 の場合、成功したことを示します。	successful
InstanceId	string	インスタンス ID	i-m5eg7be9ndloji64****
Success	string	操作が成功したかどうかを示します。	true

例

成功レスポンス

JSONJSON

{
  "KeyPairName": "testKeyPairName",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3*****83E",
  "TotalCount": "2",
  "FailCount": "1",
  "Results": {
    "Result": [
      {
        "Code": "200",
        "Message": "successful",
        "InstanceId": "i-m5eg7be9ndloji64****",
        "Success": "true"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidKeyPairName.NotFound	The specified KeyPairName does not exist in our records.	指定された KeyPairName が存在しません。
400	InvalidInstanceIds.ValueNotSupported	The specified parameter InstanceIds is not valid.	指定された InstanceIds パラメーターが無効です。
400	DependencyViolation.IoOptimize	The specified parameter InstanceIds is not valid.	指定されたインスタンス ID が無効であるか、または指定されたインスタンスの I/O 最適化構成が無効です。
403	DependencyViolation.WindowsInstance	The instance creating is windows, cannot use ssh key pair to login	Windows インスタンスではキーペアはサポートされていません。
403	InstanceKeyPairLimitExceeded	The specified instances are beyond the permitted range.

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

変更履歴

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