tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeCertificateBindResourceTaskResult

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

    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: DescribeCertificateBindResourceTaskResult.
    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.
    TaskIds.N Yes Array of String The task IDs, which are used to query the results of associated cloud resources, 100 IDs at most.

    3. Output Parameters

    Parameter Name Type Description
    SyncTaskBindResourceResult Array of SyncTaskBindResourceResult The results of the async tasks for querying associated cloud resources.
    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 Querying the total number of cloud resources associated with a certificate

    This example shows you how to query the total number 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: DescribeCertificateBindResourceTaskResult
<Common request parameters>

{
    "TaskIds": [
        "abc"
    ]
}

    Output Example

    {
    "Response": {
        "SyncTaskBindResourceResult": [
            {
                "TaskId": "abc",
                "BindResourceResult": [
                    {
                        "ResourceType": "abc",
                        "BindResourceRegionResult": [
                            {
                                "Region": "abc",
                                "TotalCount": 1
                            }
                        ]
                    }
                ],
                "Status": 1,
                "Error": {
                    "Code": "abc",
                    "Message": "abc"
                },
                "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
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy