BaradData
巴拉多返回的数据
被如下接口引用:DescribeBaradData。
名称 | 类型 | 描述 |
---|---|---|
MetricName | String | 指标名(connum表示TCP活跃连接数; new_conn表示新建TCP连接数; inactive_conn表示非活跃连接数; intraffic表示入流量; outtraffic表示出流量; alltraffic表示出流量和入流量之和; inpkg表示入包速率; outpkg表示出包速率;) |
Data | Array of Float | 值数组 |
Count | Integer | 值数组的大小 |
CCEventRecord
CC攻击事件记录
被如下接口引用:DescribeCCEvList。
名称 | 类型 | 描述 |
---|---|---|
Business | String | 大禹子产品代号(shield表示棋牌;bgpip表示高防IP;bgp表示独享包;bgp-multip表示共享包;net表示高防IP专业版;basic表示DDoS基础防护) |
Id | String | 资源ID |
Vip | String | 资源的IP |
StartTime | Timestamp | 攻击开始时间 |
EndTime | Timestamp | 攻击结束时间 |
ReqQps | Integer | 总请求QPS峰值 |
DropQps | Integer | 攻击QPS峰值 |
AttackStatus | Integer | 攻击状态,取值[0(攻击中), 1(攻击结束)] |
ResourceName | String | 资源名称 注意:此字段可能返回 null,表示取不到有效值。 |
DomainList | String | 域名列表 注意:此字段可能返回 null,表示取不到有效值。 |
UriList | String | uri列表 注意:此字段可能返回 null,表示取不到有效值。 |
AttackipList | String | 攻击源列表 注意:此字段可能返回 null,表示取不到有效值。 |
CCPolicy
cc自定义规则
被如下接口引用:CreateCCSelfDefinePolicy、ModifyCCSelfDefinePolicy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Name | String | 是 | 策略名称 |
Smode | String | 是 | 匹配模式 |
SetId | String | 否 | 策略id |
Frequency | Integer | 否 | 每分钟限制的次数 |
ExeMode | String | 否 | 执行策略模式,拦截或者验证码 |
Switch | Integer | 否 | 生效开关 |
CreateTime | String | 否 | 创建时间 |
RuleList | Array of CCRule | 否 | 规则列表 |
IpList | Array of String | 否 | IP列表 |
Protocol | String | 否 | cc防护类型,取值[http,https] |
RuleId | String | 否 | 可选字段,表示https的CC防护域名对应的转发规则ID; |
Domain | String | 否 | https的CC防护域名 |
CCRule
cc自定义策略配置的规则
被如下接口引用:CreateCCSelfDefinePolicy、ModifyCCSelfDefinePolicy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Skey | String | 是 | 规则的key, 可以为host、cgi、ua、referer |
Operator | String | 是 | 规则的条件,可以为include、not_include、equal |
Value | String | 是 | 规则的值,长度小于31字节 |
CCRuleConfig
7层CC自定义规则
被如下接口引用:CreateL7CCRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Period | Integer | 是 | 统计周期,单位秒,取值[10, 30, 60] |
ReqNumber | Integer | 是 | 访问次数,取值[1-10000] |
Action | String | 是 | 执行动作,取值["alg"(人机识别), "drop"(拦截)] |
ExeDuration | Integer | 是 | 执行时间,单位秒,取值[1-900] |
DDoSEventRecord
DDoS攻击事件记录
被如下接口引用:DescribeDDoSEvList、DescribeDDoSNetEvList。
名称 | 类型 | 描述 |
---|---|---|
Business | String | 大禹子产品代号(shield表示棋牌;bgpip表示高防IP;bgp表示独享包;bgp-multip表示共享包;net表示高防IP专业版;basic表示DDoS基础防护) |
Id | String | 资源ID |
Vip | String | 资源的IP |
StartTime | Timestamp | 攻击开始时间 |
EndTime | Timestamp | 攻击结束时间 |
Mbps | Integer | 攻击最大带宽 |
Pps | Integer | 攻击最大包速率 |
AttackType | String | 攻击类型 |
BlockFlag | Integer | 是否被封堵,取值[1(是),0(否),2(无效值)] |
OverLoad | String | 是否超过弹性防护峰值,取值取值[yes(是),no(否),空字符串(未知值)] |
AttackStatus | Integer | 攻击状态,取值[0(攻击中), 1(攻击结束)] |
ResourceName | String | 资源名称 注意:此字段可能返回 null,表示取不到有效值。 |
DDoSPolicyDropOption
DDoS高级策略的禁用协议选项
被如下接口引用:CreateDDoSPolicy、DescribeDDoSPolicy、ModifyDDoSPolicy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
DropTcp | Integer | 是 | 禁用TCP协议,取值范围[0,1] |
DropUdp | Integer | 是 | 禁用UDP协议,取值范围[0,1] |
DropIcmp | Integer | 是 | 禁用ICMP协议,取值范围[0,1] |
DropOther | Integer | 是 | 禁用其他协议,取值范围[0,1] |
DropAbroad | Integer | 是 | 拒绝海外流量,取值范围[0,1] |
CheckSyncConn | Integer | 是 | 空连接防护,取值范围[0,1] |
SdNewLimit | Integer | 否 | 基于来源IP及目的IP的新建连接抑制,取值范围[0,4294967295] |
DstNewLimit | Integer | 否 | 基于目的IP的新建连接抑制,取值范围[0,4294967295] |
SdConnLimit | Integer | 否 | 基于来源IP及目的IP的并发连接抑制,取值范围[0,4294967295] |
DstConnLimit | Integer | 否 | 基于目的IP的并发连接抑制,取值范围[0,4294967295] |
BadConnThreshold | Integer | 否 | 基于连接抑制触发阈值,取值范围[0,4294967295] |
NullConnEnable | Integer | 否 | 异常连接检测条件,空连接防护开关,,取值范围[0,1] |
ConnTimeout | Integer | 否 | 异常连接检测条件,连接超时,,取值范围[0,65535] |
SynRate | Integer | 否 | 异常连接检测条件,syn占比ack百分比,,取值范围[0,100] |
SynLimit | Integer | 否 | 异常连接检测条件,syn阈值,取值范围[0,100] |
DTcpMbpsLimit | Integer | 否 | tcp限速,取值范围[0,4294967295] |
DUdpMbpsLimit | Integer | 否 | udp限速,取值范围[0,4294967295] |
DIcmpMbpsLimit | Integer | 否 | icmp限速,取值范围[0,4294967295] |
DOtherMbpsLimit | Integer | 否 | other协议限速,取值范围[0,4294967295] |
DDoSPolicyPacketFilter
DDoS高级策略的报文过滤项
被如下接口引用:CreateDDoSPolicy、DescribeDDoSPolicy、ModifyDDoSPolicy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Protocol | String | 是 | 协议,取值范围[tcp,udp,icmp,all] |
SportStart | Integer | 是 | 开始源端口,取值范围[0,65535] |
SportEnd | Integer | 是 | 结束源端口,取值范围[0,65535] |
DportStart | Integer | 是 | 开始目的端口,取值范围[0,65535] |
DportEnd | Integer | 是 | 结束目的端口,取值范围[0,65535] |
PktlenMin | Integer | 是 | 最小包长,取值范围[0,1500] |
PktlenMax | Integer | 是 | 最大包长,取值范围[0,1500] |
MatchBegin | String | 是 | 是否检测载荷,取值范围[begin_l5(表示检测), no_match(表示不检测)] |
MatchType | String | 是 | 是否是正则表达式,取值范围[sunday(表示关键字),pcre(表示正则表达式)] |
Str | String | 是 | 关键字或正则表达式 |
Depth | Integer | 是 | 检测深度,取值范围[0,1500] |
Offset | Integer | 是 | 检测偏移量,取值范围[0,1500] |
IsNot | Integer | 是 | 是否包括,取值范围[0(表示不包含),1(表示包含)] |
Action | String | 是 | 策略动作,取值范围[drop,drop_black,drop_rst,drop_black_rst,transmit] |
DDoSPolicyPortLimit
DDoS高级策略的禁用端口
被如下接口引用:CreateDDoSPolicy、DescribeDDoSPolicy、ModifyDDoSPolicy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Protocol | String | 是 | 协议,取值范围[tcp,udp,icmp,all] |
DPortStart | Integer | 是 | 开始目的端口,取值范围[0,65535] |
DPortEnd | Integer | 是 | 结束目的端口,取值范围[0,65535],要求大于等于开始目的端口 |
SPortStart | Integer | 否 | 开始源端口,取值范围[0,65535] 注意:此字段可能返回 null,表示取不到有效值。 |
SPortEnd | Integer | 否 | 结束源端口,取值范围[0,65535],要求大于等于开始源端口 注意:此字段可能返回 null,表示取不到有效值。 |
Action | String | 否 | 执行动作,取值[drop(丢弃) ,transmit(转发)] 注意:此字段可能返回 null,表示取不到有效值。 |
Kind | Integer | 否 | 禁用端口类型,取值[0(目的端口范围禁用), 1(源端口范围禁用), 2(目的和源端口范围同时禁用)] 注意:此字段可能返回 null,表示取不到有效值。 |
DDosPolicy
DDoS高级策略
被如下接口引用:DescribeDDoSPolicy。
名称 | 类型 | 描述 |
---|---|---|
Resources | Array of ResourceIp | 策略绑定的资源 |
DropOptions | DDoSPolicyDropOption | 禁用协议 |
PortLimits | Array of DDoSPolicyPortLimit | 禁用端口 |
PacketFilters | Array of DDoSPolicyPacketFilter | 报文过滤 |
IpBlackWhiteLists | Array of IpBlackWhite | 黑白IP名单 |
PolicyId | String | 策略ID |
PolicyName | String | 策略名称 |
CreateTime | String | 策略创建时间 |
WaterPrint | Array of WaterPrintPolicy | 水印策略参数,最多只有一个,当没有水印策略时数组为空 |
WaterKey | Array of WaterPrintKey | 水印密钥,最多只有2个,当没有水印策略时数组为空 |
BoundResources | Array of String | 策略绑定的资源实例 注意:此字段可能返回 null,表示取不到有效值。 |
SceneId | String | 策略所属的策略场景 注意:此字段可能返回 null,表示取不到有效值。 |
IpBlackWhite
黑白IP
被如下接口引用:CreateDDoSPolicy、DescribeDDoSPolicy、ModifyDDoSPolicy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Ip | String | 是 | IP地址 |
Type | String | 是 | 黑白类型,取值范围[black,white] |
IpBlockData
IP封堵记录
被如下接口引用:DescribeIpBlockList。
名称 | 类型 | 描述 |
---|---|---|
Ip | String | IP |
Status | String | 状态(Blocked:被封堵;UnBlocking:解封中;UnBlockFailed:解封失败) |
BlockTime | Timestamp | 封堵时间 |
UnBlockTime | Timestamp | 解封时间(预计解封时间) |
ActionType | String | 解封类型(user:自助解封;auto:自动解封; update:升级解封;bind:绑定高防包解封) |
IpUnBlockData
IP解封记录
被如下接口引用:DescribeIpUnBlockList。
名称 | 类型 | 描述 |
---|---|---|
Ip | String | IP |
BlockTime | Timestamp | 封堵时间 |
UnBlockTime | Timestamp | 解封时间(实际解封时间) |
ActionType | String | 解封类型(user:自助解封;auto:自动解封; update:升级解封;bind:绑定高防包解封) |
KeyValue
字段值,K-V形式
被如下接口引用:DescribeActionLog、DescribeCCIpAllowDeny、DescribeCCUrlAllow、DescribeDDoSCount、DescribeDDoSIpLog、DescribeDDoSNetCount、DescribeDDoSNetIpLog、DescribeDDoSUsedStatis、DescribeIPProductInfo、DescribeInsurePacks、DescribeL4RulesErrHealth、DescribePackIndex、DescribePolicyCase、DescribeResourceList、DescribeRuleSets、DescribeSecIndex。
名称 | 类型 | 描述 |
---|---|---|
Key | String | 字段名称 |
Value | String | 字段取值 |
KeyValueRecord
KeyValue记录
被如下接口引用:DescribeActionLog、DescribeCCIpAllowDeny、DescribeCCUrlAllow、DescribeDDoSIpLog、DescribeDDoSNetIpLog、DescribeIPProductInfo、DescribeInsurePacks、DescribeL4RulesErrHealth、DescribePolicyCase、DescribeResourceList、DescribeRuleSets。
名称 | 类型 | 描述 |
---|---|---|
Record | Array of KeyValue | 一条记录的Key-Value数组 |
L4HealthConfig
四层健康检查配置
被如下接口引用:CreateL4HealthConfig、DescribeL4HealthConfig。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Protocol | String | 是 | 转发协议,取值[TCP, UDP] |
VirtualPort | Integer | 是 | 转发端口 |
Enable | Integer | 是 | =1表示开启;=0表示关闭 |
TimeOut | Integer | 是 | 响应超时时间,单位秒 |
Interval | Integer | 是 | 检测间隔时间,单位秒 |
KickNum | Integer | 是 | 不健康阈值,单位次 |
AliveNum | Integer | 是 | 健康阈值,单位次 |
KeepTime | Integer | 是 | 会话保持时间,单位秒 |
L4RuleEntry
L4规则
被如下接口引用:CreateL4Rules、DescribleL4Rules、ModifyL4Rules。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Protocol | String | 是 | 转发协议,取值[TCP, UDP] |
VirtualPort | Integer | 是 | 转发端口 |
SourcePort | Integer | 是 | 源站端口 |
SourceType | Integer | 是 | 回源方式,取值[1(域名回源),2(IP回源)] |
KeepTime | Integer | 是 | 会话保持时间,单位秒 |
SourceList | Array of L4RuleSource | 是 | 回源列表 |
LbType | Integer | 是 | 负载均衡方式,取值[1(加权轮询),2(源IP hash)] |
KeepEnable | Integer | 是 | 会话保持开关,取值[0(会话保持关闭),1(会话保持开启)] |
RuleId | String | 否 | 规则ID |
RuleName | String | 否 | 规则描述 |
RemoveSwitch | Integer | 否 | 移除水印状态,取值[0(关闭),1(开启)] |
L4RuleHealth
规则健康检查参数
被如下接口引用:DescribleL4Rules、ModifyL4Health。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
RuleId | String | 是 | 规则ID |
Enable | Integer | 是 | =1表示开启;=0表示关闭 |
TimeOut | Integer | 是 | 响应超时时间,单位秒 |
Interval | Integer | 是 | 检测间隔时间,单位秒,必须要大于响应超时时间 |
KickNum | Integer | 是 | 不健康阈值,单位次 |
AliveNum | Integer | 是 | 健康阈值,单位次 |
L4RuleSource
L4规则回源列表
被如下接口引用:CreateL4Rules、CreateL7Rules、CreateL7RulesUpload、DescribleL4Rules、DescribleL7Rules、ModifyL4Rules、ModifyL7Rules。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Source | String | 是 | 回源IP或域名 |
Weight | Integer | 是 | 权重值,取值[0,100] |
L7HealthConfig
七层健康检查配置
被如下接口引用:CreateL7HealthConfig、DescribeL7HealthConfig。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Protocol | String | 是 | 转发协议,取值[http, https, http/https] |
Domain | String | 是 | 转发域名 |
Enable | Integer | 是 | =1表示开启;=0表示关闭 |
Interval | Integer | 是 | 检测间隔时间,单位秒 |
KickNum | Integer | 是 | 异常判定次数,单位次 |
AliveNum | Integer | 是 | 健康判定次数,单位次 |
Method | String | 是 | 健康检查探测方法,可选HEAD或GET,默认为HEAD |
StatusCode | Integer | 是 | 健康检查判定正常状态码,1xx =1, 2xx=2, 3xx=4, 4xx=8,5xx=16,多个状态码值加和 |
Url | String | 是 | 检查目录的URL,默认为/ |
L7RuleEntry
L7规则
被如下接口引用:CreateL7Rules、CreateL7RulesUpload、DescribleL7Rules、ModifyL7Rules。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Protocol | String | 是 | 转发协议,取值[http, https] |
Domain | String | 是 | 转发域名 |
SourceType | Integer | 是 | 回源方式,取值[1(域名回源),2(IP回源)] |
KeepTime | Integer | 是 | 会话保持时间,单位秒 |
SourceList | Array of L4RuleSource | 是 | 回源列表 |
LbType | Integer | 是 | 负载均衡方式,取值[1(加权轮询)] |
KeepEnable | Integer | 是 | 会话保持开关,取值[0(会话保持关闭),1(会话保持开启)] |
RuleId | String | 否 | 规则ID |
CertType | Integer | 否 | 证书来源,当为协议为https协议时必须填,取值[2(腾讯云托管证书)],当协议为http时也可以填0 |
SSLId | String | 否 | 当证书来源为腾讯云托管证书时,此字段必须填写托管证书ID |
Cert | String | 否 | 当证书来源为自有证书时,此字段必须填写证书内容;(因已不再支持自有证书,此字段已弃用,请不用填写此字段) |
PrivateKey | String | 否 | 当证书来源为自有证书时,此字段必须填写证书密钥;(因已不再支持自有证书,此字段已弃用,请不用填写此字段) |
RuleName | String | 否 | 规则描述 |
Status | Integer | 否 | 规则状态,取值[0(规则配置成功),1(规则配置生效中),2(规则配置失败),3(规则删除生效中),5(规则删除失败),6(规则等待配置),7(规则等待删除),8(规则待配置证书)] |
CCStatus | Integer | 否 | cc防护状态,取值[0(关闭), 1(开启)] |
CCEnable | Integer | 否 | https的CC防护状态,取值[0(关闭), 1(开启)] |
CCThreshold | Integer | 否 | https的CC防护阈值 |
CCLevel | String | 否 | https的CC防护等级 |
L7RuleHealth
L7规则健康检查参数
被如下接口引用:DescribleL7Rules。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
RuleId | String | 是 | 规则ID |
Enable | Integer | 是 | =1表示开启;=0表示关闭 |
Interval | Integer | 是 | 检测间隔时间,单位秒 |
KickNum | Integer | 是 | 不健康阈值,单位次 |
AliveNum | Integer | 是 | 健康阈值,单位次 |
Method | String | 是 | HTTP请求方式,取值[HEAD,GET] |
StatusCode | Integer | 是 | 健康检查判定正常状态码,1xx =1, 2xx=2, 3xx=4, 4xx=8,5xx=16,多个状态码值加和 |
Url | String | 是 | 检查目录的URL,默认为/ |
Status | Integer | 是 | 配置状态,0: 正常,1:配置中,2:配置失败 |
OrderBy
排序字段
被如下接口引用:DescribeResourceList。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Field | String | 是 | 排序字段名称,取值[ bandwidth(带宽), overloadCount(超峰值次数) ] |
Order | String | 是 | 升降序,取值为[asc(升序),(升序),desc(降序), DESC(降序)] |
Paging
分页索引
被如下接口引用:DescribeIpUnBlockList。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Offset | Integer | 是 | 起始位置 |
Limit | Integer | 是 | 数量 |
ProtocolPort
Protocol、Port参数
被如下接口引用:DescribeBaradData。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Protocol | String | 是 | 协议(tcp;udp) |
Port | Integer | 是 | 端口 |
RegionInstanceCount
地域资源实例数
被如下接口引用:DescribleRegionCount。
名称 | 类型 | 描述 |
---|---|---|
Region | String | 地域码 |
RegionV3 | String | 地域码(新规范) |
Count | Integer | 资源实例数 |
ResourceIp
资源的IP数组
被如下接口引用:DescribeDDoSPolicy、DescribeResIpList。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Id | String | 是 | 资源ID |
IpList | Array of String | 否 | 资源的IP数组 |
SuccessCode
操作返回码,只用于返回成功的情况
被如下接口引用:CreateCCSelfDefinePolicy、CreateInstanceName、CreateL4HealthConfig、CreateL4Rules、CreateL7HealthConfig、CreateL7RuleCert、CreateL7Rules、CreateL7RulesUpload、DeleteCCSelfDefinePolicy、DeleteDDoSPolicy、DeleteDDoSPolicyCase、DeleteL4Rules、DeleteL7Rules、ModifyCCHostProtection、ModifyCCIpAllowDeny、ModifyCCLevel、ModifyCCPolicySwitch、ModifyCCSelfDefinePolicy、ModifyCCThreshold、ModifyCCUrlAllow、ModifyDDoSDefendStatus、ModifyDDoSPolicy、ModifyDDoSPolicyCase、ModifyDDoSPolicyName、ModifyDDoSThreshold、ModifyElasticLimit、ModifyL4Health、ModifyL4KeepTime、ModifyL4Rules、ModifyL7Rules、ModifyResBindDDoSPolicy、ModifyResourceRenewFlag。
名称 | 类型 | 描述 |
---|---|---|
Code | String | 成功/错误码 |
Message | String | 描述 |
WaterPrintKey
水印Key
被如下接口引用:DescribeDDoSPolicy、ModifyDDoSWaterKey。
名称 | 类型 | 描述 |
---|---|---|
KeyId | String | 水印KeyID |
KeyContent | String | 水印Key值 |
KeyVersion | String | 水印Key的版本号 |
OpenStatus | Integer | 是否开启,取值[0(没有开启),1(已开启)] |
CreateTime | Timestamp | 密钥生成时间 |
WaterPrintPolicy
水印策略参数
被如下接口引用:CreateDDoSPolicy、DescribeDDoSPolicy、ModifyDDoSPolicy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TcpPortList | Array of String | 是 | TCP端口段,例如["2000-3000","3500-4000"] |
UdpPortList | Array of String | 是 | UDP端口段,例如["2000-3000","3500-4000"] |
Offset | Integer | 是 | 水印偏移量,取值范围[0, 100) |
RemoveSwitch | Integer | 是 | 是否自动剥离,取值[0(不自动剥离),1(自动剥离)] |
OpenStatus | Integer | 是 | 是否开启,取值[0(没有开启),1(已开启)] |