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

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

操作説明

このオペレーションを呼び出す際は、以下の事項に注意してください。

WindowsインスタンスはSSHキーペアをサポートしていません。
SSHキーペアをインスタンスにバインドすると、ユーザー名とパスワードによる認証が無効になります。
インスタンスが実行中の状態の場合、SSHキーペアを有効にするにはインスタンスを再起動（ RebootInstance ）してください。
インスタンスが停止済みの状態の場合、SSHキーペアを有効にするにはインスタンスを起動（ StartInstance ）してください。
SSHキーペアが既にインスタンスにバインドされている場合、新しいSSHキーペアは自動的に元のキーペアを置き換えます。

今すぐお試しください

この 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 を呼び出して、Alibaba Cloudの最新のリージョンリストを照会できます。	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-A3DC0DE3C83E
TotalCount	string	キーペアがバインドされているインスタンスの合計数。	2
FailCount	string	キーペアのバインドに失敗したインスタンスの数。	0
Results	object
Result	array<object>	キーペアのバインド結果。
	object
Code	string	返される操作状態コード。 200 は、操作が成功したことを示します。	200
Message	string	返される操作情報。 Code の値が 200 の場合、Message の値は successful です。	successful
InstanceId	string	インスタンス ID。	i-m5eg7be9ndloji64****
Success	string	リクエストが成功したかどうかを示します。	true

例

成功レスポンス

JSONJSON

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

エラーレスポンス

JSONJSON

{
    "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidKeyPairName.NotFound	The specified KeyPairName does not exist in our records.
400	InvalidInstanceIds.ValueNotSupported	The specified parameter InstanceIds is not valid.
400	DependencyViolation.IoOptimize	The specified parameter InstanceIds is not valid.
403	DependencyViolation.WindowsInstance	The instance creating is windows, cannot use ssh key pair to login
403	InstanceKeyPairLimitExceeded	The specified instances are beyond the permitted range.

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

変更履歴

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