tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyL4ProxyRulesStatus

Last updated: 2024-10-11 15:52:15

1. API Description

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

This API is used to start or stop Layer 4 proxy forwarding rules, supporting both individual and batch operation.

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: ModifyL4ProxyRulesStatus.
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 Layer 4 proxy instance ID.
RuleIds.N Yes Array of String List of forwarding rule IDs. It supports up to 200 forwarding rules at a time.
Status Yes String Status of forwarding rules. Valid values:
  • online: Enabled;
  • offline: Disabled.
    		•

    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 Layer 4 proxy forwarding rule status in batches

    This example shows you how to disable all rules with RuleId 'rule-2qzkbvx3hxl7' and 'rule-3pszkbox0hm1' in ProxyId 'sid-2qwk27xf7j9g' under the zone with ZoneId 'zone-24wjy25v1cwi'.

    Input Example

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

{
    "ZoneId": "zone-24wjy25v1cwi",
    "ProxyId": "sid-2qwk27xf7j9g",
    "RuleIds": [
        "rule-2qzkbvx3hxl7",
        "rule-3pszkbox0hm1"
    ],
    "Status": "offline"
}

    Output Example

    {
    "Response": {
        "RequestId": "6f8h5358-3159-4337-adc7-7604e01e0fa9"
    }
}

    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.ErrZoneIsAlreadyPaused The EdgeOne service of the site is disabled. Please enable it and try again.
    OperationDenied.L4ProxyInBannedStatus Operation failed: The L4 proxy is blocked.
    ResourceNotFound The resource doesn’t exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy