DescribeOriginACL

1. API Description

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

This API is used to query the binding relationship between L7 acceleration domains/L4 proxy instances and origin ACLs under a site, as well as IP range details. If you want to periodically obtain the latest version of origin IP ranges through an automation script, you can poll this API at a low-frequency (recommended every three days). If the NextOriginACL field has a return value, synchronize the latest origin IP ranges 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 Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: DescribeOriginACL.
Version	Yes	String	Common Params. The value used for this API: 2022-09-01.
Region	No	String	Common Params. This parameter is not required.
ZoneId	Yes	String	Specifies the site ID.

3. Output Parameters

Parameter Name	Type	Description
OriginACLInfo	OriginACLInfo	Describes the binding relationship between the l7 acceleration domain/l4 proxy instance and the origin server IP range.
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 Querying Origin Protection Detail

This example shows you how to query the binding relationship between the L7 acceleration domain/L4 proxy instance and the origin IP range, as well as the origin IP range details for the selected site with ZoneId 'zone-276zs184g93m'.

Input Example

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

{
    "ZoneId": "zone-276zs184g93m"
}

Output Example

{
    "Response": {
        "RequestId": "de0a2b4f-df6d-4d2a-ac39-1706cbf8a797",
        "OriginACLInfo": {
            "L7Hosts": [
                "www.example.com"
            ],
            "L4ProxyIds": [
                "proxy-19389e5dwwxfs"
            ],
            "CurrentOriginACL": {
                "EntireAddresses": {
                    "IPv4": [
                        "11.11.11.11/24"
                    ],
                    "IPv6": [
                        "2001:980:7002:6::/64"
                    ]
                },
                "Version": "mlc-1.0.1-20250421",
                "ActiveTime": "2014-11-30T10:00:00Z",
                "IsPlaned": "false"
            },
            "Status": "online",
            "NextOriginACL": {
                "Version": "mlc-1.0.1-20250422",
                "PlannedActiveTime": "2014-12-30T10:00:00Z",
                "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

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.
UnauthorizedOperation.CamUnauthorized	CAM is not authorized.
UnauthorizedOperation.NoPermission	The sub-account is not authorized for the operation. Please get permissions first.
UnauthorizedOperation.Unknown	An unknown error occurred in the backend server.