tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateL4ProxyRules

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

1. API Description

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

This API is used to create Layer 4 proxy instance rules, supporting both individual and batch creation.

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: CreateL4ProxyRules.
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.
L4ProxyRules.N Yes Array of L4ProxyRule List of forwarding rules. A single request supports up to 200 forwarding rules.
Note: When L4ProxyRule is used here, Protocol, PortRange, OriginType, OriginValue, and OriginPortRange are required fields; ClientIPPassThroughMode, SessionPersist, SessionPersistTime, and RuleTag are optional fields; do not fill in RuleId and Status.

3. Output Parameters

Parameter Name Type Description
L4ProxyRuleIds Array of String IDs of newly added forwarding rules, returned as an array.
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 Creating a Layer 4 proxy forwarding rule

This example shows you how to create a forwarding rule in the instance 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: CreateL4ProxyRules
<Common Request Parameters>

{
    "ZoneId": "zone-24wjy25v1cwi",
    "ProxyId": "sid-2qwk27xf7j9g",
    "L4ProxyRules": [
        {
            "Protocol": "TCP",
            "PortRange": [
                "80"
            ],
            "OriginType": "IP_DOMAIN",
            "OriginValue": [
                "119.23.100.45"
            ],
            "OriginPortRange": "90",
            "ClientIPPassThroughMode": "TOA",
            "SessionPersist": "on",
            "SessionPersistTime": 3600,
            "RuleTag": "test"
        }
    ]
}

Output Example

{
    "Response": {
        "RequestId": "6f8h5358-df6d-4d2a-ac39-1706cbf8a707",
        "L4ProxyRuleIds": [
            "rule-2qzkbvx3hxl1"
        ]
    }
}

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
InvalidParameter.InvalidOriginIp The origin cannot be a private IP or loopback address.
InvalidParameter.InvalidOriginValue The origin server is incorrect or inexistent.
InvalidParameter.RulePortDuplicating The rule port already exists.
LimitExceeded.ProxyRulesLimitExceeded The number of rules imported has exceeded the limit.
OperationDenied Operation denied.
OperationDenied.L4PortLackOfResources The sale of Layer 4 port resources is booming and they have been sold out. We are urgently restocking. At present, it is not possible to add new Layer 4 proxies or rules, and we kindly ask for your patience.
ResourceNotFound The resource doesn’t exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy