tencent cloud

All product documents
APIs
DocumentationAPIsSSL CertificatesCertificate APIsDescribeCertificateBindResourceTaskDetail
DescribeCertificateBindResourceTaskDetail
Last updated: 2025-02-27 16:22:03
DescribeCertificateBindResourceTaskDetail
Last updated: 2025-02-27 16:22:03

1. API Description

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

This API is used to query the task result of CreateCertificateBindResourceSyncTask, returning the asynchronous task result of the certificate associated with cloud resources, supporting the following cloud resources: clb, cdn, waf, live, vod, ddos, tke, apigateway, tcb, teo (edgeOne), cos.

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, which can be used to query the result of binding cloud resources according to the task id obtained from createcertificatebindresourcesynctask.
Limit No String The number of cloud resources displayed on each page. The default value is 10, and the maximum value is 100.
Offset No String Current offset, default is 0.
ResourceTypes.N No Array of String Result detail of queried resource type. if not provided, all will be queried. valid values include:.
- clb.
- cdn.
- ddos.
- live.
- vod.
- waf.
- apigateway.
- teo.
- tke.
- cos.
- tse.
- tcb.
Regions.N No Array of String Data of querying region list. clb, tke, waf, api gateway, tcb, cos, and tse support region query, while other resource types do not support.

3. Output Parameters

Parameter Name Type Description
CLB Array of ClbInstanceList The details of associated CLB resources.
Note: This field may return null, indicating that no valid values can be obtained.
CDN Array of CdnInstanceList The details of associated CDN resources.
Note: This field may return null, indicating that no valid values can be obtained.
WAF Array of WafInstanceList The details of associated WAF resources.
Note: This field may return null, indicating that no valid values can be obtained.
DDOS Array of DdosInstanceList The details of associated Anti-DDS resources.
Note: This field may return null, indicating that no valid values can be obtained.
LIVE Array of LiveInstanceList The details of associated LIVE resources.
Note: This field may return null, indicating that no valid values can be obtained.
VOD Array of VODInstanceList The details of associated VOD resources.
Note: This field may return null, indicating that no valid values can be obtained.
TKE Array of TkeInstanceList The details of associated TKE resources.
Note: This field may return null, indicating that no valid values can be obtained.
APIGATEWAY Array of ApiGatewayInstanceList The details of associated APIGATEWAY resources.
Note: This field may return null, indicating that no valid values can be obtained.
TCB Array of TCBInstanceList The details of associated TCB resources.
Note: This field may return null, indicating that no valid values can be obtained.
TEO Array of TeoInstanceList The details of associated TEO resources.
Note: This field may return null, indicating that no valid values can be obtained.
Status Integer The status of the async task. Valid values: 0 for querying, 1 for successful, and 2 for abnormal. If the status is 1, check the result of BindResourceResult ; if the status is 2, check the error .
CacheTime String The cache time of the current result.
TSE Array of TSEInstanceList Associated TSE resource details
Note: This field may return null, indicating that no valid value can be obtained.
COS Array of COSInstanceList Information of associated cos resource.
Note: this field may return null, indicating that no valid values can be obtained.
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 Certificate Associated With Cloud Resource Details

Input Example

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

{
    "TaskId": "758439",
    "Limit": "0",
    "Offset": "10"
}

Output Example

