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

语法

{
  "Type": "ALIYUN::ESA::RoutineRoute",
  "Properties": {
    "RoutineName": String,
    "SiteId": Integer,
    "Bypass": String,
    "Fallback": String,
    "RouteName": String,
    "RouteEnable": String,
    "Rule": String,
    "Sequence": Integer
  }
}

属性

属性名称	类型	必须	允许更新	描述	约束
RoutineName	String	是	否	边缘函数路由名称。	无
SiteId	Integer	是	否	站点ID。	无
Bypass	String	否	是	Bypass模式。	取值范围： on: 开启 off: 关闭。
Fallback	String	否	是	异常回源开关。开启该开关后,当函数出现异常情况(如CPU使用率超过上限)时,请求将回源到源站。	取值范围: on: 开启 off: 关闭
RouteEnable	String	否	是	路由开关。	取值范围： on: 开启 off: 关闭。
RouteName	String	否	是	路由名称。	无
Rule	String	否	是	规则内容。	无
Sequence	Integer	否	是	规则执行顺序。	无

返回值

Fn::GetAtt

RoutineName：边缘函数Routine名称。
Bypass：Bypass模式。
Mode：配置模式。
Fallback：将启用回源服务器开关的异常处理。如果函数发生异常（如CPU使用超出限制），将发起回源请求。
RouteName：路由名称。
Sequence：规则执行顺序。
RouteEnable：路由开关。
Rule：规则内容。
ConfigId：配置ID。
SiteVersion：站点版本号。
ConfigType：配置类型。您可以使用此参数检查全局配置或规则配置。

示例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RoutineName:
    Type: String
    Description:
      en: The edge function Routine name.
    Required: true
  SiteId:
    Type: Number
    Description:
      en: The website ID.
    Required: true
  Bypass:
    Type: String
    Description:
      en: |-
        Bypass mode. Value range:
        - on: Open
        - off: off.
    AllowedValues:
      - 'on'
      - 'off'
    Required: false
  Fallback:
    Type: String
    Description:
      en: |
        The exception origin fetch switch. After you turn on this switch, if a function exception occurs, such as CPU usage exceeding the upper limit, requests are sent back to the origin. Valid values:
        on
        off
    Required: false
  RouteName:
    Type: String
    Description:
      en: The name of the route.
    Required: false
  Sequence:
    Type: Number
    Description:
      en: Rule execution order.
    Required: false
  RouteEnable:
    Type: String
    Description:
      en: |-
        Routing switch. Value range:
        - on: Open
        - off: off.
    AllowedValues:
      - 'on'
      - 'off'
    Required: false
  Rule:
    Type: String
    Description:
      en: The content of the rule.
    Required: false
Resources:
  ExtensionResource:
    Type: ALIYUN::ESA::RoutineRoute
    Properties:
      RoutineName:
        Ref: RoutineName
      SiteId:
        Ref: SiteId
      Bypass:
        Ref: Bypass
      Fallback:
        Ref: Fallback
      RouteName:
        Ref: RouteName
      Sequence:
        Ref: Sequence
      RouteEnable:
        Ref: RouteEnable
      Rule:
        Ref: Rule
Outputs:
  RoutineName:
    Description: The edge function Routine name.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - RoutineName
  Bypass:
    Description: Bypass mode.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Bypass
  Mode:
    Description: Configuration mode.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Mode
  Fallback:
    Description: An exception to the origin server switch will be enabled. If an exception occurs in the function, such as CPU usage exceeding limits, a request will be made to return to the origin server.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Fallback
  RouteName:
    Description: The route name.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - RouteName
  Sequence:
    Description: Rule execution order.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Sequence
  RouteEnable:
    Description: Routing switch.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - RouteEnable
  Rule:
    Description: The content of the rule.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Rule
  ConfigId:
    Description: The configuration ID.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ConfigId
  SiteVersion:
    Description: Version number of the site.
    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

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RoutineName": {
      "Type": "String",
      "Description": {
        "en": "The edge function Routine name."
      },
      "Required": true
    },
    "SiteId": {
      "Type": "Number",
      "Description": {
        "en": "The website ID."
      },
      "Required": true
    },
    "Bypass": {
      "Type": "String",
      "Description": {
        "en": "Bypass mode. Value range:\n- on: Open\n- off: off."
      },
      "AllowedValues": [
        "on",
        "off"
      ],
      "Required": false
    },
    "Fallback": {
      "Type": "String",
      "Description": {
        "en": "The exception origin fetch switch. After you turn on this switch, if a function exception occurs, such as CPU usage exceeding the upper limit, requests are sent back to the origin. Valid values:\non\noff\n"
      },
      "Required": false
    },
    "RouteName": {
      "Type": "String",
      "Description": {
        "en": "The name of the route."
      },
      "Required": false
    },
    "Sequence": {
      "Type": "Number",
      "Description": {
        "en": "Rule execution order."
      },
      "Required": false
    },
    "RouteEnable": {
      "Type": "String",
      "Description": {
        "en": "Routing switch. Value range:\n- on: Open\n- off: off."
      },
      "AllowedValues": [
        "on",
        "off"
      ],
      "Required": false
    },
    "Rule": {
      "Type": "String",
      "Description": {
        "en": "The content of the rule."
      },
      "Required": false
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::ESA::RoutineRoute",
      "Properties": {
        "RoutineName": {
          "Ref": "RoutineName"
        },
        "SiteId": {
          "Ref": "SiteId"
        },
        "Bypass": {
          "Ref": "Bypass"
        },
        "Fallback": {
          "Ref": "Fallback"
        },
        "RouteName": {
          "Ref": "RouteName"
        },
        "Sequence": {
          "Ref": "Sequence"
        },
        "RouteEnable": {
          "Ref": "RouteEnable"
        },
        "Rule": {
          "Ref": "Rule"
        }
      }
    }
  },
  "Outputs": {
    "RoutineName": {
      "Description": "The edge function Routine name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "RoutineName"
        ]
      }
    },
    "Bypass": {
      "Description": "Bypass mode.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Bypass"
        ]
      }
    },
    "Mode": {
      "Description": "Configuration mode.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Mode"
        ]
      }
    },
    "Fallback": {
      "Description": "An exception to the origin server switch will be enabled. If an exception occurs in the function, such as CPU usage exceeding limits, a request will be made to return to the origin server.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Fallback"
        ]
      }
    },
    "RouteName": {
      "Description": "The route name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "RouteName"
        ]
      }
    },
    "Sequence": {
      "Description": "Rule execution order.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Sequence"
        ]
      }
    },
    "RouteEnable": {
      "Description": "Routing switch.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "RouteEnable"
        ]
      }
    },
    "Rule": {
      "Description": "The content of the rule.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Rule"
        ]
      }
    },
    "ConfigId": {
      "Description": "The configuration ID.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ConfigId"
        ]
      }
    },
    "SiteVersion": {
      "Description": "Version number of the site.",
      "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"
        ]
      }
    }
  }
}