tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateApplicationProxy

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

    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 [CreateL4Proxy] (https://www.tencentcloud.com/document/product/1552/103417?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 Name Required Type Description
    Action Yes String Common Params. The value used for this API: CreateApplicationProxy.
    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 Site ID.
    ProxyName Yes String Domain name or subdomain name when ProxyType=hostname;
    Instance name when ProxyType=instance.
    PlatType Yes String The scheduling mode. Values:
  • ip: Schedule via Anycast IP.
  • domain: Schedule via CNAME.
    		•
    SecurityType Yes Integer Whether to enable security protection. Values:
  • 0: Disable security protection.
  • 1: Enable security protection.
    		•
    AccelerateType Yes Integer Whether to enable acceleration. Values:
  • 0: Disable acceleration.
  • 1: Enable acceleration.
    		•
    ProxyType No String Layer 4 proxy mode, with value:
  • instance: instance mode.
    • If not specified, the default value instance will be used.
    SessionPersistTime No Integer The session persistence duration. Value range: 30-3600 (in seconds).
    If not specified, this field uses the default value 600.
    Ipv6 No Ipv6 Ipv6 access configuration.
    IPv6 access is disabled if it is not specified.
    ApplicationProxyRules.N No Array of ApplicationProxyRule The rule details.
    If this field is not specified, an application proxy rule will not be created.
    AccelerateMainland No AccelerateMainland Cross-MLC-border acceleration. It is disabled if this parameter is not specified.

    3. Output Parameters

    Parameter Name Type Description
    ProxyId String The L4 application proxy ID.
    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 an application proxy

    This example shows you how to create an application proxy.

    Input Example

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

{
    "ZoneId": "zone-21xfqlh4qjee",
    "ProxyName": "instancd-name",
    "ProxyType": "instance",
    "PlatType": "ip",
    "SecurityType": 1,
    "AccelerateType": 1,
    "SessionPersistTime": 3600,
    "Ipv6": {
        "Switch": "on"
    },
    "ApplicationProxyRules": [
        {
            "Proto": "TCP",
            "Port": [
                "80",
                "90",
                "99-110"
            ],
            "OriginType": "custom",
            "OriginValue": [
                "1.1.1.1:80"
            ]
        },
        {
            "Proto": "UDP",
            "Port": [
                "999",
                "888",
                "99-110"
            ],
            "OriginType": "custom",
            "OriginValue": [
                "1.1.1.1:80",
                "2.2.2.2:80"
            ]
        }
    ]
}

    Output Example

    {
    "Response": {
        "RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707",
        "ProxyId": "proxy-537f5b41-162a-11ed-abaa-525400c5da15"
    }
}

    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.
    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.
    InvalidParameter.ProxyNameDuplicating The instance name already exists.
    InvalidParameter.ProxyNameNotMatched Instance name can contain 1 to 50 characters. The allowed characters are a to z, 0 to 9, and -. - cannot be registered alone or used continuously and cannot be placed at the beginning or the end.
    LimitExceeded The quota limit has been reached.
    LimitExceeded.UserQuotaLimited User instance quantity limitation.
    OperationDenied Operation denied.
    OperationDenied.ErrZoneIsAlreadyPaused The EdgeOne service of the site is disabled. Please enable it and try again.
    OperationDenied.PlatTypeIPAccelerateMainlandNotSupport This site is using Anycast IP scheduling mode and does not support Cross-MLC-border acceleration.
    OperationDenied.ZoneNotActive The zone is disabled.
    ResourceInsufficient Insufficient resource.
    ResourceNotFound The resource doesn’t exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy