1. 接口描述
接口请求域名： ssl.tencentcloudapi.com 。
本接口（DeleteCertificate）用于删除证书。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DeleteCertificate。 |
| Version | 是 | String | 公共参数，本接口取值：2019-12-05。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| CertificateId | 是 | String | 证书 ID。 示例值：qwrqwr1 |
| IsCheckResource | 否 | Boolean | 删除时是否检查证书关联了云资源。默认不检查。如选择检查(需要授权服务角色SSL_QCSLinkedRoleInReplaceLoadCertificate)删除将变成异步,接口会返回异步任务ID。需使用DescribeDeleteCertificatesTaskResult接口查询删除是否成功。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DeleteResult | Boolean | 删除结果（true：删除成功，false：删除失败） 示例值：true |
| TaskId | String | 异步删除的任务ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：12566 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 删除证书
输入示例
https://ssl.tencentcloudapi.com/?Action=DeleteCertificate
&CertificateId=CertificateId
&<公共请求参数>输出示例
{
"Response": {
"DeleteResult": true,
"RequestId": "0b39eaa4-f938-476d-9b26-19fb07b80936"
}
}示例2 异步删除
输入示例
POST / HTTP/1.1
Host: ssl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteCertificate
<公共请求参数>
{
"CertificateId": "abc",
"IsCheckResource": true
}输出示例
{
"Response": {
"DeleteResult": false,
"TaskId": "1251261",
"RequestId": "abc"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.AuthError | 请检查是否有权限。 |
| FailedOperation.BoundResources | 有未解绑的云资源，不能被删除。 |
| FailedOperation.CancelOrderFailed | 取消订单失败。 |
| FailedOperation.CannotBeDeletedIssued | 该证书已颁发， 不能删除。 |
| FailedOperation.CannotBeDeletedWithinHour | 免费证书申请1小时内不允许删除。 |
| FailedOperation.CannotGetOrder | 获取订单信息失败，请稍后重试。 |
| FailedOperation.CertificateNotFound | 证书不存在。 |
| FailedOperation.DeleteFailedTimeNotUp | 免费证书申请时间未超过1小时，不能被删除。 |
| FailedOperation.DeleteResourceFailed | 证书已关联云资源，无法删除。 |
| FailedOperation.InvalidCertificateStatusCode | 证书状态不正确。 |
| FailedOperation.InvalidParam | 参数有误。 |
| FailedOperation.NetworkError | 当前 CA 机构访问繁忙，请稍后重试。 |
| FailedOperation.NoProjectPermission | 您没有该项目的操作权限。 |
| FailedOperation.NoRealNameAuth | 尚未通过实名认证。 |
| FailedOperation.OrderAlreadyReplaced | 该订单已重签发。 |
| FailedOperation.RenewNotIssued | 续费证书未颁发，无法执行删除操作。 |
| FailedOperation.RoleNotFoundAuthorization | 角色不存在，请前往授权。 |
| InternalError | 内部错误。 |
| LimitExceeded.RateLimitExceeded | 单位时间内接口请求频率达到限制。 |