1. 接口描述
接口请求域名: ssl.tencentcloudapi.com 。
查询CreateCertificateBindResourceSyncTask任务结果, 返回证书关联云资源异步任务结果, 支持以下云资源:clb、cdn、waf、live、vod、ddos、tke、apigateway、tcb、teo(edgeOne)、cos
默认接口请求频率限制:10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeCertificateBindResourceTaskDetail。 |
Version | 是 | String | 公共参数,本接口取值:2019-12-05。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
TaskId | 是 | String | 任务ID,根据任务ID查询绑定云资源结果 |
Limit | 否 | String | 每页展示数量, 默认10,最大值100; 分页总数为云资源地域下实例总数, 即第一页会拉群每个云资源的地域下面Limit数量实例 |
Offset | 否 | String | 当前偏移量 |
ResourceTypes.N | 否 | Array of String | 查询资源类型的结果详情, 不传则查询所有 |
Regions.N | 否 | Array of String | 查询地域列表的数据,CLB、TKE、WAF、APIGATEWAY、TCB支持地域查询, 其他资源类型不支持 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
CLB | Array of ClbInstanceList | 关联clb资源详情 注意:此字段可能返回 null,表示取不到有效值。 |
CDN | Array of CdnInstanceList | 关联cdn资源详情 注意:此字段可能返回 null,表示取不到有效值。 |
WAF | Array of WafInstanceList | 关联waf资源详情 注意:此字段可能返回 null,表示取不到有效值。 |
DDOS | Array of DdosInstanceList | 关联ddos资源详情 注意:此字段可能返回 null,表示取不到有效值。 |
LIVE | Array of LiveInstanceList | 关联live资源详情 注意:此字段可能返回 null,表示取不到有效值。 |
VOD | Array of VODInstanceList | 关联vod资源详情 注意:此字段可能返回 null,表示取不到有效值。 |
TKE | Array of TkeInstanceList | 关联tke资源详情 注意:此字段可能返回 null,表示取不到有效值。 |
APIGATEWAY | Array of ApiGatewayInstanceList | 关联apigateway资源详情 注意:此字段可能返回 null,表示取不到有效值。 |
TCB | Array of TCBInstanceList | 关联tcb资源详情 注意:此字段可能返回 null,表示取不到有效值。 |
TEO | Array of TeoInstanceList | 关联teo资源详情 注意:此字段可能返回 null,表示取不到有效值。 |
Status | Integer | 关联云资源异步查询结果: 0表示查询中, 1表示查询成功。 2表示查询异常; 若状态为1,则查看BindResourceResult结果;若状态为2,则查看Error原因 |
CacheTime | String | 当前结果缓存时间 |
TSE | Array of TSEInstanceList | 关联tse资源详情 注意:此字段可能返回 null,表示取不到有效值。 |
COS | Array of COSInstanceList | 关联的COS资源详情 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 证书关联云资源详情
输入示例
POST / HTTP/1.1
Host: ssl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCertificateBindResourceTaskDetail
<公共请求参数>
{
"TaskId": "abc",
"Limit": "abc",
"Offset": "abc"
}
输出示例
{
"Response": {
"CLB": [
{
"Region": "abc",
"InstanceList": [
{
"LoadBalancerId": "abc",
"LoadBalancerName": "abc",
"Listeners": [
{
"ListenerId": "abc",
"ListenerName": "abc",
"SniSwitch": 1,
"Protocol": "abc",
"Certificate": {
"CertId": "abc",
"DnsNames": [
"abc"
],
"CertCaId": "abc",
"SSLMode": "abc"
},
"Rules": [
{
"LocationId": "abc",
"Domain": "abc",
"IsMatch": true,
"Certificate": {
"CertId": "abc",
"DnsNames": [
"abc"
],
"CertCaId": "abc",
"SSLMode": "abc"
},
"NoMatchDomains": [
"abc"
]
}
],
"NoMatchDomains": [
"abc"
]
}
]
}
],
"TotalCount": 1,
"Error": ""
}
],
"CDN": [
{
"TotalCount": 1,
"InstanceList": [
{
"Domain": "abc",
"CertId": "abc",
"Status": "abc",
"HttpsBillingSwitch": "abc"
}
],
"Error": ""
}
],
"WAF": [
{
"Region": "abc",
"InstanceList": [
{
"Domain": "abc",
"CertId": "abc",
"Keepalive": 1
}
],
"TotalCount": 1,
"Error": ""
}
],
"DDOS": [
{
"TotalCount": 1,
"InstanceList": [
{
"Domain": "abc",
"InstanceId": "abc",
"Protocol": "abc",
"CertId": "abc",
"VirtualPort": "abc"
}
],
"Error": ""
}
],
"LIVE": [
{
"TotalCount": 1,
"InstanceList": [
{
"Domain": "abc",
"CertId": "abc",
"Status": 0
}
],
"Error": ""
}
],
"VOD": [
{
"InstanceList": [
{
"Domain": "abc",
"CertId": "abc"
}
],
"TotalCount": 1,
"Error": ""
}
],
"TKE": [
{
"Region": "abc",
"InstanceList": [
{
"ClusterId": "abc",
"ClusterName": "abc",
"NamespaceList": [
{
"Name": "abc",
"SecretList": [
{
"Name": "abc",
"CertId": "abc",
"IngressList": [
{
"IngressName": "abc",
"TlsDomains": [
"abc"
],
"Domains": [
"abc"
]
}
],
"NoMatchDomains": [
"abc"
]
}
]
}
],
"ClusterType": "abc",
"ClusterVersion": "abc"
}
],
"TotalCount": 1,
"Error": ""
}
],
"APIGATEWAY": [
{
"Region": "abc",
"InstanceList": [
{
"ServiceId": "abc",
"ServiceName": "abc",
"Domain": "abc",
"CertId": "abc",
"Protocol": "abc"
}
],
"TotalCount": 1,
"Error": ""
}
],
"TCB": [
{
"Region": "abc",
"Error": "",
"Environments": [
{
"Environment": {
"ID": "abc",
"Source": "abc",
"Name": "abc",
"Status": "abc"
},
"AccessService": {
"InstanceList": [
{
"Domain": "abc",
"Status": 0,
"UnionStatus": 0,
"IsPreempted": true,
"ICPStatus": 0,
"OldCertificateId": "abc"
}
],
"TotalCount": 0
},
"HostService": {
"InstanceList": [
{
"Domain": "abc",
"Status": "abc",
"DNSStatus": "abc",
"OldCertificateId": "abc"
}
],
"TotalCount": 0
}
}
]
}
],
"TEO": [
{
"InstanceList": [
{
"Host": "abc",
"CertId": "abc",
"ZoneId": "abc",
"Status": "abc"
}
],
"TotalCount": 1,
"Error": ""
}
],
"Status": 1,
"CacheTime": "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。
- 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.CertificateSyncTaskIdInvalid | 证书关联云资源查询任务ID无效 |
FailedOperation.RoleNotFoundAuthorization | 角色不存在,请前往授权。 |