Skip to content

CustomResponseCodeRuleProps

Properties for defining a CustomResponseCodeRule.

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

Initializer

import { CustomResponseCodeRuleProps } from '@alicloud/ros-cdk-esa'
const customResponseCodeRuleProps: CustomResponseCodeRuleProps = { ... }

Properties

Name Type Description
pageId string | @alicloud/ros-cdk-core.IResolvable Property pageId: The custom response page.
returnCode string | @alicloud/ros-cdk-core.IResolvable Property returnCode: The custom response code.
siteId number | @alicloud/ros-cdk-core.IResolvable Property siteId: The site ID.
rule string | @alicloud/ros-cdk-core.IResolvable Property rule: Rule content, using conditional expressions to match user requests.
ruleEnable string | @alicloud/ros-cdk-core.IResolvable Property ruleEnable: Rule switch.
ruleName string | @alicloud/ros-cdk-core.IResolvable Property ruleName: Rule name.
sequence number | @alicloud/ros-cdk-core.IResolvable Property sequence: Order of rule execution.
siteVersion number | @alicloud/ros-cdk-core.IResolvable Property siteVersion: The version number of the site configuration.

pageIdRequired

public readonly pageId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property pageId: The custom response page.


returnCodeRequired

public readonly returnCode: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property returnCode: The custom response code.


siteIdRequired

public readonly siteId: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property siteId: The site ID.


ruleOptional

public readonly rule: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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 readonly ruleEnable: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property ruleEnable: Rule switch.

When adding global configuration, this parameter does not need to be set. Value range: - on: open. - off: close.


ruleNameOptional

public readonly ruleName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property ruleName: Rule name.

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


sequenceOptional

public readonly sequence: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property sequence: Order of rule execution.

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


siteVersionOptional

public readonly siteVersion: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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.