跳转到内容
本站为社区维护的非官方中文翻译,与 Cloudflare, Inc. 无关联。本站不提供账户登录,请勿在任何非官方站点输入您的 Cloudflare 账户信息。官方文档:developers.cloudflare.com

常用 API 调用

最后更新 查看 MarkdownAgent 设置

作为 SaaS 提供商,您可能希望通过 API 而非 Cloudflare 仪表板 ↗ 来配置和管理 Cloudflare for SaaS。以下是用于创建、编辑和删除自定义主机名,以及监控、更新和删除回退源站的相关 API 调用。更多详情请参阅 Cloudflare API 文档。


自定义主机名

Endpoint Notes
List custom hostnames 使用 page 参数拉取更多页面。添加 hostname 参数可搜索特定主机名。
Create custom hostname 在响应的 validation_records 对象中,使用列出的 txt_name 与 txt_record 验证自定义主机名。
Custom hostname details 使用此端点检查主机名激活与证书状态。
Edit custom hostname 当随请求发送的 ssl 对象与现有值匹配时,表示该主机名应重新启动域控制验证 (DCV)。
Delete custom hostname 同时删除任何关联的 SSL/TLS 证书。

确认自定义主机名就绪

要确认自定义主机名已完全配置,请检查 Custom hostname details 端点 响应中的两个状态字段:

API field What it means Ready value
result.status 主机名激活状态。该字段显示 Cloudflare 是否已验证并激活自定义主机名。 active
result.ssl.status 证书状态。该字段显示主机名的 SSL/TLS 证书是否已完成签发与部署。 active

当 result.status 为 active、result.ssl.status 为 active,且客户的 DNS 指向您的 CNAME 目标或 apex proxying 目标时,可将该自定义主机名视为已准备好用于生产 HTTPS。

若 result.status 为 active 但 result.ssl.status 不是 active,则主机名已激活,但其证书尚未完成签发与部署。仅 TLS 握手成功并不意味着自定义主机名证书已完成预配,因为 Cloudflare 可能为该主机名出示另一张匹配证书。更多信息请参阅 Certificate and hostname priority。

使用 Create custom hostname 端点 时,请选择一个 ssl.method 值:http、txt 或 email。该值控制初次证书签发。续期时,Cloudflare 可能根据当前资格使用不同方法。采取操作前请先获取当前的 ssl.method 和 ssl.validation_records。您也可以通过 Edit custom hostname 端点 显式更改方法。更多信息请参阅续期证书。

回退源站

我们的 API 包含与自定义主机名的 回退源站 相关的以下端点:

这篇文档对您有帮助吗?