OpenAPI概览
更新时间：2023-05-10 10:25:06
CDN Pro OpenAPI概述
CDN Pro提供了一系列OpenAPI接口供您进行开发集成。您可以前往API文档中心了解更多API细节。
加速项目管理
| API名称 | API概述 |
|---|---|
| 查询加速项目列表 | 该接口返回加速项目列表，包括每个加速项目的ID、最新版本号、注释、演练环境版本号、生产环境版本号，以及每个版本的最后更新时间等信息。可使用查询参数筛选加速项目。 |
| 新建加速项目 | 创建加速项目，在加速项目中定义需要部署到CDN Pro服务器的一个或多个加速域名的配置。 |
| 查询加速项目的版本列表 | 获取加速项目版本列表。返回每个版本的摘要信息，包括其状态及关联的加速域名等。 |
| 新建加速项目版本 | 创建一个新的加速项目版本。 |
| 删除加速项目 | 根据ID删除加速项目。 |
| 更新加速项目的基本信息 | 该接口用于更新加速项目的名称和描述。该操作不会创建加速项目新版本，也不会更新现有的加速项目版本。 |
| 查询加速项目的基础信息及版本信息 | 查询某个加速项目的信息，包括已创建的版本数以及哪些版本已部署等。 |
| 删除加速项目的版本 | 删除一个加速项目版本。 |
| 更新加速项目版本的配置信息 | 该接口可用来更新加速项目版本。已部署到生产或演练环境的加速项目处于“冻结”状态，无法再次被更新或验证，该状态下的加速项目版本只有版本描述字段可被更新。 |
| 查询加速项目的版本配置详情 | 获取加速项目版本的详细配置信息。 |
验证加速项目
| API名称 | API概述 |
|---|---|
| 查询验证任务列表 | 获取加速项目验证任务列表，接口返回关联的加速项目ID，加速项目版本，任务提交时间以及任务状态等信息。 |
| 查询验证任务详情 | 该接口返回加速项目验证任务的详细信息。 |
| 创建加速项目的验证任务 | 该接口用来创建任务，验证加速项目的某个版本。在您部署某个加速项目版本到演练或生产环境之前，必须先调用此接口验证加速项目中语法的准确性。 |
保密信息管理
| API名称 | API概述 |
|---|---|
| 创建保密信息 | 创建“保密信息”来存放敏感内容，然后在边缘逻辑中使用$SECRET(secretName)语法来引用保密信息，避免敏感内容直接暴露在加速项目的边缘逻辑中。 |
| 删除保密信息 | 删除保密信息。 |
| 更新保密信息 | 更新保密信息。 |
| 获取保密信息列表 | 获取保密信息列表。可使用查询参数筛选保密信息。 |
| 获取保密信息详情 | 获取保密信息的详情，包括其在演练环境及生产环境中被使用的情况。 |
证书管理
| API名称 | API概述 |
|---|---|
| 查询证书列表 | 获取证书列表。接口返回证书的ID、名称、部署到生产环境的版本、部署到演练环境的版本、最新的版本号、证书的最后更新时间以及证书的过期时间等信息。 |
| 查询证书详情 | 获取证书的详细信息，包括证书的版本以及证书使用情况。 |
| 查询证书版本信息 | 获取某个证书版本的详细信息，包括到期日期、加密算法、私钥长度、指纹，以及是否在生产环境和演练环境中部署等信息。 |
| 删除证书 | 该接口用来删除证书。当证书在生产环境或演练环境中使用时不可删除。 |
| 下载CSR | 下载证书签名请求 (CSR) 文件 。您可以向证书颁发机构提交CSR，申请证书。申请到证书后，请调用“更新证书”接口更新证书到CDN Pro。 |
部署任务管理
| API名称 | API概述 |
|---|---|
| 获取部署任务列表 | 获取加速项目/证书的部署/卸载任务列表。可使用查询参数来过滤部署任务。 |
| 获取部署任务详细信息 | 获取有关部署任务的详细信息，包括操作类型、提交时间、任务执行状态以及部署失败时的描述信息。 |
| 创建部署任务 | 创建部署任务将加速项目或证书部署到演练或生产环境，或将已部署的加速项目或证书卸载。 |
加速域名
| API名称 | API概述 |
|---|---|
| 查询已部署加速域名列表 | 获取已部署到演练或生产环境的加速项目对应的加速域名列表。 |
| 查询已部署加速域名的详情 | 该接口可用来查询已部署的加速域名的详细信息。 |
| 查询生产环境的历史部署域名 | 该接口用来查询在某段时间段内成功部署到生产环境中的加速域名列表。 |
| 查询加速域名的部署历史信息 | 该接口用来查询加速域名在生产环境的历史部署信息。可通过查询参数指定查询起止时间。 |
调度域名
| API名称 | API概述 |
|---|---|
| 查询调度域名列表 | 获取调度域名的列表。 |
| 查询调度域名详情 | 该接口返回调度域名的详细信息，包含相关的访客分区规则和调度域名的操作记录。如果您没有自定义访客分区规则，系统将创建一条默认的规则。 |
| 创建调度域名 | 使用该接口创建调度域名，自定义规则处理不同访客分区的请求。您必须在DNS创建一条CNAME记录，将您的加速域名指向调度域名，以便CDN Pro按照您定义的规则进行流量调度。 |
| 删除调度域名 | 使用该接口删除调度域名。如果您的DNS配置了CNAME记录指向该调度域名，那么您必须在删除调度域名之前更改DNS记录。否则，访问相关的加速域名将会报错。 |
| 修改调度域名的配置（增量配置修改） | 使用该接口对调度域名的部分字段进行更新。 |
| 修改调度域名的配置（全量配置修改） | 使用该接口全量更新调度域名。请确保指定调度域名所有相关的字段，包括那些不需要更改的字段。 |
| 查询支持的区域列表 | 获取CDN Pro支持的访客区域列表。这些访客区域可在创建调度域名时用于定义访客分区规则。 |
| 查询支持的ISP运营商列表 | 获取CDN Pro支持的运营商列表。这些运营商可在创建调度域名时用于定义访客分区规则。 |
服务报表
| API名称 | API概述 |
|---|---|
| 查询边缘节点带宽 | 获取一段时间内的边缘带宽数据（以Mbps为单位）。可以使用查询参数指定时间段和协议。通过在请求中传递filters对象可进一步指定查询范围。此报表的数据延迟小于两分钟。 |
| 查询带宽汇总信息 | 获取一段时间内的带宽汇总数据。可以按加速域名或serverGroups（节点组）进行查询和分组。 |
| 查询边缘节点请求数 | 获取一段时间内的边缘请求数数据。可以使用查询参数指定时间段和协议。通过在请求体中传递filters对象可进一步指定查询范围。该报表的数据延迟小于两分钟。 |
| 查询请求数汇总信息 | 获取一段时间内的请求数汇总数据。可以按加速域名或serverGroups（节点组）进行查询和分组。 |
| 查询边缘节点流量 | 获取一段时间内的边缘流量数据（以MB为单位）。可以使用查询参数指定时间段和协议。通过在请求体中传递filters对象可进一步指定查询范围。该报表的数据延迟小于两分钟。 |
| 查询流量汇总信息 | 获取一段时间内的边缘、中间层（CDN Pro服务器之间）和回源流量的汇总数据。可以在请求体中指定加速域名或serverGroups（节点组）等参数进行查询和分组。 |
| 查询边缘节点状态码详情 | 获取一段时间内的边缘状态码统计信息。可以使用查询参数指定时间段、协议和数据粒度。通过在请求体中传递filters对象可进一步指定查询范围。此报表的数据延迟最长可达30分钟。 |
| 查询边缘节点状态码汇总信息 | 获取一段时间内CDN Pro边缘服务器返回的HTTP状态码的汇总数据。可以使用查询参数指定时间段和协议。在请求体中传递filters对象可进一步指定查询范围。此报告的数据延迟最长可达30分钟。 |
| 查询回源状态码详情 | 获取一段时间内的回源状态码统计信息。可以使用查询参数指定时间段、协议和数据粒度。 |
| 查询源站状态码汇总信息 | 获取一段时间内源站返回的HTTP状态码的汇总数据。可以使用查询参数指定时间段和协议。 |
| 查询CPU使用时间 | 查询处理用户请求所消耗的CPU时间（以秒为单位）。 |
| 查询CPU使用时间汇总信息 | 获取CPU使用时间汇总信息，包括边缘服务器和中间层服务器的数据。 |
| 查询边缘节点上传流量 | 获取一段时间内上传到CDN Pro边缘服务器的流量数据（以MB为单位）。可以使用查询参数指定时间段和协议。通过在请求中传递filters对象可进一步指定查询范围。此报表的数据延迟小于两分钟。 |
| 查询中间层流量 | 获取一段时间内的中间层流量数据（以MB为单位）。中间层流量是指CDN Pro缓存服务器之间的流量。可以使用查询参数指定时间段和协议。通过在请求体中传递filters对象可进一步指定查询范围。此报表的数据延迟小于两分钟。 |
| 查询回源请求数 | 获取一段时间内的回源请求数数据。可以使用查询参数指定时间段和协议。通过在请求体中传递filters对象可进一步指定查询范围。此报表的数据延迟小于两分钟。 |
| 查询回源流量 | 获取一段时间内的回源流量数据（以MB为单位）。可以使用查询参数指定时间段和协议。通过在请求体中传递filters对象可进一步指定查询范围。此报表的数据延迟小于两分钟。 |
| 查询快速回源请求数 | 查询通过快速回源功能（Origin Fast Route）所产生的回源请求数。 |
| 查询快速回源流量 | 查询通过快速回源功能（Origin Fast Route）传输的回源流量。 |
| 查询调度域名请求数 | 获取一段时间内对调度域名发起的DNS解析请求数。 |
| 查询调度域名请求数的汇总信息 | 获取一段时间内一个或多个调度域名的DNS解析请求数汇总数据。可通过该接口查询每个调度域名的请求数数据。 |
内容管理
| API名称 | API概述 |
|---|---|
| 查询刷新任务列表 | 获取刷新请求列表。 |
| 查询刷新任务详情 | 获取刷新请求的详细信息，包括涉及的加速域名和刷新任务的执行状态等。 |
| 查询刷新任务总数 | 查询某个时间范围内的刷新请求的汇总信息。可通过查询参数指定时间范围和目标环境。 |
| 创建刷新任务 | 创建一个刷新任务来强制刷新存储在CDN Pro缓存服务器中的内容。当您更新了源站的内容，并希望访客立即看到更新后的内容，您可以创建一个刷新任务立即刷新内容。 |
| 查询刷新额度 | 该接口返回您可以在演练或生产环境进行目录和文件刷新的额度。使用限额每日有一个固定值。您可以临时超过该限额，但这会减少第二天可用的刷新额度。 |
| 查询预取任务列表 | 获取预取请求列表。 |
| 查询预取任务详情 | 获取预取请求的详细信息。 |
| 创建预取任务 | 创建一个预取请求，从您的源站预取内容来预热CDN Pro的缓存。通过内容提前预取，可避免大量请求涌入源站服务器。发起预取之前，必须先将域名对应的加速项目部署到生产环境。 |
日志下载
| API名称 | API概述 |
|---|---|
| 获取日志配置列表 | 获取已创建的日志配置列表。 |
| 创建日志配置 | 创建日志配置，用于定义访问日志的输出格式。同一个日志配置可适用于一个或多个域名。每个域名必须有指定的日志配置，才能获取到该域名的日志。 |
| 查询日志配置详情 | 获取日志配置的详细信息。 |
| 修改日志配置信息 | 更新日志配置。 |
| 删除日志配置 | 删除日志配置。 |
| 查询加速域名的访问日志 | 获取已部署的一个或多个加速域名的访问日志。这些日志是2小时或更早时间之前客户端请求所产生的日志。 |
CDN服务管理
| API名称 | API概述 |
|---|---|
| 获取CDN Pro服务IP | 获取CDN Pro对外提供服务所使用的IP地址列表，仅包含父节点IP，不包含边缘节点IP。 |
Webhooks
| API名称 | API概述 |
|---|---|
| 创建webhook | 当某个异步任务完成时，可用webhook接口来接收任务完成通知。当你创建部署任务，刷新任务，预取任务，或者配置验证任务时，都可以使用webhook接口来接收任务完成通知。 |
| 删除webhook | 删除webhook。 |
| 获取webhook详细信息 | 该接口返回webhook接口的详细信息，包括webhook接口基本信息以及接口调用情况。 |
| 获取webhook列表 | 获取已创建的webhook接口列表。当你创建部署任务，刷新任务，预取任务，或者配置验证任务时，都可以使用webhook接口来接收任务完成通知。 |
| 更新webhook | 更新webhook接口。只有请求体中携带的字段才会被更新。 |
本篇文档内容对您是否有帮助？
有帮助
我要反馈