tencent cloud

SSL 证书

文档SSL 证书API 文档Certificate APIsDescribeCertificateBindResourceTaskDetail

DescribeCertificateBindResourceTaskDetail

Download
聚焦模式
字号
最后更新时间: 2026-05-20 10:12:09

1. API Description

Domain name for API request: ssl.intl.tencentcloudapi.com.

Query the task result of CreateCertificateBindResourceSyncTask, return the asynchronous task result of binding cloud resources with the certificate, support the following cloud resources: clb, cdn, waf, live, vod, ddos, tke, apigateway, tcb, teo (edgeOne), cos, gaap, mqtt, scf, tdmq.

A maximum of 10 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeCertificateBindResourceTaskDetail.
Version Yes String Common Params. The value used for this API: 2019-12-05.
Region No String Common Params. This parameter is not required for this API.
TaskId Yes String

Task ID. Query the result of binding cloud resources based on the task ID obtained from CreateCertificateBindResourceSyncTask.

Limit No String

Number of items per page, default 10, maximum value 100; total pages is the total number of instances in the resource region, that is, page 1 will pull the number of instances under each Tencent Cloud resource region up to the Limit

Offset No String

Offset, defaults to 0

ResourceTypes.N No Array of String

Query result details of the resource type. Query all if not specified. Supported values: - clb- cdn- ddos- live- vod- waf- apigateway- teo- tke- cos- tse- tcb

Regions.N No Array of String

Query the data of region list. clb, tke, waf, API Gateway, tcb, cos, and tse support query region. Other resource types are unsupported.

3. Output Parameters

Parameter Name Type Description
CLB Array of ClbInstanceList

clb resource detail

CDN Array of CdnInstanceList

cdn resource detail

WAF Array of WafInstanceList

waf resource detail

DDOS Array of DdosInstanceList

Associate ddos resource detail

LIVE Array of LiveInstanceList

Associate live resource detail

VOD Array of VODInstanceList

vod resource detail

TKE Array of TkeInstanceList

tke resource detail

APIGATEWAY Array of ApiGatewayInstanceList

apigateway resource detail

TCB Array of TCBInstanceList

tcb resource detail

TEO Array of TeoInstanceList

Associate teo resource detail

Status Integer

Associate cloud resources async query result: 0 indicates querying, 1 indicates success. 2 indicates an exception. If the status is 1, view the BindResourceResult. If the status is 2, view the Error reason.

CacheTime String

Current result cache time

TSE Array of TSEInstanceList

Associate tse resource detail

COS Array of COSInstanceList

Associated COS resource detail

TDMQ Array of TDMQInstanceList

Associated TDMQ - Rabbit resource detail

MQTT Array of MQTTInstanceList

Associated MQTT resource detail

GAAP Array of GAAPInstanceList

Associated GAAP resource detail

SCF Array of SCFInstanceList

Associated SCF resource detail

RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Query certificate bound cloud resources

Input Example

POST / HTTP/1.1
Host: ssl.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCertificateBindResourceTaskDetail
<Common request parameters>

{
    "TaskId": "37710177"
}

Output Example

