tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Cloud EdgeOne
    Documentation
    Download PDF

    CreateApplicationProxyRule

    Last updated: 2023-12-01 15:19:05
    Download PDF

      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-09-01.
      Region No String Common Params. This parameter is not required.
      ZoneId Yes String The site ID.
      ProxyId Yes String The proxy ID.
      Proto Yes String The protocol. Values:
    • TCP: TCP protocol
    • UDP: UDP protocol
      		•
      Port.N Yes Array of String The access port, which can be:
    • A single port, such as 80
    • A port range, such as 81-90
      		•
      OriginType Yes String The origin type. Values:
    • custom: Specified origins
    • origins: Origin group
      		•
      OriginValue.N Yes Array of String Origin 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"].
      		•
      ForwardClientIp No String Passes 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.
      • Default value: OFF.
      SessionPersist No Boolean Whether to enable session persistence. Values:
    • true: Enable.
    • false: Disable.
      • Default value: false.
      SessionPersistTime No Integer Duration for the persistent session. The value takes effect only when SessionPersist = true.
      OriginPort No String The origin port, which can be:
    • A single port, such as 80
    • A port range, such as 81-82
      		•
      RuleTag No String Rule tag. This parameter is left empty by default.

      3. Output Parameters

      Parameter Name Type Description
      RuleId String The 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

      This example shows you how to create 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-21xfqlh4qjee",
    "ProxyId": "proxy-19389e5dwwxfs",
    "Proto": "TCP",
    "Port": [
        "99-110"
    ],
    "OriginType": "custom",
    "OriginValue": [
        "1.1.1.1"
    ],
    "OriginPort": "99-110",
    "ForwardClientIp": "TOA",
    "SessionPersist": false
}

      Output Example

      {
    "Response": {
        "RequestId": "3df3e931-3159-4337-adc7-7604e01e0fa9",
        "RuleId": "rule-a8f0d49a-33d7-11ed-9b89-52540005c111"
    }
}

      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
      FailedOperation Operation failed.
      InternalError.ProxyServer An unknown error occurred in the backend server.
      InvalidParameter.InvalidOriginIp The origin cannot be a private IP or loopback address.
      InvalidParameter.InvalidRuleProto Incorrect protocol of the rules. (TCP/UDP).
      InvalidParameter.ParameterError Parameter error: Invalid “End time”. The interval between the start and end time cannot exceed 7 days.
      InvalidParameter.RuleOriginFormatError Incorrect origin server information format of the rules.
      InvalidParameter.RuleOriginMultiDomain The origin of the rule does not support multiple domain names.
      InvalidParameter.RuleOriginPortInteger The origin port of the rule must be an integer.
      InvalidParameter.RuleOriginValueError Invalid origin in the rule.
      InvalidParameter.RulePortDuplicating The rule port already exists.
      InvalidParameter.RulePortGroup Incorrect port number segment of the rules.
      InvalidParameter.RulePortInteger The port number of the rules must be an integer.
      OperationDenied Operation denied.
      ResourceNotFound The resource doesn’t exist.
      UnauthorizedOperation.CamUnauthorized CAM is not authorized.
      Contact Us

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

      Contact Us
      Technical Support

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

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2023 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy