tencent cloud

DescribeMultiPathGatewayLine
Last updated: 2025-10-30 22:02:20
DescribeMultiPathGatewayLine
Last updated: 2025-10-30 22:02:20

1. API Description

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

Use this API to query the lines integrated with the multi-channel security acceleration gateway, including direct connection lines, 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: DescribeMultiPathGatewayLine.
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 Gateway ID.
LineId Yes String Line ID.

3. Output Parameters

Parameter Name Type Description
Line MultiPathGatewayLine Line information.
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 Direct-Access Routes for the Multi-Channel Security Acceleration Gateway

Query the detailed information of the gateway (GatewayId: mpgw-lbxuhk1oh) and line type (LineId: line-0) in the site (ZoneId: zone-27q0p0bal192).

Input Example

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

{
    "ZoneId": "zone-27q0p0bal192",
    "GatewayId": "mpgw-lbxuhk1oh",
    "LineId": "line-0"
}

Output Example

{
    "Response": {
        "Line": {
            "LineId": "line-0",
            "LineType": "direct",
            "LineAddress": "159.21.35.91:8080"
        },
        "RequestId": "9153aae4-26b1-4580-adc3-fa7cd4d32bf5"
    }
}

Example2 Querying Proxy Routes of Multi-Channel SCDN Gateway

Query detailed information of the gateway (GatewayId: mpgw-lbxuhk1oh) and line type (LineId: line-1) under the query site (ZoneId: zone-27q0p0bal192).

Input Example

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

{
    "ZoneId": "zone-27q0p0bal192",
    "GatewayId": "mpgw-lbxuhk1oh",
    "LineId": "line-1"
}

Output Example

{
    "Response": {
        "Line": {
            "LineType": "proxy",
            "LineAddress": "120.12.31.91:8080",
            "LineId": "line-1",
            "ProxyId": "sid-2gpv1z8cx8y2",
            "RuleId": "rule-33ik84rw3nuu"
        },
        "RequestId": "9153aae4-26b1-4580-adc3-fa7cd4d32bf5"
    }
}

Example3 Querying Custom Access Routes for Multi-Channel SCDN Gateways

Query the detailed information of the gateway (GatewayId: mpgw-lbxuhk1oh) and line type (LineId: line-2) under the site (ZoneId: zone-27q0p0bal192).

Input Example

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

{
    "ZoneId": "zone-27q0p0bal192",
    "GatewayId": "mpgw-lbxuhk1oh",
    "LineId": "line-2"
}

Output Example

{
    "Response": {
        "Line": {
            "LineId": "line-2",
            "LineType": "custom",
            "LineAddress": "120.12.31.91:8080"
        },
        "RequestId": "9153aae4-26b1-4580-adc3-fa7cd4d32bf5"
    }
}

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