- Property Manager name: API Prioritization Cloudlet
- Behavior version: The
v2023-01-05rule format supports theapi_prioritizationbehavior v2.2. - Rule format status: GA, stable
- Access: Read/Write
- Allowed in includes: Yes
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.
| Option | Type | Description | Requires | |
|---|---|---|---|---|
enabled | boolean | Activates the API Prioritization feature. | {"displayType":"boolean","tag":"input","type":"checkbox"} | |
cloudlet_policy | object | Identifies the Cloudlet policy. | {"displayType":"object","tag":"input","todo":true}{"if":{"attribute":"enabled","op":"eq","value":true}} | |
cloudlet_policy.id | number | Identifies the Cloudlet. | ||
cloudlet_policy.name | string | The Cloudlet's descriptive name. | ||
label | string | 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_code | boolean | 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_code | object | 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.description | string | Additional description for the CP code. | ||
throttled_cp_code.id | integer | Unique identifier for each CP code. | ||
throttled_cp_code.name | string | The name of the CP code. | ||
throttled_cp_code.products | array | The set of products the CP code is assigned to. | ||
use_throttled_status_code | boolean | 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_code | number | 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_storage | object | Specify the NetStorage domain that contains the alternate response. | {"displayType":"object","tag":"input","todo":true}{"if":{"attribute":"enabled","op":"eq","value":true}} | |
net_storage.cpCodeList | array | A set of CP codes that apply to this storage group. | ||
net_storage.downloadDomainName | string | Domain name from which content can be downloaded. | ||
net_storage.id | number | Unique identifier for the storage group. | ||
net_storage.name | string | Name of the storage group. | ||
net_storage.uploadDomainName | string | Domain name used to upload content. | ||
net_storagePath | string | Specify the full NetStorage 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_ttl | number (5-30) | Specifies the alternate response's time to live in the cache, | {"displayType":"number","max":[30],"min":[5],"tag":"input","type":"range"}{"if":{"attribute":"enabled","op":"eq","value":true}} |