You need to enable JavaScript to run this app.
导航

API 概览

最近更新时间2024.04.02 15:53:51

首次发布时间2021.07.15 11:09:03

本文档列出了火山引擎内容分发网络提供的 API。您可以使用这些 API 对内容分发网络进行相关操作。例如配置加速域名、提交刷新任务、查询统计数据等。

域名操作

API 名称API 概述API 说明
AddCdnDomain添加域名在内容分发网络中添加您的站点域名作为加速域名。在添加域名时,您可以设置相关的配置。
StartCdnDomain启用加速域名启用一个加速域名。加速域名启用后,其状态为正常运行。

内容分发网络为每个加速域名分配了一个 CNAME 地址。在您启用一个加速域名后,您需要为该 CNAME 地址配置域名解析。之后,用户对您站点的访问就能被加速。
StopCdnDomain停用加速域名停用一个加速域名。在您停用一个加速域名前,请先移除解析到该加速域名 CNAME 地址的解析记录。
DeleteCdnDomain删除加速域名删除一个加速域名。删除加速域名后,您将无法查看该加速域名的配置和统计数据。
ListCdnDomains获取加速域名列表获取您账号下的加速域名列表以及每个加速域名的基本信息。基本信息包括业务类型、状态、CNAME 地址、加速区域等。

域名配置

API 名称API 概述API 说明
DescribeCdnConfig获取加速域名配置获取指定的加速域名的所有配置信息。
UpdateCdnConfig修改加速域名配置修改指定的加速域名的配置。这些配置与内容分发网络控制台提供的配置相同。这些配置包括基本配置、源站配置、HTTPS 配置、缓存配置、访问控制配置、高级配置。

数据统计

API 名称API 概述API 说明

DescribeCdnData

获取访问统计的细分数据

指定一个或者多个域名,对每个域名的访问请求进行统计。数据指标包括流量、带宽、请求数、命中率和指定状态码的数量。

您可以指定以下对象类型对请求进行过滤:

  • 客户端 IP 归属的省份。

  • 客户端 IP 归属的 ISP。

  • 客户端 IP 的类型。

  • 用户请求所使用的协议。

您还可以指定数据统计所使用的时间粒度。您可以指定的时间粒度包括 1 分钟 、5 分钟、1 小时和 1 天。

DescribeEdgeNrtDataSummary

获取访问统计的汇总数据

指定一个或者多个域名,对这些域名的访问请求进行统计并做数据聚合。数据指标包括总流量、峰值带宽、总请求数、平均命中率和指定状态码的总数。

除了平均命中率这个指标,您可以指定以下对象类型对请求进行过滤:

  • 客户端 IP 归属的省份。

  • 客户端 IP 归属的 ISP。

  • 客户端 IP 的类型。

  • 用户请求所使用的协议。

您还可以指定数据统计所使用的时间粒度。您可以指定的时间粒度包括 1 分钟和 5 分钟。

DescribeCdnOriginData

获取回源统计的细分数据

指定一个或者多个域名,对每个域名的回源请求进行统计。数据指标包括流量、带宽、请求数和指定状态码的数量。

您可以指定数据统计所使用的时间粒度。您可以指定的时间粒度包括 1 分钟 、5 分钟、1 小时和 1 天。

DescribeOriginNrtDataSummary

获取回源统计的汇总数据

指定一个或者多个域名。对这些域名的回源请求进行统计并做数据聚合。数据指标包括总流量、峰值带宽、总请求数和指定状态码的总数。

您可以指定数据统计所使用的时间粒度。您可以指定的时间粒度包括 1 分钟和 5 分钟。

DescribeCdnDataDetail

获取单个域名的省份和 ISP 的细分数据

指定一个域名。基于该域名的访问请求,统计以下维度的数据:

  • 客户端 IP 归属的省份。

  • 客户端 IP 归属的 ISP。

数据指标包括流量、带宽、请求数、请求 QPS 和指定状态码的数量。

您可以指定以下对象类型对请求进行过滤:

  • 客户端 IP 的类型。

  • 用户请求所使用的协议。

您还可以指定数据统计所使用的时间粒度。您可以指定的时间粒度包括 1 分钟、5 分钟、1 小时和 1 天。

DescribeDistrictIspData

获取多个域名的省份和 ISP 的细分数据

