本文为您列出 DDoS 防护服务当前支持的 API 功能及对应调用文档。
ddos
,版本为2020-12-08
。AdvDefence
,版本为2021-06-15
和2023-03-08
。origin_defence
,版本为2022-01-01
。API | 说明 |
---|---|
查询指定 IP 的 DDoS 基础防护攻击和黑洞信息。 |
API | 说明 |
---|---|
根据实例名称和状态查询实例列表。 |
API | 说明 |
---|---|
创建域名接入规则。 | |
根据域名删除相关的防护接入规则。 | |
根据高防实例 IP 和防护域名,修改域名接入规则信息。 | |
通过实例或域名,查询对应的域名接入规则详情。 | |
根据域名信息查询关联的证书详情,也可以查询账号下所有证书信息。 | |
当您需要批量接入多个域名,可使用此接口批量添加域名接入规则。 | |
当您的源站服务器组因故障不可用或是因业务变化、资源分配等问题需要切换主备源站,可调用此接口。 | |
根据域名规则 ID 批量删除域名接入规则。 | |
当您需要批量修改多个防护域名的接入规则时,可调用此接口,修改后原有的规则将被直接覆盖。 |
API | 说明 |
---|---|
添加端口转发规则,支持添加单条规则或批量添加多条规则。 | |
删除不再需要的端口转发规则,支持单条删除或批量删除。 | |
如因为源站地址变化需要编辑已有的端口转发规则,可调用此接口。支持同时更新源站地址和连接超时时间。 | |
按特定协议或端口号查询对应实例下的端口转发规则。 | |
查询高防回源 IP 地址段信息,用于源站地址加白。 |
API | 说明 |
---|---|
查询指定域名下的 CC 防护规则详情。 | |
查询指定域名下的 Web 攻击防护策略开启状态,即 CC 防护、区域封禁、访问黑白名单是否开启。 | |
为防护网站配置 CC 规则后,DDoS 高防服务会限制对网站特定路径的访问频率,精准识别 CC 攻击,缓解 CC 攻击对服务器的影响。 | |
根据规则 ID 和防护域名,删除已经创建的 CC 防护规则。暂不支持批量删除。 | |
根据防护域名,修改 CC 防护规则的启用状态。修改后,该域名下所有 CC 规则的启用状态将同步变化。 | |
更新 CC 防护规则,支持修改创建 CC 规则时传入的所有参数,包括规则名称、请求路径等。 |
API | 说明 |
---|---|
查询实例在固定时段内的业务流量数据,包括业务带宽、包速率和连接数。 | |
根据域名查询 Web 攻击次数趋势,包括攻击次数、回源次数和入向次数。 | |
根据域名信息查询被攻击次数最多的前 10 个路径,包括被攻击的域名、路径、攻击次数及其对应百分比。 | |
查询 DDoS 攻击流量带宽和包速率信息,支持查询峰值或加和值。 | |
根据域名查询 Web 攻击总览信息,包括攻击次数、攻击源 IP 数量与攻击峰值,支持查询单个或多个域名。 | |
根据域名信息查询发起攻击次数最多的前 10 个攻击源 IP 信息,包括 IP 地址、归属地、攻击次数及其对应百分比。 | |
查询实例在特定时段内遭受的 DDoS 攻击事件详情,包括攻击状态、攻击类型和攻击持续时间等信息。 | |
如果告警阈值过低,可能导致告警事件过于频繁,造成干扰;而告警阈值过高,可能导致漏掉攻击事件信息,影响正常业务。因此,建议根据业务实际场景调整告警阈值。 | |
根据高防实例 IP 地址查询当前攻击告警阈值。 | |
查询指定域名的 Web 攻击防护应用层带宽趋势,包括在不同时间点的平均值和峰值。 | |
查询指定域名的 Web 攻击防护请求速率趋势,包括入向、回源和攻击三种流量在不同时间点的平均值和峰值。 | |
查询指定域名的 Web 攻击防护响应码分布趋势及占比。 |
API | 说明 |
---|---|
根据防护域名,攻击源 IP、攻击类型或攻击路径等信息,查询 Web 攻击防护日志,包括请求方法,请求协议等信息。 |
API | 说明 |
---|---|
查询指定原生防护实例下的攻击事件列表。 | |
根据防护实例 ID 或攻击事件 ID 查询特定时间范围内的业务流量数据。 | |
根据防护实例 ID 或者攻击事件 ID 查询特定时间范围内的攻击流量数据。 | |
根据防护实例 ID 和 IP 地址查询特定时间范围内的入向流量数据。入向流量是指从请求端流向 DDoS 原生防护实例的流量。 |
API | 说明 |
---|---|
根据需要绑定的 EIP 地址,将待防护 EIP 绑定至指定的原生防护实例中。 | |
查询指定实例下可绑定的防护资源列表,可根据资源类型进行筛选。 | |
获取指定实例下已绑定的防护资源列表信息。 | |
批量移除指定防护实例下的防护资源。 | |
将处于黑洞封禁状态中的防护资源 IP 解除封禁。建议您在解封黑洞前先提升保底或弹性防护能力,避免解封后 DDoS 实例因再次被攻击而进入黑洞状态。 |
API | 说明 |
---|---|
按指定规格购买 DDoS 原生防护实例。 | |
查询 DDoS 原生防护实例列表,获取实例 ID、规格、计费状态等信息。 | |
根据实例 ID,查询单个实例的基本信息。 | |
根据实例规格(企业版或高级版)查询对应的实例列表信息,或根据实例名称模糊匹配对应的实例列表。 | |
支持手动更新实例的名称,便于识别和管理您的示例。 |
API | 说明 |
---|---|
查询单个攻击事件内攻击源 IP 发送的攻击流量占比,按攻击源 IP 所属地域聚合,由高至低排列。 | |
查询单个攻击事件内,各种拦截流量类型对应攻击流量占总攻击流量的比例,按占比数值由高至低排列。 | |
您可调用此接口查询防护资源 IP 遭受的攻击事件详情,例如攻击类型、持续时间、攻击状态等,支持查询单个或多个防护资源 IP。 | |
查询单个攻击事件内目的端口信息,包括端口号、协议和所收到的攻击流量占比。按占比由高至低排列。 | |
攻击告警阈值基于实例维度生效,当攻击峰值超出设定的阈值时,平台会记录攻击事件记录并发送告警通知。您可以根据实例 ID,查询对应的攻击告警阈值。 | |
查询指定攻击事件中,攻击源 IP 的地址和流量占比,按占比数值由高至低排列。 | |
如果告警阈值过低,可能导致告警事件过于频繁,造成干扰;而告警阈值过高,可能导致漏掉攻击事件信息,影响正常业务。因此,建议根据业务实际场景调整告警阈值。 |