Docs Overview/
DescribeAvailableOriginACLFamily/

DescribeAvailableOriginACLFamily

1. API Description

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

This API is used to query detailed information about the origin protection IP range control domain, including the version number and specific IP range information.
The main difference between standard control domain and streamlined control domain is the number of IP ranges provided. The latter has fewer IP ranges, but has some usage restrictions. For specific restrictions, consult the product. The format description is as follows:
Standard control domain:

  • gaz: standard global control domain;
  • mlc: Standard China control domain;
  • emc: standard overseas (worldwide excluding China) control domain;
    • Streamline the control domain.
  • plat-gaz: simplified global control domain;
  • plat-mlc: Simplified China control domain;
  • plat-emc: Simplified overseas (global excluding China) control domain;
  • plat-specific-gaz: custom edition global availability zone control domain;
  • plat-specific-mlc: custom edition for controlling the Chinese mainland availability zone control domain;
  • plat-specific-emc: custom edition control domain for availability zones worldwide (excluding Chinese mainland);
    • Abbreviation description:
  • gaz:Global AZ Availability Zone;
  • mlc:mainlandChina;
  • emc:Exclude mainlandChina.

    • 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: DescribeAvailableOriginACLFamily.
    VersionYesStringCommon Params. The value used for this API: 2022-09-01.
    RegionNoStringCommon Params. This parameter is not required.
    ZoneIdYesString

    Site ID.

    Filters.NNoArray of Filter

    Filter criteria. The maximum number of Filters.Values is 20. If this parameter is left empty, all available versions under the current site are returned. The IP range control domain of origin protection includes the standard control domain and the streamlined control domain. The main difference between the standard control domain and the streamlined control domain is the quantity difference of origin IP ranges provided. The latter has fewer IP ranges, however it is limited in use. Contact technical support if needed. Specific values are as follows:
    Detailed filter criteria are as follows:
    OriginACLFamily: filter by control domain;

  • gaz: standard global availability zone control domain;
  • mlc: standard Chinese mainland availability zone control domain;
  • emc: standard global (excluding Chinese mainland) availability zone control domain;
  • plat-gaz: streamlined global availability zone control domain;
  • plat-mlc: streamlined Chinese mainland availability zone control domain;
  • plat-emc: streamlined global (excluding Chinese mainland) availability zone control domain;
  • plat-specific-gaz: custom edition global availability zone control domain;
  • plat-specific-mlc: custom edition Chinese mainland availability zone control domain;
  • plat-specific-emc: custom edition global (excluding Chinese mainland) availability zone control domain.
    • OffsetNoInteger

    The offset of paginated query. Default value: 0.

    LimitNoInteger

    Number limit of paginated query. Default value: 20. Maximum value: 100.

    3. Output Parameters

    Parameter NameTypeDescription
    TotalCountInteger

    Total number of detailed information entries for origin protection IP ranges.

    OriginACLFamilyInfosArray of OriginACLFamilyInfo

    Detailed information list of origin-pull 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 Query the origin protection control domain by any specified site under the account

    You can select a site under any account to query the IP range information of various control domains for origin protection.

    Input Example

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

{
    "ZoneId": "zone-2w0bpv1wlag8",
    "Offset": 0,
    "Limit": 1
}

    Output Example

    {
    "Response": {
        "OriginACLFamilyInfos": [
            {
                "ActiveTime": "2025-08-15T00:00:00+08:00",
                "EntireAddresses": {
                    "IPv4": [
                        "113.13.111.0/24"
                    ],
                    "IPv6": [
                        "240d:c010:c2:3::/64"
                    ]
                },
                "OriginACLFamily": "emc",
                "Version": "emc-0.0.2-20250814"
            }
        ],
        "TotalCount": 4,
        "RequestId": "ddc1548a-a1d3-464d-a4d8-377ef6b5ed1f"
    }
}

    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

    There is no error code related to the API business logic. For other error codes, please see Common Error Codes.