Overview
Menu

CreateL4Proxy

1. API Description

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

This API is used to create Layer 4 proxy instances.

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: CreateL4Proxy.
VersionYesStringCommon Params. The value used for this API: 2022-09-01.
RegionNoStringCommon Params. This parameter is not required.
ZoneIdYesStringZone ID.
ProxyNameYesStringLayer 4 proxy instance name. You can enter 1-50 characters. Valid characters are a-z, 0-9, and hyphens (-). However, hyphens (-) cannot be used individually or consecutively and should not be placed at the beginning or end of the name. Modifications are not allowed after creation.
AreaYesStringAcceleration zone of the Layer 4 proxy instance.
  • mainland: Availability zone in the Chinese mainland;
  • overseas: Global availability zone (excluding the Chinese mainland);
  • global: Global availability zone.
  • Ipv6NoStringSpecifies whether to enable IPv6 access. The default value off is used if left empty. This configuration can only be enabled in certain acceleration zones and security protection configurations. For details, see Creating an L4 Proxy Instance. Valid values:
  • on: Enable;
  • off: Disable.

  • StaticIpNoStringSpecifies whether to enable the fixed IP address. The default value off is used if left empty. This configuration can only be enabled in certain acceleration zones and security protection configurations. For details, see Creating an L4 Proxy Instance. Valid values:
  • on: Enable;
  • off: Disable.

  • AccelerateMainlandNoStringSpecifies whether to enable network optimization in the Chinese mainland. The default value off is used if left empty. This configuration can only be enabled in certain acceleration zones and security protection configurations. For details, see Creating an L4 Proxy Instance. Valid values:
  • on: Enable;
  • off: Disable.

  • DDosProtectionConfigNoDDosProtectionConfigLayer 3/Layer 4 DDoS protection. The default protection option of the platform will be used if it is left empty. For details, see Exclusive DDoS Protection Usage.

    3. Output Parameters

    Parameter NameTypeDescription
    ProxyIdStringLayer 4 instance ID.
    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 Creating a Layer 4 proxy instance with the acceleration zone of 'Availability Zone in the Chinese mainland'

    This example shows you how to create a Layer 4 instance named 'test', with the acceleration zone of 'Availability zone in the Chinese mainland', under the zone with ZoneId 'zone-2jc2xy3hr7f7'.

    Input Example

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreateL4Proxy
    <Common Request Parameters>
    
    {
        "ProxyName": "test",
        "ZoneId": "zone-2jc2xy3hr7f7",
        "Area": "mainland"
    }
    

    Output Example

    {
        "Response": {
            "ProxyId": "sid-2jc2hl2hr8f7",
            "RequestId": "0se57a54-cc42-11ed-8efb-525401a961b1"
        }
    }
    

    Example2 Creating a Layer 4 proxy instance with the acceleration zone of 'Global Availability Zone (excluding Chinese mainland)' and exclusive DDoS protection enabled

    This example shows you how to create a Layer 4 instance named 'test', with the acceleration zone of 'Global availability zone (excluding the Chinese mainland)', and exclusive DDoS protection enabled under the zone with ZoneId 'zone-2jc2xy3hr7f7', to provide full protection within the acceleration zone.

    Input Example

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreateL4Proxy
    <Common Request Parameters>
    
    {
        "ZoneId": "zone-2jc2xy3hr7f7",
        "ProxyName": "test",
        "Area": "overseas",
        "DDosProtectionConfig": {
            "LevelOverseas": "ANYCAST_ALLIN"
        }
    }
    

    Output Example

    {
        "Response": {
            "ProxyId": "sid-2jc2hl2hr8f7",
            "RequestId": "0se57a54-cc42-11ed-8efb-525401a961b1"
        }
    }
    

    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.ProxyNameDuplicatingThe instance name already exists.
    OperationDeniedOperation denied.
    OperationDenied.AccelerateMainlandDisableCross-MLC-border acceleration is in beta. To join the beta, submit a ticket.
    OperationDenied.ErrZoneIsAlreadyPausedThe EdgeOne service of the site is disabled. Please enable it and try again.
    OperationDenied.L4LackOfResourcesThe layer-4 instance resource sales are skyrocketing and now the resources are sold out. Replenishing is in progress. Currently, new layer-4 proxies cannot be added. Please wait.
    UnauthorizedOperation.CamUnauthorizedCAM is not authorized.