刪除一對或者多對 SSH 金鑰對。刪除 SSH 金鑰對後,我們不再為您保存該 SSH 金鑰對,但是已經綁定的執行個體可以正常使用該 SSH 金鑰對,其 SSH 金鑰組名稱仍然顯示在執行個體詳情中。
描述
調用該介面時,您需要注意:
-
刪除 SSH 金鑰對後,您將無法通過 DescribeKeyPairs 查詢該 SSH 金鑰對。
-
查詢執行個體資訊時(DescribeInstances),會顯示 SSH 金鑰組名稱(
KeyPairNames
),不再顯示該 SSH 金鑰對的其他資訊。
請求參數
名稱 | 類型 | 是否必需 | 描述 |
---|---|---|---|
Action | String | 是 | 系統規定參數。取值:DeleteKeyPairs |
RegionId | String | 是 | SSH 金鑰對所在的地域。您可以調用 DescribeRegions 查看最新的阿里雲地域列表。 |
KeyPairNames | String | 是 | SSH 金鑰對名稱。取值可以由多個 SSH 金鑰對名稱組成一個 JSON 數組,格式為 ["key-xxxxxxxxx", "key-yyyyyyyyy", … "key-zzzzzzzzz"],最多支援 100 對 SSH 金鑰組,名稱之間用半形逗號(,)隔開。 |
返回參數
全是公共返回參數。參閱 公共參數。
樣本
請求樣本
https://ecs.aliyuncs.com/?Action=DeleteKeyPairs
&RegionId=cn-qingdao
&KeyPairNames=test
&<公共請求參數>
返回樣本
XML 格式
<DeleteKeyPairsResponse>
<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
</DeleteKeyPairsResponse>
JSON 格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}
錯誤碼
以下為本介面特有的錯誤碼。更多錯誤碼,請訪問 API 錯誤中心。
錯誤碼 | 錯誤資訊 | HTTP 狀態碼 | 說明 |
---|---|---|---|
MissingParameter | The input parameter RegionId that is mandatory for processing this request is not supplied. | 400 | 您需要指定參數 RegionId 。或者您暫時無法使用該地域的資源。 |
MissingParameter | The input parameter KeyPairName that is mandatory for processing this request is not supplied. | 400 | 您需要指定參數 KeyPairName 。 |
InvalidRegionId.NotFound | The specified RegionId does not exist. | 404 | 指定的 RegionId 不存在。 |