API概览

本文档汇总了DDoS高防服务所有可调用的API，具体接口信息请参见相关文档。

说明 本文档所列举的接口适用于DDoS高防（新BGP）和DDoS高防（国际）服务。

• 在使用以下接口前，请确认您已经开通了DDoS高防（新BGP）或者DDoS高防（国际）实例。更多信息，请参见开通DDoS高防（新BGP&国际）。
• 如无特殊说明，以下接口同时适用于DDoS高防（新BGP）和DDoS高防（国际），个别仅适用于DDoS高防（新BGP）或者DDoS高防（国际）的接口，在相关接口文档中有说明。

  关于DDoS高防（新BGP）和DDoS高防（国际）的功能差异，请参见DDoS高防（新BGP）和DDoS高防（国际）的功能差异。

关于更多API资源，请访问API Explorer。

实例

API	描述
DescribeInstanceIds	查询DDoS高防实例的ID信息。
DescribeInstances	查询DDoS高防实例的版本和状态信息，例如业务转发状态、到期状态、欠费状态等。
DescribeInstanceDetails	查询DDoS高防实例的IP和线路信息。
DescribeInstanceSpecs	查询DDoS高防实例的规格信息。
DescribeInstanceStatistics	查询DDoS高防实例的统计信息，例如已防护的域名、端口数量等。
ModifyInstanceRemark	编辑DDoS高防实例的备注。
DescribeElasticBandwidthSpec	查询DDoS高防（新BGP）实例的可选弹性防护带宽规格。
ModifyElasticBandWidth	修改DDoS高防（新BGP）实例的弹性防护带宽。
DescribeDefenseCountStatistics	查询DDoS高防（国际）服务的防护次数统计信息，例如可用和已用的高级防护次数。
ReleaseInstance	释放某个已经到期的DDoS高防实例。

接入管理

表 1. 域名接入

API	描述
DescribeDomains	查询已配置网站业务转发规则的域名。
DescribeWebRules	查询网站业务转发规则。
CreateWebRule	创建网站业务转发规则。
ModifyWebRule	编辑网站业务转发规则。
DeleteWebRule	删除网站业务转发规则。
DescribeWebInstanceRelations	查询网站业务关联的DDoS高防实例信息。
AssociateWebCert	为网站业务转发规则关联SSL证书。
ModifyTlsConfig	编辑网站业务转发规则的TLS安全策略。
DescribeWebCustomPorts	查询DDoS高防支持的网站业务自定义端口范围。
DescribeWebAccessMode	查询网站业务的接入模式。
ModifyWebAccessMode	设置网站业务的接入模式。
DescribeCerts	查询网站业务的证书信息。
DescribeCnameReuses	查询网站业务的CNAME复用信息。
ModifyCnameReuse	为网站业务开启或关闭CNAME复用。
ModifyHttp2Enable	设置网站业务转发规则的HTTP2.0开关状态。

表 2. 端口接入

API	描述
DescribeNetworkRules	查询端口转发规则。
CreateNetworkRules	创建端口转发规则。
ConfigNetworkRules	编辑端口转发规则。
DeleteNetworkRule	删除端口转发规则。
DescribeHealthCheckList	查询端口转发规则的健康检查配置（四层或七层）。
ModifyHealthCheckConfig	编辑端口转发规则的健康检查配置（四层或七层）。
DescribeHealthCheckStatus	查询源站健康检查状态信息。

表 3. 流量调度器

API	描述
DescribeSchedulerRules	查询流量调度器的调度规则。
CreateSchedulerRule	创建流量调度器调度规则。
ModifySchedulerRule	编辑流量调度器调度规则。
DeleteSchedulerRule	删除流量调度器调度规则。

防护设置

表 4. 基础设施防护策略

