tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

ModifyL4Proxy

最后更新时间：2024-04-09 10:25:52

1. API Description

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

This API is used to modify the configuration of a Layer 4 proxy instance.

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: ModifyL4Proxy.
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.
ProxyId Yes String Application ID.
Ipv6 No String Specifies whether to enable IPv6 access. If this parameter is not filled, this configuration will not be modified. This configuration can only be enabled in certain acceleration zones and security protection configurations. For details, see [Creating an L4 Proxy Instance] (https://www.tencentcloud.com/document/product/1552/90025?from_cn_redirect=1). Valid values:
  • on: Enable;

  • off: Disable.

    		•
    AccelerateMainland No String Specifies whether to enable network optimization in the Chinese mainland. If this parameter is not filled, this configuration will not be modified. This configuration can only be enabled in certain acceleration zones and security protection configurations. For details, see [Creating an L4 Proxy Instance] (https://www.tencentcloud.com/document/product/1552/90025?from_cn_redirect=1). Valid values:
  • on: Enable;

  • off: Disable.
    		•

    3. Output Parameters

    Parameter Name Type Description
    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 Modifying IPv6 access configuration

    This example shows you how to enable IPv6 access for the Layer 4 proxy instance with ZoneId 'zone-24wjy25v1cwi' and ProxyId 'sid-2qwk27xf7j9g'.

    Input Example

    POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyL4Proxy
<Common Request Parameters>

{
    "ZoneId": "zone-24wjy25v1cwi",
    "ProxyId": "sid-2qwk27xf7j9g",
    "Ipv6": "on"
}

    Output Example

    {
    "Response": {
        "RequestId": "fbdb42f0-6a1e-4d397783c36csdf"
    }
}

    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
    OperationDenied Operation denied.
    OperationDenied.AccelerateMainlandDisable Cross-MLC-border acceleration is in beta. To join the beta, submit a ticket.
    OperationDenied.ErrZoneIsAlreadyPaused The EdgeOne service of the site is disabled. Please enable it and try again.
    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.L4ProxyInOfflineStatus The Layer 4 channel is closed and rule addition is disallowed.
    OperationDenied.L4ProxyInProcessStatus The instance is currently in deployment and cannot be operated.
    ResourceNotFound The resource doesn’t exist.
    UnauthorizedOperation.CamUnauthorized CAM is not authorized.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款