当前内容仅提供英语版本,中文版我们将尽快补充,感谢您的理解。

DescribePrefetchOriginLimit

1. API Description

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

This API is used to query the origin speed limit. This feature is in closed beta testing.

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: DescribePrefetchOriginLimit.
VersionYesStringCommon Params. The value used for this API: 2022-09-01.
RegionNoStringCommon Params. This parameter is not required.
ZoneIdYesStringSpecifies the site ID.
OffsetNoIntegerOffset of paginated query. Default value: 0.
LimitNoIntegerSpecifies the paginated query limit. default value: 20. upper limit: 100.
Filters.NNoArray of FilterFilter condition. specifies the maximum number of Filters.Values is 20. detailed filter criteria:.
  • Domain-Name: specifies domain filtering. the domain-name format is like www.qq.com. fuzzy queries are not supported.
  • .
  • area: specifies the acceleration region to filter by limit. fuzzy queries are not supported. valid values:
     Overseas: global availability zone (excludes chinese mainland);
     MainlandChina: chinese mainland availability zone.
  • .

    3. Output Parameters

    Parameter NameTypeDescription
    TotalCountIntegerSpecifies the total count of origin-pull speed limit restrictions.
    LimitsArray of PrefetchOriginLimitDescribes the List of origin-pull speed limit details.
    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 Preheating Speed Limit Restrictions

    This example shows you how to query the preheating origin speed limit for the accelerated domain name cn2.test-***a.online.

    Input Example

    POST / HTTP/1.1
    Host: teo.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribePrefetchOriginLimit
    <Common request parameters>
    
    {
        "ZoneId": "zone-3***j8tqd",
        "Offset": 0,
        "Limit": 10,
        "Filters": [
            {
                "Name": "domain-name",
                "Values": [
                    "cn2.test-***a.online"
                ]
            }
        ]
    }
    

    Output Example

    {
        "Response": {
            "Limits": [
                {
                    "Area": "Overseas",
                    "Bandwidth": 100,
                    "CreateTime": "2025-12-16T07:08:40Z",
                    "DomainName": "cn2.test-***a.online",
                    "UpdateTime": "2025-12-16T07:08:40Z",
                    "ZoneId": "zone-3***j8tqd"
                }
            ],
            "TotalCount": 1,
            "RequestId": "7db71bfe-e735-4d1a-8f2d-90c085b7418d"
        }
    }
    

    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
    FailedOperationOperation failed.
    InternalError.BackendErrorServer error.
    InvalidParameterParameter error.
    InvalidParameter.DomainNotFoundThe domain name does not exist or is not belong to this account.
    InvalidParameter.PrefetchOriginLimitAreaInvalidThe preheating origin rate limiting region parameter is invalid. please adjust the region and resubmit.
    OperationDenied.NotInPrefetchOriginLimitWhiteListNot in the preheating origin speed limit allowlist. submit a ticket.
    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.