調用DescribeKeyPairs介面查詢SSH金鑰組-邊緣節點服務 ENS-阿里雲

調用DescribeKeyPairs查詢一個或多個金鑰組。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

ens:DescribeKeyPairs

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
KeyPairName	string	否	金鑰組名稱。長度為 2~128 個英文或中文字元。必須以大小字母或中文開頭，不能以`http://`和`https://`開頭。可以包含以下字元：數字 : _ . 僅支援傳單個名稱。預設查詢所有金鑰組資訊。	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	金鑰組的建立時間。日期格式按照 ISO8601 標記法，並使用 UTC 時間。格式為 yyyy-MM-ddTHH:mm:ssZ。	2020-04-26T15:38:27Z
KeyPairFingerPrint	string	金鑰組的指紋。	fdaf8ff7a756ef843814fc****
KeyPairName	string	金鑰組的名稱。	TestKeyPairName
KeyPairId	string	金鑰組的 ID	ssh-50cynkq42sgj4ej1tn78t4***
PageNumber	integer	當前頁碼。	1
PageSize	integer	每頁行數。	10
RequestId	string	請求 ID。	37B52F33-6879-49D0-A39B-22966B01449E
TotalCount	integer	金鑰組的總數。	7

樣本

正常返回樣本

JSON格式

{
  "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 status code	錯誤碼	錯誤資訊	描述
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.	介面調用出錯。

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

變更歷史

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