INTEGRITY Документация

Управление шлюзами

Шлюз Cloudflare Web3 предоставляет доступные по HTTP интерфейсы к различным сетям Web3. Взаимодействовать со шлюзом можно несколькими способами.

Создание шлюза

Чтобы создать шлюз через панель управления:

  1. На панели управления Cloudflare перейдите к разделу Web3 страницу.

    Перейдите в Web3 ↗
  2. Нажмите Create Gateway.

  3. Введите следующие данные:

  • Имя хоста: укажите имя хоста для использования в качестве шлюза, оно должно быть поддоменом текущей зоны Cloudflare.
  • Описание шлюза: укажите описание, которое поможет различать шлюзы между собой.
  • Тип Gateway: выберите целевой тип шлюза IPFS DNSLink, IPFS Universal Path, или Ethereum.
  • DNSLink: применимо только к шлюзам IPFS, подробнее на DNSLink.
  1. Нажмите Развернуть.

Чтобы создать шлюз через API, отправьте POST запрос, включающий следующие параметры:

  • name: имя хоста, которое будет указывать на целевой шлюз через CNAME запись.
  • target: целевой шлюз для имени хоста (ethereum, ipfs, ipfs_universal_path).

Если вам нужна помощь с аутентификацией API, см. Документация по API Cloudflare.

Запрос
curl "https://api.cloudflare.com/client/v4/zones/{zone_id}/web3/hostnames" \
--header "X-Auth-Email: <EMAIL>" \
--header "X-Auth-Key: <API_KEY>" \
--header "Content-Type: application/json" \
--data '{
  "name": "gateway.example.com",
  "description": "This is my IPFS gateway.",
  "target": "ipfs",
  "dnslink": "/ipns/onboarding.ipfs.cloudflare.com"
}'

Ответ содержит полное описание нового шлюза.

Ответ
{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "<WEB3_GATEWAY_ID>",
    "name": "gateway.example.com",
    "description": "This is my IPFS gateway.",
    "status": "active",
    "target": "ipfs",
    "dnslink": "/ipns/onboarding.ipfs.cloudflare.com",
    "created_on": "<CREATED_ON_DATE>",
    "modified_on": "<MODIFIED_ON_DATE>"
  }
}

При создании шлюза Cloudflare автоматически:


Редактирование шлюза

После того как вы создали шлюз, вы можете изменить только Описание шлюза и если это IPFS шлюза, также измените значение для DNSLink поле.

Если вам нужно изменить другие поля, удалить шлюз и создайте новую.

Чтобы изменить шлюз через панель управления:

  1. На панели управления Cloudflare перейдите к разделу Web3 страницу.

    Перейдите в Web3 ↗
  2. На странице нужного шлюза нажмите Изменить.

  3. Обновите Описание шлюза и, если вы редактируете IPFS шлюза: значение для DNSLink.

  4. Нажмите Применить повторно.

Чтобы изменить отдельные настройки шлюза, используйте PATCH запрос.


Обновление шлюза

Если ваш шлюз застрял в статусе Ошибка статус, вам следует попробовать обновить шлюз: это приведёт к попытке заново создать связанные DNS-записи для этого имени хоста.

Чтобы обновить шлюз через панель управления:

  1. На панели управления Cloudflare перейдите к разделу Web3 страницу.

    Перейдите в Web3 ↗
  2. На странице шлюза нажмите на раскрывающийся список, затем Обновить.

Чтобы обновить шлюз через API, отправьте запрос PATCH запрос с пустым телом запроса.


Обновить блок-лист

При настройке шлюз IPFS Universal Path, вам может понадобиться добавить элементы в блок-лист шлюза, который позволяет блокировать доступ к определённому контенту.

Вы можете блокировать доступ к одному или нескольким:

Чтобы добавить элемент в список блокировки через панель управления:

  1. На панели управления Cloudflare перейдите к разделу Web3 страницу.

    Перейдите в Web3 ↗
  2. На странице нужного шлюза нажмите на раскрывающийся список, затем Блок-лист.

  3. Нажмите Добавить запись.

  4. Введите следующие данные:

    • Тип записи блок-листа: Выберите CID или Путь к контенту.
    • Содержимое записи блок-листа: добавьте CID или путь к контенту для блокировки, то есть либо корректную строку CIDv0 или CIDv1 (CID), либо запись, начинающуюся с /ipfs/ или /ipns/ (путь к содержимому).
    • Описание записи блок-листа: добавьте описание, которое поможет опознать запись в блок-листе.
  5. Нажмите Add.

Чтобы добавить элемент в список блокировки через API, отправьте POST запрос.


Удаление шлюза

При удалении шлюза Cloudflare автоматически удалит все связанные с именем хоста DNS-записи. Это действие повлияет на ваш трафик, и его нельзя отменить.

Чтобы удалить шлюз через панель управления:

  1. На панели управления Cloudflare перейдите к разделу Web3 страницу.

    Перейдите в Web3 ↗
  2. На странице нужного шлюза нажмите на раскрывающийся список, затем Удалить.

  3. Нажмите Удаление имени хоста.

Чтобы удалить шлюз через API, отправьте запрос DELETE запрос.