Updates a site's origin fetch rules.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| SiteId |
integer |
Yes |
The site ID. You can get this ID by calling the ListSites operation. |
5407498413**** |
| ConfigId |
integer |
Yes |
The configuration ID. |
35281609698**** |
| RuleName |
string |
No |
The rule name. Not required for global configurations. |
rule_example |
| RuleEnable |
string |
No |
Whether the rule is enabled. Not required for global configurations. Valid values:
|
on |
| Rule |
string |
No |
The rule content, a conditional expression that matches user requests. Not required for global configurations.
|
(http.host eq \"video.example.com\") |
| OriginHost |
string |
No |
The |
origin.example.com |
| OriginScheme |
string |
No |
The protocol for origin requests. Valid values:
|
http |
| OriginSni |
string |
No |
The Server Name Indication (SNI) for the origin request. |
origin.example.com |
| DnsRecord |
string |
No |
Overrides the DNS record for the origin request. |
test.example.com |
| OriginHttpPort |
string |
No |
The origin server port for HTTP requests. |
8080 |
| OriginHttpsPort |
string |
No |
The origin server port for HTTPS requests. |
4433 |
| Range |
string |
No |
Whether to use range requests when fetching files from the origin server. Valid values:
|
on |
| OriginMtls |
string |
No |
Whether to enable mutual TLS (mTLS) for origin requests. Valid values:
|
on |
| OriginVerify |
string |
No |
Whether to enable origin certificate verification. Valid values:
|
on |
| RangeChunkSize |
string |
No |
The size of each chunk for range requests. Valid values:
|
1MB |
| Sequence |
integer |
No |
The execution priority of the rule. Smaller values have higher priority. |
1 |
| OriginReadTimeout |
string |
No |
The read timeout for the origin server, in seconds. |
10 |
| Follow302Enable |
string |
No |
Whether to follow 302 redirects for origin requests. Valid values:
|
on |
| Follow302MaxTries |
string |
No |
The maximum number of 302 redirects to follow. Valid values: 1 to 5. |
1 |
| Follow302RetainArgs |
string |
No |
Whether to retain the original request parameters when following a 302 redirect. Valid values:
|
on |
| Follow302RetainHeader |
string |
No |
Whether to retain the original request headers when following a 302 redirect. Valid values:
|
on |
| Follow302TargetHost |
string |
No |
The |
test.com |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response body. |
||
| RequestId |
string |
The request ID. |
0AEDAF20-4DDF-4165-8750-47FF9C1929C9 |
Examples
Success response
JSON format
{
"RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9"
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | CanNotSetSequence | Non-regular configuration, you cannot set Sequence parameters. | Sequence parameters is not allowed in global configuration. |
| 400 | CacheReserveSiteExceedLimit | The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit. | The number of sites for which the cache reserve instance bindings exceeds the limit. |
| 400 | CompileRuleError | Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document. | Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document. |
| 400 | SiteConfigLengthExceedLimit | The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K. | The size of the site configuration exceeds the limit, and the total size cannot exceed 512K. |
| 400 | ConfigConflicts | Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations. | The parameter uniqueness check failed. Check for duplicate parameter values. |
| 400 | RuleRegexQuotaCheckFailed | When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan. | The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan. |
| 400 | NestedRuleQuotaCheckFailed | The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan. | The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan. |
| 400 | ServiceInvokeFailed | The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details. | Failed to call the service. Please try again later or contact customer service for details. |
| 400 | FunctionConflict | The feature configuration conflicts. Sites with version management enabled cannot configure this feature. | The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first. |
| 400 | SpecifiedVersionReadOnly | The specified version number is read-only and cannot be modified. | The specified version number is read-only and cannot be modified. |
| 400 | VersionNotValid | The site does not have version management enabled, or the version number passed in does not exist. | The site does not have version management enabled, or the version number passed in does not exist. |
| 400 | InternalException | Failed to call the service. Try again later or contact technical support. | Failed to call the service. Try again later or contact technical support. |
| 400 | InvalidParameter.ArgName | Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation. | Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation. |
| 400 | InvalidParameter.ArgValue | Invalid parameter value. Check whether the value format and length meet the requirements. | Invalid parameter value. Check whether the value format and length meet the requirements. |
| 400 | InvalidParameter.Configs | Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements. | Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements. |
| 400 | InstanceNotExist | The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account. | The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account. |
| 400 | LockFailed | The system is handling requests you previously submitted. Try again later. | The system is handling requests you previously submitted. Try again later. |
| 400 | IllegalOperation.VersionManagement | The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again. | The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again. |
| 400 | QuotaCheckFailed.VersionManagement | Insufficient quota for version management. Contact technical support. | Insufficient quota for version management. Contact technical support. |
| 400 | InvalidConfigId | The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction. | The ConfigId does not exist. |
| 400 | Instance.NotOnline | Your plan is unavailable due to an overdue payment. Complete the payment first. | Your plan is unavailable due to an overdue payment. Complete the payment first. |
| 400 | FunctionQuotaCheckFailed | The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site. | The current plan does not support the configuration of restricted functions, please check the plan related function description. |
| 400 | QuotaCheckFailed.FunctionArg | The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan. | The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan. |
| 400 | MissingParameter | The specified ArgName is required for this function. | When configuring a specific function, the required parameter is missing. |
| 400 | FunctionArgError | Failed to check the configured function parameters. | Failed to check the configured function parameters |
| 404 | SiteNotFound | The website does not exist or does not belong to you. | The website does not exist or does not belong to you. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.