调用DeleteSecret接口删除凭据对象_密钥管理服务(KMS)-阿里云帮助中心

您可以设置计划删除凭据，时间窗口支持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.	参数非法。

访问错误中心查看更多错误码。