tencent cloud

Feedback

CreateApplicationProxyRule

Last updated: 2022-09-01 15:05:35

1. API Description

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

This API is used to create an application proxy rule.

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: CreateApplicationProxyRule.
Version Yes String Common Params. The value used for this API: 2022-01-06.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ZoneId Yes String Site ID
ProxyId Yes String Proxy ID
Proto Yes String Protocol. Valid values: TCP and UDP.
Port.N Yes Array of String Port. Valid values:
80: Port 80
81-90: Port range 81-90
OriginType Yes String Origin type. Valid values:
custom: Specified origins
origins: Origin group
OriginValue.N Yes Array of String Origin information:
When OriginType=custom, it can include one or more origins in either of the following formats:
IP:Port
Domain name:Port
When OriginType=origins, it is an origin group ID.
ForwardClientIp No String Passes the client IP. When Proto=TCP, valid values:
TOA: Pass the client IP via TOA
PPV1: Pass the client IP via Proxy Protocol V1
PPV2: Pass the client IP via Proxy Protocol V2
OFF: Do not pass the client IP.
When Proto=UDP, valid values:
PPV2: Pass the client IP via Proxy Protocol V2
OFF: Do not pass the client IP.
SessionPersist No Boolean Specifies whether to enable session persistence

3. Output Parameters

Parameter Name Type Description
RuleId String Rule ID
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating an application proxy rule

Input Example

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

{
    "ZoneId": "zone-id123",
    "ProxyId": "proxy-id123",
    "Proto": "TCP",
    "Port": [
        "80",
        "90",
        "99-110"
    ],
    "OriginType": "custom",
    "OriginValue": [
        "1.1.1.1:80"
    ],
    "ForwardClientIp": "TOA",
    "SessionPersist": false
}

Output Example

{
    "Response": {
        "RequestId": "xx",
        "RuleId": "rule-xxx"
    }
}

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.ParameterError Invalid parameter
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support