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 Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribePrefetchOriginLimit. |
| 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. |
| Offset | No | Integer | Offset of paginated query. Default value: 0. |
| Limit | No | Integer | Specifies the paginated query limit. default value: 20. upper limit: 100. |
| Filters.N | No | Array of Filter | Filter condition. specifies the maximum number of Filters.Values is 20. detailed filter criteria:. Overseas: global availability zone (excludes chinese mainland); MainlandChina: chinese mainland availability zone. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Specifies the total count of origin-pull speed limit restrictions. |
| Limits | Array of PrefetchOriginLimit | Describes the List of origin-pull speed limit details. |
| 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 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.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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 |
|---|---|
| FailedOperation | Operation failed. |
| InternalError.BackendError | Server error. |
| InvalidParameter | Parameter error. |
| InvalidParameter.DomainNotFound | The domain name does not exist or is not belong to this account. |
| InvalidParameter.PrefetchOriginLimitAreaInvalid | The preheating origin rate limiting region parameter is invalid. please adjust the region and resubmit. |
| OperationDenied.NotInPrefetchOriginLimitWhiteList | Not in the preheating origin speed limit allowlist. submit a ticket. |
| 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. |