ALIYUN::ESA::CustomResponseCodeRule-资源编排(ROS)-阿里云帮助中心

语法

{
  "Type": "ALIYUN::ESA::CustomResponseCodeRule",
  "Properties": {
    "PageId": String,
    "ReturnCode": String,
    "SiteId": Integer,
    "RuleEnable": String,
    "Rule": String,
    "RuleName": String,
    "Sequence": Integer,
    "SiteVersion": Integer
  }
}

属性

属性名称	类型	必须	允许更新	描述	约束
PageId	String	是	是	自定义响应页面。	无
ReturnCode	String	是	是	自定义响应码。	无
SiteId	Integer	是	否	站点ID。	无
Rule	String	否	是	规则内容，使用条件表达式匹配用户请求。	添加全局配置时，无需设置此参数。有两种使用场景： - 匹配所有传入请求: 将值设置为 true。 - 匹配指定请求：将值设置为自定义表达式，例如： (http.host eq \"video.example.com\").
RuleEnable	String	否	是	规则开关。	添加全局配置时，无需设置此参数。取值范围： - on: 开启。 - off: 关闭。
RuleName	String	否	是	规则名称。	添加全局配置时，无需设置此参数。
Sequence	Integer	否	是	规则执行顺序。	值越小，执行优先级越高。
SiteVersion	Integer	否	否	站点配置的版本号。	对于已启用配置版本管理的站点，可使用此参数指定配置站点的生效版本，默认为版本0。

返回值

Fn::GetAtt

PageId：自定义响应页面。
ReturnCode：自定义响应码。
RuleEnable：规则开关。添加全局配置时，无需设置此参数。
Sequence：规则执行顺序。值越小，执行优先级越高。
Rule：规则内容，使用条件表达式匹配用户请求。添加全局配置时，无需设置此参数。
ConfigId：配置ID。
SiteVersion：站点配置的版本号。对于已启用配置版本管理的站点，可使用此参数指定配置站点的生效版本，默认为版本0。
ConfigType：配置类型。您可以使用此参数检查全局配置或规则配置。
RuleName：规则名称。添加全局配置时，无需设置此参数。

示例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  PageId:
    Type: String
    Description:
      en: The custom response page.
    Required: true
  SiteId:
    Type: Number
    Description:
      en: The site ID.
    Required: true
  ReturnCode:
    Type: String
    Description:
      en: The custom response code.
    Required: true
  RuleEnable:
    Type: String
    Description:
      en: |-
        Rule switch. When adding global configuration, this parameter does not need to be set. Value range:
        - on: open.
        - off: close.
    AllowedValues:
      - 'on'
      - 'off'
    Required: false
  Sequence:
    Type: Number
    Description:
      en: Order of rule execution. The smaller the value, the higher the priority for execution.
    Required: false
  Rule:
    Type: String
    Description:
      en: |-
        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\").
    Required: false
  SiteVersion:
    Type: Number
    Description:
      en: 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.
    Required: false
  RuleName:
    Type: String
    Description:
      en: Rule name. When adding global configuration, this parameter does not need to be set.
    Required: false
Resources:
  ExtensionResource:
    Type: ALIYUN::ESA::CustomResponseCodeRule
    Properties:
      PageId:
        Ref: PageId
      SiteId:
        Ref: SiteId
      ReturnCode:
        Ref: ReturnCode
      RuleEnable:
        Ref: RuleEnable
      Sequence:
        Ref: Sequence
      Rule:
        Ref: Rule
      SiteVersion:
        Ref: SiteVersion
      RuleName:
        Ref: RuleName
Outputs:
  PageId:
    Description: The custom response page.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - PageId
  ReturnCode:
    Description: The custom response code.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ReturnCode
  RuleEnable:
    Description: Rule switch. When adding global configuration, this parameter does not need to be set.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - RuleEnable
  Sequence:
    Description: Order of rule execution. The smaller the value, the higher the priority for execution.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Sequence
  Rule:
    Description: Rule content, using conditional expressions to match user requests. When adding global configuration, this parameter does not need to be set.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Rule
  ConfigId:
    Description: Config Id.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ConfigId
  SiteVersion:
    Description: 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.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - SiteVersion
  ConfigType:
    Description: The configuration type. You can use this parameter to check the global configuration or rule configuration.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ConfigType
  RuleName:
    Description: Rule name. When adding global configuration, this parameter does not need to be set.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - RuleName

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "PageId": {
      "Type": "String",
      "Description": {
        "en": "The custom response page."
      },
      "Required": true
    },
    "SiteId": {
      "Type": "Number",
      "Description": {
        "en": "The site ID."
      },
      "Required": true
    },
    "ReturnCode": {
      "Type": "String",
      "Description": {
        "en": "The custom response code."
      },
      "Required": true
    },
    "RuleEnable": {
      "Type": "String",
      "Description": {
        "en": "Rule switch. When adding global configuration, this parameter does not need to be set. Value range:\n- on: open.\n- off: close."
      },
      "AllowedValues": [
        "on",
        "off"
      ],
      "Required": false
    },
    "Sequence": {
      "Type": "Number",
      "Description": {
        "en": "Order of rule execution. The smaller the value, the higher the priority for execution."
      },
      "Required": false
    },
    "Rule": {
      "Type": "String",
      "Description": {
        "en": "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:\n- Match all incoming requests: value set to true\n- Match specified request: Set the value to a custom expression, for example: (http.host eq \\\"video.example.com\\\")."
      },
      "Required": false
    },
    "SiteVersion": {
      "Type": "Number",
      "Description": {
        "en": "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."
      },
      "Required": false
    },
    "RuleName": {
      "Type": "String",
      "Description": {
        "en": "Rule name. When adding global configuration, this parameter does not need to be set."
      },
      "Required": false
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::ESA::CustomResponseCodeRule",
      "Properties": {
        "PageId": {
          "Ref": "PageId"
        },
        "SiteId": {
          "Ref": "SiteId"
        },
        "ReturnCode": {
          "Ref": "ReturnCode"
        },
        "RuleEnable": {
          "Ref": "RuleEnable"
        },
        "Sequence": {
          "Ref": "Sequence"
        },
        "Rule": {
          "Ref": "Rule"
        },
        "SiteVersion": {
          "Ref": "SiteVersion"
        },
        "RuleName": {
          "Ref": "RuleName"
        }
      }
    }
  },
  "Outputs": {
    "PageId": {
      "Description": "The custom response page.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "PageId"
        ]
      }
    },
    "ReturnCode": {
      "Description": "The custom response code.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ReturnCode"
        ]
      }
    },
    "RuleEnable": {
      "Description": "Rule switch. When adding global configuration, this parameter does not need to be set.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "RuleEnable"
        ]
      }
    },
    "Sequence": {
      "Description": "Order of rule execution. The smaller the value, the higher the priority for execution.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Sequence"
        ]
      }
    },
    "Rule": {
      "Description": "Rule content, using conditional expressions to match user requests. When adding global configuration, this parameter does not need to be set.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Rule"
        ]
      }
    },
    "ConfigId": {
      "Description": "Config Id.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ConfigId"
        ]
      }
    },
    "SiteVersion": {
      "Description": "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.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SiteVersion"
        ]
      }
    },
    "ConfigType": {
      "Description": "The configuration type. You can use this parameter to check the global configuration or rule configuration.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ConfigType"
        ]
      }
    },
    "RuleName": {
      "Description": "Rule name. When adding global configuration, this parameter does not need to be set.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "RuleName"
        ]
      }
    }
  }
}