DeleteSecret
最近更新时间: 2025-10-20 17:05:52
1. 接口描述
接口请求域名: ssm.api3.fincloud.tencent.cn。
删除指定的凭据信息,可以通过RecoveryWindowInDays参数设置立即删除或者计划删除。对于计划删除的凭据,在删除日期到达之前状态为 PendingDelete,并可以通过RestoreSecret 进行恢复,超出指定删除日期之后会被彻底删除。您必须先通过 DisableSecret 停用凭据后才可以进行(计划)删除操作。
默认接口请求频率限制:50次/秒。
接口更新时间:2019-12-26 14:20:46。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DeleteSecret |
| Version | 是 | 否 | String | 公共参数,本接口取值:2019-09-23 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| SecretName | 是 | 否 | String | 指定需要删除的凭据名称。 |
| RecoveryWindowInDays | 否 | 否 | Uint64 | 指定计划删除日期,单位(天),0(默认)表示立即删除, 1-30 表示预留的天数,超出该日期之后彻底删除。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| SecretName | String | 指定删除的凭据名称。 |
| DeleteTime | Int64 | 凭据删除的日期,unix时间戳。 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue | 参数取值错误。 |
| InternalError | 内部错误。 |
| UnauthorizedOperation | 未授权操作。 |
| ResourceNotFound | 资源不存在。 |
| FailedOperation | 操作失败。 |
| ResourceUnavailable.NotPurchased | 服务未购买。 |