Skip to content

CustomResponseCodeRuleProps

Properties for defining a CustomResponseCodeRule.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-esa-customresponsecoderule

Initializer

using AlibabaCloud.SDK.ROS.CDK.Esa;
new CustomResponseCodeRuleProps {
    object PageId,
    object ReturnCode,
    object SiteId,
    object Rule = null,
    object RuleEnable = null,
    object RuleName = null,
    object Sequence = null,
    object SiteVersion = null
};

Properties

Name Type Description
PageId object Property pageId: The custom response page.
ReturnCode object Property returnCode: The custom response code.
SiteId object Property siteId: The site ID.
Rule object Property rule: Rule content, using conditional expressions to match user requests.
RuleEnable object Property ruleEnable: Rule switch.
RuleName object Property ruleName: Rule name.
Sequence object Property sequence: Order of rule execution.
SiteVersion object Property siteVersion: The version number of the site configuration.

PageIdRequired

public object PageId { get; set; }
  • Type: object

Property pageId: The custom response page.


ReturnCodeRequired

public object ReturnCode { get; set; }
  • Type: object

Property returnCode: The custom response code.


SiteIdRequired

public object SiteId { get; set; }
  • Type: object

Property siteId: The site ID.


RuleOptional

public object Rule { get; set; }
  • Type: object

Property rule: Rule content, using conditional expressions to match user requests.

When adding global configuration, this parameter does not need to be set. There are two usage scenarios:

  • Match all incoming requests: value set to true
  • Match specified request: Set the value to a custom expression, for example: (http.host eq "video.example.com").

RuleEnableOptional

public object RuleEnable { get; set; }
  • Type: object

Property ruleEnable: Rule switch.

When adding global configuration, this parameter does not need to be set. Value range:

  • on: open.
  • off: close.

RuleNameOptional

public object RuleName { get; set; }
  • Type: object

Property ruleName: Rule name.

When adding global configuration, this parameter does not need to be set.


SequenceOptional

public object Sequence { get; set; }
  • Type: object

Property sequence: Order of rule execution.

The smaller the value, the higher the priority for execution.


SiteVersionOptional

public object SiteVersion { get; set; }
  • Type: object

Property siteVersion: The version number of the site configuration.

For sites that have enabled configuration version management, this parameter can be used to specify the effective version of the configuration site, which defaults to version 0.