← Cloudflare for Platforms / cloudflare-for-platforms / cloudflare-for-saas / start
Частые вызовы API
Как поставщик SaaS вы можете захотеть настраивать и управлять Cloudflare for SaaS через API а не Панель управления Cloudflare ↗. Ниже приведены соответствующие вызовы API для создания, редактирования и удаления пользовательских имён хостов, а также для отслеживания, обновления и удаления запасных origin-серверов. Дополнительные сведения можно найти в Документация по API Cloudflare.
Пользовательские имена хостов
| Конечная точка | Примечания |
|---|---|
| Получить список пользовательских имён хостов | Используйте page параметр для получения дополнительных страниц. Добавьте hostname параметр для поиска конкретных имён хостов. |
| Create custom hostname | В validation_records объекта ответа используйте txt_name и txt_record указанные для проверки пользовательского имени хоста. |
| Custom hostname details | Используйте этот эндпоинт, чтобы проверить активацию имени хоста и статус сертификата. |
| Изменение пользовательского имени хоста | При отправке с ssl объект, совпадающий с уже существующим значением, означает, что для этого имени хоста нужно заново пройти проверку контроля над доменом (DCV). |
| Удаление пользовательского имени хоста | Также удаляет все связанные сертификаты SSL/TLS. |
Подтверждение готовности пользовательского имени хоста
Чтобы убедиться, что пользовательское имя хоста полностью настроено, проверьте оба поля статуса в Custom hostname details endpoint ответ:
| Поле API | Что это значит | Значение Ready |
|---|---|---|
result.status |
Статус активации имени хоста. Это поле показывает, проверил и активировал ли Cloudflare пользовательское имя хоста. | active |
result.ssl.status |
Статус сертификата. Это поле показывает, завершены ли выпуск и развёртывание SSL/TLS-сертификата для данного имени хоста. | active |
Пользовательское имя хоста готово к продакшен-HTTPS, если result.status это active, result.ssl.status это active, и DNS клиента указывает на вашу цель CNAME или цель apex-проксирования.
Если result.status это active но result.ssl.status не active, имя хоста активно, но выпуск и развёртывание его сертификата ещё не завершены. Одно лишь успешное TLS-рукопожатие не означает, что подготовка сертификата пользовательского имени хоста завершена, поскольку Cloudflare может предоставить для этого имени хоста другой подходящий сертификат. Дополнительные сведения см. в Приоритет сертификата и хоста.
Когда вы используете Create custom hostname endpoint, выберите один ssl.method значение: http, txt, или email. Для пользовательских имён хостов без wildcard Cloudflare всегда пытается выполнить Проверка сертификата через HTTP после того как имя хоста начнёт указывать на целевой ресурс SaaS, даже если вы выбрали TXT проверка.
Резервные исходные серверы
Наш API включает следующие конечные точки, связанные с резервный исходный сервер пользовательского имени хоста: