Overview
Menu

ModifyApplicationProxyRule

1. API Description

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

This API is on an earlier version. If you want to call it, please switch to the latest version. For details, see [ModifyL4ProxyRules] (https://intl.cloud.tencent.com/document/product/1552/103410?from_cn_redirect=1).

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: ModifyApplicationProxyRule.
VersionYesStringCommon Params. The value used for this API: 2022-09-01.
RegionNoStringCommon Params. This parameter is not required.
ZoneIdYesStringThe site ID.
ProxyIdYesStringThe proxy ID.
RuleIdYesStringThe rule ID.
OriginTypeYesStringOrigin server type. Valid values:
  • custom: Manually added;
  • origins: Origin server group.
  • Port.NYesArray of StringThe access port, which can be:
  • A single port, such as 80
  • A port range, such as 81-90
  • ProtoNoStringThe protocol. Values:
  • TCP: TCP protocol
  • UDP: UDP protocol
  • The original configuration will apply if this field is not specified.
    OriginValue.NNoArray of StringOrigin server information:
  • When OriginType=custom, it indicates one or more origin servers, such as ["8.8.8.8","9.9.9.9"] or ["test.com"].
  • When OriginType=origins, it indicates an origin group ID, such as ["origin-537f5b41-162a-11ed-abaa-525400c5da15"].


  • The original configuration will apply if this field is not specified.
    ForwardClientIpNoStringPasses the client IP. Values:
  • TOA: Pass the client IP via TOA (available only when Proto=TCP).
  • PPV1: Pass the client IP via Proxy Protocol V1 (available only when Proto=TCP).
  • PPV2: Pass the client IP via Proxy Protocol V2.
  • OFF: Not pass the client IP.
  • If not specified, this field uses the default value OFF.
    SessionPersistNoBooleanWhether to enable session persistence. Values:
  • true: Enable
  • false: Disable
  • If it is left empty, the default value false is used.
    SessionPersistTimeNoIntegerDuration for the persistent session. The value takes effect only when SessionPersist = true.
    OriginPortNoStringThe origin port, which can be:
  • A single port, such as 80
  • A port range, such as 81-82
  • RuleTagNoStringRule tag. The original configuration will apply if it is not specified.

    3. Output Parameters

    Parameter NameTypeDescription
    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 Modifying an application proxy rule

    This example shows you how to modify an application proxy rule.

    Input Example

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: ModifyApplicationProxyRule
    <Common Request Parameters>
    
    {
        "ZoneId": "zone-276zs184g93m",
        "ProxyId": "proxy-19389e5dwwxfs",
        "RuleId": "rule-5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707",
        "Proto": "TCP",
        "Port": [
            "99-110"
        ],
        "OriginType": "custom",
        "OriginValue": [
            "1.1.1.1"
        ],
        "OriginPort": "99-110",
        "ForwardClientIp": "TOA",
        "SessionPersist": false,
        "RuleTag": "rule-service-1"
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707"
        }
    }
    

    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 CodeDescription
    FailedOperationOperation failed.
    InvalidParameter.InvalidOriginIpThe origin cannot be a private IP or loopback address.
    InvalidParameter.ParameterErrorParameter error: Invalid “End time”. The interval between the start and end time cannot exceed 7 days.
    OperationDeniedOperation denied.
    OperationDenied.L4ProxyInBannedStatusOperation failed: The L4 proxy is blocked.
    ResourceNotFoundThe resource doesn’t exist.