全部產品
Search
文件中心

:DeleteSecret

更新時間:Jan 22, 2025

調用DeleteSecret介面刪除指定的憑據。

您可以設定計劃刪除憑據,時間視窗支援7天~30天,視窗期內憑據可以恢複。也可以立即刪除憑據,憑據立即刪除且不可恢複。

調試

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

請求參數

名稱

類型

是否必選

樣本值

描述

Action String DeleteSecret

要執行的操作。取值:DeleteSecret

SecretName String secret001

憑據名稱或憑據資源名稱(ARN)。

說明 訪問其他阿里雲帳號下的憑據時,必須輸入憑據ARN。憑據ARN的格式為acs:kms:${region}:${account}:secret/${secret-name}
ForceDeleteWithoutRecovery String false

是否立即刪除憑據,且不允許恢複。

取值範圍:

  • true
  • false(預設值)
RecoveryWindowInDays String 10

計劃刪除憑據時,該參數用於指定刪除視窗,視窗期內可以恢複憑據。取值:7天~30天。

預設值:30。

說明 當您需要立即刪除憑據,即ForceDeleteWithoutRecovery取值為true時,不允許輸入本參數。

返回資料

名稱

類型

樣本值

描述

SecretName String secret001

憑據名稱。

RequestId String 38bbed2a-15e0-45ad-98d4-816ad2ccf4ea

本次調用請求的ID,是由阿里雲為該請求產生的唯一識別碼,可用於排查和定位問題。

PlannedDeleteTime String 2024-04-15T07:02:14Z

憑據的刪除時間,為時間戳記格式。

樣本

請求樣本

http(s)://[Endpoint]/?Action=DeleteSecret
&SecretName=secret001
&ForceDeleteWithoutRecovery=false
&RecoveryWindowInDays=10
&公用請求參數

正常返回樣本

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DeleteSecretResponse>
    <SecretName>secret001</SecretName>
    <RequestId>38bbed2a-15e0-45ad-98d4-816ad2ccf4ea</RequestId>
    <PlannedDeleteTime>2022-09-15T07:02:14Z</PlannedDeleteTime>
</DeleteSecretResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "SecretName" : "secret001",
  "RequestId" : "38bbed2a-15e0-45ad-98d4-816ad2ccf4ea",
  "PlannedDeleteTime" : "2022-09-15T07:02:14Z"
}

錯誤碼

HttpCode

錯誤碼

錯誤資訊

描述

400 InvalidParameter The specified parameter is not valid. 參數非法。

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