Docs Overview/
DescribeMultiPathGatewayOriginACL/

DescribeMultiPathGatewayOriginACL

1. API Description

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

This API is used to query the binding relationship between a multi-channel security acceleration gateway instance and the origin server IP range, as well as the IP range details. If the MultiPathGatewayNextOriginACL field has a return value, the latest origin server IP range must be synchronized to the origin server firewall configuration.

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 NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: DescribeMultiPathGatewayOriginACL.
VersionYesStringCommon Params. The value used for this API: 2022-09-01.
RegionNoStringCommon Params. This parameter is not required for this API.
ZoneIdYesStringZone ID.
GatewayIdYesStringGateway ID.

3. Output Parameters

Parameter NameTypeDescription
MultiPathGatewayOriginACLInfoMultiPathGatewayOriginACLInfoDescribes the binding relationship between the multi-channel gateway instance and the origin IP ranges.
RequestIdStringThe 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 Querying Multi-Channel SCDN Gateway Origin Server Protection Detail

This example shows you how to query the binding relationship between instances with ZoneId 'zone-27q0p0bal192' and GatewayId 'mpgw-lbxuhk1oh' and the IP address range, as well as the IP range details.

Input Example

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

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

Output Example

{
    "Response": {
        "RequestId": "de0a2b4f-df6d-4d2a-ac39-1706cbf8a797",
        "MultiPathGatewayOriginACLInfo": {
            "MultiPathGatewayCurrentOriginACL": {
                "EntireAddresses": {
                    "IPv4": [
                        "11.11.11.11/24"
                    ],
                    "IPv6": [
                        "2001:980:7002:6::/64"
                    ]
                },
                "Version": 3,
                "IsPlaned": "false"
            },
            "MultiPathGatewayNextOriginACL": {
                "Version": 4,
                "EntireAddresses": {
                    "IPv4": [
                        "11.11.11.11/24",
                        "22.22.22.22/24"
                    ],
                    "IPv6": [
                        "2001:980:7002:6::/64"
                    ]
                },
                "AddedAddresses": {
                    "IPv4": [
                        "22.22.22.22/24"
                    ],
                    "IPv6": []
                },
                "RemovedAddresses": {
                    "IPv4": [],
                    "IPv6": []
                },
                "NoChangeAddresses": {
                    "IPv4": [
                        "11.11.11.11/24"
                    ],
                    "IPv6": [
                        "2001:980:7002:6::/64"
                    ]
                }
            }
        }
    }
}

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 CodeDescription
InternalErrorInternal error.
InvalidParameterParameter error.
UnauthorizedOperation.CamUnauthorizedCAM is not authorized.
UnauthorizedOperation.NoPermissionThe sub-account is not authorized for the operation. Please get permissions first.
UnauthorizedOperation.UnknownAn unknown error occurred in the backend server.