tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateCertificateBindResourceSyncTask

Last updated: 2023-12-01 16:21:33

    1. API Description

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

    This API is used to create an async task for querying the cloud resources associated with a certificate. If such a task already exists under the certificate ID, the ID of this task is returned as the result. The following types of cloud resources are supported: CLB, CDN, WAF, LIVE, VOD, DDOS, TKE, APIGATEWAY, TCB, and TEO (EDGEONE). You can query the result of this task using the DescribeCertificateBindResourceTaskResult API.

    A maximum of 20 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: CreateCertificateBindResourceSyncTask.
    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.
    CertificateIds.N Yes Array of String The list of certificate IDs, 100 IDs at most.
    IsCache Yes Integer Whether to use the cached results. Valid values: 1 (default) for yes and 0 for no. If any task completed within last 30 minutes exists under the current certificate ID, and the cache is used, the query result of the last task completed within 30 minutes will be read.

    3. Output Parameters

    Parameter Name Type Description
    CertTaskIds Array of CertTaskId The IDs of async tasks for querying cloud resources associated with a certificate.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Creating an async task for querying cloud resources associated with a certificate

    Input Example

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

{
    "CertificateIds": [
        "abc"
    ],
    "IsCache": 1
}

    Output Example

    {
    "Response": {
        "CertTaskIds": [
            {
                "CertId": "abc",
                "TaskId": "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.CertificateHostResourceInnerInterrupt Unable to use the deployment feature because the login account is an internal account with too many instance resources. Please contact us to handle it.
    FailedOperation.CertificateNotFound The certificate does not exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy