当前内容仅提供英语版本，中文版我们将尽快补充，感谢您的理解。

CreateMultiPathGatewayLine

1. API Description

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

This API is used to create lines integrated with the multi-channel security acceleration gateway, including EdgeOne Layer-4 proxy and custom lines.

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: CreateMultiPathGatewayLine.
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	Specifies the site ID.
GatewayId	Yes	String	Multi-Channel security gateway ID.
LineType	Yes	String	Line type. valid values: direct: direct connection line, cannot be modified or deleted. proxy: EdgeOne layer-4 proxy line, supports modifying instance ID and rule ID, but cannot be deleted. custom: custom line, supports modifying and deleting instance ID and rule ID.
LineAddress	Yes	String	Line address format: ip:port.
ProxyId	No	String	The layer-4 proxy instance ID is required when the LineType value is proxy (EdgeOne layer-4 proxy) and can be obtained via the api DescribeL4proxy.
RuleId	No	String	Forwarding rule ID, this field is required when the line type LineType value is proxy (EdgeOne layer-4 proxy). you can obtain it from the api DescribeL4ProxyRules.

3. Output Parameters

Parameter Name	Type	Description
LineId	String	Line ID. valid values: line-1: EdgeOne layer-4 proxy line, supports modifying instances and rules, but cannot be deleted. line-2 and above: EdgeOne layer-4 proxy or custom lines, supports modifying, deleting instances and rules.
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 an EdgeOne Layer-4 Proxy Line

Create a Layer-4 proxy route for EdgeOne on the multi-channel security acceleration gateway with Gateway ID mpgw-lbxuhk1oh in the designated site (ZoneId zone-27q0p0bal192).

Input Example

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

{
    "ZoneId": "zone-27q0p0bal192",
    "GatewayId": "mpgw-lbxuhk1oh",
    "LineType": "proxy",
    "LineAddress": "101.23.573.10:8989",
    "ProxyId": "sid-2gpv1z8cx8y2",
    "RuleId": "rule-33ik84rw3nuu"
}

Output Example

{
    "Response": {
        "LineId": "line-1",
        "RequestId": "34b734a7-71de-4ffc-a59d-eeac9d171da2"
    }
}

Example2 Creating a Custom Line

Create a custom line for the multi-channel security acceleration gateway with Gateway ID mpgw-lbxuhk1oh under the specified site (ZoneId zone-27q0p0bal192).

Input Example

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

{
    "ZoneId": "zone-27q0p0bal192",
    "GatewayId": "mpgw-lbxuhk1oh",
    "LineType": "custom",
    "LineAddress": "120.62.91.54:8080"
}

Output Example

{
    "Response": {
        "LineId": "line-2",
        "RequestId": "a622678d-ea5b-41e8-9cd2-d335816141a0"
    }
}

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

Tencent Cloud CLI 3.0

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.

1. API Description
2. Input Parameters
3. Output Parameters
4. Example
Example1 Creating an EdgeOne Layer-4 Proxy Line
Example2 Creating a Custom Line
5. Developer Resources
SDK
Command Line Interface
6. Error Code