Listar balanceadores de carga

GET

apps

load-balancers

curl --request GET \
  --url https://api.squarecloud.app/v2/apps/load-balancers \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/apps/load-balancers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.squarecloud.app/v2/apps/load-balancers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.squarecloud.app/v2/apps/load-balancers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/apps/load-balancers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "response": {
    "limit": 2,
    "balancers": [
      {
        "hostname": "example.com",
        "apps": [
          { "id": "abc123def456abc123def456", "name": "web-1", "cluster": "suki-cluster" },
          { "id": "def456abc123def456abc123", "name": "web-2", "cluster": "nasa-cluster" }
        ]
      }
    ]
  }
}

Agrupa las aplicaciones de la cuenta por dominio personalizado asociado. Cada dominio personalizado aparece como un grupo con las aplicaciones que lo sirven; un grupo con dos o más aplicaciones es un balanceador de carga activo, donde el tráfico se distribuye entre las aplicaciones en el edge con failover automático cuando una está fuera de línea. Asocia el mismo dominio a varias aplicaciones con la ruta Establecer dominio personalizado.

string

requerido

La clave de API de tu cuenta. Puedes encontrarla en la configuración de tu cuenta.

Este endpoint lee de la misma lista de proyectos en caché usada en otras partes de la API, por lo que no llama al proveedor de borde y no está sujeto a los límites de tasa por aplicación que controlan Analítica de red y Errores de red. En su lugar, tiene un límite de tasa de 20 solicitudes cada 60 segundos por usuario. limit refleja el nivel de plan de quien realiza la solicitud (2 en Standard, 5 en Pro, 10 en Enterprise), así que verifícalo antes de intentar agregar otra aplicación a un grupo existente. Asocia o desasocia aplicaciones de un dominio con Establecer dominio personalizado, o consulta todos los hostnames de la cuenta con Listar dominios.

Respuesta

string

Indica si la llamada fue exitosa. success si fue exitosa, error si no.

object

Ocultar properties

integer

Número máximo de aplicaciones permitidas en un dominio según el plan de la cuenta: 2 en Standard, 5 en Pro, 10 en Enterprise.

array

Dominios personalizados agrupados por nombre de host. Array vacío cuando ninguna aplicación tiene un dominio personalizado.

Mostrar properties

string

El dominio personalizado.

array

Aplicaciones que sirven este dominio (id, name y el cluster que aloja cada una actualmente).

{
  "status": "success",
  "response": {
    "limit": 2,
    "balancers": [
      {
        "hostname": "example.com",
        "apps": [
          { "id": "abc123def456abc123def456", "name": "web-1", "cluster": "suki-cluster" },
          { "id": "def456abc123def456abc123", "name": "web-2", "cluster": "nasa-cluster" }
        ]
      }
    ]
  }
}

Listar DominiosLista todos los hostnames configurados en tus aplicaciones, incluyendo el subdominio predeterminado squareweb.app y cualquier dominio personalizado asociado. Tiene un límite de 20 solicitudes cada 60 segundos.

Listar balanceadores de carga

curl --request GET \
  --url https://api.squarecloud.app/v2/apps/load-balancers \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/apps/load-balancers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.squarecloud.app/v2/apps/load-balancers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.squarecloud.app/v2/apps/load-balancers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/apps/load-balancers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "response": {
    "limit": 2,
    "balancers": [
      {
        "hostname": "example.com",
        "apps": [
          { "id": "abc123def456abc123def456", "name": "web-1", "cluster": "suki-cluster" },
          { "id": "def456abc123def456abc123", "name": "web-2", "cluster": "nasa-cluster" }
        ]
      }
    ]
  }
}

​Respuesta

Respuesta