← Правила Cloudflare / rules / cloud-connector

Настройка правила Cloud Connector через API

Настроить правила Cloud Connector можно с помощью Cloudflare API.

Необходимые разрешения

API-токен используемый в запросах API для управления правилами Cloud Connector, должен иметь как минимум следующее разрешение:

Zone > Cloud Connector > Write

Конечные точки

Чтобы получить полную конечную точку, добавьте перечисленные ниже конечные точки Cloud Connector к базовому URL-адресу API Cloudflare:

https://api.cloudflare.com/client/v4

{zone_id} аргумент представляет собой ID зоны (шестнадцатеричная строка). Это значение можно найти в панели управления Cloudflare.

В следующей таблице приведена сводка доступных операций.

Операция	Метод + конечная точка
Список правил Cloud Connector	`GET /zones/{zone_id}/cloud_connector/rules`
Создание/обновление/удаление правил Cloud Connector	`PUT /zones/{zone_id}/cloud_connector/rules`

Примеры вызовов API

Список правил Cloud Connector

Следующий пример возвращает список существующих правил Cloud Connector:

Необходимые разрешения API-токена

Хотя бы одно из следующих права доступа токена требуется:

Cloud Connector Read
Cloud Connector Write

Правила

curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/cloud_connector/rules" \
	--request GET \
	--header "X-Auth-Email: $CLOUDFLARE_EMAIL" \
	--header "X-Auth-Key: $CLOUDFLARE_API_KEY"

{
	"result": [
		{
			"id": "<RULE_1_ID>",
			"provider": "aws_s3",
			"expression": "http.request.uri.path wildcard \"/images/*\"",
			"description": "Connect to S3 bucket containing images",
			"enabled": true,
			"parameters": {
				"host": "examplebucketwithimages.s3.north-eu.amazonaws.com"
			}
		}
	],
	"success": true,
	"errors": [],
	"messages": []
}

Создание/обновление/удаление правил Cloud Connector

Следующий пример запроса заменит все существующие правила Cloud Connector одним правилом:

Необходимые разрешения API-токена

Хотя бы одно из следующих права доступа токена требуется:

Cloud Connector Write

Put Rules

curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/cloud_connector/rules" \
	--request PUT \
	--header "X-Auth-Email: $CLOUDFLARE_EMAIL" \
	--header "X-Auth-Key: $CLOUDFLARE_API_KEY" \
	--json '[
		{
				"expression": "http.request.uri.path wildcard \"/images/*\"",
				"provider": "cloudflare_r2",
				"description": "Connect to R2 bucket containing images",
				"parameters": {
						"host": "mybucketcustomdomain.example.com"
				}
		}
	]'

Обязательные параметры тела запроса для каждого правила: expression, provider, а также parameters.host.

provider значение должно быть одним из следующих: cloudflare_r2, aws_s3, azure_storage, gcp_storage, а также oci_storage.