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 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. |
| Ipv6 | No | String | Whether to enable IPv6 access. If this parameter is not input, the default value off is used. This configuration can be enabled only in certain acceleration zones and security protection configurations. For details, see [Creating an L4 Proxy Instance] (https://intl.cloud.tencent.com/document/product/1552/90025?from_cn_redirect=1). Valid values: |
| StaticIp | No | String | Whether to enable static IP. If this parameter is not input, the default value off is used. This configuration can be enabled only in certain acceleration zones and security protection configurations. For details, see [Creating an L4 Proxy Instance] (https://intl.cloud.tencent.com/document/product/1552/90025?from_cn_redirect=1). Valid values: |
| AccelerateMainland | No | String | Whether to enable network optimization for the Chinese mainland. If this parameter is not input, the default value off is used. This configuration can be enabled only in certain acceleration zones and security protection configurations. For details, see [Creating an L4 Proxy Instance] (https://intl.cloud.tencent.com/document/product/1552/90025?from_cn_redirect=1). Valid values: |
| DDosProtectionConfig | No | DDosProtectionConfig | Configuration of L3/L4 DDoS protection. If this parameter is not input, the default platform protection option is used. For details, see [Exclusive DDoS Protection Usage] (https://intl.cloud.tencent.com/document/product/1552/95994?from_cn_redirect=1). |
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 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.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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. |
- 1. API Description
- 2. Input Parameters
- 3. Output Parameters
- 4. Example
- Example1 Creating a Layer 4 proxy instance with the acceleration zone of 'Availability Zone in the Chinese mainland'
- Example2 Creating a Layer 4 proxy instance with the acceleration zone of 'Global Availability Zone (excluding Chinese mainland)' and exclusive DDoS protection enabled
- 5. Developer Resources
- SDK
- Command Line Interface
- 6. Error Code