tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyL4ProxyRules

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

1. API Description

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

This API is used to modify Layer 4 proxy forwarding rules, supporting both individual and batch modification.

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: ModifyL4ProxyRules.
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, RuleId is a required field; Protocol, PortRange, OriginType, OriginValue, OriginPortRange, ClientIPPassThroughMode, SessionPersist, SessionPersistTime, and RuleTag are all optional fields. No modification is made when no value is specified for those fields. Status should not be filled.

3. Output Parameters

Parameter Name Type Description
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 Modifying Layer 4 proxy forwarding rules

This example shows you how to modify the RuleTag of the rule with RuleId 'rule-2qzkbvx3hxl7' in ProxyId 'sid-2qwk27xf7j9g' of ZoneId 'zone-24wjy25v1cwi' as 'service-1', Protocol as 'TCP', and ClientIPPassThroughMode as 'TOA'.

Input Example

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

{
    "ZoneId": "zone-24wjy25v1cwi",
    "ProxyId": "sid-2qwk27xf7j9g",
    "L4ProxyRules": [
        {
            "RuleId": "rule-2qzkbvx3hxl7",
            "RuleTag": "service-1",
            "Protocol": "TCP",
            "ClientIPPassThroughMode": "TOA"
        }
    ]
}

Output Example

{
    "Response": {
        "RequestId": "3df3e931-3119-4237-adc7-7604e01e0fa9"
    }
}

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.ParameterError Parameter error: Invalid “End time”. The interval between the start and end time cannot exceed 7 days.
OperationDenied Operation denied.
OperationDenied.L4ProxyInBannedStatus Operation failed: The L4 proxy is blocked.
ResourceNotFound The resource doesn’t exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy