Overview
Menu

DescribeL4ProxyRules

1. API Description

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

This API is used to query the forwarding rule list under a Layer 4 proxy instance.

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 NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: DescribeL4ProxyRules.
VersionYesStringCommon Params. The value used for this API: 2022-09-01.
RegionNoStringCommon Params. This parameter is not required.
ZoneIdYesStringZone ID.
ProxyIdYesStringLayer 4 proxy instance ID.
OffsetYesIntegerPaginated query offset. Defaults to 0 when not specified.
LimitYesIntegerPaginated query limit. Default value: 20. Maximum value: 1000.
Filters.NNoArray of FilterFilter criteria. The upper limit for Filters.Values is 20. All rule information under the current Layer 4 instance will be returned if left empty. The detailed filter criteria are as follows:
  • rule-tag: Filters rules under the Layer 4 proxy instance according to rule tag.
  • 3. Output Parameters

    Parameter NameTypeDescription
    TotalCountIntegerThe total count of forwarding rules.
    L4ProxyRulesArray of L4ProxyRuleList of forwarding rules.
    RequestIdStringThe 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 a Layer 4 proxy instance forwarding rule list

    This example shows you how to query the list of forwarding rules with ProxyId 'sid-2qwk27xf7j9g' under the zone with ZoneId 'zone-24wjy25v1cwi'.

    Input Example

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeL4ProxyRules
    <Common Request Parameters>
    
    {
        "ZoneId": "zone-24wjy25v1cwi",
        "ProxyId": "sid-2qwk27xf7j9g",
        "Offset": 1,
        "Limit": 0
    }
    

    Output Example

    {
        "Response": {
            "TotalCount": 1,
            "L4ProxyRules": [
                {
                    "RuleId": "rule-2qzkbvx3hxl1",
                    "Protocol": "TCP",
                    "PortRange": [
                        "80"
                    ],
                    "OriginType": "IP_DOMAIN",
                    "OriginValue": [
                        "119.23.100.45"
                    ],
                    "OriginPortRange": "90",
                    "ClientIPPassThroughMode": "TOA",
                    "SessionPersist": "on",
                    "SessionPersistTime": 3600,
                    "RuleTag": "test",
                    "Status": "online"
                }
            ],
            "RequestId": "6f8h5358-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

    There is no error code related to the API business logic. For other error codes, please see Common Error Codes.