tencent cloud

ModifyMultiPathGatewayStatus
最后更新时间:2025-11-07 14:38:31
ModifyMultiPathGatewayStatus
最后更新时间: 2025-11-07 14:38:31

1. API Description

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

This API is used to update the status of a multi-channel security gateway.

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: ModifyMultiPathGatewayStatus.
Version Yes String Common Params. The value used for this API: 2022-09-01.
Region No String Common Params. This parameter is not required for this API.
GatewayId Yes String Gateway ID.
ZoneId Yes String Zone ID.
GatewayStatus No String Modifies the enabled/disabled status of the gateway. valid values:
  • offline: disabled;
  • online: enabled.
  • .

    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 Update Multi-Channel Security Gateway Status

    This example shows you how to update the status of a multi-channel security gateway with ZoneId 'zone-27q0p0bal192' and GatewayId 'eo-gw-lb-uhk1oh'.

    Input Example

    POST / HTTP/1.1
    Host: teo.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: ModifyMultiPathGatewayStatus
    <Common request parameters>
    
    {
        "GatewayId": "eo-gw-lb-uhk1oh",
        "GatewayStatus": "offline",
        "ZoneId": "zone-27q0p0bal192"
    }

    Output Example

    {
        "Response": {
            "RequestId": "a03c3e4d-3a8c-4ef1-924c-81b33df6453a"
        }
    }

    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
    InternalError Internal error.
    InvalidParameter Parameter error.
    InvalidParameterValue Invalid parameter value.
    MissingParameter Missing parameters.
    OperationDenied Operation denied.
    本页内容是否解决了您的问题?
    您也可以 联系销售 提交工单 以寻求帮助。

    文档反馈