接口请求域名： ssm.intl.tencentcloudapi.com 。
删除指定的凭据信息，可以通过RecoveryWindowInDays参数设置立即删除或者计划删除。对于计划删除的凭据，在删除日期到达之前状态为 PendingDelete，并可以通过RestoreSecret 进行恢复，超出指定删除日期之后会被彻底删除。您必须先通过 DisableSecret 停用凭据后才可以进行（计划）删除操作。
默认接口请求频率限制：50次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DeleteSecret。 |
| Version | 是 | String | 公共参数，本接口取值：2019-09-23。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| SecretName | 是 | String | 指定需要删除的凭据名称。 |
| RecoveryWindowInDays | 否 | Integer | 指定计划删除日期，单位（天），0（默认）表示立即删除， 1-30 表示预留的天数，超出该日期之后彻底删除。 当凭据类型为SSH密钥对凭据时，此字段只能取值只能为0。 |
| CleanSSHKey | 否 | Boolean | 当凭据类型为SSH密钥对凭据时，此字段有效，取值： True -- 表示不仅仅清理此凭据中存储的SSH密钥信息，还会将SSH密钥对从CVM侧进行清理。注意，如果SSH密钥此时绑定了CVM实例，那么会清理失败。 False -- 表示仅仅清理此凭据中存储的SSH密钥信息，不在CVM进侧进行清理。 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| SecretName | String | 指定删除的凭据名称。 |
| DeleteTime | Integer | 凭据删除的日期，unix时间戳。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
https://ssm.intl.tencentcloudapi.com/?Action=DeleteSecret
&SecretName=lzctest
&RecoveryWindowInDays=1
&<公共请求参数>
{
"Response": {
"RequestId": "2609a8fd-4584-4f89-98be-8c7ae1b81ef4",
"SecretName": "lzctest",
"DeleteTime": 1574247268
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameterValue | 参数取值错误。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable.NotPurchased | 服务未购买。 |
| ResourceUnavailable.ResourceUninitialized | 凭据未完成初始化。 |
| UnauthorizedOperation | 未授权操作。 |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback