tencent cloud

DescribeMultiPathGateways
Last updated:2025-10-30 22:02:19
DescribeMultiPathGateways
Last updated: 2025-10-30 22:02:19

1. API Description

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

Query the multi-channel security acceleration gateway list created by the user through this interface. Supports pagination.

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: DescribeMultiPathGateways.
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.
ZoneId Yes String Zone ID.
Offset No Integer Pagination offset. Default value: 0.
Limit No Integer Pagination limit. Default value: 20, maximum value: 1000.
Filters.N No Array of Filter Filter fields for gateway list. If this parameter is left empty, return the current appid's all gateway information. detailed filter criteria:.
  • Gateway-Type: filter by gateway type. valid values: cloud and private, representing cloud gateway and private gateway respectively.

  • Keyword: filter by keyword in the gateway name.
    		•

    3. Output Parameters

    Parameter Name Type Description
    Gateways Array of MultiPathGateway Gateway detail.
    TotalCount Integer Total number of entries.
    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 Query the Multi-Channel Security Acceleration Gateway List

    Query the list of multi-channel security acceleration gateways with 10 row records per page and no filter conditions.

    Input Example

    POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMultiPathGateways
<Common request parameters>

{
    "ZoneId": "zone-27q0p0bal192",
    "Offset": 0,
    "Limit": 10
}

    Output Example

    {
    "Response": {
        "Gateways": [
            {
                "GatewayId": "mpgw-lbxuhk1oh",
                "GatewayName": "mpgw",
                "GatewayType": "private",
                "GatewayPort": 8080,
                "Status": "online",
                "GatewayIP": "101.43.204.125"
            }
        ],
        "RequestId": "a622678d-ea5b-41e8-9cd2-d335816141a0",
        "TotalCount": 1
    }
}

    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.
    Was this page helpful?
    You can also Contact Sales or Submit a Ticket for help.
    Yes
    No

    Feedback