GuideReference
TrainingSupportCommunity

origin_​failure_​recovery_​policy


Configures how to detect an origin failure, 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 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.

OptionTypeDescriptionRequires
enabledboolean

Activates and configures a recovery policy.

{"displayType":"boolean","tag":"input","type":"checkbox"}
enable_​ip_​avoidanceboolean

Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the config​Name established for origin_​responsiveness_​recovery_​config_​name is applied.

{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"enabled","op":"eq","value":true}}
ip_​avoidance_​error_​thresholdnumber

Defines the number of failures that need to occur to an origin address before it's blocked.

enable_​ip_​avoidance is true
{"displayType":"number","tag":"input","type":"number"}
{"if":{"attribute":"enableIPAvoidance","op":"eq","value":true}}
ip_​avoidance_​retry_​intervalnumber

Defines the number of seconds after which the IP address is removed from the blocklist.

enable_​ip_​avoidance is true
{"displayType":"number","tag":"input","type":"number"}
{"if":{"attribute":"enableIPAvoidance","op":"eq","value":true}}
binary_​equivalent_​contentboolean

Synchronizes content between the primary and backup origins, byte for byte.

{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"enabled","op":"eq","value":true}}
monitor_​origin_​responsivenessboolean

Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.

{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"enabled","op":"eq","value":true}}
origin_​responsiveness_​timeoutenum

The timeout threshold that triggers a retry or recovery action.

monitor_​origin_​responsiveness is true
{"displayType":"enum","options":["AGGRESSIVE","MODERATE","CONSERVATIVE","USER_SPECIFIED"],"tag":"select"}
{"if":{"attribute":"monitorOriginResponsiveness","op":"eq","value":true}}
AGGRESSIVE

A 2 second threshold.

MODERATE

3 seconds.

CONSERVATIVE

4 seconds.

USER_​SPECIFIED

Specify your own timeout.

origin_​responsiveness_​custom_​timeoutnumber

Specify a custom timeout, from 1 to 10 seconds.

origin_​responsiveness_​timeout is USER_​SPECIFIED
{"displayType":"number","tag":"input","type":"number"}
{"if":{"attribute":"originResponsivenessTimeout","op":"eq","value":"USER_SPECIFIED"}}
origin_​responsiveness_​enable_​retryboolean

If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.

monitor_​origin_​responsiveness is true
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"monitorOriginResponsiveness","op":"eq","value":true}}
origin_​responsiveness_​enable_​recoveryboolean

Enables a recovery action for a specific failure condition.

monitor_​origin_​responsiveness is true
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"monitorOriginResponsiveness","op":"eq","value":true}}
origin_​responsiveness_​recovery_​config_​namestring

Specifies a recovery configuration using the config​Name 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.

origin_​responsiveness_​enable_​recovery is true
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"originResponsivenessEnableRecovery","op":"eq","value":true}}
monitor_​status_​codes1boolean

Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.

{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"enabled","op":"eq","value":true}}
monitor_​response_​codes1string array

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 monitor​Status​Codes* and monitor​Response​Codes* options, you can't use the same codes here.

monitor_​status_​codes1 is true
{"displayType":"string array","tag":"input","todo":true}
{"if":{"attribute":"monitorStatusCodes1","op":"eq","value":true}}
monitor_​status_​codes1Enable​Retryboolean

When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.

monitor_​status_​codes1 is true
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"monitorStatusCodes1","op":"eq","value":true}}
monitor_​status_​codes1Enable​Recoveryboolean

Enables the recovery action for the response codes you define.

monitor_​status_​codes1 is true
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"monitorStatusCodes1","op":"eq","value":true}}
monitor_​status_​codes1Recovery​Config​Namestring

Specifies a recovery configuration using the config​Name 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_​codes1Enable​Recovery is true
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"monitorStatusCodes1EnableRecovery","op":"eq","value":true}}
monitor_​status_​codes2boolean

Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.

{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"enabled","op":"eq","value":true}}
monitor_​response_​codes2string array

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 monitor​Status​Codes* and monitor​Response​Codes* options, you can't use the same codes here.

monitor_​status_​codes2 is true
{"displayType":"string array","tag":"input","todo":true}
{"if":{"attribute":"monitorStatusCodes2","op":"eq","value":true}}
monitor_​status_​codes2Enable​Retryboolean

When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.

monitor_​status_​codes2 is true
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"monitorStatusCodes2","op":"eq","value":true}}
monitor_​status_​codes2Enable​Recoveryboolean

Enables the recovery action for the response codes you define.

monitor_​status_​codes2 is true
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"monitorStatusCodes2","op":"eq","value":true}}
monitor_​status_​codes2Recovery​Config​Namestring

Specifies a recovery configuration using the config​Name 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_​codes2Enable​Recovery is true
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"monitorStatusCodes2EnableRecovery","op":"eq","value":true}}
monitor_​status_​codes3boolean

Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.

{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"enabled","op":"eq","value":true}}
monitor_​response_​codes3string array

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 monitor​Status​Codes* and monitor​Response​Codes* options, you can't use the same codes here..

monitor_​status_​codes3 is true
{"displayType":"string array","tag":"input","todo":true}
{"if":{"attribute":"monitorStatusCodes3","op":"eq","value":true}}
monitor_​status_​codes3Enable​Retryboolean

When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.

monitor_​status_​codes3 is true
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"monitorStatusCodes3","op":"eq","value":true}}
monitor_​status_​codes3Enable​Recoveryboolean

Enables the recovery action for the response codes you define.

monitor_​status_​codes3 is true
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"monitorStatusCodes3","op":"eq","value":true}}
monitor_​status_​codes3Recovery​Config​Namestring

Specifies a recovery configuration using the config​Name 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_​codes3Enable​Recovery is true
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"monitorStatusCodes3EnableRecovery","op":"eq","value":true}}