origin_failure_recovery_policy
Version: v2025-01-13 | Includes use: Yes |
---|
Behavior name: Origin Failure Recovery Policy
Configures how to detect origin failures, in which case the origin_failure_recovery_method
behavior applies. You can also define up to three sets of criteria to detect origin failure based on specific response codes. Use it to apply specific retry or recovery actions. You can do this using Property Manager. Learn more about this process in the Adaptive Media Delivery Implementation Guide.
You can use the origin_failure_recovery_method
member to edit existing instances of the Origin Failure Recover Method behavior.
Default behavior
These samples reflect the behavior's default settings. You can use these as is in your configurations or make adjustments based on the behavior's available options.
data "akamai_property_rules_builder" "origin_failure_recovery_policy" {
rules_v2025_02_18 {
name = "Origin Failure Recovery Policy"
comments = "Configures how to detect an origin failure."
behavior {
origin_failure_recovery_policy {
enabled = false
}
}
}
}
"behaviors": [
{
"name": "originFailureRecoveryPolicy",
"options": {
"enabled": false
}
}
]
Options
Option | Description |
---|---|
enabled |
Activates and configures a recovery policy.
|
enable_ip_avoidance |
Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the
configName established for origin_responsiveness_recovery_config_name is applied.
|
ip_avoidance_error_threshold |
Defines the number of failures that need to occur to an origin address before it's blocked.
|
ip_avoidance_retry_interval |
Defines the number of seconds after which the IP address is removed from the blocklist.
|
binary_equivalent_content |
Synchronizes content between the primary and backup origins, byte for byte.
|
monitor_origin_responsiveness |
Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
|
origin_responsiveness_timeout |
The timeout threshold that triggers a retry or recovery action. Value is one of:
|
origin_responsiveness_custom_timeout |
Specify a custom timeout, from 1 to 10 seconds.
|
origin_responsiveness_enable_retry |
If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
|
origin_responsiveness_enable_recovery |
Enables a recovery action for a specific failure condition.
|
origin_responsiveness_recovery_config_name |
Specifies a recovery configuration using the
configName you defined in the recovery_config match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recovery_config match criteria to apply this option.
|
monitor_status_codes1 |
Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
|
monitor_response_codes1 |
Defines the origin response codes that trigger a subsequent retry or recovery action. Specify a single code entry (
501 ) or a range (501:504 ). If you configure other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
|
monitor_status_codes1_enable_retry |
When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
|
monitor_status_codes1_enable_recovery |
Enables the recovery action for the response codes you define.
|
monitor_status_codes1_recovery_config_name |
Specifies a recovery configuration using the
configName you defined in the recovery_config match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recovery_config match criteria to apply this option.
|
monitor_status_codes2 |
Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
|
monitor_response_codes2 |
Defines the origin response codes that trigger a subsequent retry or recovery action. Specify a single code entry (
501 ) or a range (501:504 ). If you configure other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here.
|
monitor_status_codes2_enable_retry |
When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
|
monitor_status_codes2_enable_recovery |
Enables the recovery action for the response codes you define.
|
monitor_status_codes2_recovery_config_name |
Specifies a recovery configuration using the
configName you defined in the recovery_config match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recovery_config match criteria to apply this option.
|
monitor_status_codes3 |
Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
|
monitor_response_codes3 |
Defines the origin response codes that trigger a subsequent retry or recovery action. Specify a single code entry (
501 ) or a range (501:504 ). If you configure other monitorStatusCodes* and monitorResponseCodes* options, you can't use the same codes here..
|
monitor_status_codes3EnableRetry |
When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
|
monitor_status_codes3_enable_recovery |
Enables the recovery action for the response codes you define.
|
monitor_status_codes3_recovery_config_name |
Specifies a recovery configuration using the
configName you defined in the recovery_config match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recovery_config match criteria to apply this option.
|
Updated about 1 hour ago