tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeL4ProxyRules

Last updated: 2024-12-03 16:17:34

1. API Description

Domain name for API request: teo.intl.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 Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeL4ProxyRules.
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 Zone ID.
ProxyId Yes String Layer 4 proxy instance ID.
Offset Yes Integer Paginated query offset. Defaults to 0 when not specified.
Limit Yes Integer Paginated query limit. Default value: 20. Maximum value: 1000.
Filters.N No Array of Filter Filter criteria. The upper limit of Filters.Values is 20. If it is not filled in, all rule information under the current layer-4 instance will be returned. The detailed filter criteria are as follows:
  • rule-id: filter as per the rules under the layer-4 proxy instance by Rule ID. Rule ID is in the form: rule-31vv7qig0vjy;
  • rule-tag: filter as per the rules under the layer-4 proxy instance by Rule Tag.
    		•

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer The total count of forwarding rules.
    L4ProxyRules Array of L4ProxyRule List of forwarding rules.
    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 Forwarding Rules for Layer-4 Proxy Instances

    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.intl.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": [
                    "test.origin.com"
                ],
                "OriginPortRange": "90",
                "ClientIPPassThroughMode": "TOA",
                "SessionPersist": "on",
                "SessionPersistTime": 3600,
                "RuleTag": "test",
                "Status": "online"
            }
        ],
        "RequestId": "6f8h5358-cdda-4f82-b7sc-0aef4a219244"
    }
}

    Example2 Querying the List of Forwarding Rules for Layer-4 Proxy Instances under the Specified Forwarding Rule ID

    This example shows you how to query the list of forwarding rules with ProxyId 'sid-33ik2zqsvcqq' and specified forwarding rule ID 'rule-33ik84rw3nuu' under the zone with ZoneId 'zone-2zzj3cyeonyy'.

    Input Example

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

{
    "ZoneId": "zone-2zzj3cyeonyy",
    "ProxyId": "sid-33ik2zqsvcqq",
    "Offset": 0,
    "Limit": 10,
    "Filters": [
        {
            "Name": "rule-id",
            "Values": [
                "rule-33ik84rw3nuu"
            ]
        }
    ]
}

    Output Example

    {
    "Response": {
        "L4ProxyRules": [
            {
                "ClientIPPassThroughMode": "TOA",
                "OriginPortRange": "20",
                "OriginType": "IP_DOMAIN",
                "OriginValue": [
                    "test.origin.com"
                ],
                "PortRange": [
                    "10"
                ],
                "Protocol": "TCP",
                "RemoteAuth": {
                    "Address": "",
                    "ServerFaultyBehavior": "allow",
                    "Switch": "off"
                },
                "RuleId": "rule-33ik84rw3nuu",
                "RuleTag": "tag",
                "SessionPersist": "on",
                "SessionPersistTime": 2000,
                "Status": "online"
            }
        ],
        "RequestId": "7bea447f-ec2f-41d2-bd49-5dc566359777",
        "TotalCount": 1
    }
}

    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.

    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy