tencent cloud

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.

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.

3. Output Parameters

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.

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for Node.js
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

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