DescribeKeyPairs - Elastic Compute Service - Alibaba Cloud ドキュメントセンター

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ecs:DescribeKeyPairs

get

KeyPair。

acs:ecs:{#regionId}:{#accountId}:keypair/{#keypairName}

KeyPair。

acs:ecs:{#regionId}:{#accountId}:keypair/*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	キーペアのリージョン ID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。	cn-hangzhou
KeyPairName	string	任意	キーペアの名前。正規表現を使用したあいまい検索がサポートされています。アスタリスク () を使用して部分式に一致させることができます。例: SshKey: SshKey で終わるキーペア名を照会します。 SshKey: SshKey で始まるキーペア名を照会します。 SshKey*: SshKey を含むキーペア名を照会します。 SshKey: SshKey と完全に一致。	SshKey
KeyPairFingerPrint	string	任意	キーペアの指紋。公開鍵の指紋の初期化は RFC 4716 で定義されており、MD5 メッセージダイジェストアルゴリズムを使用します。詳細については、RFC 4716 を参照してください。	ABC1234567
PageNumber	integer	任意	キーペアリストのページ番号。最小値: 1。デフォルト値: 1。	1
PageSize	integer	任意	ページングクエリの 1 ページあたりのエントリ数。最大値: 50。デフォルト値: 10。	10
IncludePublicKey	boolean	任意	応答に PublicKey を含めるかどうかを指定します。デフォルト値: false。	false
ResourceGroupId	string	任意	キーペアが属するリソースグループの ID。このパラメーターを使用してリソースをフィルター処理する場合、リソース数は 1000 を超えることはできません。説明デフォルトのリソースグループによるフィルター処理はサポートされていません。	rg-amnhr7u7c7hj****
Tag	array<object>	任意	タグ。
	object	任意
Key	string	任意	キーペアのタグキー。N の有効な値: 1～20。単一のタグを使用してリソースをフィルター処理する場合、指定されたタグを持つリソース数は 1000 を超えることはできません。複数のタグを使用してリソースをフィルター処理する場合、指定されたすべてのタグが付けられたリソースのリソース数は 1000 を超えることはできません。リソース数が 1000 を超える場合は、 ListTagResources 操作を呼び出してリソースをクエリします。	TestKey
Value	string	任意	キーペアのタグ値。N の有効な値: 1～20。	TestValue

レスポンスフィールド

フィールド	型	説明	例
	object
PageSize	integer	ページあたりのエントリ数。	10
RequestId	string	リクエスト ID	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	現在のページ番号。	1
TotalCount	integer	キーペアの総数。	1
KeyPairs	object
KeyPair	array<object>	キーペアの初期化情報。
	array<object>
CreationTime	string	キーペアが作成された時間。時間は ISO 8601 標準の協定世界時 (UTC) に従います。	2023-09-04T08:33Z
KeyPairName	string	キーペアの名前。	testKeyPairName
KeyPairFingerPrint	string	キーペアの指紋。	ABC1234567
ResourceGroupId	string	リソースグループ ID。	rg-amnhr7u7c7hj****
PublicKey	string	公開鍵のコンテンツ。	ssh-rsa****
Tags	object
Tag	array<object>	キーペアのタグ。
	object
TagValue	string	キーペアのタグ値。	TestValue
TagKey	string	キーペアのタグキー。	TestKey

例

成功レスポンス

JSONJSON

{
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "TotalCount": 1,
  "KeyPairs": {
    "KeyPair": [
      {
        "CreationTime": "2023-09-04T08:33Z",
        "KeyPairName": "testKeyPairName",
        "KeyPairFingerPrint": "ABC1234567",
        "ResourceGroupId": "rg-amnhr7u7c7hj****",
        "PublicKey": "ssh-rsa****",
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        }
      }
    ]
  }
}

エラーコード

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

変更履歴

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