文档中心>API 中心>SSL 证书>证书相关接口>创建证书关联云资源异步任务

创建证书关联云资源异步任务

最近更新时间:2024-07-01 01:22:35

我的收藏

1. 接口描述

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

创建证书绑定关联云资源异步任务, 该接口用于查询证书关联云资源。 若证书ID已存在查询云资源任务,则结果返回该任务ID。关联云资源类型,支持以下云资源:clb、cdn、waf、live、vod、ddos、tke、apigateway、tcb、teo(edgeOne)、cos。查询关联云资源结果使用DescribeCertificateBindResourceTaskResult接口

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateCertificateBindResourceSyncTask。
Version String 公共参数,本接口取值:2019-12-05。
Region String 公共参数,本接口不需要传递此参数。
CertificateIds.N Array of String 证书ID列表,总数不能超过100
IsCache Integer 是否使用缓存, 1使用缓存,0不使用缓存; 默认为1使用缓存; 若当前证书ID存在半小时已完成的任务, 则使用缓存的情况下, 会读取半小时内离当前时间最近的查询结果

3. 输出参数

参数名称 类型 描述
CertTaskIds Array of CertTaskId 证书关联云资源异步任务ID列表
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建证书关联云资源异步任务

输入示例

POST / HTTP/1.1
Host: ssl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCertificateBindResourceSyncTask
<公共请求参数>

{
    "CertificateIds": [
        "abc"
    ],
    "IsCache": 1
}

输出示例

{
    "Response": {
        "CertTaskIds": [
            {
                "CertId": "abc",
                "TaskId": "abc"
            }
        ],
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.CertificateHostResourceInnerInterrupt 当前为内部账号,账号涉及实例资源较多,无法使用部署功能,请联系SSL证书特殊处理。
FailedOperation.CertificateNotFound 证书不存在。