1 回のリクエストで、最大 30 個のインスタンスからキーペアをデタッチします。キーペアは、キーペア名またはキーペア ID で指定できます。
操作説明
使用上の注意
この操作は、複数のインスタンスからキーペアをバッチでデタッチします。ターゲットインスタンスは停止状態である必要があります。
1 回のリクエストで、最大 30 個のインスタンスからキーペアをデタッチできます。
KeyPairNameパラメーターを指定し、指定されたインスタンスのいずれかがそのキーペア名に関連付けられていない場合、操作はエラーを返します。KeyPairNameまたはKeyPairIdパラメーターのいずれかを指定する必要があります。KeyPairIdパラメーターの使用を推奨します。KeyPairNameパラメーターは将来のリリースで非推奨になる予定です。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| KeyPairName |
string |
任意 |
キーペアの名前。 |
test-kp |
| KeyPairId |
string |
任意 |
キーペアの ID。 |
ssh-xxx |
| InstanceIds |
array |
必須 |
キーペアをデタッチするインスタンス ID の配列。 |
["i-50f8q9mbfjzlkuk9znjglnne3"] |
|
string |
任意 |
インスタンス ID。 |
i-xxxu |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答オブジェクト。 |
||
| RequestId |
string |
リクエスト ID。 |
xx-xx-xx-xx |
| KeyPairId |
string |
キーペアの ID。 |
ssh-xxx |
| KeyPairName |
string |
キーペアの名前。 |
test-kp |
| FailCount |
integer |
デタッチ操作が失敗したインスタンスの数。 |
1 |
| TotalCount |
integer |
リクエストで指定されたインスタンスの総数。 |
3 |
| Results |
array<object> |
各インスタンスに対する操作の結果。 |
|
|
object |
|||
| Code |
integer |
特定のインスタンスに対する操作の状態コード。値が |
200 |
| InstanceId |
string |
インスタンス ID。 |
i-xxx |
| Message |
string |
操作の応答メッセージ。 |
successful |
| Success |
boolean |
インスタンスでの操作が成功したかどうかを示します。有効な値: |
true |
例
成功レスポンス
JSONJSON
{
"RequestId": "xx-xx-xx-xx",
"KeyPairId": "ssh-xxx",
"KeyPairName": "test-kp",
"FailCount": 1,
"TotalCount": 3,
"Results": [
{
"Code": 200,
"InstanceId": "i-xxx",
"Message": "successful",
"Success": true
}
]
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | PublicKeyNotAttachWithInstance | Public Key Not Attach With Instance. | |
| 400 | NoPermission | Permission denied. | |
| 400 | InvalidParameter.%s | The specified field %s invalid. Please check it again. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。