tencent cloud

Feedback

ModifyApplicationProxy

Last updated: 2024-12-03 16:17:34

    1. API Description

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

    This API is on an earlier version. If you want to call it, please switch to the latest version. For details, see [ModifyL4Proxy
    ] (https://www.tencentcloud.com/document/product/1552/103411?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: ModifyApplicationProxy.
    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.
    ProxyId Yes String Proxy ID.
    ProxyName Yes String Domain name or subdomain name when ProxyType=hostname;
    Instance name when ProxyType=instance.
    SessionPersistTime No Integer The session persistence duration. Value range: 30-3600 (in seconds).
    The original configuration will apply if this field is not specified.
    ProxyType No String L4 proxy mode. Valid values:
  • instance: Instance mode.
  • If it is not specified, instance is used by default.
    Ipv6 No Ipv6 IPv6 access configuration. The original configuration will apply if it is not specified.
    AccelerateMainland No AccelerateMainland Cross-MLC-border acceleration. The original configuration will apply if it is not specified.

    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 Modify Application Proxy

    Modify the application proxy.

    Input Example

    POST / HTTP/1.1
    Host: teo.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: ModifyApplicationProxy
    <Common request parameters>
    
    {
        "ZoneId": "zone-21xfqlh4qjee",
        "ProxyId": "proxy-537f5b41-162a-11ed-abaa-525400c5da15",
        "ProxyName": "ssss",
        "ProxyType": "instance",
        "SessionPersistTime": 3600,
        "Ipv6": {
            "Switch": "on"
        }
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "b03fe5dd-be04-444c-a2e1-49f1bf2f399a"
        }
    }
    

    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
    InvalidParameter.InvalidOriginIp The origin cannot be a private IP or loopback address.
    OperationDenied Operation denied.
    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.L4ProxyInBannedStatus Operation failed: The L4 proxy is blocked.
    ResourceNotFound The resource doesn’t exist.