tencent cloud

CreateMultiPathGateway
Last updated: 2025-10-30 22:02:23
CreateMultiPathGateway
Last updated: 2025-10-30 22:02:23

1. API Description

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

Create a multi-channel security acceleration gateway via this API, including Cloud Gateway (gateway created and managed by Tencent Cloud) and private gateway (gateway deployed by users). Query the status using DescribeMultiPathGateway, and creation is successful if the status is online.

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: CreateMultiPathGateway.
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.
GatewayType Yes String Gateway type. valid values:
  • Cloud: cloud gateway, a gateway created and managed by Tencent cloud;

  • Private: private gateway, a user-deployed private gateway.
    		•
    GatewayName Yes String Gateway name: up to 16 characters, allowed characters (a-z, A-Z, 0-9, -, _).
    GatewayPort Yes Integer Gateway port: value range: 1-65535 (excluding 8888).
    RegionId No String Gateway region: GatewayType value is cloud (cloud gateway). required. RegionId list can be obtained from the DescribeMultiPathGatewayRegions API.
    GatewayIP No String Gateway address (required when GatewayType=private):
    Before using this address, ensure it has been registered in the Tencent Cloud Multi-Path Security Acceleration Gateway system.
    If not registered, submit a support ticket or contact your architect to pre-register the gateway IP address in the system before API invocation.

    3. Output Parameters

    Parameter Name Type Description
    GatewayId String Specifies the gateway ID.
    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 Creating a Multi-Channel Security Acceleration Gateway (Cloud Gateway)

    This example shows you how to create a Cloud Gateway in the specified zone (ZoneId: zone-27q0p0bal192) in the Beijing region (RegionId: ap-beijing) with the port (GatewayPort) set to 8080.

    Input Example

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

{
    "ZoneId": "zone-27q0p0bal192",
    "GatewayType": "cloud",
    "GatewayName": "EOMPGW-1",
    "RegionId": "ap-beijing",
    "GatewayPort": 8080
}

    Output Example

    {
    "Response": {
        "GatewayId": "mpgw-9d65563y6p",
        "RequestId": "04e15f26-7a59-4e29-b297-1b43ed4ec691"
    }
}

    Example2 Creating a Multi-Channel Security Acceleration Gateway (Private Gateway)

    Create a private gateway in the designated zone (ZoneId: zone-27q0p0bal192) with IP (GatewayIP) 49.7.248.202 and port (GatewayPort) 443.

    Input Example

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

{
    "GatewayType": "private",
    "GatewayName": "private-1",
    "ZoneId": "zone-27q0p0bal192",
    "GatewayPort": 443,
    "GatewayIP": "49.7.248.202"
}

    Output Example

    {
    "Response": {
        "GatewayId": "mpgw-ajf5qkoync",
        "RequestId": "e8fef204-be7b-4a39-aee3-85b617651734"
    }
}

    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