Create a cache overload profile

post https://{hostname}/api/lcdn-services/v1/hypercache/cache-overload-profiles

This operation creates a new cache overload profile instance.

Body Params

name

string

required

length between 1 and 128

A unique name assigned to the HPC Overload Profile. The minumum length is 1 and the maximum length is 128.

lowPriorityLoadThresholdPercent

integer

0 to 90

Defaults to 60

A value between 0 and 90 that represents the load capacity threshold above which LCDN nodes only accepts medium and high prefix traffic. Ensure that the low-priority traffic value you specify is equal to or less than the medium-priority traffic value. An HPC is considered overloaded for low-priority traffic when its average load capacity exceeds the configured load capacity threshold.

mediumPriorityLoadThresholdPercent

integer

0 to 90

Defaults to 70

A value between 0 and 90 that represents the load capacity threshold above which nodes only accepts high priority prefix traffic. Ensure that the medium-priority traffic value you specify is equal to or less than the high-priority traffic value. An HPC is considered overloaded for medium priority traffic when its average load capacity exceeds the configured load capacity threshold.

highPriorityLoadThresholdPercent

integer

0 to 90

Defaults to 80

A value between 0 and 90 that represents the load capacity threshold above which the HPC nodes should be considered overloaded.

lowPriorityBandwidthThresholdPercent

integer

0 to 100

Defaults to 100

A value between 0 and 100 that represents the bandwidth capacity threshold above which nodes only accepts medium and high priority prefix traffic. Ensure that the low-priority traffic value you specify is equal to or less than the medium-priority traffic value. An HPC is considered overloaded for low-priority traffic when its average bandwidth capacity exceeds the configured bandwidth capacity threshold.

mediumPriorityBandwidthThresholdPercent

integer

0 to 100

Defaults to 100

A value between 0 and 100 that represents the bandwidth capacity threshold above which nodes only accepts high priority prefix traffic. Ensure that the medium-priority traffic you specify is equal to or less than the high-priority traffic value. An HPC is considered overloaded for medium-priority traffic when its average bandwidth capacity exceeds the configured bandwidth capacity threshold.

highPriorityBandwidthThresholdPercent

integer

0 to 100

Defaults to 100

A value between 0 and 100 that represents the bandwidth capacity threshold above which the HPC nodes should be considered overloaded.

overloadAction

object

Overload action types are measures that HPCs take when the traffic levels for load average and bandwidth thresholds on HPCs exceed the configured load and bandwidth capacity thresholds. Reject Connection Overload Action Type tells the HPC to reject the persistent connection without sending an HTTP response header or disallow HPCs from rejecting the persistent connection. Site Redirect Overload Action Type tells the HPC to issue a 302 response redirecting HTTP client requests to another HPC in the site that is not overloaded. HTTP Response Code Options Overload Action Type lets you choose from among a list HTTP response codes that you want the HPC to return for a client request, when the HPC load exceeds the configured thresholds.

Responses

Response body

object

cacheOverloadProfileId

integer

required

≥ 1

The unique identifier assigned to the HPC Overload Profile.

name

string

required

length between 1 and 128

A unique name assigned to the HPC Overload Profile. The minumum length is 1 and the maximum length is 128.

lowPriorityLoadThresholdPercent

integer

0 to 90

Defaults to 60

mediumPriorityLoadThresholdPercent

integer

0 to 90

Defaults to 70

highPriorityLoadThresholdPercent

integer

0 to 90

Defaults to 80

A value between 0 and 90 that represents the load capacity threshold above which the HPC nodes should be considered overloaded.

lowPriorityBandwidthThresholdPercent

integer

0 to 100

Defaults to 100

mediumPriorityBandwidthThresholdPercent

integer

0 to 100

Defaults to 100

highPriorityBandwidthThresholdPercent

integer

0 to 100

Defaults to 100

A value between 0 and 100 that represents the bandwidth capacity threshold above which the HPC nodes should be considered overloaded.

overloadAction

object

Headers

object

Location

string

The location header specifies a URI pointing to the newly created resource.

Language

Credentials

OAuth2

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://hostname/api/lcdn-services/v1/hypercache/cache-overload-profiles \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
15
 
1
{
2
  "lowPriorityLoadThresholdPercent": 60,
3
  "mediumPriorityLoadThresholdPercent": 70,
4
  "highPriorityLoadThresholdPercent": 80,
5
  "lowPriorityBandwidthThresholdPercent": 100,
6
  "mediumPriorityBandwidthThresholdPercent": 100,
7
  "highPriorityBandwidthThresholdPercent": 100,
8
  "cacheOverloadProfileId": 1389,
9
  "name": "profile4",
10
  "overloadAction": {
11
    "action": "SITE_REDIRECT",
12
    "redirectMode": "CLIENT_IP",
13
    "enablePersistentConnectionClose": false
14
  }
15
}

200Successful response

201An HTTP 201 will be returned if the request is successfully processed, and a new cache-overload-profile object is created. The location of the new object will be specified in the location header.

400An HTTP 400 will be returned if the request is badly formed or has constraint violations

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.

409An HTTP 409 will be returned if the cache-memory-profile offered for create/update would lead to a conflicting state.