You need to enable JavaScript to run this app.
导航
API 列表
最近更新时间:2024.07.22 11:54:09首次发布时间:2023.12.13 17:08:15

本文为您列出 DDoS 防护服务当前支持的 API 功能及对应调用文档。

服务名和版本信息

  • DDoS 基础防护的服务名为ddos,版本为2020-12-08
  • DDoS 高防的服务名为AdvDefence,版本为2021-06-152023-03-08
  • DDoS 原生防护的服务名为origin_defence,版本为2022-01-01

DDoS 基础防护

告警列表

API

说明

GetAlarm-获取基础防护攻击和黑洞信息

查询指定 IP 的 DDoS 基础防护攻击和黑洞信息。

DDoS 高防

实例管理

API

说明

DescInstanceList-获取实例列表

根据实例名称和状态查询实例列表。

域名接入配置

API

说明

AddHostRule-添加域名接入规则

创建域名接入规则。

DelHostRule-删除域名接入规则

根据域名删除相关的防护接入规则。

UpdHostRule-修改域名接入规则

根据高防实例 IP 和防护域名,修改域名接入规则信息。

DescHostRules-查询域名接入规则

通过实例或域名,查询对应的域名接入规则详情。

DescCertificate-查询域名关联证书

根据域名信息查询关联的证书详情,也可以查询账号下所有证书信息。

BatchAddHostRule-批量添加域名接入规则

当您需要批量接入多个域名,可使用此接口批量添加域名接入规则。

BatchSwitchBackupServers-批量切换主备源站

当您的源站服务器组因故障不可用或是因业务变化、资源分配等问题需要切换主备源站,可调用此接口。

BatchDelHostRule-批量删除域名接入规则

根据域名规则 ID 批量删除域名接入规则。

BatchUpdHostRule-批量修改域名接入规则

当您需要批量修改多个防护域名的接入规则时,可调用此接口,修改后原有的规则将被直接覆盖。

端口接入配置

API

说明

BatchAddFwdRule-添加端口转发规则

添加端口转发规则,支持添加单条规则或批量添加多条规则。

BatchDeleteFwdRule-删除端口转发规则

删除不再需要的端口转发规则,支持单条删除或批量删除。

UpdateFwdRule-更新端口转发规则

如因为源站地址变化需要编辑已有的端口转发规则,可调用此接口。支持同时更新源站地址和连接超时时间。

DescFwdRule-查询端口转发规则

按特定协议或端口号查询对应实例下的端口转发规则。

GetFwdRuleLipList-查询回源 IP 地址

查询高防回源 IP 地址段信息,用于源站地址加白。

防护策略

API

说明

DescWebDefCcRule-查询 CC 防护规则

查询指定域名下的 CC 防护规则详情。

GetHostDefStatus-查询 Web 攻击防护策略启用状态

查询指定域名下的 Web 攻击防护策略开启状态,即 CC 防护、区域封禁、访问黑白名单是否开启。

AddWebDefCcRule-添加 CC 防护规则

为防护网站配置 CC 规则后,DDoS 高防服务会限制对网站特定路径的访问频率,精准识别 CC 攻击,缓解 CC 攻击对服务器的影响。

DelWebDefCcRule-删除 CC 防护规则

根据规则 ID 和防护域名,删除已经创建的 CC 防护规则。暂不支持批量删除。

SetDefSwitch-修改 CC 防护规则开关

根据防护域名,修改 CC 防护规则的启用状态。修改后,该域名下所有 CC 规则的启用状态将同步变化。

UpdWebDefCcRule-更新 CC 防护规则

更新 CC 防护规则,支持修改创建 CC 规则时传入的所有参数,包括规则名称、请求路径等。

流量报表

API

说明

DescBizFlowAndConnCount-查询业务流量数据

查询实例在固定时段内的业务流量数据,包括业务带宽、包速率和连接数。

DescWebAtkStatistics-查询 Web 攻击次数信息

根据域名查询 Web 攻击次数趋势,包括攻击次数、回源次数和入向次数。

DescWebAtkTopUrl-查询 Top 10 被攻击路径

根据域名信息查询被攻击次数最多的前 10 个路径,包括被攻击的域名、路径、攻击次数及其对应百分比。

DescBizAttackFlow-查询 DDoS 攻击流量信息

查询 DDoS 攻击流量带宽和包速率信息,支持查询峰值或加和值。

DescWebAtkOverview-查询 Web 攻击概览数据

根据域名查询 Web 攻击总览信息,包括攻击次数、攻击源 IP 数量与攻击峰值,支持查询单个或多个域名。

DescWebAtkTopSrcIp-查询 Top 10 攻击源 IP

根据域名信息查询发起攻击次数最多的前 10 个攻击源 IP 信息,包括 IP 地址、归属地、攻击次数及其对应百分比。

DescribeAttackEvent-查询 DDoS 攻击事件详情

查询实例在特定时段内遭受的 DDoS 攻击事件详情,包括攻击状态、攻击类型和攻击持续时间等信息。

