Domain name for API request: teo.intl.tencentcloudapi.com.
This API is used to configure the origin speed limit. This feature is in beta test.
This API is used to create, modify and delete preheating origin speed limit restrictions. Each account supports up to 100 restrictions.
A maximum of 20 requests can be initiated per second for this API.
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: ModifyPrefetchOriginLimit. |
| 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 | Zone ID. |
| DomainName | Yes | String | Acceleration domain name. |
| Area | Yes | String | Specifies the acceleration region with origin-pull speed limit. During preheating, the acceleration region will be subject to the configured Bandwidth value limit. valid values:. |
| Bandwidth | Yes | Integer | Specifies the bandwidth limit for origin-pull. Specifies the upper limit of bandwidth returning to the origin server during preheating. value ranges from 100 to 100,000 Mbps. |
| Enabled | Yes | String | Specifies the control switch for origin-pull rate limiting. Used to enable/delete the origin-pull speed limit. valid values:. |
| Parameter Name | Type | Description |
|---|---|---|
| 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. |
This example shows you how to create a preheated origin-pull bandwidth limit for cn2.test-***a.online, configuring the preheated global availability zone (excluding Chinese mainland) acceleration region with an origin-pull bandwidth of 100Mbps.
POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyPrefetchOriginLimit
<Common request parameters>
{
"ZoneId": "zone-3***j8tqd",
"DomainName": "cn2.test-***a.online",
"Area": "Overseas",
"Bandwidth": 100,
"Enabled": "on"
}
{
"Response": {
"RequestId": "591c01a2-af21-4c09-af23-8f7d96832d01"
}
}
Remove the limit for cn2.test-***a.online.
POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyPrefetchOriginLimit
<Common request parameters>
{
"ZoneId": "zone-3***j8tqd",
"DomainName": "cn2.test-***a.online",
"Area": "Overseas",
"Bandwidth": 100,
"Enabled": "off"
}
{
"Response": {
"RequestId": "67a3d9f3-b852-4f6e-af7d-cc66ebc4fb08"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
| FailedOperation.CreatePrefetchOriginLimitFailed | Failed to create the preheating origin speed limit configuration. please retry later or submit a ticket. |
| FailedOperation.PrefetchOriginLimitCountExceeded | Exceed the quantity limit, unable to create more, delete unnecessary configuration or submit a request to enhance configuration quantity. |
| FailedOperation.PrefetchOriginLimitNotFound | Corresponding preheating origin speed limit configuration not found. confirm whether there is configuration and retry. |
| InternalError.BackendError | Server error. |
| InternalError.DomainConfig | Failed to get configuration |
| InvalidParameter | Parameter error. |
| InvalidParameter.DomainAreaNotSupportPrefetchOriginLimitArea | The domain name acceleration region does not support the preheating origin rate limiting regional configuration. please adjust and resubmit. |
| 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. |
| InvalidParameter.PrefetchOriginLimitBandwidthTooLarge | Preheated origin-pull speed limit bandwidth value is too large. adjust and resubmit. |
| InvalidParameter.PrefetchOriginLimitBandwidthTooSmall | Preheated origin-pull speed limit bandwidth value is too low. adjust and resubmit. |
| InvalidParameter.PrefetchOriginLimitEnabledInvalid | The preheating origin rate limiting control switch parameter is invalid. please adjust the region and resubmit. |
| InvalidParameter.ZoneAreaNotSupportPrefetchOriginLimitArea | The site acceleration region does not support the preheating origin rate limiting regional configuration. please adjust and resubmit. |
| OperationDenied.NotInPrefetchOriginLimitWhiteList | Not in the preheating origin speed limit allowlist. submit a ticket. |
| ResourceInUse.PrefetchOriginLimitAlreadyExists | The preheating origin speed limit configuration already exists and cannot be recreated. please check whether the corresponding configuration has been created. |
| 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. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback