AI 助理
备案控制台
文档
输入文档关键字查找
首页 DDoS防护 DDoS高防 开发参考 API参考 API概览

API概览

更新时间：
产品详情
我的收藏
本产品（新BGP高防IP/2020-01-01）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（78410016550），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

实例

API标题API概述
ReleaseInstance释放已经到期的DDoS高防实例释放已经到期的DDoS高防实例。
ModifyInstanceRemark修改指定实例的备注信息编辑DDoS高防实例的备注。
ModifyElasticBandWidth修改指定实例的弹性防护带宽修改DDoS高防（中国内地）实例的弹性防护带宽。
DescribeInstanceIds查询DDoS高防实例的ID信息查询DDoS高防实例的ID、版本、备注、IP类型信息。
DescribeInstanceStatus查询指定的DDoS高防实例的状态查询指定的DDoS高防实例的状态。
DescribeElasticBandwidthSpec查询指定实例的弹性带宽规格查询DDoS高防（中国内地）实例的可选弹性防护带宽规格。
DescribeInstanceStatistics查询指定实例的统计信息查询DDoS高防实例的统计信息，例如已防护的域名、端口数量等。
DescribeInstances分页查询DDoS高防（中国内地）实例信息列表查询DDoS高防实例的详情列表。
DescribeInstanceSpecs查询DDoS高防实例的规格信息查询DDoS高防实例的规格配置。
DescribeInstanceDetails查询DDoS高防实例的IP和线路信息查询DDoS高防实例的IP和线路信息。
ModifyElasticBizQps修改指定实例的弹性QPS设置DDoS高防实例的弹性QPS和模式。
ModifyQpsMode切换弹性QPS计费模式切换弹性业务带宽的95计费模式。
DescribeInstanceExt查询DDoS高防实例的扩展信息查询DDoS高防实例的扩展信息。

域名

API标题API概述
CreateWebRule创建一条网站业务转发规则创建一条网站业务转发规则。
DeleteWebRule删除网站业务转发规则删除网站业务转发规则。
ModifyWebRule修改已经创建的网站业务转发规则修改已经创建的网站业务转发规则。
ModifyTlsConfig编辑网站业务转发规则的TLS安全策略编辑网站业务转发规则的TLS安全策略。
ModifyHttp2Enable设置网站业务转发规则的HTTP2.0开关状态设置网站业务转发规则的HTTP2.0开关状态。
ModifyWebAccessMode设置网站业务的接入模式设置网站业务的接入模式。
ModifyCnameReuse为网站业务开启或关闭CNAME复用为网站业务开启或关闭CNAME复用。
DescribeWebRules查询已经创建的网站业务转发规则查询网站业务转发规则的配置。
DescribeWebInstanceRelations查询网站业务关联的DDoS高防实例信息查询网站业务关联的DDoS高防实例信息。
DescribeCerts查询适用于当前域名的所有证书列表查询用户适用于当前域名的所有证书信息，而非当前使用的证书。
DescribeWebCustomPorts查询网站业务自定义端口范围查询DDoS高防支持的网站业务自定义端口范围。
DescribeWebAccessMode查询网站业务的接入模式查询网站业务的接入模式。
DescribeCnameReuses查询网站业务的CNAME复用信息查询网站业务的CNAME复用信息。
DescribeL7RsPolicy查询网站业务转发规则的回源策略查询网站业务转发规则的回源策略。
AssociateWebCert为网站业务转发规则关联SSL证书为网站业务转发规则关联SSL证书。
ConfigL7RsPolicy为转发规则设置回源策略为已经创建的网站业务转发规则设置回源策略。
ModifyOcspStatus设置是否启用 OCSP （Online Certificate Status Protocol）功能是否启用 OCSP （Online Certificate Status Protocol）功能。
ConfigL7UsKeepalive配置域名回源长连接设置配置域名回源长连接设置。
DescribeL7UsKeepalive查询回源长连接设置查询域名回源长连接设置。
ModifyHeaders修改自定义header修改DDoS高防实例中已创建的域名自定义Header。
DescribeDomainH2Fingerprint查询网站 HTTP2.0 指纹查询网站的HTTP 2.0 指纹信息。
DescribeDomainTopReferer查询网站Top Referer查询网站Top N Referer。
DescribeDomainTopUserAgent查询网站Top UserAgent查询网站Top UserAgent。
DescribeDomainTopFingerprint查询网站Top N客户端指纹查询网站Top N 客户端指纹。
DescribeDomainBps查询网站带宽流量查询网站带宽流量。
DescribeDomainTopHttpMethod查询网站Top HTTP_Method查询网站Top N的HTTP_Method。

