edit-icon download-icon

DescribeKeyPairs

最終更新日: Dec 10, 2018

1 つまたは複数の SSH キーペアについて説明します。

リクエストパラメータ

名前 必須かどうか 説明
Action String はい このインタフェースの名前。値:DescribeKeyPairs。
RegionId String はい SSH キーペアが属するリージョンの ID。詳細については、DescribeRegions を呼び出して最新のリージョンリストを取得してください。
KeyPairFingerPrint tring いいえ キーペアの指紋。公開キーフィンガープリント形式は RFC4716 で定義されており、MD5 メッセージダイジェストアルゴリズムを使用します。詳細は、RFC4716 を参照してください。
KeyPairName String いいえ キーのペア名。キーペア名のあいまい文字列検索には、正規表現と *という記号を使用できます。サンプルパターン:
  • *SshKey: SshKey を含む SshKey で終わる文字列セットと一致します。
  • SshKey*: SshKey を始めとする SshKey で始まる文字列セットにマッチします。
  • *SshKey*: SshKey を含む SshKey で設定された文字列と一致します。
  • SshKey: 文字列セット SshKey にマッチします。
PageNumber Integer いいえ 複数のページに SSH キーペアを表示します。
開始値:1。
デフォルト値:1
PageSize Integer いいえ ページの最大エントリ数。
最大値:50。
デフォルト値:10。

レスポンスパラメータ

名前 説明
TotalCount Integer キーペアの総数。
PageNumber Integer 現在のページ。
PageSize Integer ページの最大エントリ数。
RegionId String キーのペアのリージョン。
KeyPairs KeyPairItemType キーペアに関する情報、KeyPairItemType で構成されるセット。

リクエストの例

  1. https://ecs.aliyuncs.com/?Action=DescribeKeyPairs
  2. &RegionId=cn-qingdao
  3. &KeyPairFingerPrint=xxxxxxxxxx
  4. &KeyPairName=test
  5. &PageNumber=1
  6. &PageSize=20
  7. &<Common Request Parameters>

レスポンスの例

XML 形式

  1. <DescribeKeyPairsResponse>
  2. <PageNumber>1</PageNumber>
  3. <PageSize>2</PageSize>
  4. <TotalCount>1</TotalCount>
  5. <KeyPairs>
  6. <KeyPair>
  7. <KeyPairName>test</KeyPairName >
  8. <KeyPairFingerPrint>xxxxxxxxxx</KeyPairFingerPrint>
  9. </KeyPair>
  10. </KeyPairs>
  11. <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
  12. </DescribeKeyPairsResponse>

JSON 形式

  1. {
  2. "PageNumber":1
  3. "PageSize":2
  4. "TotalCount":1
  5. "KeyPairs":{
  6. "KeyPair":[{
  7. "KeyPairName": "test"
  8. "KeyPairFingerPrint": "xxxxxxxxxx"
  9. }]
  10. }
  11. "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
  12. }

エラーコード

このインタフェースに固有のエラーコードは次のとおりです。より多くのエラーコードについては、API のエラー・センターを参照してください。

エラーコード エラーメッセージ HTTP ステータスコード 意味
MissingParameter The input parameter “RegionId” that is mandatory for processing this request is not supplied. 400 RegionIdパラメータを指定する必要があります。
InvalidParameter The specified parameter “PageNumber” is not valid. 400 指定された PageNumberパラメータは無効です。
InvalidParameter The specified parameter “PageSize” is not valid. 400 指定された PageSizeパラメータは無効です。