tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeL4Proxy

Last updated: 2024-10-11 15:52:18

1. API Description

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

This API is used to query a Layer 4 proxy instance list.

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: DescribeL4Proxy.
Version Yes String Common Params. The value used for this API: 2022-09-01.
Region No String Common Params. This parameter is not required.
ZoneId Yes String ID of the zone where the Layer 4 proxy instance belongs.
Offset No Integer Paginated query offset. Defaults to 0 when not specified.
Limit No Integer Paginated query limit. Default value: 20. Maximum value: 1000.
Filters.N No Array of Filter Filter criteria. The upper limit for Filters.Values is 20. If left empty, all Layer 4 proxy instance information under the current zone ID is returned. The detailed filter criteria are as follows:
  • proxy-id: Filters by Layer 4 proxy instance ID;
  • ddos-protection-type: Filters by security protection type;

    		•

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer The number of Layer 4 proxy instances.
    L4Proxies Array of L4Proxy List of Layer 4 proxy instances.
    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 list of Layer 4 proxy instances under a zone

    This example shows you how to query the list of Layer 4 proxy instances under the zone with ZoneId 'zone-24wjy25v1cwi'.

    Input Example

    POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeL4Proxy
<Common Request Parameters>

{
    "Offset": 1,
    "Limit": 10,
    "Filters": [],
    "ZoneId": "zone-24wjy25v1cwi"
}

    Output Example

    {
    "Response": {
        "TotalCount": 1,
        "L4Proxies": [
            {
                "ZoneId": "zone-24wjy25v1cwi",
                "ProxyId": "sid-2qwk27xf7j9g",
                "ProxyName": "test",
                "Area": "mainland",
                "Cname": "test.24wjy25v1cwi.eo.dnse5.com",
                "Ips": [],
                "Status": "online",
                "Ipv6": "off",
                "StaticIp": "off",
                "AccelerateMainland": "off",
                "UpdateTime": "2023-09-22T15:31:04+00:00"
            }
        ],
        "RequestId": "6f8h5258-cdda-4f82-b7sc-0aef4a219244"
    }
}

    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
    InternalError.ProxyServer An unknown error occurred in the backend server.
    UnauthorizedOperation.CamUnauthorized CAM is not authorized.
    UnauthorizedOperation.NoPermission The sub-account is not authorized for the operation. Please get permissions first.
    UnauthorizedOperation.Unknown An unknown error occurred in the backend server.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy