tencent cloud

Tencent Cloud EdgeOne

DocumentationTencent Cloud EdgeOneAPI DocumentationLayer 4 Application Proxy APIsCreateL4Proxy

CreateL4Proxy

PDF
Focus Mode
Font Size
Last updated: 2026-04-13 14:45:56

1. API Description

Domain name for API request: teo.intl.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 Name Required Type Description
Action Yes String Common Params. The value used for this API: CreateL4Proxy.
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 Zone ID.
ProxyName Yes String Name of the L4 proxy instance, which can contain 1-50 characters, including 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. Modification is not allowed after creation.
Area Yes String Acceleration zone of the L4 proxy instance.
  • mainland: Chinese mainland availability zone;
  • overseas: global availability zone (excluding the Chinese mainland);
  • global: global availability zone.
    		•
    Ipv6 No String Whether IPv6 access is enabled. default off if left empty. this configuration can only be enabled in certain acceleration zones and security protection configurations. for details, refer to creating a new layer 4 proxy instance. valid values:.
  • on: Enable;
  • off: Disable.
    		•
    StaticIp No String Whether to enable static IP, default off if left empty. this configuration can only be enabled in certain acceleration zones and security protection configurations. for details, refer to creating a new layer 4 proxy instance (https://www.tencentcloud.comom/document/product/1552/90025?from_cn_redirect=1). valid values:.
  • on: Enable;
  • off: Disable.
    		•
    AccelerateMainland No String Whether network optimization in the chinese mainland is enabled. default off if left empty. this configuration can only be enabled in certain acceleration zones and security protection configurations. for details, refer to creating a new layer 4 proxy instance (https://www.tencentcloud.comom/document/product/1552/90025?from_cn_redirect=1). valid values:.
  • on: Enable;
  • off: Disable.
    		•

    3. Output Parameters

    Parameter Name Type Description
    ProxyId String L4 instance 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 Create an Overseas Ordinary Layer-4 Instance

    Create a layer-4 instance named proxy-name with global acceleration region (excluding Chinese mainland) under the selected site where ZoneId is zone-3kq782jghthh.

    Input Example

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

{
    "ZoneId": "zone-3kq782jghthh",
    "ProxyName": "proxy-name",
    "Area": "overseas"
}

    Output Example

    {
    "Response": {
        "ProxyId": "sid-3kq7it9slfmc",
        "RequestId": "37752cc1-7d73-47b4-801a-31a6a38c4dea"
    }
}

    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.ProxyNameDuplicating The instance name already exists.
    OperationDenied Operation denied.
    OperationDenied.AccelerateMainlandDisable Cross-MLC-border acceleration is in beta. To join the beta, submit a ticket.
    OperationDenied.AccelerateMainlandIpv6Conflict Cross-MLC-border acceleration and IPv6 cannot be configured at the same time.
    OperationDenied.ErrZoneIsAlreadyPaused The EdgeOne service of the site is disabled. Please enable it and try again.
    OperationDenied.Ipv6AdvancedConflict Exclusive DDoS protection conflicts with IPv6. They cannot be configured at the same time.
    OperationDenied.Ipv6StaticIpConflict The IPv6 feature and static IP cannot be enabled at the same time.
    OperationDenied.L4LackOfResources The 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.
    OperationDenied.MsgIpv6AdvancedConflict IPv6 cannot be enabled for non-overseas exclusive protection.
    OperationDenied.StaticIpAreaConflict The static IP cannot be enabled for this instance's region.
    UnauthorizedOperation.CamUnauthorized CAM is not authorized.
    Previous Topic: ModifyDDoSProtectionNext Topic: ModifyL4Proxy

    Help and Support

    Was this page helpful?

    Help us improve! Rate your documentation experience in 5 mins.

    Feedback