You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The domain name to configure the load balancer for
string
N/A
Yes
name
Name of the load balancer (alphanumeric and hyphens only)
string
N/A
Yes
description
Description of the load balancer
string
""
No
status
Whether the load balancer is enabled
bool
true
No
method
Load balancing method: failover, cluster_rr, or cluster_chash
string
failover
No
time_slice
Duration for pool selection in cluster_rr strategy
string
0s
No
pools
List of pool configurations with their origins
list(object)
[]
No
Pool Object Structure
Name
Description
Type
Default
Required
name
Pool name
string
N/A
Yes
description
Pool description
string
null
No
status
Pool enabled status
bool
true
No
priority
Pool priority (0 = default)
number
0
No
method
Pool method: cluster_rr or cluster_chash
string
cluster_rr
No
keepalive
Keepalive setting: on or off
string
off
No
next_upstream_tcp
Try next upstream on failure
string
off
No
next_upstream_codes
Map of HTTP methods to status codes for retry
map(list(number))
{}
No
regions
List of 3-letter region codes (e.g., THR, FRA)
list(string)
N/A
Yes
origins
List of origin configurations
list(object)
[]
No
Origin Object Structure
Name
Description
Type
Default
Required
name
Origin name
string
N/A
Yes
address
Origin address (IP or hostname)
string
N/A
Yes
port
Origin port (1-65535)
number
null
No
weight
Origin weight (1-1000)
number
100
No
status
Origin enabled status
bool
true
No
protocol
Origin protocol: auto, http, or https
string
auto
No
host_header
Custom host header for the origin
string
null
No
Outputs
Name
Description
load_balancer_id
The ID of the load balancer
load_balancer_name
The name of the load balancer
load_balancer
The complete load balancer resource
pool_ids
Map of pool names to their IDs
pools
Map of all pool resources
origin_ids
Map of origin keys to their IDs
origins
Map of all origin resources
Load Balancing Methods
failover: Routes traffic to the first healthy pool; falls back to lower priority pools when primary fails
cluster_rr (Round Robin): Distributes traffic evenly across all healthy pools
cluster_chash (Consistent Hash): Routes requests to the same pool based on request characteristics
Region Codes
Region codes must be exactly 3 uppercase letters (e.g., THR, FRA). You can retrieve the list of available regions for your domain using the ArvanCloud API:
curl -X GET "https://napi.arvancloud.ir/cdn/4.0/domains/{your-domain}/load-balancers/regions" \
-H "Authorization: Apikey {your-api-key}"