tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeCertificateBindResourceTaskDetail

Last updated: 2024-12-02 16:46:28

    1. API Description

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

    This API is used to query the result of an async task created with CreateCertificateBindResourceSyncTask to query cloud resources associated with a certificate. The following types of cloud resources are supported: CLB, CDN, WAF, LIVE, VOD, DDOS, TKE, APIGATEWAY, TCB, and TEO (EDGEONE).

    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 The task ID, which is required to query the result of associated cloud resources.
    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 The current offset.
    ResourceTypes.N No Array of String The types of the resources to be queried. If no value is passed in, all types of resources will be queried.
    Regions.N No Array of String The regions of the resources to be queried. Only CLB, TKE, WAF, APIGATEWAY, and TCB resources support the query by region.

    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, the result of BindResourceResult will be displayed; if the status is 2, the error causes will be displayed.
    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.
    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 Querying the details of cloud resources associated with a certificate

    Input Example

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

{
    "TaskId": "abc",
    "Limit": "abc",
    "Offset": "abc"
}

    Output Example

    {
    "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
            }
        ],
        "CDN": [
            {
                "TotalCount": 1,
                "InstanceList": [
                    {
                        "Domain": "abc",
                        "CertId": "abc",
                        "Status": "abc",
                        "HttpsBillingSwitch": "abc"
                    }
                ]
            }
        ],
        "WAF": [
            {
                "Region": "abc",
                "InstanceList": [
                    {
                        "Domain": "abc",
                        "CertId": "abc",
                        "Keepalive": 1
                    }
                ],
                "TotalCount": 1
            }
        ],
        "DDOS": [
            {
                "TotalCount": 1,
                "InstanceList": [
                    {
                        "Domain": "abc",
                        "InstanceId": "abc",
                        "Protocol": "abc",
                        "CertId": "abc",
                        "VirtualPort": "abc"
                    }
                ]
            }
        ],
        "LIVE": [
            {
                "TotalCount": 1,
                "InstanceList": [
                    {
                        "Domain": "abc",
                        "CertId": "abc",
                        "Status": 0
                    }
                ]
            }
        ],
        "VOD": [
            {
                "InstanceList": [
                    {
                        "Domain": "abc",
                        "CertId": "abc"
                    }
                ],
                "TotalCount": 1
            }
        ],
        "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
            }
        ],
        "APIGATEWAY": [
            {
                "Region": "abc",
                "InstanceList": [
                    {
                        "ServiceId": "abc",
                        "ServiceName": "abc",
                        "Domain": "abc",
                        "CertId": "abc",
                        "Protocol": "abc"
                    }
                ],
                "TotalCount": 1
            }
        ],
        "TCB": [
            {
                "Region": "abc",
                "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
            }
        ],
        "Status": 1,
        "CacheTime": "abc",
        "RequestId": "abc"
    }
}

    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
    FailedOperation.RoleNotFoundAuthorization The role does not exist. Please authorize the role first.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy