ENS:DeleteKeyPairs を使用した SSH キーペアの削除 - ENS

操作説明

SSH キーペアを削除した後は、DescribeKeyPairs 操作を呼び出してキーペアを照会できなくなります。
Edge Node Service (ENS) インスタンスにバインドされている SSH キーペアを削除した場合、ENS ではその SSH キーペアが保存されなくなります。ただし、インスタンスへのアクセスには引き続きそのキーペアを使用できます。また、DescribeInstance 操作を呼び出してインスタンス情報を照会する際には、キーペア名（KeyPairName）のみが応答として返され、他の情報は含まれません。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ens:DeleteKeyPairs

delete

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
KeyPairName	string	任意	キーペアの名称です。以下の命名規則に従う必要があります：長さは 2 文字以上、128 文字以下である必要があります。先頭は英字で始める必要があり、`http://` または `https://` で始めてはいけません。使用可能な文字は、英字、数字、コロン（:）、アンダースコア（_）、ハイフン（-）です。キーペアを削除する前に、DescribeKeyPairs 操作を呼び出して既存のキーペアを照会できます。	TestKeyPairName
KeyPairId	string	任意	SSH キーペアの ID です。	ssh-5lywanlkih1zo9yl8eg****

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID です。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	MissingParameter	The input parameter that is mandatory for processing this request is not supplied.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.
400	InvalidParameter	The errorMessage is %s. Please check it again.
400	ens.interface.error	An error occurred while calling the API.
400	PubKeyNameExisted	Public Key Pair Name Existed.
400	PubKeyAttachedWithInstance	Public Key Attached With Instance.
400	InvalidPubKeyBody	Invalid Public Key Body.
400	PubKeyNameNotExist	Public Key Pair Name Not Exist.
400	CallInterface	Call Interface Happen Error.

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

変更履歴

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