删除凭据对象。
接口说明
-
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 | 否 | 是否立即删除凭据,且不允许恢复。 取值范围:
| false |
RecoveryWindowInDays | string | 否 | 计划删除凭据时,该参数用于指定删除窗口,窗口期内可以恢复凭据。取值:7 天~30 天。 默认值:30。 说明
当您需要立即删除凭据,即 ForceDeleteWithoutRecovery 取值为 true 时,不允许输入本参数。
| 10 |
返回参数
示例
正常返回示例
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. | 参数非法。 |
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 | - |
500 | InternalFailure | Internal Failure | - |
访问错误中心查看更多错误码。