API	描述
DescribeAutoCcListCount	查询针对DDoS高防实例的黑名单和白名单IP的数量。
DescribeAutoCcBlacklist	查询针对DDoS高防实例的黑名单IP。
AddAutoCcBlacklist	添加针对DDoS高防实例的黑名单IP。
DeleteAutoCcBlacklist	删除针对DDoS高防实例的黑名单IP。
EmptyAutoCcBlacklist	清空针对DDoS高防实例的黑名单IP。
DescribeAutoCcWhitelist	查询针对DDoS高防实例的白名单IP。
AddAutoCcWhitelist	添加针对DDoS高防实例的白名单IP。
DeleteAutoCcWhitelist	删除针对DDoS高防实例的白名单IP。
EmptyAutoCcWhitelist	清空针对DDoS高防实例的白名单IP。
DescribeUnBlackholeCount	查询黑洞解封次数。
DescribeBlackholeStatus	查询DDoS高防实例的黑洞状态。
ModifyBlackholeStatus	执行黑洞解封。
DescribeNetworkRegionBlock	查询针对DDoS高防实例的区域封禁配置。
ConfigNetworkRegionBlock	设置针对DDoS高防实例的区域封禁。
DescribeBlockStatus	查询DDoS高防（新BGP）实例的近源流量压制配置。
ModifyBlockStatus	设置DDoS高防（新BGP）实例的近源流量压制。
DescribeUnBlockCount	查询可用的近源流量压制次数。

表 5. 网站业务防护策略

API	描述
DescribeWebCcProtectSwitch	查询网站业务各防护功能的开关状态。
ModifyWebAIProtectSwitch	设置网站业务AI智能防护的开关状态。
ModifyWebAIProtectMode	设置网站业务AI智能防护的模式。
ModifyWebIpSetSwitch	设置网站业务黑白名单（针对域名）的开关状态。
ConfigWebIpSet	设置针对网站业务的黑名单和白名单IP。
EnableWebCC	开启网站业务频率控制防护（CC防护）的开关。
DisableWebCC	关闭网站业务频率控制防护（CC防护）的开关。
ConfigWebCCTemplate	设置网站业务频率控制防护（CC防护）的防护模式。
EnableWebCCRule	开启网站业务频率控制防护（CC防护）的自定义规则开关。
DisableWebCCRule	关闭网站业务频率控制防护（CC防护）的自定义规则开关。
DescribeWebCCRules	查询网站业务频率控制防护（CC防护）的自定义规则。
CreateWebCCRule	创建网站业务频率控制防护（CC防护）的自定义规则。
ModifyWebCCRule	编辑网站业务频率控制防护（CC防护）的自定义规则。
DeleteWebCCRule	删除网站业务频率控制防护（CC防护）的自定义规则。
ModifyWebPreciseAccessSwitch	设置网站业务精确访问控制的开关状态。
DescribeWebPreciseAccessRule	查询网站业务精确访问控制规则。
ModifyWebPreciseAccessRule	编辑网站业务精确访问控制规则。
DeleteWebPreciseAccessRule	删除网站业务精确访问控制规则。
ModifyWebAreaBlockSwitch	设置网站业务区域封禁（针对域名）的开关状态。
DescribeWebAreaBlockConfigs	查询网站业务区域封禁（针对域名）的配置信息。
ModifyWebAreaBlock	设置网站业务区域封禁（针对域名）的封禁地区。

表 6. 非网站业务防护策略

API	描述
DescribePortAutoCcStatus	查询非网站业务AI智能防护的配置信息。
ModifyPortAutoCcStatus	设置非网站业务AI智能防护。
DescribeNetworkRuleAttributes	查询非网站业务端口转发规则的防护配置，包括会话保持和DDoS防护策略。
ModifyNetworkRuleAttribute	编辑非网站业务端口转发规则的会话保持策略。

表 7. 定制场景策略

API	描述
DescribeSceneDefensePolicies	查询定制场景策略的详细信息。
CreateSceneDefensePolicy	创建定制场景策略。
ModifySceneDefensePolicy	编辑定制场景策略。
DeleteSceneDefensePolicy	删除定制场景策略。
DescribeSceneDefenseObjects	查询定制场景策略的防护对象。
AttachSceneDefenseObject	为定制场景策略添加防护对象。
DetachSceneDefenseObject	为定制场景策略移除防护对象。
EnableSceneDefensePolicy	启用定制场景策略。
DisableSceneDefensePolicy	禁用定制场景策略。

监控报表

