Update a load balancing version

put https://{hostname}/cloudlets/api/v2/origins/{originId}/versions/{version}

Use this operation to update a selected load balancer version. You cannot edit a load balancer version that has ever been activated.

Path Params

version

number

required

The version number of the policy.

originId

string

required

Unique identifier for the origin.

Query Params

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

balancingType

string

The type of load balancing, either WEIGHTED or PERFORMANCE.

dataCenters

array of objects

length between 1 and 199

The object containing information on conditional origins being used as data centers for an Application Load Balancer implementation, as detailed below. Only conditional origins with an originType of CUSTOMER or NETSTORAGE can be used as data centers in an Application Load Balancer configuration.

dataCenters

deleted

boolean

If true, the conditional origin version has been deleted. If you set this member to false, you can use this version again.

description

string

The description of the load balancing configuration provided by a user.

livenessSettings

object

The object containing information on the liveness settings for an Application Load Balancer implementation, as detailed below.

originId

string

length between 2 and 62

The conditional origin's unique identifier.

Response

Response body

object

balancingType

string

The type of load balancing, either WEIGHTED or PERFORMANCE.

WEIGHTED PERFORMANCE

createdBy

string

The name of the user who created this load balancing configuration.

createdDate

date-time

The time, in ISO 8601 format, when this load balancing configuration was created.

dataCenters

array of objects

length between 1 and 199

dataCenters

object

city

string

The city in which the data center is located.

cloudServerHostHeaderOverride

boolean

When set to true, overides the host header for load balancing in a cloud environment.

cloudService

boolean

required

If true, caching for the data center is updated at a certain interval, like it would for a cloud-based service.

continent

string

required

The continent on which the data center is located. See Continent Codes for a list of valid codes.

AF AS EU NA OC OT SA

country

string

required

length between 2 and 2

The country in which the data center is located. See Country Codes for a list of valid codes.

hostname

string

length ≤ 256

The name of the host that can be used as a conditional origin.

latitude

number

required

-180 to 180

The latitude value for the data center. This member supports six decimal places of precision.

livenessHosts

array of strings

length ≥ 1

An array of strings that represent the origin servers used to poll the data centers in an Application Load Balancer configuration. These servers support basic HTTP polling.

livenessHosts

longitude

number

required

-180 to 180

The longitude value for the data center. This member supports six decimal places of precision.

originId

string

required

length ≤ 128

The conditional origin's unique identifier.

percent

number

required

0 to 100

The percent of traffic that is sent to the data center. The total for all dataCenters objects within the array must equal 100%.

stateOrProvince

string

The state, province, or region where the data center is located. See region codes.

deleted

boolean

If true, the conditional origin version has been deleted. If you set this member to false, you can use this version again.

description

string

The description of the load balancing configuration provided by a user.

immutable

boolean

Indicated whether you can edit the load balancing version. The default is false. It automatically becomes true when the load balancing version is activated for the first time.

lastModifiedBy

string

The user who last modified the load balancing configuration.

lastModifiedDate

date-time

The time, in ISO 8601 format, when the initial load balancing configuration was last modified.

livenessSettings

object

The object containing information on the liveness settings for an Application Load Balancer implementation, as detailed below.

Has additional fields

originId

string

length between 2 and 62

The conditional origin's unique identifier.

version

integer

≥ 0

The version number of the activated load balancing configuration.

warnings

array of objects

Provides error response data to help diagnose the problem that led to the error.

warnings

object

detail

string

required

Provides actionable instructions to diagnose the problem that caused the error.

errors

array of objects

Error objects that provide information for debugging.

errors

object

detail

string

required

Provides actionable instructions to diagnose the problem that caused the error.

errors

array of objects

Error objects that provide information for debugging.

errors

object

jsonPointer

string

length ≤ 128

The pointer to the error response JSON body.

status

integer

The HTTP problem status code.

title

string

required

The descriptive label for the overall problem.

type

string

required

The error type uniquely identifies each distinct error case. An error can have multiple types.

jsonPointer

string

length ≤ 128

The pointer to the error response JSON body.

status

integer

The HTTP problem status code.

title

string

required

The descriptive label for the overall problem.

type

string

required

The error type uniquely identifies each distinct error case. An error can have multiple types.

Language

URL


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://hostname/cloudlets/api/v2/origins/originId/versions/version \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Returns details about an origin version.