删除凭据信息

最近更新时间:2019-12-27 15:47:05

1. 接口描述

接口请求域名: ssm.tencentcloudapi.com 。

删除指定的凭据信息,可以通过RecoveryWindowInDays参数设置立即删除或者计划删除。对于计划删除的凭据,在删除日期到达之前状态为 PendingDelete,并可以通过RestoreSecret 进行恢复,超出指定删除日期之后会被彻底删除。您必须先通过 DisableSecret 停用凭据后才可以进行(计划)删除操作。

默认接口请求频率限制:50次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DeleteSecret
Version String 公共参数,本接口取值:2019-09-23
Region String 公共参数,详见产品支持的 地域列表
SecretName String 指定需要删除的凭据名称。
RecoveryWindowInDays Integer 指定计划删除日期,单位(天),0(默认)表示立即删除, 1-30 表示预留的天数,超出该日期之后彻底删除。

3. 输出参数

参数名称 类型 描述
SecretName String 指定删除的凭据名称。
DeleteTime Integer 凭据删除的日期,unix时间戳。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 删除凭据信息

输入示例

https://ssm.tencentcloudapi.com/?Action=DeleteSecret
&SecretName=test
&RecoveryWindowInDays=1
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "2609a8fd-4584-4f89-98be-8c7ae1b81ef4",
    "SecretName": "test",
    "DeleteTime": 1574247268
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameterValue 参数取值错误。
ResourceNotFound 资源不存在。
ResourceUnavailable.NotPurchased 服务未购买。
UnauthorizedOperation 未授权操作。