API	描述
DescribeDDoSEvents	查询针对DDoS高防实例的攻击事件。
DescribePortFlowList	查询DDoS高防实例的流量数据列表。
DescribePortConnsList	查询DDoS高防实例的端口连接数列表。
DescribePortConnsCount	查询DDoS高防实例的端口连接数统计信息。
DescribePortMaxConns	查询DDoS高防实例的端口连接峰值信息。
DescribePortAttackMaxFlow	查询指定时间段内DDoS高防受到的攻击带宽和包速峰值。
DescribePortViewSourceCountries	查询指定时间段内DDoS高防实例的请求来源国家分布。
DescribePortViewSourceProvinces	查询指定时间段内DDoS高防实例的请求来源（中国）省份分布。
DescribePortViewSourceIsps	查询指定时间段内DDoS高防实例的请求来源运营商分布。
DescribeDomainAttackEvents	查询针对网站业务的攻击事件。
DescribeDomainQPSList	查询网站业务的QPS统计信息。
DescribeDomainQpsWithCache	查询网站业务的QPS数据列表，例如总QPS、由不同防护功能阻断的QPS、缓存命中数等。
DescribeDomainOverview	查询网站业务攻击总览，包括HTTP攻击峰值、HTTPS攻击峰值。
DescribeDomainStatusCodeList	查询网站业务的各类响应状态码统计列表。
DescribeDomainStatusCodeCount	查询指定时间段内网站业务的各类响应状态码的统计信息。
DescribeDomainTopAttackList	查询指定时间段内网站业务的QPS峰值数据，包括攻击QPS、总QPS。
DescribeDomainViewSourceCountries	查询指定时间段内网站业务的请求来源国家分布。
DescribeDomainViewSourceProvinces	查询指定时间段内网站业务的请求来源（中国）省份分布。
DescribeDomainViewTopCostTime	查询指定时间段内网站业务的请求耗时最大的前N个URL。
DescribeDomainViewTopUrl	查询指定时间段内网站业务访问量最大的前N个URL。

全量日志分析

API	描述
DescribeSlsOpenStatus	查询阿里云日志服务SLS（Log Service）的开通状态。
DescribeSlsAuthStatus	查询DDoS高防全量日志分析服务的授权状态，即是否授权DDoS高防访问日志服务。
DescribeLogStoreExistStatus	查询是否已创建DDoS高防的日志库。
DescribeSlsLogstoreInfo	查询DDoS高防的日志库信息，例如日志存储容量、日志存储时长等。
ModifyFullLogTtl	编辑DDoS高防全量日志的存储时长。
DescribeWebAccessLogDispatchStatus	查询所有域名的全量日志开关状态。
DescribeWebAccessLogStatus	查询单个网站业务的全量日志服务信息，例如开关状态、对接的日志项目、日志库。
EnableWebAccessLogConfig	为网站业务开启全量日志分析。
DisableWebAccessLogConfig	为网站业务关闭全量日志分析。
DescribeWebAccessLogEmptyCount	查询可用的清空日志库的次数。
EmptySlsLogstore	清空DDoS高防的日志库。

标签

API	描述
DescribeTagKeys	查询所有标签键。
DescribeTagResources	查询资源关联的标签信息。
CreateTagResources	为资源关联标签。
DeleteTagResources	为资源移除标签。

静态页面缓存

API	描述
DescribeWebCacheConfigs	查询网站业务静态页面缓存的配置。
ModifyWebCacheSwitch	设置网站业务静态页面缓存的开关状态。
ModifyWebCacheMode	设置网站业务静态页面缓存的缓存模式。
ModifyWebCacheCustomRule	设置网站业务静态页面缓存的自定义规则。
DeleteWebCacheCustomRule	删除网站业务静态页面缓存的自定义规则。

系统配置与日志

API	描述
DescribeStsGrantStatus	查询是否授权DDoS高防服务访问其他云产品。
DescribeBackSourceCidr	查询DDoS高防的回源IP网段。
DescribeOpEntities	查询DDoS高防（新BGP）的操作日志。
DescribeDefenseRecords	查询DDoS高防（国际）的高级防护日志。
DescribeAsyncTasks	查询异步导出任务的详细信息，例如任务ID、任务开始和结束时间、任务状态、任务参数、任务结果等。
CreateAsyncTask	创建异步导出任务，例如导出网站业务转发规则、端口转发规则、会话保持和健康检查配置、DDoS防护策略、IP黑白名单。
DeleteAsyncTask	删除异步导出任务。