All Products
Search
Document Center

Edge Security Acceleration:CreateOriginRule

Last Updated:Mar 23, 2026

Create a Back-to-Origin Rule for a Site.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

SiteId

integer

Yes

The ID of the site. You can obtain this ID by calling the ListSites operation.

340035003106221

SiteVersion

integer

No

For sites with version management enabled, this specifies the version to which the configuration applies. The default value is 0.

1

RuleName

string

No

The rule name. Not required when creating a Global Configuration.

rule_example

RuleEnable

string

No

Specifies whether to enable the rule. Not required when creating a Global Configuration. Valid values:

  • on: Enables the rule.

  • off: Disables the rule.

on

Rule

string

No

The content of the rule, a Conditional Expression that matches user requests. Not required when creating a Global Configuration. There are two scenarios:

  • To match all incoming requests, set the value to true.

  • To match specific requests, set the value to a custom expression. Example: (http.host eq "video.example.com").

(http.host eq \"video.example.com\")

OriginHost

string

No

The Host header to use in Origin requests.

origin.example.com

OriginScheme

string

No

The protocol for Origin requests. Valid values:

  • http: Uses the HTTP protocol.

  • https: Uses the HTTPS protocol.

  • follow: Uses the same protocol as the client request.

http

OriginSni

string

No

The Server Name Indication (SNI) to use in Origin requests.

origin.example.com

DnsRecord

string

No

Overrides the DNS Record for Origin requests.

test.example.com

OriginHttpPort

string

No

The Origin Port to use for HTTP Origin requests.

8080

OriginHttpsPort

string

No

The Origin Port to use for HTTPS Origin requests.

4433

Range

string

No

Specifies whether to use range requests to download files from the Origin. Valid values:

  • on: Enables range requests.

  • off: Disables range requests.

  • force: Forces range requests.

on

OriginMtls

string

No

Specifies whether to enable mutual Transport Layer Security (mTLS) for Origin connections. Valid values:

  • on: Enables mTLS.

  • off: Disables mTLS.

on

OriginVerify

string

No

Specifies whether to enable Origin Certificate Verification. Valid values:

  • on: Enables verification.

  • off: Disables verification.

on

RangeChunkSize

string

No

The size of each chunk for range requests. Valid values:

  • 512KB

  • 1MB

  • 2MB

  • 4MB

1MB

Sequence

integer

No

The priority of the rule. A smaller value indicates a higher priority.

1

OriginReadTimeout

string

No

The Origin read timeout in seconds.

10

Follow302Enable

string

No

Specifies whether to follow 302 redirects from the Origin. Valid values:

  • on: Enables following redirects.

  • off: Disables following redirects.

on

Follow302MaxTries

string

No

The maximum number of 302 redirects to follow. Valid range: 1 to 5.

1

Follow302RetainArgs

string

No

Specifies whether to retain the original request parameters when following a 302 redirect. Valid values:

  • on: Retains the request parameters.

  • off: Does not retain the request parameters.

on

Follow302RetainHeader

string

No

Specifies whether to retain the original request header when following a 302 redirect. Valid values:

  • on: Retains the request header.

  • off: Does not retain the request header.

on

Follow302TargetHost

string

No

The Origin Host header to use after a 302 redirect.

test.com

Response elements

Element

Type

Description

Example

object

The response object.

RequestId

string

The ID of the request.

04F0F334-1335-436C-A1D7-6C044FE73368

ConfigId

integer

The ID of the configuration.

352816096987136

Examples

Success response

JSON format

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "ConfigId": 352816096987136
}

Error codes

HTTP status code

Error code

Error message

Description

400 MissingParameter The specified ArgName is required for this function. When configuring a specific function, the required parameter is missing.
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 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 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 ArgQuotaCheckFailed The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan. The current plan does not support the configuration of restricted parameters, please check the input parameters.
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 ConfExceedLimit The number of function configurations exceeds the limit. Please check the interface document to see the number of configurations that can be supported by a single function. The number of configuration items for the current function has exceeded the upper limit set by the system.
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 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 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 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 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.