DescribeKeyPairs - Elastic Compute Service

呼叫DescribeKeyPairs查詢一個或多個金鑰對。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

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。 `SshKey`：精確匹配 SshKey。	SshKey
KeyPairFingerPrint	string	否	金鑰對的指紋。根據 RFC 4716 定義的公鑰指紋格式，採用 MD5 資訊摘要演算法。更多詳情，請參見RFC 4716。	ABC1234567
PageNumber	integer	否	金鑰對列表的頁碼。起始值：1。預設值：1 。	1
PageSize	integer	否	分頁查詢時設定的每頁行數。最大值：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	金鑰組的建立時間。	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

樣本

正常返回樣本

JSON格式

{
  "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"
            }
          ]
        }
      }
    ]
  }
}

異常返回樣本

JSON格式

{
    "PageNumber": 1,
    "PageSize": 2,
    "TotalCount": 1,
    "KeyPairs": {
        "KeyPair":[{
            "KeyPairName": "test",
            "KeyPairFingerPrint": "xxxxxxxxxx"
        }]
    }
    "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。