調用DeleteKeyPairs刪除一對SSH金鑰組。
介面說明
如果您成功刪除金鑰組,將無法通過 DescribeKeyPairs 查詢該金鑰組。
如果您的 ENS 執行個體已經綁定了金鑰組,在刪除了該金鑰組後,阿里雲 ENS 不再為您儲存該 SSH 金鑰對,但是執行個體可以正常使用該 SSH 金鑰對。調用 DescribeInstances 查詢執行個體資訊時,會顯示金鑰組名稱(KeyPairName),但不再顯示其他相關資訊。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
ens:DeleteKeyPairs |
delete |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| KeyPairName |
string |
否 |
金鑰組名稱。命名規則如下所示:
在進行刪除金鑰組前,您可以調用 DescribeKeyPairs 查詢已有金鑰組。 |
TestKeyPairName |
| KeyPairId |
string |
否 |
SSH 金鑰對的 ID。 |
ssh-5lywanlkih1zo9yl8eg**** |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求 ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
樣本
正常返回樣本
JSON格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\t"
}
錯誤碼
|
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 | PubKeyNameExisted | Public Key Pair Name Existed. | 金鑰組名字已存在 |
| 400 | PubKeyAttachedWithInstance | Public Key Attached With Instance. | 密鑰已綁定了執行個體 |
| 400 | InvalidPubKeyBody | Invalid Public Key Body. | 不合法的密鑰 |
| 400 | PubKeyNameNotExist | Public Key Pair Name Not Exist. | 金鑰組名字不存在 |
| 400 | CallInterface | Call Interface Happen Error. | 介面調用出錯。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。