ロードバランサーの一覧取得

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" }
        ]
      }
    ]
  }
}

アカウントのアプリケーションを、割り当てられたカスタムドメインごとにグループ化します。各カスタムドメインは、それを提供するアプリケーションを含む1つのグループとして表示されます。2つ以上のアプリケーションを含むグループはアクティブなロードバランサーであり、トラフィックはエッジでアプリケーション間に分散され、いずれかがオフラインになると自動的にフェイルオーバーします。カスタムドメインの設定ルートで、同一ドメインを複数のアプリケーションに割り当てられます。

string

必須

アカウントの API キーです。これはアカウント設定で確認できます。

このエンドポイントは、API の他の箇所でも使われているキャッシュ済みのプロジェクト一覧を参照するため、エッジプロバイダーへの呼び出しは発生せず、ウェブサイトアナリティクスやネットワークエラーを制限するアプリケーションごとのネットワークレート制限の対象にもなりません。代わりに、ユーザーごとに 60 秒あたり 20 リクエストのレート制限が適用されます。 limit は呼び出し元のプラン(Standard は 2、Pro は 5、Enterprise は 10)を反映するため、既存のグループに別のアプリケーションを追加する前に確認してください。ドメインへのアプリケーションの割り当て・解除はカスタムドメインの設定で行い、アカウント上のすべてのホスト名はドメイン一覧の取得で確認できます。

レスポンス

string

呼び出しが成功したかどうかを示します。成功した場合は success、失敗した場合は error です。

object

非表示 properties

integer

アカウントのプランで1つのドメインに割り当て可能なアプリケーションの最大数: Standard で2、Pro で5、Enterprise で10。

array

ホスト名ごとにグループ化されたカスタムドメイン。カスタムドメインを持つアプリケーションがない場合は空の配列になります。

表示 properties

string

カスタムドメイン。

array

このドメインを提供するアプリケーション(id、name、および各アプリケーションを現在ホストしている cluster)。

{
  "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" }
        ]
      }
    ]
  }
}

ドメイン一覧の取得デフォルトの squareweb.app サブドメインと、割り当てられたカスタムドメインを含む、すべてのアプリケーションに設定されたホスト名を一覧取得します。60 秒あたり 20 リクエストのレート制限があります。

ロードバランサーの一覧取得

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" }
        ]
      }
    ]
  }
}

​レスポンス

レスポンス