apiPrioritization


Enables the API Prioritization Cloudlet, which maintains continuity in user experience by serving an alternate static response when load is too high. You can configure rules using either the Cloudlets Policy Manager application or the Cloudlets API. Use this feature serve static API content, such as fallback JSON data. To serve non-API HTML content, use the visitor‚ÄčPrioritization behavior.

OptionTypeDescriptionRequires
enabledboolean

Activates the API Prioritization feature.

{"displayType":"boolean","tag":"input","type":"checkbox"}
cloudlet‚ÄčPolicyobject

Identifies the Cloudlet policy.

{"displayType":"object","tag":"input","todo":true}
{"if":{"attribute":"enabled","op":"eq","value":true}}
cloudlet‚ÄčPolicy.idnumber

Identifies the Cloudlet.

cloudlet‚ÄčPolicy.namestring

The Cloudlet's descriptive name.

labelstring

A label to distinguish this API Prioritization policy from any others in the same property.

{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"enabled","op":"eq","value":true}}
use‚ÄčThrottled‚ÄčCp‚ÄčCodeboolean

Specifies whether to apply an alternative CP code for requests served the alternate response.

{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"enabled","op":"eq","value":true}}
throttled‚ÄčCp‚ÄčCodeobject

Specifies the CP code as an object.

use‚ÄčThrottled‚ÄčCp‚ÄčCode is true
{"displayType":"object","tag":"input","todo":true}
{"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"useThrottledCpCode","op":"eq","value":true}]}}
throttled‚ÄčCp‚ÄčCode.descriptionstring

Additional description for the CP code.

throttled‚ÄčCp‚ÄčCode.idinteger

Unique identifier for each CP code.

throttled‚ÄčCp‚ÄčCode.namestring

The name of the CP code.

throttled‚ÄčCp‚ÄčCode.productsarray

The set of products the CP code is assigned to.

use‚ÄčThrottled‚ÄčStatus‚ÄčCodeboolean

Allows you to assign a specific HTTP response code to a throttled request.

{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"enabled","op":"eq","value":true}}
throttled‚ÄčStatus‚ÄčCodenumber

Specifies the HTTP response code for requests that receive the alternate response.

use‚ÄčThrottled‚ÄčStatus‚ÄčCode is true
{"displayType":"number","tag":"input","type":"number"}
{"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"useThrottledStatusCode","op":"eq","value":true}]}}
net‚ÄčStorageobject

Specify the Net‚ÄčStorage domain that contains the alternate response.

{"displayType":"object","tag":"input","todo":true}
{"if":{"attribute":"enabled","op":"eq","value":true}}
net‚ÄčStorage.cp‚ÄčCode‚ÄčListarray

A set of CP codes that apply to this storage group.

net‚ÄčStorage.download‚ÄčDomain‚ÄčNamestring

Domain name from which content can be downloaded.

net‚ÄčStorage.idnumber

Unique identifier for the storage group.

net‚ÄčStorage.namestring

Name of the storage group.

net‚ÄčStorage.upload‚ÄčDomain‚ÄčNamestring

Domain name used to upload content.

net‚ÄčStorage‚ÄčPathstring

Specify the full Net‚ÄčStorage path for the alternate response, including trailing file name.

{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"enabled","op":"eq","value":true}}
alternate‚ÄčResponse‚ÄčCache‚ÄčTtlnumber (5-30)

Specifies the alternate response's time to live in the cache, 5 minutes by default.

{"displayType":"number","max":[30],"min":[5],"tag":"input","type":"range"}
{"if":{"attribute":"enabled","op":"eq","value":true}}