DeleteSecret - 删除凭据对象

删除凭据对象。

接口说明

  • RAM 用户或 RAM 角色调用该 OpenAPI 需要被授予的权限策略详情,请参见访问控制

  • 您可以设置计划删除凭据,时间窗口支持 7 天~30 天,窗口期内凭据可以恢复。也可以立即删除凭据,凭据立即删除且不可恢复。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
SecretNamestring

凭据名称或凭据资源名称(ARN)。

说明 访问其他阿里云账号下的凭据时,必须输入凭据 ARN。凭据 ARN 的格式为acs:kms:${region}:${account}:secret/${secret-name}
secret001
ForceDeleteWithoutRecoverystring

是否立即删除凭据,且不允许恢复。

取值范围:

  • true
  • false(默认值)
false
RecoveryWindowInDaysstring

计划删除凭据时,该参数用于指定删除窗口,窗口期内可以恢复凭据。取值:7 天~30 天。 默认值:30。

说明 当您需要立即删除凭据,即 ForceDeleteWithoutRecovery 取值为 true 时,不允许输入本参数。
10

返回参数

名称类型描述示例值
object
SecretNamestring

凭据名称。

secret001
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

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

凭据的删除时间,为时间戳格式。

2024-04-15T07:02:14Z

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400InvalidParameterThe specified parameter is not valid.参数非法。
404Forbidden.ResourceNotFoundResource not found-
404InvalidAccessKeyId.NotFoundThe Access Key ID provided does not exist in our records.-
409Rejected.ResourceInDeleteWindowsecret in delete peroid-
500InternalFailureInternal Failure-

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