Get HyperCache service settings

get https://{hostname}/api/lcdn-services/v1/hypercache

This operation retrieves details about global HyperCache service configuration settings.

Responses

Response body

object

lastMileAcceleration

object

Specify the types of content you want to compress and the types of clients you want to exclude from receiving compressed content. When configured globally across all HyperCache nodes on an LCDN, Last Mile Acceleration uses a predefined default list of compressed content types and a predefined set of client types that can't receive compressed content.

compressionLevel

integer

1 to 9

Defaults to 6

Specify a value that determines the degree to which the content is compressed, from 1 to 9 in increased compression.

enable

boolean

Defaults to false

Enable Last Mile Acceleration globally, across all HyperCache nodes in the LCDN, except for content associated with specific URI filters that you configure on a per-URI filter basis.

originOverloadProtection

object

Enables HPCs to detect origin server overload and limit the ingest requests sent to an origin server. Under certain circumstances, an origin server becomes overloaded with more ingest requests than the origin can handle.

throttleProfile

string

Defaults to NONE

A preconfigured list of profiles that defines how HPCs react to different levels of overload errors, how they manage new requests, and how they determine when the overload has subsided. These profiles apply to all origins and all HPCs in the LCDN. Apply FAST or HEAVY to throttle fewer new requests, LIGHT to throttle more, or NONE to disable throttling.

NONE LIGHT HEAVY FAST

responseCodes

array of strings

length ≤ 256

Defaults to 500,503,504

A list of response codes that the origin server returns for an ingest request, when the origin server is overloaded. Each string in the array must contain 3 digits, with no whitespace, tabs, or carriage returns allowed.

responseCodes

individualQueueMaximum

integer

0 to 2147483647

Defaults to 0

The maximum number of ingest requests that the HPC can hold in the throttle queue for any individual origin server IP address, before the HPC begins to drop ingest requests to that origin server. Specify the maximum value in kilobytes.

ingestTcpReceiveBufferSizeKB

integer

64 to 8192

Defaults to 64

Specifies the size of the receive buffer, in kilobytes, for the socket that the HPC uses to ingest content. The value you specify depends on the ingest bandwidth and round trip delay.

interSiteTcpTransmitBufferSizeKB

integer

64 to 8192

Defaults to 64

Specifies the size of the transmit buffers, in kilobytes, from HPC parent nodes to child nodes and transmit buffers between HPC nodes in a site.

enableTcpSlowStartOnIdleConnection

boolean

Defaults to true

Controls or regulates the amount of data that an HPC parent node can send over a new TCP connection with the amount of data an HPC child node can accept.

frontEndCaching

object

The front-end caching types you can specify to minimize CPU processing when serving popular content.

maxObjectSizeMB

integer

4 to 2147483647

Defaults to 10

The maximum object size, in megabytes. The HPC doesn't cache objects larger than the object size you specify in front-end cache.

maxIngestDelayMs

integer

0 to 2147483647

Defaults to 0

Indicates the maximum amount of time, in milliseconds, that the HPC can delay client requests for objects that are currently being ingested by front-end cache. A setting of zero specifies that no ingest delay occurs for client requests.

minUseCount

integer

1 to 2147483647

Defaults to 1

The minimum number of client requests for an object before the HPC attempts to cache the object in front-end cache. If the number of client requests is less than the value specified, the HPC doesn't use front-end caching for the requested object. Instead, the HPC proceeds with the normal caching flow.

cacheRangeMode

string

Defaults to OFF

Specifies the front-end cache range request behavior. OFF indicates that the HPC doesn't cache range requests in front-end cache. This is the default. RANGE indicates that the HyperCache includes the range as part of the cache key. OBJECT indicates that upon receiving a new client range request, the HPC attempts to ingest and cache the entire object if the object does not reside in front-end cache or the HPC serves the requested range to the client with a 206 response code if the object resides in front-end cache.

OFF RANGE OBJECT

enablePragmaHeaders

boolean

Defaults to false

Pragma header support is disabled by default on all HPC nodes configured on the LCDN. When enabled, the HPC node receives HTML requests that include Pragma headers.

keepAliveRequestLimit

integer

0 to 100000

Defaults to 100000

Sets the number of requests that the HPC can serve to clients using one persistent connection. After the HPC serves the configured number of requests, the connection is closed.

xxxxxxxxxx
 
{
  "ingestTcpReceiveBufferSizeKB": 64,
  "interSiteTcpTransmitBufferSizeKB": 64,
  "enableTcpSlowStartOnIdleConnection": true,
  "enablePragmaHeaders": false,
  "enableQuickRecoveryMode": false,
  "keepAliveRequestLimit": 100000,
  "frontEndCaching": {
    "maxObjectSizeMB": 10,
    "maxIngestDelayMs": 0,
    "minUseCount": 1,
    "cacheRangeMode": "OFF"
  },
  "originOverloadProtection": {
    "throttleProfile": "NONE",
    "individualQueueMaximum": 0,
    "responseCodes": []
  },
  "lastMileAcceleration": {
    "enable": false
  }
}

200Successful response

403An HTTP 403 will be returned if the principal is not authorized to access the instance of cache-hierarchy that the request was made against.