{
    "Response": {
        "APIGATEWAY": [
            {
                "Error": "",
                "InstanceList": [],
                "Region": "ap-guangzhou",
                "TotalCount": 0
            }
        ],
        "CDN": [
            {
                "Error": "",
                "InstanceList": [],
                "TotalCount": 0
            }
        ],
        "CLB": [
            {
                "Error": "",
                "InstanceList": [],
                "Region": "ap-guangzhou",
                "TotalCount": 0
            }
        ],
        "COS": [
            {
                "Error": "",
                "InstanceList": [],
                "Region": "ap-nanjing",
                "TotalCount": 0
            }
        ],
        "CacheTime": "2025-12-12 15:42:46",
        "DDOS": [
            {
                "Error": "",
                "InstanceList": [],
                "TotalCount": 0
            }
        ],
        "GAAP": [
            {
                "Error": "",
                "InstanceList": [
                    {
                        "InstanceId": "ga-9ri8fhos",
                        "InstanceName": "ssltest",
                        "ListenerList": [
                            {
                                "CertIdList": [
                                    "TVPV0B8A"
                                ],
                                "ListenerId": "lsr-g1f9fth1",
                                "ListenerName": "ssl",
                                "ListenerStatus": "ACTIVE",
                                "NoMatchDomains": [
                                    "xinge-test-2020112002.cn"
                                ],
                                "Protocol": "HTTPS"
                            }
                        ]
                    }
                ],
                "TotalCount": 1
            }
        ],
        "LIVE": [
            {
                "Error": "",
                "InstanceList": [],
                "TotalCount": 0
            }
        ],
        "MQTT": [
            {
                "Error": "",
                "InstanceList": [
                    {
                        "CaCertIdList": [
                            "QmRR1PkY"
                        ],
                        "InstanceId": "mqtt-9xgzvm2g",
                        "InstanceName": "ssl",
                        "InstanceStatus": "RUNNING",
                        "NoMatchDomains": [
                            "xinge-test-2020112002.cn"
                        ],
                        "ServerCertIdList": [
                            "N6MDRovP"
                        ]
                    }
                ],
                "Region": "ap-guangzhou",
                "TotalCount": 1
            }
        ],
        "SCF": [
            {
                "Error": "",
                "InstanceList": [
                    {
                        "CertificateId": "TVPV0B8A",
                        "Domain": "xinge-test-2020112002.cn",
                        "Protocol": "HTTP&HTTPS",
                        "Region": "ap-guangzhou"
                    }
                ],
                "Region": "ap-guangzhou",
                "TotalCount": 1
            }
        ],
        "Status": 1,
        "TCB": [
            {
                "Environments": [
                    {
                        "AccessService": {
                            "InstanceList": [],
                            "TotalCount": 0
                        },
                        "Environment": {
                            "ID": "dns-ssl-8gdfg2h1ff43c5ab",
                            "Name": "dns-ssl",
                            "Source": "qcloud",
                            "Status": "NORMAL"
                        },
                        "HostService": {
                            "InstanceList": [],
                            "TotalCount": 0
                        }
                    }
                ],
                "Error": "",
                "Region": "ap-guangzhou"
            }
        ],
        "TDMQ": [
            {
                "Error": "",
                "InstanceList": [
                    {
                        "CaCertId": "RDU0LL2y",
                        "CertId": "TVPV0B8A",
                        "InstanceId": "amqp-7dx2ozor",
                        "InstanceName": "ssl",
                        "InstanceStatus": "HEALTHY",
                        "NoMatchDomains": [
                            "xinge-test-2020112002.cn"
                        ]
                    }
                ],
                "Region": "ap-guangzhou",
                "TotalCount": 1
            }
        ],
        "TEO": [
            {
                "Error": "",
                "InstanceList": [],
                "TotalCount": 0
            }
        ],
        "TKE": [
            {
                "Error": "",
                "InstanceList": [],
                "Region": "ap-guangzhou-lwy-cft",
                "TotalCount": 0
            }
        ],
        "TSE": [
            {
                "Error": "",
                "InstanceList": [],
                "Region": "ap-guangzhou",
                "TotalCount": 0
            }
        ],
        "VOD": [
            {
                "Error": "",
                "InstanceList": [],
                "TotalCount": 0
            }
        ],
        "WAF": [
            {
                "Error": "",
                "InstanceList": [],
                "Region": "ap-guangzhou",
                "TotalCount": 0
            }
        ],
        "RequestId": "c1fc42bb-93b5-405b-81a8-75625bd56195"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation failed.
FailedOperation.CertificateSyncTaskIdInvalid The cert associated with the cloud resource query task id is invalid.
FailedOperation.RoleNotFoundAuthorization The role does not exist. Please authorize the role first.

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