プールの管理

Within Cloudflare, pools represent your endpoints and how they are organized. As such, a pool can be a group of several endpoints, or you could also have only one endpoint (an origin server, for example) per pool.

If you are familiar with DNS terminology, think of a pool as a “record set,” except Cloudflare only returns addresses that are considered healthy. You can attach health monitors to individual pools for customized monitoring.

プールに関する詳細情報は、プールを参照してください。

注意

Since load balancing targets are not limited to origin web servers, the term endpoints has been introduced. Refer to Service-Specific Terms ↗ for its use in the context of Cloudflare offerings, and to load balancing concepts or Reference Architecture for use case examples.

On the Load Balancing API, origin has been maintained.

---

プールの作成

ダッシュボード

You can create a pool within the load balancer workflow or in the Pools section of the dashboard:

1. Go to Traffic > Load Balancing.

2. Select Manage Pools and then Create.

3. For your pool, enter the following information:

   • A name (must be unique)
   • A description to provide more detail on the name
   • A choice for Endpoint Steering, which affects how your pool routes traffic to each endpoint

4. For each endpoint, enter the following information:

   • A name (must be unique)
   • The endpoint address or associated hostname
   • (Optional) A Virtual Network. Required when the endpoint has a private IP address.
   • A Weight
   • (Optional) A hostname by clicking Add host header

Note

If your endpoint is a website or application hosted on Cloudflare Pages, you will need to fill in the host header field with the project domain for it to resolve correctly.

5. Repeat this process for additional endpoints in the pool.

6. (Optional) Set up coordinates for Proximity Steering on the pool.

7. On the pool, update the following information:

   • Health Threshold:

     The Health Threshold is the number of healthy endpoints for the pool as a whole to be considered Healthy and receive traffic based on pool order in a load balancer. Increasing this number makes the pool more reliable, but also more likely to become unhealthy.

   • Monitor: Attach a monitor
   • Health Monitor Regions: Choose whether to check pool health from multiple locations, which increases accuracy but can lead to probe traffic to your endpoint
   • Pool Notifications: You can set up new alerts - and view existing alerts - to be notified when pools are enabled or disabled, or pools or endpoints have changes in their health status.

8. When finished, select Save.

API

For a full list of properties, refer to Create Pool. If you need help with API authentication, refer to Cloudflare API documentation.

Request

curl "https://api.cloudflare.com/client/v4/accounts/{account_id}/load_balancers/pools" \
--header "Authorization: Bearer <API_TOKEN>" \
--header "Content-Type: application/json" \
--data '{
  "description": "Primary data center - Provider XYZ",
  "name": "primary-dc-1",
  "enabled": false,
  "load_shedding": {
    "default_percent": 0,
    "default_policy": "random",
    "session_percent": 0,
    "session_policy": "hash"
  },
  "minimum_origins": 2,
  "monitor": "f1aba936b94213e5b8dca0c0dbf1f9cc",
  "check_regions": [
    "WEU",
    "ENAM"
  ],
  "origins": [
    {
      "name": "app-server-1",
      "address": "0.0.0.0",
      "enabled": true,
      "weight": 0.56,
      "header": {
        "Host": [
          "example.com"
        ]
      }
    }
  ],
  "origin_steering": {
    "policy": "random"
  },
  "notification_filter": {
    "origin": {
      "disable": false,
      "healthy": null
    },
    "pool": {
      "disable": false,
      "healthy": null
    }
  }
}'

The response contains the complete definition of the new pool.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "17b5962d775c646f3f9725cbc7a53df4",
    "created_on": "2021-01-01T05:20:00.12345Z",
    "modified_on": "2021-01-01T05:20:00.12345Z",
    "description": "Primary data center - Provider XYZ",
    "name": "primary-dc-1",
    "enabled": false,
    "load_shedding": {
      "default_percent": 0,
      "default_policy": "random",
      "session_percent": 0,
      "session_policy": "hash"
    },
    "minimum_origins": 2,
    "monitor": "f1aba936b94213e5b8dca0c0dbf1f9cc",
    "check_regions": [
      "WEU",
      "ENAM"
    ],
    "origins": [
      {
        "name": "app-server-1",
        "address": "0.0.0.0",
        "enabled": true,
        "weight": 0.56,
        "header": {
          "Host": [
            "example.com"
          ]
        }
      }
    ],
    "origin_steering": {
      "policy": "random"
    },
    "notification_filter": {
      "origin": {
        "disable": false,
        "healthy": null
      },
      "pool": {
        "disable": false,
        "healthy": null
      }
    }
  }
}

After creating the pool, you would also want to create a new notification with the following parameters specified:

"alert_type": "load_balancing_health_alert",
"filters": {
  "pool_id": <<ARRAY_OF_INCLUDED_POOL_IDS>>,
  "new_health": <<ARRAY_OF_STATUS_TRIGGERS>> ["Unhealthy", "Healthy"],
  "event_source": <<ARRAY_OF_OBJECTS_WATCHED>> ["pool", "origin"]
}

---

プールの編集

ダッシュボード

ダッシュボードでプールを編集するには：

1. トラフィック > ロードバランシングに移動します。
2. プールの管理をクリックします。
3. 特定のプールで編集をクリックします。
4. 必要に応じて設定を更新します。
5. 保存をクリックします。

API

APIを使用してプールを編集する場合、リクエストの種類は編集したい内容によって異なります。

全体の設定を再送信せずに特定の設定を更新するには、PATCHリクエストを使用します。より広範な変更には、PUTリクエストを使用します。

---

プールの削除

ロードバランサーによって使用されているプールは削除できません。これには、ジオスティアリング地域プールやフォールバックプールが含まれます。

プールを削除しようとしたときにエラーが発生した場合は、エラーにリストされているホスト名を考慮し、該当するロードバランサーを編集して、プールへのすべての参照を削除してください。

ノート

プールがジオスティアリングによって参照されている場合、別のトラフィックスティアリングメソッドに変更しても設定は自動的に削除されません。削除を確実に行うために、ジオスティアリングを選択し、プールを削除し、他の必要な変更を適用して保存してください。

ダッシュボード

ダッシュボードでプールを削除するには：

1. トラフィック > ロードバランシングに移動します。
2. プールの管理をクリックします。
3. 特定のプールで削除をクリックします。

API

APIを使用してプールを削除するには、DELETEリクエストを送信します。

---

アラートの設定

プールのステータスの変更に対する通知を受け取るために、アラートを設定できます。

Pool Enablement

Who is it for?

Customers who want to be warned about status changes (enabled/disabled) in their pools.

Other options / filters

Available filters include:

• You can search for and add pools from your list of pools.
• You can also choose the trigger that fires the notification when the Load Balancing pool is enabled, disabled, and either enabled or disabled.

Included with

Purchase of Load Balancing.

What should you do if you receive one?

No action is needed.

Load Balancing Health Alert

Who is it for?

Customers who want to be warned about changes in health status in their pools or origins.

Other options / filters

Available filters include:

• You can search for and add pools from your list of pools, as well as Include future pools (if all pools are selected).
• You can choose the trigger that fires the notification when the health status becomes unhealthy, healthy, or either unhealthy or healthy
• You can choose the trigger that fires the notification when the event source health status changes in pool, origin, or either pool or origin.

Included with

Purchase of Load Balancing.

What should you do if you receive one?

Evaluate load balancing analytics to review changes in health status over time.

Refer to Cloudflare Notifications for more information on how to set up an alert.