AttachKeyPair - ENS - Alibaba Cloud ドキュメントセンター

1 回の呼び出しで、最大 30 個のインスタンスに SSH キーペアをアタッチします。

操作説明

キーペアは、停止中のインスタンスにのみアタッチできます。

呼び出しごとに最大 30 個のインスタンスを指定します。
KeyPairName または KeyPairId のいずれかを指定します。
KeyPairName は非推奨になるため、KeyPairId を使用することを推奨します。

今すぐお試しください

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

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
KeyPairName	string	任意	キーペア名。	test-kp
InstanceIds	array	必須	インスタンス ID のリスト。	["i-50f8q9mbfjzlkuk9znjglnne3"]
	string	任意	インスタンス ID。	i-xxx
KeyPairId	string	任意	キーペアの一意の ID。	ssh-xxx

レスポンスフィールド

フィールド	型	説明	例
	object	応答オブジェクト。
RequestId	string	リクエスト ID。	xx-xx-xx-xx
KeyPairName	string	キーペア名。	ssh-xxx
FailCount	integer	アタッチが失敗したインスタンスの数。	1
TotalCount	integer	リクエスト内のインスタンスの総数。	3
Results	array<object>	各インスタンスのアタッチ結果。
	object
Code	integer	操作の状態コード。値が `200` の場合、成功を示します。	200
InstanceId	string	インスタンス ID。	i-xxx
Message	string	応答メッセージ。`Code` が `200` の場合、このメッセージは `successful` です。	successful
Success	boolean	インスタンスに対する操作が成功したかどうかを示します。	true
KeyPairId	string	キーペア ID。	ssh-xxx

例

成功レスポンス

JSONJSON

{
  "RequestId": "xx-xx-xx-xx",
  "KeyPairName": "ssh-xxx",
  "FailCount": 1,
  "TotalCount": 3,
  "Results": [
    {
      "Code": 200,
      "InstanceId": "i-xxx",
      "Message": "successful",
      "Success": true
    }
  ],
  "KeyPairId": "ssh-xxx"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

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

変更履歴

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