ModifyMultiPathGatewayLine

1. API Description

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

This API is used to modify the access lines of the multi-channel security acceleration gateway, including EdgeOne Layer-4 proxy lines 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: ModifyMultiPathGatewayLine.
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.
GatewayId	Yes	String	Multi-Channel security acceleration gateway ID.
LineId	Yes	String	Line ID. valid values: Line-1: EdgeOne layer-4 proxy line. Supports modifying instances and rules, but does not support deletion. <li line-2 and above: EdgeOne layer-4 proxy lines or custom lines, supports modifying, deleting instances and rules.
LineType	No	String	Line type. valid values:. proxy: EdgeOne layer-4 proxy line, supports modifying instances and rules, but deletion is not supported. . custom: Custom line.Supports editing, deleting instances and rules.
LineAddress	No	String	Line address, formatted as host:port. Direct lines (LineType value is direct) cannot be modified, while other types support modifications.
ProxyId	No	String	Layer-4 proxy instance ID. when the line type value is proxy (EdgeOne layer-4 proxy), it allows modifications to the instance.
RuleId	No	String	Forwarding rule ID. when the line type value is proxy (EdgeOne layer-4 proxy), it allows input to modify.

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 Modify the Proxy Route of the Multi-Channel Security Acceleration Gateway

Modify the Edgeone Layer 4 proxy forwarding route for the multi-channel security acceleration gateway (ID: mpgw-lbxuhk1oh) under the site (ZoneId value is zone-27q0p0bal192). Change LineAddress to 101.23.573.10:8989, ProxyId to sid-2gpv1z8cx8y2, and RuleId to rule-33ik84rw3nuu.

Input Example

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

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

Output Example

{
    "Response": {
        "RequestId": "a622678d-ea5b-41e8-9cd2-d335816141a0"
    }
}

Example2 Modifying Custom Lines for the Multi-Channel Security Acceleration Gateway

Modify the custom lines of the multi-channel SCDN gateway with ID mpgw-lbxuhk1oh under the site (ZoneId value is zone-27q0p0bal192) by changing LineAddress to 120.91.82.74:8080.

Input Example

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

{
    "ZoneId": "zone-27q0p0bal192",
    "GatewayId": "mpgw-lbxuhk1oh",
    "LineId": "line-2",
    "LineType": "custom",
    "LineAddress": "120.91.82.74:8080"
}

Output Example

{
    "Response": {
        "RequestId": "548b1b65-fcec-4095-8c7a-ec8afa862635"
    }
}

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 Modify the Proxy Route of the Multi-Channel Security Acceleration Gateway
Example2 Modifying Custom Lines for the Multi-Channel Security Acceleration Gateway
5. Developer Resources
SDK
Command Line Interface
6. Error Code