DetachKeyPair API で SSH キーペアのバインドを解除 - SAS

操作説明

ご利用のシンプルアプリケーションサーバーにバインドされている 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

swas-open:DetachKeyPair

update

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	シンプルアプリケーションサーバーが設置されているリージョン ID。	cn-hangzhou
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアント側でトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。詳細については、「べき等性の確保」をご参照ください。	123e4567-e89b-12d3-a456-426655440000
InstanceIds	array	必須	SSH キーペアのバインドを解除するシンプルアプリケーションサーバーの ID。最大 50 個のシンプルアプリケーションサーバー ID を指定できます。
	string	任意	SSH キーペアのバインドを解除するシンプルアプリケーションサーバーの ID。最大 50 個のシンプルアプリケーションサーバー ID を指定できます。	2ad1ae67295445f598017499dc****
KeyPairName	string	必須	キーペアの名前。名前はグローバルに一意である必要があります。名前の長さは 2～64 文字で、文字、数字、コロン (:)、アンダースコア (_)、ハイフン (-) を使用できます。名前は文字で始まる必要があり、http:// または https:// で始めることはできません。	KeyPairName

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	20758A-585D-4A41-A9B2-28DA8F4F534F
TotalCount	integer	SSH キーペアのバインドが解除されたシンプルアプリケーションサーバーの総数。	1
FailCount	integer	キーペアのバインド解除に失敗したシンプルアプリケーションサーバーの総数。	0
Results	array<object>	リクエストの結果。
	object	バインド解除操作の結果セット。
Code	string	HTTP ステータスコード。	200
Message	string	応答メッセージ。	success
Success	string	キーペアがシンプルアプリケーションサーバーから正常にバインド解除されたかどうかを示します。有効な値： true false	true
InstanceId	string	シンプルアプリケーションサーバーの ID。	aa6e71ddb35c46679bc4753d6219d604

例

成功レスポンス

JSONJSON

{
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "TotalCount": 1,
  "FailCount": 0,
  "Results": [
    {
      "Code": "200",
      "Message": "success",
      "Success": "true",
      "InstanceId": "aa6e71ddb35c46679bc4753d6219d604"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParameter.KeypairNotAttachedInstance	The specified keyPair not attached to instances.
404	InvalidInstanceId.NotFound	The specified Instance Id does not exist.

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

変更履歴

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