本产品(
新BGP高防IP/2020-01-01
)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。在使用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 | 分页查询新BGP高防实例信息列表 | 查询DDoS高防实例的详情列表。 |
DescribeInstanceSpecs | 查询DDoS高防实例的规格信息 | 查询DDoS高防实例的规格配置。 |
DescribeInstanceDetails | 查询DDoS高防实例的IP和线路信息 | 查询DDoS高防实例的IP和线路信息。 |
ModifyElasticBizQps | 修改指定实例的弹性QPS | 设置DDoS高防实例的弹性QPS和模式。 |
ModifyQpsMode | 切换弹性QPS计费模式 | 切换弹性业务带宽的95计费模式。 |
域名
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。 |
任务
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 | 查询端口转发规则的回源设置 | 查询端口转发规则的回源设置。 |
DescribeInstanceExt | 查询DDoS高防实例的扩展信息 | 查询DDoS高防实例的扩展信息。 |