全部產品
Search
文件中心

:DeleteSecret - 刪除憑據對象

更新時間:Dec 21, 2025

刪除憑據對象。

介面說明

  • RAM 使用者或 RAM 角色調用該 OpenAPI 需要被授與權限策略詳情,請參見存取控制

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

調試

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

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱

類型

必填

描述

樣本值

SecretName

string

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

說明

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

secret001

ForceDeleteWithoutRecovery

string

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

取值範圍:

  • true

  • false(預設值)

false

RecoveryWindowInDays

string

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

說明

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

10

返回參數

名稱

類型

描述

樣本值

object

SecretName

string

憑據名稱。

secret001

RequestId

string

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

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

PlannedDeleteTime

string

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

2024-04-15T07:02:14Z

樣本

正常返回樣本

JSON格式

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

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 InvalidParameter The specified parameter is not valid. 參數非法。
500 InternalFailure Internal Failure
404 Forbidden.ResourceNotFound Resource not found
404 InvalidAccessKeyId.NotFound The Access Key ID provided does not exist in our records.
409 Rejected.ResourceInDeleteWindow secret in delete peroid

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

變更歷史

更多資訊,參考變更詳情