任务

API标题API概述
CreateAsyncTask创建异步导出任务创建异步导出任务，例如导出网站业务转发规则、端口转发规则、会话保持和健康检查配置、DDoS防护策略、IP黑白名单。
DeleteAsyncTask删除指定的异步任务删除异步导出任务。

网络转发规则

API标题API概述
CreateNetworkRules创建端口转发规则创建端口转发规则。
DeleteNetworkRule删除端口转发规则目前不支持批量删除，每次只允许删除一个对象。
ModifyHealthCheckConfig编辑健康检查配置编辑端口转发规则的健康检查配置（四层或七层）。
DescribeNetworkRules查询端口转发规则查询端口转发规则。
DescribeHealthCheckStatus查询源站健康检查状态信息查询源站健康检查状态信息。
ConfigNetworkRules编辑端口转发规则修改源站IP地址。

流量调度器

API标题API概述
CreateSchedulerRule创建流量调度器调度规则创建流量调度器调度规则。
DeleteSchedulerRule删除流量调度器调度规则删除流量调度器调度规则。
ModifySchedulerRule编辑流量调度器调度规则编辑流量调度器调度规则。
DescribeSchedulerRules查询流量调度器的调度规则查询流量调度器的调度规则。
SwitchSchedulerRule切换调度规则将业务流量切换到DDoS高防实例进行清洗、回切到联动资源。

基础设施防护策略

API标题API概述
AddAutoCcBlacklist添加针对DDoS高防实例的黑名单IP添加针对DDoS高防实例的黑名单IP。
AddAutoCcWhitelist添加针对DDoS高防实例的白名单IP添加针对DDoS高防实例的白名单IP。
DeleteAutoCcBlacklist删除针对DDoS高防实例的黑名单IP删除针对DDoS高防实例的黑名单IP。
DeleteAutoCcWhitelist删除针对DDoS高防实例的白名单IP删除针对DDoS高防实例的白名单IP。
ModifyBlackholeStatus执行黑洞解封执行黑洞解封。
ModifyBlockStatus设置实例近源流量压制设置DDoS高防（中国内地）实例的近源流量压制。
DescribeAutoCcListCount查询黑名单和白名单IP的数量查询针对DDoS高防实例的黑名单和白名单IP的数量。
DescribeAutoCcBlacklist查询针对DDoS高防实例的黑名单IP查询针对DDoS高防实例的黑名单IP。
DescribeAutoCcWhitelist查询针对DDoS高防实例的白名单IP查询针对DDoS高防实例的白名单IP。
DescribeUnBlackholeCount查询黑洞解封次数查询黑洞解封次数。
DescribeBlackholeStatus查询DDoS高防实例的黑洞状态查询DDoS高防实例的黑洞状态。
DescribeNetworkRegionBlock查询区域封禁配置查询针对DDoS高防实例的区域封禁配置。
DescribeBlockStatus查询实例近源流量压制配置查询DDoS高防（中国内地）实例的近源流量压制配置。
DescribeUnBlockCount查询可用的近源流量压制次数查询可用的近源流量压制次数。
EmptyAutoCcBlacklist清空针对DDoS高防实例的黑名单IP清空针对DDoS高防实例的黑名单IP。
EmptyAutoCcWhitelist清空针对DDoS高防实例的白名单IP清空针对DDoS高防实例的白名单IP。
ConfigNetworkRegionBlock设置针对DDoS高防实例的区域封禁设置针对DDoS高防实例的区域封禁。
DescribeUdpReflect查询 UDP 反射攻击防护策略查询指定的DDoS高防实例上被UDP反射攻击防护策略过滤的反射源端口。
ConfigUdpReflect配置 UDP 反射攻击防护策略添加UDP反射攻击防护策略，过滤指定的反射源端口。

网站业务防护策略

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

非网站业务防护策略

API标题API概述
ModifyPortAutoCcStatus设置非网站业务AI智能防护设置非网站业务AI智能防护。
ModifyNetworkRuleAttribute编辑端口转发规则的会话保持和DDoS防护策略设置编辑端口转发规则的会话保持和DDoS防护策略设置。
DescribePortAutoCcStatus查询非网站业务AI智能防护的配置信息查询非网站业务AI智能防护的配置信息。
DescribeDomains查询已配置网站业务转发规则的域名查询已配置网站业务转发规则的域名。
DescribeHealthCheckList查询端口转发规则的健康检查配置查询端口转发规则的健康检查配置（四层或七层）。
DescribeNetworkRuleAttributes查询非网站业务端口转发规则防护配置查询非网站业务端口转发规则的防护配置，包括会话保持和DDoS防护策略。