{
    "Response": {
        "CLB": [
            {
                "Region": "ap-guangzhou",
                "InstanceList": [
                    {
                        "LoadBalancerId": "lb-*****",
                        "LoadBalancerName": "lb-zrh",
                        "Listeners": [
                            {
                                "ListenerId": "lbl-*****",
                                "ListenerName": "lb-zrh",
                                "SniSwitch": 1,
                                "Protocol": "https",
                                "Certificate": {
                                    "CertId": "T***jdj",
                                    "DnsNames": [
                                        "www.test.com"
                                    ],
                                    "CertCaId": "T***jdj",
                                    "SSLMode": "mutual"
                                },
                                "Rules": [
                                    {
                                        "LocationId": "/test",
                                        "Domain": "www.test.com",
                                        "IsMatch": true,
                                        "Certificate": {
                                            "CertId": "hr***jdj",
                                            "DnsNames": [
                                                "www.test.com"
                                            ],
                                            "CertCaId": "hr***jdj",
                                            "SSLMode": "mutual"
                                        },
                                        "NoMatchDomains": [
                                            "www.test2.com"
                                        ]
                                    }
                                ],
                                "NoMatchDomains": [
                                    "www.test2.com"
                                ]
                            }
                        ]
                    }
                ],
                "TotalCount": 1,
                "Error": ""
            }
        ],
        "CDN": [
            {
                "TotalCount": 1,
                "InstanceList": [
                    {
                        "Domain": "www.test.com",
                        "CertId": "T***jdj",
                        "Status": "online",
                        "HttpsBillingSwitch": "on"
                    }
                ],
                "Error": ""
            }
        ],
        "WAF": [
            {
                "Region": "ap-guangzhou",
                "InstanceList": [
                    {
                        "Domain": "www.test.com",
                        "CertId": "T***jdj",
                        "Keepalive": 1
                    }
                ],
                "TotalCount": 1,
                "Error": ""
            }
        ],
        "DDOS": [
            {
                "TotalCount": 1,
                "InstanceList": [
                    {
                        "Domain": "www.test.com",
                        "InstanceId": "ddos-*****",
                        "Protocol": "https",
                        "CertId": "T***jdj",
                        "VirtualPort": "443"
                    }
                ],
                "Error": ""
            }
        ],
        "LIVE": [
            {
                "TotalCount": 1,
                "InstanceList": [
                    {
                        "Domain": "www.test.com",
                        "CertId": "T***jdj",
                        "Status": 0
                    }
                ],
                "Error": ""
            }
        ],
        "VOD": [
            {
                "InstanceList": [
                    {
                        "Domain": "www.test.com",
                        "CertId": "T***jdj"
                    }
                ],
                "TotalCount": 1,
                "Error": ""
            }
        ],
        "TKE": [
            {
                "Region": "ap-guangzhou",
                "InstanceList": [
                    {
                        "ClusterId": "cls-***",
                        "ClusterName": "zrh",
                        "NamespaceList": [
                            {
                                "Name": "zrh",
                                "SecretList": [
                                    {
                                        "Name": "secret-***",
                                        "CertId": "T***jdj",
                                        "IngressList": [
                                            {
                                                "IngressName": "ins-****",
                                                "TlsDomains": [
                                                    "www.test.com"
                                                ],
                                                "Domains": [
                                                    "www.test.com"
                                                ]
                                            }
                                        ],
                                        "NoMatchDomains": [
                                            "www.test2.com"
                                        ]
                                    }
                                ]
                            }
                        ],
                        "ClusterType": "tke",
                        "ClusterVersion": "1.16"
                    }
                ],
                "TotalCount": 1,
                "Error": ""
            }
        ],
        "APIGATEWAY": [
            {
                "Region": "ap-guangzhou",
                "InstanceList": [
                    {
                        "ServiceId": "service-*****",
                        "ServiceName": "svc-zrh",
                        "Domain": "www.test.com",
                        "CertId": "T***jdj",
                        "Protocol": "https"
                    }
                ],
                "TotalCount": 1,
                "Error": ""
            }
        ],
        "TCB": [
            {
                "Region": "ap-guangzhou",
                "Error": "",
                "Environments": [
                    {
                        "Environment": {
                            "ID": "TCB-*****",
                            "Source": "cdn",
                            "Name": "test-*****",
                            "Status": "online"
                        },
                        "AccessService": {
                            "InstanceList": [
                                {
                                    "Domain": "www.test.com",
                                    "Status": 0,
                                    "UnionStatus": 0,
                                    "IsPreempted": true,
                                    "ICPStatus": 0,
                                    "OldCertificateId": "jd***jdj"
                                }
                            ],
                            "TotalCount": 0
                        },
                        "HostService": {
                            "InstanceList": [
                                {
                                    "Domain": "www.test.com",
                                    "Status": "online",
                                    "DNSStatus": "online",
                                    "OldCertificateId": "jd***jdj"
                                }
                            ],
                            "TotalCount": 0
                        }
                    }
                ]
            }
        ],
        "TEO": [
            {
                "InstanceList": [
                    {
                        "Host": "www.test.com",
                        "CertId": "T***jdj",
                        "ZoneId": "zone-*****",
                        "Status": "online"
                    }
                ],
                "TotalCount": 1,
                "Error": ""
            }
        ],
        "Status": 1,
        "CacheTime": "2023-10-12 12:00:00",
        "RequestId": "14727a68-3b90-4408-99c9-dea6d7de9456"
    }
}

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.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon