# BreakerContent 表1BreakerContent | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | scope | 否 | String | 断路器策略的类型。支持的取值： - basic：基础，表示绑定到断路器插件的每个API各自计算断路器策略 - share：共享，表示绑定到断路器插件的所有API共享断路器策略 | | breaker_condition | 是 | [PluginBreakerCondition] object | 断路器插件判断条件内容对象。 | | downgrade_default | 否 | [PluginBreakerDowngradeInfo] object | 断路器插件降级后端内容定义对象。 | | downgrade_parameters | 否 | Array of [PluginCommonParameter] objects | 断路器规则使用的参数列表。 | | downgrade_rules | 否 | Array of [PluginBreakerDowngradeRule] objects | 断路器插件降级规则列表。 | 表2PluginBreakerDowngradeRule | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | rule_name | 是 | String | 断路器规则名称。 | | match_regex | 是 | String | 断路器规则表达式。详情参看规则表达式说明。 | | breaker_condition | 否 | [PluginBreakerCondition] object | 断路器插件判断条件内容对象。 | | downgrade_backend | 否 | [PluginBreakerDowngradeInfo] object | 断路器插件降级后端内容定义对象。 | | parameters | 否 | Array of [PluginCommonParameter] objects | 断路器规则使用的参数列表。 | 表3PluginBreakerCondition | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | breaker_type | 是 | String | 断路器类型。支持的取值： - timeout：按后端超时的断路器 - condition：按后端匹配条件判断的断路器 | | breaker_mode | 否 | String | 断路器条件模式。支持的取值： - counter：计数器模式 - percentage：百分比模式 | | unhealthy_condition | 否 | String | 规则表达式。详情参看规则表达式说明。 | | unhealthy_threshold | 否 | Integer | 触发不健康条件的请求次数，使用*breaker_mode* 为*counter*时，必填。 | | min_call_threshold | 否 | Integer | 触发的最小调用次数，使用*breaker_mode* 为*percentage*时，必填。 | | unhealthy_percentage | 否 | Integer | 触发断路的不健康条件最小百分比，使用*breaker_mode* 为*percentage*时，必填。 | | time_window | 是 | Integer | 判断不健康次数的时间窗口，单位为秒。 | | open_breaker_time | 是 | Integer | 断路器打开的持续时间，单位为秒。 | 表4PluginBreakerDowngradeInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | type | 是 | String | 熔断降级类型，支持http、http_vpc、function、mock、passthrough。支持的取值： - http：http请求到后端 - http_vpc：http请求负载到后端 - function：函数类型后端 - mock：Mock类型后端 - passthrough：添加透传参数到后端 | | http_info | 否 | [PluginBreakerDowngradeHttpInfo] object | 断路器插件降级后端HTTP内容定义对象。 | | http_vpc_info | 否 | [PluginBreakerDowngradeHttpVpcInfo] object | 断路器插件降级后端HTTP负载内容定义对象。 | | func_info | 否 | [PluginBreakerDowngradeFunctionInfo] object | 断路器插件降级后端函数内容定义对象。 | | mock_info | 否 | [PluginBreakerDowngradeMockInfo] object | 断路器插件降级后端Mock内容定义对象。 | | passthrough_infos | 否 | Array of [PluginBreakerDowngradePassthroughInfo] objects | 熔断降级类型*type* 为*passthrough*时，必填。 | 表5PluginBreakerDowngradeHttpInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | address | 是 | String | 后端服务的地址。 由主机（IP或域名）和端口号组成，总长度不超过255。格式为主机:端口（如：apig.example.com:7443）。如果不写端口，则HTTPS默认端口号为443，HTTP默认端口号为80。 | | scheme | 是 | String | 请求协议。支持的取值： - HTTP - HTTPS | | method | 是 | String | 请求方式。支持的取值： - GET - POST - PUT - DELETE - HEAD - PATCH - OPTIONS - ANY | | path | 是 | String | 请求地址。可以包含请求参数，用{}标识，比如/getUserInfo/{userId}，支持 \* % - _ . 等特殊字符，总长度不超过512，且满足URI规范。 说明： 需要服从URI规范。 | | timeout | 是 | Integer | 请求后端服务的超时时间。最大超时时间可通过实例特性backend_timeout配置修改，可修改的上限为600000。 单位：毫秒。 | 表6PluginBreakerDowngradeHttpVpcInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | vpc_channel_id | 是 | String | 负载通道编号。 | | scheme | 是 | String | 请求协议。支持的取值： - HTTP - HTTPS | | method | 是 | String | 请求方式。 | | path | 是 | String | 请求地址。可以包含请求参数，用{}标识，比如/getUserInfo/{userId}，支持 \* % - _ . 等特殊字符，总长度不超过512，且满足URI规范。 说明： 需要服从URI规范。 | | timeout | 是 | Integer | 请求后端服务的超时时间。最大超时时间可通过实例特性backend_timeout配置修改，可修改的上限为600000。 单位：毫秒。 | 表7PluginBreakerDowngradeFunctionInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | function_urn | 是 | String | 函数URN。 | | version | 否 | String | 版本。别名和版本选择一个参数输入即可。 | | alias_urn | 否 | String | 别名。别名和版本选择一个参数输入即可。 | | invocation_type | 是 | String | 调用类型。支持的取值： - async： 异步 - sync：同步 | | timeout | 是 | Integer | 请求后端服务的超时时间。最大超时时间可通过实例特性backend_timeout配置修改，可修改的上限为600000。 单位：毫秒。 | 表8PluginBreakerDowngradeMockInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | status_code | 是 | String | Mock返回的HTTP状态码。支持的取值： - 200：OK - 201：Created - 202：Accepted - 203：NonAuthoritativeInformation - 204：NoContent - 205：ResetContent - 206：PartialContent - 300：MultipleChoices - 301：MovedPermanently - 302：Found - 303：SeeOther - 304：NotModified - 305：UseProxy - 306：Unused - 307：TemporaryRedirect - 400：BadRequest - 401：Unauthorized - 402：PaymentRequired - 403：Forbidden - 404：NotFound - 405：MethodNotAllowed - 406：NotAcceptable - 407：ProxyAuthenticationRequired - 408：RequestTimeout - 409：Conflict - 410：Gone - 411：LengthRequired - 412：PreconditionFailed - 413：RequestEntityTooLarge - 414：RequestURITooLong - 415：UnsupportedMediaType - 416：RequestedRangeNotSatisfiable - 417：ExpectationFailed - 450：ParameterRequried - 451：MethodConnectException - 500：InternalServerError - 501：NotImplemented - 502：BadGateway - 503：ServiceUnavailable - 504：GatewayTimeout - 505：HTTPVersionNotSupported | | result_content | 否 | String | 返回Body。 | | headers | 否 | Array of [PluginBreakerDowngradeMockHeader] objects | Mock返回响应头。 | 表9PluginBreakerDowngradeMockHeader | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key | 否 | String | 响应头域的名称。 | | value | 是 | String | 响应头域的值。 | 表10PluginBreakerDowngradePassthroughInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | location | 否 | String | 参数位置：header、query、path。 | | name | 是 | String | 参数名称。 字符串由英文字母、数字、中划线、下划线、英文句号组成，且只能以英文开头。 | | origin | 是 | String | 参数类别：constant、system。 | | value | 是 | String | 参数值。字符长度不超过255。 *origin* 类别为*constant*时，此字段值为参数真正的值； *origin* 类别为*system*时，此字段值为系统参数名称，系统参数分为网关内置参数、前端认证参数和后端认证参数，当api前端安全认证方式为自定义认证时，可以填写前端认证参数，当api开启后端认证时，可以填写后端认证参数。 网关内置参数取值及对应含义： - $context.sourceIp：API调用者的源地址 - $context.stage：API调用的部署环境 - $context.apiName：API的名称 - $context.apiId：API的ID - $context.appName：API调用者的APP对象名称 - $context.appId：API调用者的APP对象ID - $context.requestId：当次API调用生成跟踪ID - $context.serverAddr：网关的服务器地址 - $context.serverName：网关的服务器名称 - $context.handleTime：本次API调用的处理时间 - $context.providerAppId：API拥有者的应用对象ID，暂不支持使用 前端认证参数取值：以"$context.authorizer.frontend."为前缀，如希望自定义认证校验通过返回的参数为aaa，那么此字段填写为$context.authorizer.frontend.aaa。 后端认证参数取值：以"$context.authorizer.backend."为前缀，如希望自定义认证校验通过返回的参数为aaa，那么此字段填写为$context.authorizer.backend.aaa。 | 表11PluginCommonParameter | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | type | 是 | String | 参数类型。支持的取值： - header：HTTP头域的第一个值 - query：QueryString的第一个值 - path：HTTP完整请求路径 - method：HTTP请求方法 - system：系统参数 | | name | 是 | String | 用于*rules* 的*parameters*的参数名称。 | | value | 是 | String | 参数来源值。 |