跳转到内容
搜索文档

已弃用 API

最后更新 查看 MarkdownAgent 设置

目的

已弃用 API 内容的目的在于告知用户 Cloudflare 不再支持某个端点,并为用户提供替代方案。

语气

指导性、直截了当

content_type

reference

结构

必需组件

已弃用的端点名称:必须与未弃用的 端点 中的名称一致。

上下文:简要描述发生的情况、Cloudflare 为什么要弃用此端点以及任何其他重要信息。避免使用有时间限制的描述词(今天、明天、一周内等)。相反,在包含日期时要具体。

替代方案:对替代端点的描述和/或链接,或者对 Cloudflare 为什么要移除该端点功能的解释。

生命周期结束日期:用户将无法再使用该端点的日期。格式为完整月份名称、日期和年份(例如 May 10, 2021)。

可选组件

正在被弃用的端点或相关 API 的完整列表

其他信息

按弃用日期将 API 弃用通知添加到 API 弃用页面,而不是按端点字母顺序。

当某个端点将在指定的时间范围内被弃用但仍可用时,在端点描述中添加关于即将弃用的说明("<name of endpoint> will be deprecated on <full month name, date, year>. Use the <alternative endpoint> instead.")。

示例

Cloudflare Images - Create authenticated direct upload URL v1

生命周期结束日期:July 1, 2022

弃用此端点以支持使用 v2,v2 允许您控制元数据、定义访问策略并获取图像 ID。

已弃用 API:

POST accounts/:account_identifier/images/v1/direct_upload

替代方案:

POST accounts/:account_identifier/images/v2/direct_upload

这篇文档对您有帮助吗?