1. 接口描述
接口请求域名: ssl.tencentcloudapi.com 。
批量删除证书,删除证书前支持查询证书是否关联了腾讯云云资源 (需自定义配置参数,参数名称:IsSync)
默认接口请求频率限制:10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DeleteCertificates。 |
Version | 是 | String | 公共参数,本接口取值:2019-12-05。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
CertificateIds.N | 是 | Array of String | 要删除的证书ID。单次最多100个 |
IsSync | 否 | Boolean | 删除时是否检查证书关联了云资源。默认不检查。如需要检查关联云资源 (需授权服务角色SSL_QCSLinkedRoleInReplaceLoadCertificate),完成授权后,删除将变成异步任务,接口会返回异步任务ID。需搭配 DescribeDeleteCertificatesTaskResult接口使用,查询删除任务是否成功。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Success | Array of String | 成功的ID |
Fail | Array of BatchDeleteFail | 失败的ID和原因 |
CertTaskIds | Array of CertTaskId | 证书ID和异步任务的ID |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 批量删除
批量删除
输入示例
POST / HTTP/1.1
Host: ssl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteCertificates
<公共请求参数>
{
"CertificateIds": [
"abc"
]
}
输出示例
{
"Response": {
"CertTaskIds": [
{
"CertId": "1ODjBeH8",
"TaskId": "1"
},
{
"CertId": "25EMBPYQ",
"TaskId": "2"
},
{
"CertId": "txV0pewo",
"TaskId": "3"
},
{
"CertId": "rcGiGyTx",
"TaskId": "4"
},
{
"CertId": "4FVmnb1u",
"TaskId": "5"
}
],
"Success": [],
"Fail": [],
"RequestId": "687f27b0-c256-40ea-adf6-efb715001f2e"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure.UnauthorizedOperation | 操作未授权。 |
FailedOperation.CAMAuthorizedFail | CAM鉴权出现错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.WithDetailReason | 参数有误。 |