指定一个或者多个域名。基于每个域名的访问请求,统计以下维度的数据:

  • 客户端 IP 归属的省份。

  • 客户端 IP 归属的 ISP。

数据指标包括流量、带宽、请求数和请求 QPS。

您可以指定以下对象类型对请求进行过滤:

  • 客户端 IP 的类型。

  • 用户请求所使用的协议。

您还可以指定数据统计所使用的时间粒度。您可以指定的时间粒度包括 1 分钟、5 分钟、1 小时和 1 天。

DescribeEdgeStatisticalData

获取独立访客的细分数据

指定一个域名。基于该域名的访问请求,统计来自指定区域的独立访客的数量。独立访客是对客户端 IP 去重后得到的。

您可以指定以下对象类型对请求进行过滤:

  • 中国的省份。例如湖南和河北。

  • 国家。例如中国和美国。

  • 用户请求所使用的协议。

您还可以指定数据统计所使用的时间粒度。您可以指定的时间粒度包括 1 小时和 1 天。

DescribeEdgeTopNrtData

获取访问数据的统计排名

指定一个或者多个域名。基于每个域名的访问请求,获取以下排名:

  • 域名的排名:

    • 基于流量的域名排名。

    • 基于总请求数的域名排名。

    • 基于峰值带宽的域名排名。

  • 客户端 IP 所归属的区域的排名:

    • 基于总流量的中国省份排名。

    • 基于总请求数的中国省份排名。

    • 基于峰值带宽的中国省份排名。

    • 基于总流量的国家排名。

    • 基于总请求数的国家排名。

    • 基于峰值带宽的国家排名。

  • 客户端 IP 所归属的 ISP 的排名:

    • 基于总流量的 ISP 排名。

    • 基于总请求数的 ISP 排名。

    • 基于峰值带宽的 ISP 排名。

DescribeOriginTopNrtData

获取回源数据的统计排名

指定一个或者多个域名。基于每个域名的回源请求,获取以下排名:

  • 基于流量的域名排名。

  • 基于总请求数的域名排名。

  • 基于峰值带宽的域名排名。

DescribeEdgeTopStatusCode

获取访问状态码的统计排名

指定一个或者多个域名。基于每个域名的访问请求,获取以下排名:

  • 基于 2xx 响应状态码总数的域名排名。2xx 代表所有以数字 2 开头的响应状态码。

  • 基于 3xx 响应状态码总数的域名排名。

  • 基于 4xx 响应状态码总数的域名排名。

  • 基于 5xx 响应状态码总数的域名排名。

DescribeOriginTopStatusCode

获取回源状态码的统计排名

指定一个或者多个域名。基于每个域名的回源请求,获取以下排名:

  • 基于 2xx 响应状态码总数的域名排名。2xx 代表所有以数字 2 开头的响应状态码。

  • 基于 3xx 响应状态码总数的域名排名。

  • 基于 4xx 响应状态码总数的域名排名。

  • 基于 5xx 响应状态码总数的域名排名。

DescribeEdgeTopStatisticalData

获取热点及访客的统计排名

指定一个域名。基于该域名的访问请求,获取以下排名:

  • TOP URL。

  • TOP Referer。

  • 独立访客所在的区域。

这里的 URL 表示请求的目标 URL。TOP URL 的排名包括:

  • 基于总流量的 URL 排名。

  • 基于总请求数的 URL 排名。

  • 基于 2xx 响应状态码总数的 URL 排名。2xx 代表所有以数字 2 开头的响应状态码。

  • 基于 3xx 响应状态码总数的 URL 排名。

  • 基于 4xx 响应状态码总数的 URL 排名。

  • 基于 5xx 响应状态码总数的 URL 排名。

这里的 Referer 表示请求所包含的 Referer 头的值。TOP Referer 的排名包括:

  • 基于总流量的 Referer 排名。

  • 基于总请求数的 Referer 排名。

这里的独立访客是对客户端 IP 去重后得到的。独立访客所在的区域排名包括:

  • 基于独立访客数量的中国省份排名。

  • 基于独立访客数量的国家排名。

DescribeCdnRegionAndIsp

获取支持的区域和 ISP 列表

获取内容分发网络支持的省份、国家,ISP 以及对应的代码。

计费查询

API 名称API 概述API 说明
DescribeCdnService获取 CDN 的计费信息获取您账号下内容分发网络的计费相关信息。这些信息包括服务的启用时间、状态、计费方式、计费周期等。