定制场景策略

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

静态页面缓存

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

攻击分析

API标题API概述
DescribeDDosEventMax查询攻击峰值查询流量型攻击峰值（bps）、连接型攻击峰值（cps）、Web资源耗尽型攻击峰值（qps）。
DescribeDDosEventArea查询某次流量型攻击的来源地域详情查询某次流量型攻击的来源地域详情。
DescribeDDosEventAttackType查询某次流量型攻击的攻击类型详情查询某次流量型攻击的攻击类型详情。
DescribeDDosEventIsp查询攻击来源网络运营商（ISP）信息查询某次流量型攻击的攻击来源网络运营商（ISP）信息。
DescribeDDosEventSrcIp查询某次流量型攻击的攻击来源IP详情查询某次流量型攻击的攻击来源IP详情。
DescribeBackSourceCidr查询高防回源网段地址查询DDoS高防的回源IP网段。
DescribeDDosAllEventList查询攻击事件列表查询DDoS攻击事件列表。
DescribeDDoSEvents查询指定IP的DDoS攻击事件查询针对DDoS高防实例的攻击事件。
DescribeSlaEventList查询目的限速事件列表查询目的限速事件列表。
DescribeDomainAttackEvents查询针对网站业务的攻击事件查询针对网站业务的攻击事件。
DescribeDefenseCountStatistics查询DDoS高防（非中国内地）服务的高级防护次数统计数据查询DDoS高防（非中国内地）服务的高级防护次数统计数据。
DescribeAttackAnalysisMaxQps查询指攻击的峰值查询指定时间段内DDoS攻击的峰值（qps）。
DescribeDestinationPortEvent查询DDoS高防攻击IP的目的端口包数量信息查询DDoS高防被攻击IP的目的端口包数量信息。

监控报表

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

日志

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

系统配置与日志

API标题API概述
DescribeStsGrantStatus查询是否授权访问其他云产品查询是否授权DDoS高防服务访问其他云产品。
DescribeAsyncTasks查询异步导出任务详细信息例如任务ID、任务开始和结束时间、任务状态、任务参数、任务结果等。
DescribeSystemLog获取系统日志查询弹性业务带宽的账单详情。
DescribeElasticQps查询DDoS高防实例弹性QPS账单曲线图查询DDoS高防实例弹性QPS账单曲线图。
DescribeElasticQpsRecord查询实例弹性QPS详情查询实例弹性QPS详情。

标签

API标题API概述
CreateTagResources为资源关联标签为DDoS高防实例绑定标签。
DeleteTagResources为资源移除标签为DDoS高防（中国内地）实例移除标签。
DescribeTagKeys查询所有标签键查询所有标签键及标签键关联的DDoS高防（中国内地）实例的数量。
DescribeTagResources查询资源关联的标签信息查询DDoS高防（中国内地）实例绑定的标签信息。

端口

API标题API概述
CreatePort创建一条端口转发规则创建一条端口转发规则。
DeletePort删除指定的端口转发规则删除指定的端口转发规则。
ModifyPort修改已创建的端口转发规则修改已创建的端口转发规则。
DescribePort查询端口转发规则查询DDoS高防实例下已创建的端口转发规则。

其他

API标题API概述
CreateDomainResource创建一条网站业务转发规则创建一条网站业务转发规则。
DeleteDomainResource删除指定的网站业务转发规则删除指定的网站业务转发规则。
DescribeDomainResource查询网站业务转发规则的配置查询网站业务转发规则的配置。
ModifyDomainResource修改已创建的网站业务转发规则修改已创建的网站业务转发规则。
ConfigLayer4Remark为端口转发规则添加备注为端口转发规则添加备注。
ConfigLayer4RuleBakMode修改端口转发规则的回源模式修改端口转发规则的回源模式（启用或关闭主备回源）。
ConfigLayer4RulePolicy配置4层规则策略为端口转发规则设置主、备源站IP地址。
DescribeLayer4RulePolicy查询端口转发规则的回源设置查询端口转发规则的回源设置。
上一篇：API参考下一篇：服务接入点
文档推荐