DescribeKeyPairs を使用したキーペアのクエリ - ENS

1 つ以上のキーペアを照会します。

今すぐお試しください

この 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:DescribeKeyPairs

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
KeyPairName	string	任意	シンプルアプリケーションサーバーにバインドするキーペアの名前です。名前は 2 ～ 128 文字の長さである必要があります。名前は文字で始まる必要がありますが、`http://` または `https://` で始めることはできません。名前には次の文字を含めることができます。数字 : _ . 名前は 1 つのみ指定できます。デフォルトでは、すべてのキーペアが照会されます。	TestKeyPairName
PageNumber	string	任意	返されるページのページ番号です。有効な値：0 より大きい整数。デフォルト値：1。	1
PageSize	string	任意	ページあたりのエントリ数。有効な値：0 より大きい整数。デフォルト値：10。	10
KeyPairId	string	任意	キーペアの ID。	ssh-50cynkq42sgj4ej1tn78t4***

レスポンスフィールド

フィールド	型	説明	例
	object
KeyPairs	object
KeyPair	array<object>	キーペアに関する詳細。
	object
CreationTime	string	キーペアが作成された時間。時間は ISO 8601 標準の yyyy-MM-ddThh:mm:ssZ フォーマットに従います。時間は協定世界時 (UTC) で表示されます。	2020-04-26T15:38:27Z
KeyPairFingerPrint	string	キーペアの指紋。	fdaf8ff7a756ef843814fc****
KeyPairName	string	SSH キーペアの名前。	TestKeyPairName
KeyPairId	string	キーペアの ID。	ssh-50cynkq42sgj4ej1tn78t4***
PageNumber	integer	ページ番号。	1
PageSize	integer	ページあたりの返されるエントリ数。	10
RequestId	string	リクエスト ID。	37B52F33-6879-49D0-A39B-22966B01449E
TotalCount	integer	キーペアの合計数。	7

例

成功レスポンス

JSONJSON

{
  "KeyPairs": {
    "KeyPair": [
      {
        "CreationTime": "2020-04-26T15:38:27Z",
        "KeyPairFingerPrint": "fdaf8ff7a756ef843814fc****",
        "KeyPairName": "TestKeyPairName",
        "KeyPairId": "ssh-50cynkq42sgj4ej1tn78t4***"
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "37B52F33-6879-49D0-A39B-22966B01449E",
  "TotalCount": 7
}

エラーコード

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	CallInterface	Call Interface Happen Error.

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

変更履歴

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