UpdateAtkAlarmThreshold-更新实例的攻击告警阈值

如果告警阈值过低,可能导致告警事件过于频繁,造成干扰;而告警阈值过高,可能导致漏掉攻击事件信息,影响正常业务。因此,建议根据业务实际场景调整告警阈值。

DescAtkAlarmThreshold-查询实例的攻击告警阈值

根据高防实例 IP 地址查询当前攻击告警阈值。

DescWebBpsFlow-查询 Web 攻击防护应用层带宽信息

查询指定域名的 Web 攻击防护应用层带宽趋势,包括在不同时间点的平均值和峰值。

DescWebQpsFlow-查询 Web 攻击防护请求速率信息

查询指定域名的 Web 攻击防护请求速率趋势,包括入向、回源和攻击三种流量在不同时间点的平均值和峰值。

DescWebRespCode-查询 Web 攻击防护响应码信息

查询指定域名的 Web 攻击防护响应码分布趋势及占比。

日志管理

API

说明

GetWebDefAttackLog-查询 Web 攻击防护日志

根据防护域名,攻击源 IP、攻击类型或攻击路径等信息,查询 Web 攻击防护日志,包括请求方法,请求协议等信息。

DDoS 原生防护

流量报表

API

说明

DescAttackEvent-查询攻击事件列表

查询指定原生防护实例下的攻击事件列表。

DescBizFlow-查询业务流量信息

根据防护实例 ID 或攻击事件 ID 查询特定时间范围内的业务流量数据。

DescAttackFlow-查询攻击流量信息

根据防护实例 ID 或者攻击事件 ID 查询特定时间范围内的攻击流量数据。

DescInFlow-查询入向流量信息

根据防护实例 ID 和 IP 地址查询特定时间范围内的入向流量数据。入向流量是指从请求端流向 DDoS 原生防护实例的流量。

防护资源

API

说明

BindEipToIns-将 EIP 资源绑定至原生防护实例

根据需要绑定的 EIP 地址,将待防护 EIP 绑定至指定的原生防护实例中。

DescFreeEipList-查询可绑定的防护资源信息

查询指定实例下可绑定的防护资源列表,可根据资源类型进行筛选。

DescResourceList-查询实例已绑定的防护资源

获取指定实例下已绑定的防护资源列表信息。

RemoveEipsFromIns-从原生防护实例中批量移除 EIP 资源

批量移除指定防护实例下的防护资源。

UnBlockHole-解除黑洞封禁资源

将处于黑洞封禁状态中的防护资源 IP 解除封禁。建议您在解封黑洞前先提升保底或弹性防护能力,避免解封后 DDoS 实例因再次被攻击而进入黑洞状态。

实例列表

API

说明

PurchaseInstanceInOneStep-购买原生防护实例

按指定规格购买 DDoS 原生防护实例。

DescInstanceList-查询原生防护实例列表

查询 DDoS 原生防护实例列表,获取实例 ID、规格、计费状态等信息。

DescInstance-查询实例基本信息

根据实例 ID,查询单个实例的基本信息。

DescInstanceList-查询实例列表

根据实例规格(企业版或高级版)查询对应的实例列表信息,或根据实例名称模糊匹配对应的实例列表。

UpdateInstance-更新实例名称

支持手动更新实例的名称,便于识别和管理您的示例。

攻击详情

API

说明

DescAttackSrcRegionTop100-查询攻击事件内攻击源 IP 地理位置分布占比

查询单个攻击事件内攻击源 IP 发送的攻击流量占比,按攻击源 IP 所属地域聚合,由高至低排列。

DescAttackTypeTop100-查询攻击事件内拦截流量类型分布占比

查询单个攻击事件内,各种拦截流量类型对应攻击流量占总攻击流量的比例,按占比数值由高至低排列。

DescAttackEvent-获取攻击事件列表

您可调用此接口查询防护资源 IP 遭受的攻击事件详情,例如攻击类型、持续时间、攻击状态等,支持查询单个或多个防护资源 IP。

DescAttackDstPortTop100-查询攻击事件内目的端口流量占比

查询单个攻击事件内目的端口信息,包括端口号、协议和所收到的攻击流量占比。按占比由高至低排列。

DescAtkAlarmThreshold-查询实例的攻击告警阈值

攻击告警阈值基于实例维度生效,当攻击峰值超出设定的阈值时,平台会记录攻击事件记录并发送告警通知。您可以根据实例 ID,查询对应的攻击告警阈值。

DescAttackSrcIpTop100-查询攻击事件内攻击源 IP 地址和占比

查询指定攻击事件中,攻击源 IP 的地址和流量占比,按占比数值由高至低排列。

UpdateAtkAlarmThreshold-更新实例的攻击报警阈值

如果告警阈值过低,可能导致告警事件过于频繁,造成干扰;而告警阈值过高,可能导致漏掉攻击事件信息,影响正常业务。因此,建议根据业务实际场景调整告警阈值。