- Property Manager name: Media Origin Failover
- Behavior version: The
v2023-01-05rule format supports themedia_origin_failoverbehavior v1.0. - Rule format status: GA, stable
- Access: Read/Write
- Allowed in includes: Yes
Specifies how edge servers respond when the origin is unresponsive, or suffers from server or content errors. You can specify how many times to retry, switch to a backup origin hostname, or configure a redirect.
| Option | Type | Description | Requires | |
|---|---|---|---|---|
detect_origin_unresponsive | boolean | Allows you to configure what happens when the origin is unresponsive. | {"displayType":"boolean","tag":"input","type":"checkbox"} | |
origin_unresponsive_detection_level | enum | Specify the level of response to slow origin connections. | detect_origin_unresponsive is true | {"displayType":"enum","options":["AGGRESSIVE","CONSERVATIVE","MODERATE"],"tag":"select"}{"if":{"attribute":"detectOriginUnresponsive","op":"eq","value":true}} |
AGGRESSIVE | Aggressive response. | |||
CONSERVATIVE | Conservative response. | |||
MODERATE | Moderate response. | |||
origin_unresponsive_blacklist_origin_ip | boolean | Enabling this blacklists the origin's IP address. | detect_origin_unresponsive is true | {"displayType":"boolean","tag":"input","type":"checkbox"}{"if":{"attribute":"detectOriginUnresponsive","op":"eq","value":true}} |
origin_unresponsive_blacklist_window | enum | This sets the delay before blacklisting an IP address. | origin_unresponsive_blacklist_origin_ip is true | {"displayType":"enum","options":["TEN_S","THIRTY_S"],"tag":"select"}{"if":{"attribute":"originUnresponsiveBlacklistOriginIp","op":"eq","value":true}} |
TEN_S | 10 seconds. | |||
THIRTY_S | 30 seconds. | |||
origin_unresponsive_recovery | enum | This sets the recovery option. | detect_origin_unresponsive is true | {"displayType":"enum","options":["RETRY_X_TIMES","SWITCH_TO_BACKUP_ORIGIN","REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION"],"tag":"select"}{"if":{"attribute":"detectOriginUnresponsive","op":"eq","value":true}} |
RETRY_X_TIMES | Retry. | |||
SWITCH_TO_BACKUP_ORIGIN | Switch to a backup origin. | |||
REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION | Redirect to a different origin. | |||
origin_unresponsive_retry_limit | enum | Sets how many times to retry. | origin_unresponsive_recovery is RETRY_X_TIMES | {"displayType":"enum","options":["ONE","TWO","THREE"],"tag":"select"}{"if":{"attribute":"originUnresponsiveRecovery","op":"eq","value":"RETRY_X_TIMES"}} |
Supported values: ONE THREE TWO | ||||
origin_unresponsive_backup_host | string | This specifies the origin hostname. | origin_unresponsive_recovery is SWITCH_TO_BACKUP_ORIGIN | {"displayType":"string","tag":"input","type":"text"}{"if":{"attribute":"originUnresponsiveRecovery","op":"eq","value":"SWITCH_TO_BACKUP_ORIGIN"}} |
origin_unresponsive_alternate_host | string | This specifies the redirect's destination hostname. | origin_unresponsive_recovery is REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION | {"displayType":"string","tag":"input","type":"text"}{"if":{"attribute":"originUnresponsiveRecovery","op":"eq","value":"REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION"}} |
origin_unresponsive_modify_request_path | boolean | Modifies the request path. | origin_unresponsive_recovery is SWITCH_TO_BACKUP_ORIGINOR origin_unresponsive_recovery is REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION | {"displayType":"boolean","tag":"input","type":"checkbox"}{"if":{"op":"or","params":[{"attribute":"originUnresponsiveRecovery","op":"eq","value":"SWITCH_TO_BACKUP_ORIGIN"},{"attribute":"originUnresponsiveRecovery","op":"eq","value":"REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION"}]}} |
origin_unresponsive_modified_path | string | This specifies the path to form the new URL. | origin_unresponsive_modify_request_path is true | {"displayType":"string","tag":"input","type":"text"}{"if":{"attribute":"originUnresponsiveModifyRequestPath","op":"eq","value":true}} |
origin_unresponsive_include_query_string | boolean | Enabling this includes the original set of query parameters. | origin_unresponsive_modify_request_path is true | {"displayType":"boolean","tag":"input","type":"checkbox"}{"if":{"attribute":"originUnresponsiveModifyRequestPath","op":"eq","value":true}} |
origin_unresponsive_redirect_method | enum | Specifies the redirect response code. | origin_unresponsive_recovery is REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION | {"displayType":"enum","options":["301","302"],"tag":"select"}{"if":{"attribute":"originUnresponsiveRecovery","op":"eq","value":"REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION"}} |
Supported values: 301 302 | ||||
origin_unresponsive_change_protocol | boolean | This allows you to change the request protocol. | origin_unresponsive_recovery is SWITCH_TO_BACKUP_ORIGINOR origin_unresponsive_recovery is REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION | {"displayType":"boolean","tag":"input","type":"checkbox"}{"if":{"op":"or","params":[{"attribute":"originUnresponsiveRecovery","op":"eq","value":"SWITCH_TO_BACKUP_ORIGIN"},{"attribute":"originUnresponsiveRecovery","op":"eq","value":"REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION"}]}} |
origin_unresponsive_protocol | enum | Specifies which protocol to use. | origin_unresponsive_change_protocol is true | {"displayType":"enum","options":["HTTP","HTTPS"],"tag":"select"}{"if":{"attribute":"originUnresponsiveChangeProtocol","op":"eq","value":true}} |
Supported values: HTTP HTTPS | ||||
detect_origin_unavailable | boolean | Allows you to configure failover settings when the origin server responds with errors. | {"displayType":"boolean","tag":"input","type":"checkbox"} | |
origin_unavailable_detection_level | enum | Specify | detect_origin_unavailable is true | {"displayType":"enum","options":["RESPONSE_CODES"],"tag":"select"}{"if":{"attribute":"detectOriginUnavailable","op":"eq","value":true}} |
RESPONSE_CODES | This is the only value currently available. | |||
origin_unavailable_response_codes | string array | Specifies the set of response codes identifying when the origin responds with errors. | detect_origin_unavailable is true | {"displayType":"string array","tag":"input","todo":true}{"if":{"attribute":"detectOriginUnavailable","op":"eq","value":true}} |
origin_unavailable_blacklist_origin_ip | boolean | Enabling this blacklists the origin's IP address. | detect_origin_unavailable is true | {"displayType":"boolean","tag":"input","type":"checkbox"}{"if":{"attribute":"detectOriginUnavailable","op":"eq","value":true}} |
origin_unavailable_blacklist_window | enum | This sets the delay before blacklisting an IP address. | origin_unavailable_blacklist_origin_ip is true | {"displayType":"enum","options":["TEN_S","THIRTY_S"],"tag":"select"}{"if":{"attribute":"originUnavailableBlacklistOriginIp","op":"eq","value":true}} |
TEN_S | 10 seconds. | |||
THIRTY_S | 30 seconds. | |||
origin_unavailable_recovery | enum | This sets the recovery option. | detect_origin_unavailable is true | {"displayType":"enum","options":["RETRY_X_TIMES","SWITCH_TO_BACKUP_ORIGIN","REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION"],"tag":"select"}{"if":{"attribute":"detectOriginUnavailable","op":"eq","value":true}} |
RETRY_X_TIMES | Retry. | |||
SWITCH_TO_BACKUP_ORIGIN | Switch to a backup origin. | |||
REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION | Redirect to a different origin. | |||
origin_unavailable_retry_limit | enum | Sets how many times to retry. | origin_unavailable_recovery is RETRY_X_TIMES | {"displayType":"enum","options":["ONE","TWO","THREE"],"tag":"select"}{"if":{"attribute":"originUnavailableRecovery","op":"eq","value":"RETRY_X_TIMES"}} |
Supported values: ONE THREE TWO | ||||
origin_unavailable_backup_host | string | This specifies the origin hostname. | origin_unavailable_recovery is SWITCH_TO_BACKUP_ORIGIN | {"displayType":"string","tag":"input","type":"text"}{"if":{"attribute":"originUnavailableRecovery","op":"eq","value":"SWITCH_TO_BACKUP_ORIGIN"}} |
origin_unavailable_alternate_host | string | This specifies the redirect's destination hostname. | origin_unavailable_recovery is REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION | {"displayType":"string","tag":"input","type":"text"}{"if":{"attribute":"originUnavailableRecovery","op":"eq","value":"REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION"}} |
origin_unavailable_modify_request_path | boolean | Modifies the request path. | origin_unavailable_recovery is SWITCH_TO_BACKUP_ORIGINOR origin_unavailable_recovery is REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION | {"displayType":"boolean","tag":"input","type":"checkbox"}{"if":{"op":"or","params":[{"attribute":"originUnavailableRecovery","op":"eq","value":"SWITCH_TO_BACKUP_ORIGIN"},{"attribute":"originUnavailableRecovery","op":"eq","value":"REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION"}]}} |
origin_unavailable_modified_path | string | This specifies the path to form the new URL. | origin_unavailable_modify_request_path is true | {"displayType":"string","tag":"input","type":"text"}{"if":{"attribute":"originUnavailableModifyRequestPath","op":"eq","value":true}} |
origin_unavailable_include_query_string | boolean | Enabling this includes the original set of query parameters. | origin_unavailable_modify_request_path is true | {"displayType":"boolean","tag":"input","type":"checkbox"}{"if":{"attribute":"originUnavailableModifyRequestPath","op":"eq","value":true}} |
origin_unavailable_redirect_method | enum | Specifies either a redirect response code. | origin_unavailable_recovery is REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION | {"displayType":"enum","options":["301","302"],"tag":"select"}{"if":{"attribute":"originUnavailableRecovery","op":"eq","value":"REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION"}} |
Supported values: 301 302 | ||||
origin_unavailable_change_protocol | boolean | Modifies the request protocol. | origin_unavailable_recovery is SWITCH_TO_BACKUP_ORIGINOR origin_unavailable_recovery is REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION | {"displayType":"boolean","tag":"input","type":"checkbox"}{"if":{"op":"or","params":[{"attribute":"originUnavailableRecovery","op":"eq","value":"SWITCH_TO_BACKUP_ORIGIN"},{"attribute":"originUnavailableRecovery","op":"eq","value":"REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION"}]}} |
origin_unavailable_protocol | enum | Specifies either the | origin_unavailable_change_protocol is true | {"displayType":"enum","options":["HTTP","HTTPS"],"tag":"select"}{"if":{"attribute":"originUnavailableChangeProtocol","op":"eq","value":true}} |
Supported values: HTTP HTTPS | ||||
detect_object_unavailable | boolean | Allows you to configure failover settings when the origin has content errors. | {"displayType":"boolean","tag":"input","type":"checkbox"} | |
object_unavailable_detection_level | enum | Specify | detect_object_unavailable is true | {"displayType":"enum","options":["RESPONSE_CODES"],"tag":"select"}{"if":{"attribute":"detectObjectUnavailable","op":"eq","value":true}} |
RESPONSE_CODES | This is the only value currently available. | |||
object_unavailable_response_codes | string array | Specifies the set of response codes identifying when there are content errors. | detect_object_unavailable is true | {"displayType":"string array","tag":"input","todo":true}{"if":{"attribute":"detectObjectUnavailable","op":"eq","value":true}} |
object_unavailable_blacklist_origin_ip | boolean | Enabling this blacklists the origin's IP address. | detect_object_unavailable is true | {"displayType":"boolean","tag":"input","type":"checkbox"}{"if":{"attribute":"detectObjectUnavailable","op":"eq","value":true}} |
object_unavailable_blacklist_window | enum | This sets the delay before blacklisting an IP address. | object_unavailable_blacklist_origin_ip is true | {"displayType":"enum","options":["TEN_S","THIRTY_S"],"tag":"select"}{"if":{"attribute":"objectUnavailableBlacklistOriginIp","op":"eq","value":true}} |
TEN_S | 10 seconds. | |||
THIRTY_S | 30 seconds. | |||
object_unavailable_recovery | enum | This sets the recovery option. | detect_object_unavailable is true | {"displayType":"enum","options":["RETRY_X_TIMES","SWITCH_TO_BACKUP_ORIGIN","REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION"],"tag":"select"}{"if":{"attribute":"detectObjectUnavailable","op":"eq","value":true}} |
RETRY_X_TIMES | Retry. | |||
SWITCH_TO_BACKUP_ORIGIN | Switch to a backup origin. | |||
REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION | Redirect to a different origin. | |||
object_unavailable_retry_limit | enum | Sets how many times to retry. | object_unavailable_recovery is RETRY_X_TIMES | {"displayType":"enum","options":["ONE","TWO","THREE"],"tag":"select"}{"if":{"attribute":"objectUnavailableRecovery","op":"eq","value":"RETRY_X_TIMES"}} |
Supported values: ONE THREE TWO | ||||
object_unavailable_backup_host | string | This specifies the origin hostname. | object_unavailable_recovery is SWITCH_TO_BACKUP_ORIGIN | {"displayType":"string","tag":"input","type":"text"}{"if":{"attribute":"objectUnavailableRecovery","op":"eq","value":"SWITCH_TO_BACKUP_ORIGIN"}} |
object_unavailable_alternate_host | string | This specifies the redirect's destination hostname. | object_unavailable_recovery is REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION | {"displayType":"string","tag":"input","type":"text"}{"if":{"attribute":"objectUnavailableRecovery","op":"eq","value":"REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION"}} |
object_unavailable_modify_request_path | boolean | Enabling this allows you to modify the request path. | object_unavailable_recovery is SWITCH_TO_BACKUP_ORIGINOR object_unavailable_recovery is REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION | {"displayType":"boolean","tag":"input","type":"checkbox"}{"if":{"op":"or","params":[{"attribute":"objectUnavailableRecovery","op":"eq","value":"SWITCH_TO_BACKUP_ORIGIN"},{"attribute":"objectUnavailableRecovery","op":"eq","value":"REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION"}]}} |
object_unavailable_modified_path | string | This specifies the path to form the new URL. | object_unavailable_modify_request_path is true | {"displayType":"string","tag":"input","type":"text"}{"if":{"attribute":"objectUnavailableModifyRequestPath","op":"eq","value":true}} |
object_unavailable_include_query_string | boolean | Enabling this includes the original set of query parameters. | object_unavailable_modify_request_path is true | {"displayType":"boolean","tag":"input","type":"checkbox"}{"if":{"attribute":"objectUnavailableModifyRequestPath","op":"eq","value":true}} |
object_unavailable_redirect_method | enum | Specifies a redirect response code. | object_unavailable_recovery is REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION | {"displayType":"enum","options":["301","302"],"tag":"select"}{"if":{"attribute":"objectUnavailableRecovery","op":"eq","value":"REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION"}} |
Supported values: 301 302 | ||||
object_unavailable_change_protocol | boolean | Changes the request protocol. | object_unavailable_recovery is SWITCH_TO_BACKUP_ORIGINOR object_unavailable_recovery is REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION | {"displayType":"boolean","tag":"input","type":"checkbox"}{"if":{"op":"or","params":[{"attribute":"objectUnavailableRecovery","op":"eq","value":"SWITCH_TO_BACKUP_ORIGIN"},{"attribute":"objectUnavailableRecovery","op":"eq","value":"REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION"}]}} |
object_unavailable_protocol | enum | Specifies either the | object_unavailable_change_protocol is true | {"displayType":"enum","options":["HTTP","HTTPS"],"tag":"select"}{"if":{"attribute":"objectUnavailableChangeProtocol","op":"eq","value":true}} |
Supported values: HTTP HTTPS | ||||
client_response_code | string | Specifies the response code served to the client. | {"displayType":"string","tag":"input","type":"text"} | |
cache_error_response | boolean | When enabled, caches the error response. | {"displayType":"boolean","tag":"input","type":"checkbox"} | |
cache_window | enum | This sets error response's TTL. | cache_error_response is true | {"displayType":"enum","options":["ONE_S","TEN_S","THIRTY_S"],"tag":"select"}{"if":{"attribute":"cacheErrorResponse","op":"eq","value":true}} |
ONE_S | 1 second. | |||
TEN_S | 10 seconds. | |||
THIRTY_S | 30 seconds. |