調用DeleteKeyPairs刪除一對或者多對SSH密鑰對。
接口說明
刪除 SSH 密鑰對后，您需要注意：
- 無法通過 DescribeKeyPairs 查詢該 SSH 密鑰對。
- 若已有 ECS 實例綁定了該 SSH 密鑰對，則該 SSH 密鑰對不支持被刪除。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| ecs:DeleteKeyPairs | delete | *KeyPair acs:ecs:{#regionId}:{#accountId}:keypair/{#keypairName} |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | SSH 密鑰對所在的地域。您可以調用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
| KeyPairNames | string | 是 | SSH 密鑰對名稱。取值可以由多個 SSH 密鑰對名稱組成一個 JSON 數組，最多支持 100 對 SSH 密鑰對，名稱之間用半角逗號（,）隔開。 說明
在進行刪除 SSH 密鑰對前，您可以調用 DescribeKeyPairs 查詢已有密鑰對。
| ["TestKeyPairName-1", "TestKeyPairName-2", … "TestKeyPairName-100"] |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | MissingParameter | The input parameter "KeyPairNames" that is mandatory for processing this request is not supplied. | - |
| 400 | InvalidKeyPairNames.ValueNotSupported | The specified parameter "KeyPairNames" is not valid. | 指定的參數“KeyPairNames”無效。 |
| 400 | InvalidParameter.KeypairAlreadyAttachedInstance | The specified parameter "KeyPairNames" attached to instances can not be deleted. | 指定的KeyPair存在關聯的實例。 |
| 403 | InstanceKeyPairLimitExceeded | Exceeding the allowed amount of instance which will be deleted. | 要刪除的密鑰對數量達到上限。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-12-17 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |