調(diào)用DescribeKeyPairs查詢一個或多個密鑰對。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| ecs:DescribeKeyPairs | get | *KeyPair acs:ecs:{#regionId}:{#accountId}:keypair/{#keypairName}*KeyPair acs:ecs:{#regionId}:{#accountId}:keypair/* |
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 密鑰對所在的地域 ID。您可以調(diào)用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
| KeyPairName | string | 否 | 密鑰對名稱。支持正則表達式模糊搜索，使用*匹配子表達式，示例：
| *SshKey* |
| KeyPairFingerPrint | string | 否 | 密鑰對的指紋。根據(jù) RFC 4716 定義的公鑰指紋格式，采用 MD5 信息摘要算法。更多詳情，請參見RFC 4716。 | ABC1234567 |
| PageNumber | integer | 否 | 密鑰對列表的頁碼。起始值：1。 默認值：1 。 | 1 |
| PageSize | integer | 否 | 分頁查詢時設(shè)置的每頁行數(shù)。最大值：50。 默認值：10 。 | 10 |
| IncludePublicKey | boolean | 否 | 是否在返回結(jié)果中包含 PublicKey。 默認值：false。 | false |
| ResourceGroupId | string | 否 | 密鑰對所在的企業(yè)資源組 ID。使用該參數(shù)過濾資源時，資源數(shù)量不能超過 1000 個。 說明
不支持默認資源組過濾。
| rg-amnhr7u7c7hj**** |
| Tag | array<object> | 否 | 標(biāo)簽列表。 | |
| object | 否 | |||
| Key | string | 否 | 密鑰對的標(biāo)簽鍵。N 的取值范圍：1~20。 使用一個標(biāo)簽過濾資源，查詢到該標(biāo)簽下的資源數(shù)量不能超過 1000 個；使用多個標(biāo)簽過濾資源，查詢到同時綁定了多個標(biāo)簽的資源數(shù)量不能超過 1000 個。如果資源數(shù)量超過 1000 個，請使用 ListTagResources 接口進行查詢。 | TestKey |
| Value | string | 否 | 密鑰對的標(biāo)簽值。N 的取值范圍：1~20。 | TestValue |
返回參數(shù)
示例
正常返回示例
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"
}
]
}
}
]
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-12-17 | OpenAPI 描述信息更新 | 查看變更詳情 |
| 2024-02-01 | OpenAPI 入?yún)l(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |