tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeHostTeoInstanceList

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

    1. API Description

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

    This API is used to query the list of EDGEONE instances to which a certificate can be deployed.

    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: DescribeHostTeoInstanceList.
    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.
    CertificateId Yes String The ID of the certificate to be deployed.
    ResourceType Yes String The type of resource for certificate deployment.
    IsCache No Integer Whether to query the cached results. Valid values: 1 (yes) and 0 (no). By default, the cached results within 30 minutes are queried.
    Filters.N No Array of Filter The list of filter parameters. FilterKey: domainMatch (query the list of instances with matching or non-matching domains). FilterValue: 1 (default; query the list of instances with matching domains) or 0 (query the list of instances with non-matching domains).
    OldCertificateId No String The ID of the deployed certificate.
    Offset No Integer The pagination offset, starting from 0.
    Limit No Integer The number of instances on each page. Default value: 10.
    AsyncCache No Integer Whether the query is asynchronous.

    3. Output Parameters

    Parameter Name Type Description
    InstanceList Array of TeoInstanceDetail The list of EDGEONE instances.
    Note: This field may return null, indicating that no valid values can be obtained.
    TotalCount Integer The total count.
    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 u200cQuerying the list of EDGEONE instances

    This example shows you how to query the list of EDGEONE instances to which a certificate can be deployed.

    Input Example

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

{
    "CertificateId": "abc",
    "IsCache": 1,
    "Filters": [
        {
            "FilterKey": "abc",
            "FilterValue": "abc"
        }
    ],
    "ResourceType": "abc",
    "OldCertificateId": "abc"
}

    Output Example

    {
    "Response": {
        "InstanceList": [
            {
                "Host": "abc",
                "CertId": "abc",
                "ZoneId": "abc",
                "Status": "abc"
            }
        ],
        "TotalCount": 0,
        "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.AuthError You do not have permission to perform this operation.
    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.CertificateNotAvailable The certificate is not available. Please check and try again.
    FailedOperation.CertificateNotFound The certificate does not exist.
    FailedOperation.InvalidParam Incorrect parameters.
    FailedOperation.NoProjectPermission You do not have the permission to operate on this project.
    FailedOperation.NoRealNameAuth You have not completed the identity verification.
    FailedOperation.RoleNotFoundAuthorization The role does not exist. Please authorize the role first.
    InternalError Internal error.
    LimitExceeded.RateLimitExceeded The API rate limit is reached.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy