import requests
url = "https://platform.ankra.app/api/v1/clusters/upcloud/{cluster_id}/load-balancer-plan"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://platform.ankra.app/api/v1/clusters/upcloud/{cluster_id}/load-balancer-plan', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://platform.ankra.app/api/v1/clusters/upcloud/{cluster_id}/load-balancer-plan \
--header 'Authorization: Bearer <token>'{
"load_balancer_plan": "<string>",
"managed": true,
"load_balancers_observed": true,
"load_balancers": [
{
"uuid": "<string>",
"name": "<string>",
"plan": "<string>",
"operational_state": "<string>",
"ingress": true
}
],
"observation_error": "<string>",
"available_plans": [
{
"name": "<string>",
"server_number": 123,
"per_server_max_sessions": 123,
"highly_available": true
}
]
}{
"detail": "Cluster not found"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Get ingress load balancer plan
Read the UpCloud plan Ankra has recorded for the cluster’s ingress load balancer beside the plans its live load balancers run on. load_balancer_plan is null when no plan was ever recorded: Ankra then leaves the balancer’s plan alone. When UpCloud cannot be read, load_balancers_observed is false and load_balancers is null rather than empty.
import requests
url = "https://platform.ankra.app/api/v1/clusters/upcloud/{cluster_id}/load-balancer-plan"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://platform.ankra.app/api/v1/clusters/upcloud/{cluster_id}/load-balancer-plan', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://platform.ankra.app/api/v1/clusters/upcloud/{cluster_id}/load-balancer-plan \
--header 'Authorization: Bearer <token>'{
"load_balancer_plan": "<string>",
"managed": true,
"load_balancers_observed": true,
"load_balancers": [
{
"uuid": "<string>",
"name": "<string>",
"plan": "<string>",
"operational_state": "<string>",
"ingress": true
}
],
"observation_error": "<string>",
"available_plans": [
{
"name": "<string>",
"server_number": 123,
"per_server_max_sessions": 123,
"highly_available": true
}
]
}{
"detail": "Cluster not found"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
Successful Response
The recorded ingress load balancer plan; null when none was ever recorded, in which case Ankra leaves the live plan alone.
False when Ankra does not render the ingress load balancer (no Ankra-managed cloud controller or ingress).
False when UpCloud could not be read; load_balancers is then null.
Show child attributes
Show child attributes
Show child attributes
Show child attributes