DescribeAccountingData

获取计费指标的细分数据

从计费角度获取您账号下内容分发网络的用量数据。用量数据的指标包括流量、带宽和请求数。

根据内容分发网络的计费方式,您可以指定相应的指标获取用量数据。对于流量和带宽,用量数据统计的时间粒度是 5 分钟。

内容管理

API 名称API 概述API 说明
SubmitRefreshTask提交刷新任务向内容分发网络提交一个刷新任务。刷新任务将指定的一个或者多个文件标记为缓存过期。您可以指定刷新类型为 URL 刷新或者目录刷新。
SubmitPreloadTask提交预热任务向内容分发网络提交一个预热任务。预热任务将指定的一个或者多个文件从源站拉取到所有缓存节点。
DescribeContentTasks获取刷新与预热任务列表获取已提交的刷新任务和预热任务。
DescribeContentQuota获取刷新与预热的配额获取您账号下刷新任务和预热任务的日额度和剩余量。

SubmitBlockTask

提交 URL 封禁任务

向内容分发网络提交一个 URL 封禁任务。您可以在一个封禁任务中指定一个或者多个 URL。用户无法访问被封禁的 URL。

该 API 为白名单功能。如果您需要使用该 API,请联系火山引擎服务技术支持

SubmitUnblockTask

提交 URL 解封任务

向内容分发网络提交一个 URL 解封任务,解除一个或者多个 URL 的封禁。

该 API 为白名单功能。如果您需要使用该 API,请联系火山引擎服务技术支持

DescribeContentBlockTasks

获取 URL 封禁与解封任务列表

获取已提交的 URL 封禁任务或者 URL 解封任务的状态。状态包括执行成功、执行中和执行失败。

该 API 为白名单功能。如果您需要使用该 API,请联系火山引擎服务技术支持

日志查询

API 名称API 概述API 说明
DescribeCdnAccessLog获取访问日志的下载链接指定一个加速域名。获取该加速域名的访问日志的下载链接。

服务查询

API 名称API 概述API 说明
DescribeIPInfo查询单个 IP 是否归属 CDN指定一个 IP 并查询该 IP 是否是内容分发网络某个边缘缓存节点的 IP。
DescribeIPListInfo查询多个 IP 是否归属 CDN指定一个或者多个 IP 并查询这些 IP 是否是内容分发网络边缘缓存节点的 IP。

DescribeCdnUpperIp

获取回源层节点的所有 IP

指定一个域名,获取与该域名关联的所有回源层节点的 IP。

该 API 为白名单功能。如果您需要使用该 API,请联系火山引擎服务技术支持

DescribeCdnEdgeIp

获取边缘层节点的所有 IP

指定一个域名,获取与该域名关联的所有边缘层节点的 IP。

该 API 为白名单功能。如果您需要使用该 API,请联系火山引擎服务技术支持

标签操作

API 名称API 概述API 说明
AddResourceTags添加资源标签对一组加速域名添加一组资源标签。添加资源标签不会影响加速域名已有的资源标签。在某些 API 操作中,您可以使用资源标签对域名进行筛选。
UpdateResourceTags更新资源标签将一组加速域名的现有资源标签更新为一组新的资源标签。
ListResourceTags获取资源标签列表获取一个资源标签的列表。列表中的资源标签都已关联了您账号下的一个或者多个加速域名。列表中的资源标签已经经过去重处理。
DeleteResourceTags删除资源标签对一组加速域名删除一组资源标签。

证书管理

API 名称API 概述API 说明
AddCdnCertificate上传证书向内容分发网络上传一个证书。证书包括公钥文件和私钥文件的内容。上传后的证书托管在火山引擎证书中心。
ListCertInfo获取证书列表获取火山引擎证书中心中的证书并展示这些证书的信息。 这些证书已经或可以与您的加速域名相关联。

ListCdnCertInfo

获取已与加速域名关联的证书列表

获取火山引擎证书中心中的证书并展示这些证书的信息。 这些证书已经与您的加速域名相关联。

DescribeCertConfig

获取指定证书的域名关联情况

指定一个火山引擎证书中心中的证书。对于该证书所签发给的域名,查询这些域名在内容分发网络中的证书关联情况。

BatchDeployCert

关联证书与加速域名

指定一个火山引擎证书中心中的证书,将该证书与一个或者多个加速域名关联。