数据结构

最近更新时间: 2026-10-11 00:09:20

SubClassItem

子类信息

被如下接口引用:DescribeMainClass

名称 必选 允许NULL 类型 描述
SubClassID 否 否 String 子类id
示例值:
SubClassName 否 否 String 子类名字
示例值:
Description 否 否 String 描述
示例值:

BotUCBPreinstallRuleData

BotUCBPreinstallRule封装

被如下接口引用:DescribeBotUCBPreinstallRule

名称 必选 允许NULL 类型 描述
Res 是 否 Array of BotUCBPreinstallRule 参数封装
示例值:查看

DomainPackage

clb-waf 域名扩展套餐

被如下接口引用:DescribeUserInfo

名称 必选 允许NULL 类型 描述
ResourceIds 是 否 String 资源ID
示例值:
ValidTime 是 否 String 过期时间
示例值:
AutoRenew 是 否 Uint64 是否自动续费,1:自动续费,0:不自动续费
示例值:
Count 是 否 Uint64 套餐购买个数
示例值:
Region 是 否 String 套餐购买地域,clb-waf暂时没有用到
示例值:

ClbHostResult

CLB查询对应绑定的WAF状态的结果参数

被如下接口引用:DescribeWafInfo

名称 必选 允许NULL 类型 描述
LoadBalancer 是 否 LoadBalancer WAF绑定的监听器实例
示例值:查看
Domain 是 否 String WAF绑定的域名
示例值:
DomainId 是 否 String WAF绑定的实例ID
示例值:
Status 是 否 Uint64 是否有绑定WAF,1:绑定了WAF,0:没有绑定WAF
示例值:
FlowMode 是 否 Uint64 绑定了WAF的情况下,WAF流量模式,1:清洗模式,0:镜像模式(默认)
示例值:

DescribeCustomRulesPagingInfo

DescribeCustomRules接口的翻页参数

被如下接口引用:DescribeCustomRules

名称 必选 允许NULL 类型 描述
Offset 是 否 Int64 当前页码
示例值:
Limit 是 否 Int64 当前页的最大数据条数
示例值:

DescribeAntiInfoLeakRulesRuleItem

DescribeAntiInfoLeakRules返回的规则列表元素

被如下接口引用:DescribeAntiInfoLeakRules

名称 必选 允许NULL 类型 描述
RuleId 是 否 String 规则ID
示例值:
Name 是 否 String 规则名称
示例值:
Status 是 否 String 规则状态
示例值:
ActionType 是 否 String 规则动作类型
示例值:
CreateTime 是 否 String 规则创建时间
示例值:
Strategies 是 否 Array of DescribeAntiInfoLeakRulesStrategyItem 详细的规则
示例值:查看

BotTcbRuleData

封装使用

被如下接口引用:DescribeBotTCBRule

名称 必选 允许NULL 类型 描述
Res 是 否 Array of String tcb规则
示例值:

DescribeSpartaProtectionListItem

DescribeSpartaProtectionList的入参

被如下接口引用:DescribeSpartaProtectionList

名称 必选 允许NULL 类型 描述
IsCdn 否 否 String 是否是cdn
示例值:
Status 否 否 String 状态
示例值:
LogStatus 否 否 String 日志开关
示例值:
Mode 否 否 String AI模式
示例值:
State 否 否 String 状态
示例值:

ActionedIpData

封装数据

被如下接口引用:DescribeActionedIp

名称 必选 允许NULL 类型 描述
Res 是 是 Array of ActionedIpItem ip数据
示例值:查看
TotalCount 是 否 Uint64 计数
示例值:

CreateAccessDownloadRecordRsp

CreateAccessDownloadRecord接口的返回值

被如下接口引用:CreateAccessDownloadRecord

名称 必选 允许NULL 类型 描述
Code 是 否 Int64 是否成功,正常情况为0
示例值:
Flow 是 否 String 下载记录编号
示例值:

DescribePieChartRsp

DescribePieChart的返回值

被如下接口引用:DescribePieChart

名称 必选 允许NULL 类型 描述
Piechart 是 是 Array of String 详细的内容
示例值:

BotListStat

bot列表的stat数据

被如下接口引用:DescribeBotTCBRecords、DescribeBotUBRecords、DescribeBotUCBRecords

名称 必选 允许NULL 类型 描述
AvgSpeed 是 否 Float 平均速度
示例值:

AttackExportJobInfo

攻击日志导出任务基本信息

被如下接口引用:DescribeExportAttackDetailJobs

名称 必选 允许NULL 类型 描述
Id 是 否 Uint64 ID
示例值:
CreateTime 是 否 Datetime 创建时间
示例值:
FileName 是 否 String 任务名称
示例值:
LogsCount 是 否 Uint64 日志总数量
示例值:
UploadCount 是 否 Uint64 日志已导出数量
示例值:
UploadProgress 是 否 String 日志导出进度
示例值:
DeleteFlag 是 否 Uint64 cos删除标志 0为未删除,1为已删除
示例值:
ExpiredDays 是 否 Uint64 过期天数
示例值:
ExpiredTime 是 否 Datetime 过期时间
示例值:
FileDownloadUrl 是 否 String cos文件下载地址
示例值:
TaskType 是 否 Uint64 任务类型 0租户端 1运营端
示例值:
TaskStatus 是 否 Uint64 任务状态 0、进行中 1、完成 2、失败
示例值:
QueryParams 是 否 String 查询参数
示例值:
AppId 是 否 Uint64 Appid
示例值:
Uin 是 否 Uint64 账号
示例值:

DescribeCachePathRspListItem

DescribeCachePath返回值中的类型

被如下接口引用:DescribeCachePath

名称 必选 允许NULL 类型 描述
Id 是 否 String ID
示例值:
Domain 是 否 String 域名
示例值:
Name 是 否 String 名称
示例值:
State 是 否 String 状态
示例值:
Path 是 否 String 路径
示例值:
CreateTime 是 否 String 创建时间
示例值:
ModifyTime 是 否 String 修改时间
示例值:

BotRecordItem

Bot_V2 bot记录访问详情元素结构

被如下接口引用:DescribeBotRecordItems

名称 必选 允许NULL 类型 描述
Items 是 否 String 压缩的字符串
示例值:

StatisticType

攻击类型统计

被如下接口引用:DescribeStatisticTypes

名称 必选 允许NULL 类型 描述
Type 是 否 String 攻击类型
示例值:
Count 是 否 Int64 攻击类型数目
示例值:

CCRuleData

数据封装

被如下接口引用:DescirbeCCRule

名称 必选 允许NULL 类型 描述
Res 是 否 Array of CCRuleItem cc规则
示例值:查看
TotalCount 是 否 Int64 规则数目
示例值:

IpHitItem

ip封堵状态数据

被如下接口引用:DescribeIpHitItems

名称 必选 允许NULL 类型 描述
Action 是 否 Uint64 动作
示例值:
Category 是 否 String 类别
示例值:
Ip 是 否 String ip
示例值:
Name 是 否 String 规则名称
示例值:
TsVersion 是 否 Uint64 时间戳
示例值:
ValidTs 是 否 Uint64 有效截止时间戳
示例值:

QPSPackage

clb-waf QPS套餐

被如下接口引用:DescribeSpartUserInfo、DescribeUserInfo

名称 必选 允许NULL 类型 描述
ResourceIds 是 否 String 资源ID
示例值:
ValidTime 是 否 String 过期时间
示例值:
AutoRenew 是 否 Int64 是否自动续费,1:自动续费,0:不自动续费
示例值:
Count 是 否 Int64 套餐购买个数
示例值:
Region 是 否 String 套餐购买地域,clb-waf暂时没有用到
示例值:

PortItem

防护域名端口配置信息

被如下接口引用:AddSpartaProtection、DescribeSpartaProtectionInfo、DescribeSpartaProtectionList

名称 必选 允许NULL 类型 描述
Port 是 否 String 监听端口配置
示例值:
Protocol 是 否 String 与Port一一对应,表示端口对应的协议
示例值:
UpstreamPort 是 否 String 与Port一一对应,  表示回源端口
示例值:
UpstreamProtocol 是 否 String 与Port一一对应,  表示回源协议
示例值:
NginxServerId 是 否 String Nginx的服务器ID
示例值:

DownloadRecordItem

下载记录

被如下接口引用:DescribeAttackDownloadRecords

名称 必选 允许NULL 类型 描述
Name 是 否 String 任务名
示例值:
Flow 是 否 String 任务ID
示例值:
Host 是 否 String 任务对应域名
示例值:
CreateTime 是 否 Datetime 任务创建时间
示例值:
ExpireTime 是 否 Datetime 任务过期时间
示例值:
Count 是 否 Uint64 任务涉及的记录条数
示例值:
Status 是 否 Uint64 任务运行状态,0运行中,1完成,2失败
示例值:
Url 是 否 String 任务结果的下载地址
示例值:
Id 是 否 Uint64 数据库自增ID
示例值:

HostStatus

设置WAF状态的结构体

被如下接口引用:ModifyHostStatus

名称 必选 允许NULL 类型 描述
Domain 是 否 String 域名
示例值:
DomainId 是 否 String 域名ID
示例值:
Status 是 否 Uint64 WAF的开关,1:开,0:关
示例值:

StrategyForAntiInfoLeak

防信息泄露的匹配条件结构体

被如下接口引用:AddAntiInfoLeakRules、ModifyAntiInfoLeakRules

名称 必选 允许NULL 类型 描述
Field 是 否 String 匹配字段
示例值:
CompareFunc 是 否 String 逻辑符号
示例值:
Content 是 否 String 匹配内容
示例值:

IpAccessControlItem

ip黑白名单

被如下接口引用:DescribeIpAccessControl

名称 必选 允许NULL 类型 描述
ActionType 是 否 Uint64 动作
示例值:
Ip 是 否 String ip
示例值:
Note 是 否 String 备注
示例值:
Source 是 否 String 来源
示例值:
TsVersion 是 是 Uint64 更新时间戳
示例值:
ValidTs 是 否 Uint64 有效截止时间戳
示例值:

MenshenDomainWhiteRule

门神-白名单规则列表

被如下接口引用:DescribeDomainWhiteRules

名称 必选 允许NULL 类型 描述
Id 是 是 Uint64 Id
示例值:
Rules 是 是 Array of Uint64 规则id列表
示例值:
Url 是 是 String 地址
示例值:
Function 是 是 String 比较方法
示例值:
Status 是 是 Uint64 状态
示例值:
Time 是 是 Datetime 时间
示例值:

HostRecord

clb-waf防护域名

被如下接口引用:CreateHost、DescribeHost、DescribeHosts、ModifyHost

名称 必选 允许NULL 类型 描述
Domain 是 否 String 域名
示例值:
DomainId 是 否 String 域名ID
示例值:
MainDomain 是 否 String 主域名,入参时为空
示例值:
Mode 是 否 Uint64 waf模式,同saas waf保持一致
示例值:
Status 是 否 Uint64 waf和LD的绑定,0:没有绑定,1:绑定
示例值:
State 是 否 Uint64 域名状态,0:正常,1:未检测到流量,2:即将过期,3:过期
示例值:
Engine 是 否 Uint64 使用的规则,同saas waf保持一致
示例值:
IsCdn 是 否 Uint64 是否开启代理,0:不开启,1:开启
示例值:
LoadBalancerSet 是 否 Array of LoadBalancer 绑定的LB列表
示例值:查看
Region 是 否 String 域名绑定的LB的地域,以,分割多个地域
示例值:
Edition 是 否 String 产品分类,取值为:sparta-waf、clb-waf、cdn-waf
示例值:
FlowMode 是 否 Uint64 WAF的流量模式,1:清洗模式,0:镜像模式
示例值:
ClsStatus 是 否 Uint64 是否开启访问日志,1:开启,0:关闭
示例值:
NetworkType 是 否 String 网络类型
示例值:
Level 是 否 Uint64 门神防护等级
示例值:

IpAccessControlData

数据封装

被如下接口引用:DescribeIpAccessControl

名称 必选 允许NULL 类型 描述
Res 是 是 Array of IpAccessControlItem ip黑白名单
示例值:查看
TotalCount 是 否 Uint64 计数
示例值:

MonitorDomainItem

云监控域名字段

被如下接口引用:DescribeMonitorDomains

名称 必选 允许NULL 类型 描述
Domain 是 否 String 域名
示例值:
Appid 是 否 Uint64 用户自己的Appid
示例值:
Edition 是 否 Int64 域名对应的版本信息,0代表saas,1代表clb
示例值:
DomainId 是 否 String 域名ID
示例值:

ClbHostsParams

CLB回调WAF接口(获取、删除)的参数

被如下接口引用:DescribeWafInfo

名称 必选 允许NULL 类型 描述
LoadBalancerId 是 否 String 负载均衡实例ID,如果不传次参数则默认认为操作的是整个AppId的监听器,如果此参数不为空则认为操作的是对应负载均衡实例。
示例值:
ListenerId 否 否 String 负载均衡监听器ID,,如果不传次参数则默认认为操作的是整个负载均衡实例,如果此参数不为空则认为操作的是对应负载均衡监听器。
示例值:
DomainId 否 否 String WAF实例ID,,如果不传次参数则默认认为操作的是整个负载均衡监听器实例,如果此参数不为空则认为操作的是对应负载均衡监听器的某一个具体的域名。
示例值:

MenshenDomainRule

门神域名规则列表

被如下接口引用:DescribeDomainRules

名称 必选 允许NULL 类型 描述
Id 是 是 Uint64 Id
示例值:
Type 是 是 String 规则类型
示例值:
Level 是 是 String 等级
示例值:
Description 是 是 String 描述
示例值:
CVE 是 是 String CVE
示例值:
Status 是 是 String 状态
示例值:
ModifyTime 是 是 Datetime 修改时间
示例值:
TypeEn 是 是 String 规则类型英文
示例值:
LevelEn 是 是 String 等级英文
示例值:
DescriptionEn 是 是 String 描述英文
示例值:

ResponseCode

响应体的返回码

被如下接口引用:DeleteHost、DescribeHostLimit、ModifyHostFlowMode、ModifyHostMode、ModifyHostStatus、ModifyPackageRenew、ModifyWebshellStatus

名称 必选 允许NULL 类型 描述
Code 是 否 String 如果成功则返回Success,失败则返回yunapi定义的错误码
示例值:
Message 是 否 String 如果成功则返回Success,失败则返回WAF定义的二级错误码
示例值:

HostDel

CLB-WAF删除域名参数

被如下接口引用:DeleteHost

名称 必选 允许NULL 类型 描述
Domain 是 否 String 域名
示例值:
DomainId 是 否 String 域名ID
示例值:

SessionItem

session定义

被如下接口引用:DescribeSession

名称 必选 允许NULL 类型 描述
Category 是 否 String 匹配类型
示例值:
KeyOrStartMat 是 否 String 起始模式
示例值:
EndMat 是 否 String 结束模式
示例值:
StartOffset 是 否 String 起始偏移
示例值:
EndOffset 是 否 String 结束偏移
示例值:
Source 是 否 String 数据源
示例值:
TsVersion 是 否 String 更新时间戳
示例值:

BotListScore

拨通列表得分字段

被如下接口引用:DescribeBotTCBRecords、DescribeBotUBRecords、DescribeBotUCBRecords

名称 必选 允许NULL 类型 描述
Total 是 否 Int64 得分
示例值:

DescribeDNSDetectDataMapRspItem

DescribeDNSDetectDataMap返回值的元素

被如下接口引用:DescribeDNSDetectDataMap

名称 必选 允许NULL 类型 描述
Key 是 否 String 地域
示例值:
Value 是 否 String 地域的劫持数量
示例值:

RuleVersionData

数组

被如下接口引用:DescribeRuleVersion

名称 必选 允许NULL 类型 描述
Id 是 否 Int64 出参
示例值:
Appid 是 是 Int64 出参
示例值:
Version 是 是 String 出参
示例值:
Rules 是 是 Int64 出参
示例值:
Description 是 是 String 出参
示例值:
CreateTime 是 是 String 出参
示例值:
ModifyTime 是 是 String 出参
示例值:

UserWhiteRule

全局规则白名单

被如下接口引用:DescribeUserWhiteRule

名称 必选 允许NULL 类型 描述
Id 否 否 Uint64 序号
示例值:
Name 否 否 String 规则名称
示例值:
Domain 否 否 String 域名
示例值:
SignatureId 否 否 String 特征序号
示例值:
Status 否 否 Uint64 规则开关
示例值:
CreateTime 否 否 Datetime_iso 创建时间
示例值:
ModifyTime 否 否 Datetime_iso 修改时间
示例值:
Rules 否 否 Array of GlobalWhiteCond 规则详细
示例值:查看

BotsGeoStatStyledItem

GetBotsGeoStatStyled接口的返回数据的元素类型

被如下接口引用:DescribeBotRegionsStat

名称 必选 允许NULL 类型 描述
Key 是 否 String 地域
示例值:
Value 是 否 Int64 值
示例值:

Strategy

自定义规则的匹配条件结构体

被如下接口引用:AddCustomRule、DescribeCustomRules、ModifyCustomRule

名称 必选 允许NULL 类型 描述
Field 是 否 String 匹配字段
示例值:
CompareFunc 是 否 String 逻辑符号
示例值:
Content 是 否 String 匹配内容
示例值:
Arg 是 否 String 匹配参数
示例值:

MenshenRuleType

门神-规则类型信息

被如下接口引用:DescribeRuleTypes

名称 必选 允许NULL 类型 描述
Id 是 是 Uint64 Id
示例值:
Name 是 是 String 规则类型名称
示例值:
Description 是 是 String 规则类型描述
示例值:
Count 是 是 Uint64 规则数量
示例值:
DescriptionEn 是 是 String 规则类型描述英文
示例值:
NameEn 是 是 String 规则类型名称英文
示例值:

DomainBotStatus

DomainBotStatus

被如下接口引用:DescribeBotStatus

名称 必选 允许NULL 类型 描述
Category 是 否 String 类别
示例值:
Domain 是 否 String 域名
示例值:
Status 是 否 Uint64 状态
示例值:

PiechartItem

饼图数据类型

被如下接口引用:DescribeAttackType

名称 必选 允许NULL 类型 描述
Type 是 否 String 类型
示例值:
Count 是 否 Uint64 数量
示例值:

WebshellStatus

域名的webshell开启状态

被如下接口引用:ModifyWebshellStatus

名称 必选 允许NULL 类型 描述
Domain 是 否 String 域名
示例值:
Status 是 否 Uint64 webshell开关,1:开。0:关。2:观察
示例值:

CacheUrlItem

防篡改url元素

被如下接口引用:DescribeAntiFakeUrl

名称 必选 允许NULL 类型 描述
Id 是 否 String Id
示例值:
Name 是 否 String 名称
示例值:
Domain 是 否 String 域名
示例值:
Uri 是 否 String uri
示例值:
Protocol 是 否 String 协议
示例值:
Status 是 否 String 状态
示例值:

ActionedIpItem

ip查询参数

被如下接口引用:DescribeActionedIp

名称 必选 允许NULL 类型 描述
Action 是 否 Uint64 动作
示例值:
Category 是 否 String 类别
示例值:
Ip 是 否 String ip
示例值:
Name 是 否 String 策略名称
示例值:
Note 是 否 String 备注
示例值:
TsVersion 是 否 Uint64 更新时间戳
示例值:
ValidTs 是 否 Uint64 有效时间戳
示例值:

KVInt

Key-Value的形式,Value为Int

被如下接口引用:DescribeTopAttackDomain

名称 必选 允许NULL 类型 描述
Key 是 否 String Key
示例值:
Value 是 否 Uint64 Value
示例值:

DescribeBotUCBFeatureRuleRsp

DescribeBotUCBFeatureRule的返回参数

被如下接口引用:DescribeBotUCBFeatureRule

名称 必选 允许NULL 类型 描述
TotalCount 是 否 Int64 规则数目
示例值:
Res 是 否 Array of String 详细的规则
示例值:

CopyBotTCBRuleRsp

CopyBotTCBRule函数的返回值

被如下接口引用:CopyBotTCBRule

名称 必选 允许NULL 类型 描述
Code 是 否 Int64 0表示成功,其他表示失败
示例值:
ErrMsg 是 否 String 错误信息
示例值:
SuccessNum 是 否 Int64 成功的数目
示例值:
FailedNum 是 否 Int64 失败的数目
示例值:
T 是 否 Array of String 成功的域名列表
示例值:

DomainBotStatusData

封装参数

被如下接口引用:DescribeBotStatus

名称 必选 允许NULL 类型 描述
Res 是 否 Array of DomainBotStatus 数据
示例值:查看

PageForDescribeSpartaProtectionList

PageForDescribeSpartaProtectionList接口专用的翻页结构体

被如下接口引用:DescribeSpartaProtectionList

名称 必选 允许NULL 类型 描述
Count 是 否 Uint64 每页个数
示例值:
Index 是 否 Uint64 页码
示例值:

DescribeAntiInfoLeakRulesStrategyItem

DescribeAntiInfoLeakRules返回的规则元素中的具体的规则元素

被如下接口引用:DescribeAntiInfoLeakRules

名称 必选 允许NULL 类型 描述
Field 是 否 String 字段
示例值:
CompareFunc 是 否 String 条件
示例值:
Content 是 否 String 内容
示例值:

SearchItem

接入列表查询复杂条件

被如下接口引用:DescribeHosts

名称 必选 允许NULL 类型 描述
ClsStatus 否 否 String 日志开关
示例值:
Status 否 否 String waf开关
示例值:
FlowMode 否 否 String 流量模式
示例值:

ReqUserRule

用户规则更新输出规则子项

被如下接口引用:ModifyUserSignatureRule

名称 必选 允许NULL 类型 描述
Id 是 否 String 特征序号
示例值:
Status 是 否 Int64 规则开关  0:关  1:开  2:只告警
示例值:
Reason 否 否 Int64 修改原因  0:无(兼容记录为空)  1:业务自身特性
示例值:

BotUCBPreinstallRule

bot内置类型自定义策略

被如下接口引用:DescribeBotUCBPreinstallRule

名称 必选 允许NULL 类型 描述
Action 是 否 String 动作
示例值:
AdditionArg 是 否 String 附加参数
示例值:
Name 是 否 String 名称
示例值:
OnOff 是 否 String 开关
示例值:
Timestamp 是 否 Uint64 时间戳
示例值:
ValidTime 是 否 Uint64 有效时间
示例值:

BotItemsListItem

bot列表元素

被如下接口引用:DescribeBotTCBRecords、DescribeBotUBRecords、DescribeBotUCBRecords

名称 必选 允许NULL 类型 描述
Action 是 否 String 动作
示例值:
BotFeature 是 是 Array of String bot特征
示例值:
Id 是 否 String mongodb id
示例值:
Nums 是 否 Int64 数目
示例值:
RuleName 是 是 String 关联规则名称
示例值:
Score 是 否 BotListScore 得分
示例值:查看
SessionDuration 是 否 Float 持续时间
示例值:
SrcIp 是 否 String 源ip
示例值:
Stat 是 否 BotListStat 统计数据
示例值:查看
Timestamp 是 否 Uint64 时间戳
示例值:
TcbDetail 是 是 String 公开类型附加参数
示例值:

PageInfo

公共翻页参数

被如下接口引用:DescribeAntiFakeUrl、DescribeAntiInfoLeakRules、DescribeCachePath、DescribeDNSDetectHijackData

名称 必选 允许NULL 类型 描述
PageNumber 是 否 String 页码
示例值:
PageSize 是 否 String 页条目数量
示例值:

DescribeAreaBanAreasRsp

DescribeAreaBanAreas接口的回包

被如下接口引用:DescribeAreaBanAreas

名称 必选 允许NULL 类型 描述
Status 是 否 String 状态 "0":未开启地域封禁 "1":开启地域封禁
示例值:
Areas 是 否 Array of String 字符串数据,配置的地域列表
示例值:

PageInfoForInt

分页参数复杂结构体

被如下接口引用:DescribeDNSDetectDomainList

名称 必选 允许NULL 类型 描述
PageNumber 是 否 Uint64 页码
示例值:
PageSize 是 否 Uint64 每页个数
示例值:

CopyBotsUCBFeatureRuleRsp

CopyBotsUCBFeatureRule的返回值

被如下接口引用:CopyBotUCBFeatureRules

名称 必选 允许NULL 类型 描述
Code 是 否 Int64 0表示成功,其他表示失败
示例值:
ErrMsg 是 否 String 错误信息
示例值:
SuccessNum 是 否 Int64 成功的数目
示例值:
FailedNum 是 否 Int64 失败的数目
示例值:
T 是 否 Array of String 成功的域名列表
示例值:

MenshenRulesInfo

门神-规则库描述信息

被如下接口引用:DescribeRulesInfo

名称 必选 允许NULL 类型 描述
Date 是 是 Date 日期
示例值:
Version 是 是 String 版本
示例值:
Memos 是 是 Array of String 描述信息
示例值:
MemosEng 是 是 Array of String 描述标题
示例值:

AppIdDetail

clb-waf AppId对应的详情

被如下接口引用:DescribeUserInfo

名称 必选 允许NULL 类型 描述
Level 是 否 Uint64 套餐版本,跟saas保持一致
示例值:
AutoRenew 是 否 Uint64 是否自动续费,1:自动续费,0:不自动续费
示例值:
BeginTime 是 否 String 套餐的购买时间
示例值:
Cls 是 是 ClsPackage 购买的日志套餐
示例值:查看
ValidTime 是 否 String 过期时间
示例值:
DomainLimit 是 否 Uint64 套餐子域名限制个数
示例值:
DomainCount 是 否 Uint64 套餐子域名已经使用的个数
示例值:
MainDomainCount 是 否 Uint64 套餐主域名已经使用的个数
示例值:
MainDomainLimit 是 否 Uint64 套餐主域名限制个数
示例值:
RegionLimit 是 否 Uint64 套餐的地域限制个数
示例值:
LbLimit 是 否 Uint64 套餐的监听器限制个数
示例值:
QPS 是 是 QPSPackage 购买的QPS套餐
示例值:查看
MaxQPS 是 否 Uint64 当前的QPS峰值
示例值:
ResourceIds 是 否 String 资源ID
示例值:
Type 是 是 String 暂时未用到
示例值:
DomainPkg 是 是 DomainPackage 购买的域名套餐
示例值:查看
AllowRegions 是 是 String 账号开通了clbwaf的地域白名单,如果为空则表示开通了全部地域,否则则开通的地域以,串接。
示例值:
CCGuardRegions 是 是 String 账号开通了clbwaf的清洗模式的地域白名单,如果为空则表示没有地域开启了清洗模式,否则则开通的地域以,串接。
示例值:

CCRuleItem

cc规则

被如下接口引用:DescirbeCCRule

名称 必选 允许NULL 类型 描述
ActionType 是 否 Uint64 动作
示例值:
Advance 是 否 Uint64 高级模式
示例值:
Interval 是 否 Uint64 时间周期
示例值:
Limit 是 否 Uint64 限制次数
示例值:
MatchFunc 是 否 Uint64 匹配方法
示例值:
Name 是 否 String 名称
示例值:
Priority 是 否 Uint64 优先级
示例值:
Status 是 否 Int64 状态
示例值:
TsVersion 是 否 Uint64 更新时间戳
示例值:
Url 是 否 String 匹配url
示例值:
ValidTime 是 否 Uint64 策略动作有效时间
示例值:
OptionsArr 是 是 String 高级参数
示例值:

IpHitItemsData

封装参数

被如下接口引用:DescribeIpHitItems

名称 必选 允许NULL 类型 描述
Res 是 否 Array of IpHitItem 数组封装
示例值:查看
TotalCount 是 否 Uint64 总数目
示例值:

AttackDetail

攻击详情数据类型

被如下接口引用:DescribeAttackDetail

名称 必选 允许NULL 类型 描述
ArgsName 是 否 String 攻击命中位置
示例值:
AttackContent 是 否 String 攻击命中的内容
示例值:
AttackIp 是 否 String 攻击者IP
示例值:
AttackTime 是 否 String 攻击时间
示例值:
AttackType 是 否 String 攻击类型
示例值:
Count 是 否 Uint64 攻击聚合次数
示例值:
Domain 是 否 String 被攻击的域名
示例值:
HttpLog 是 否 String 原始请求字符串
示例值:
IpinfoCity 是 是 String 攻击者城市
示例值:
IpinfoDetail 是 否 String 攻击者运营商
示例值:
IpinfoDimensionality 是 是 Float 经度
示例值:
IpinfoLongitude 是 是 Float 纬度
示例值:
IpinfoIsp 是 否 String 线路
示例值:
IpinfoNation 是 否 String 国家
示例值:
IpinfoProvince 是 否 String 省份
示例值:
IpinfoState 是 否 String 国家简称
示例值:
Method 是 否 String HTTP方法
示例值:
RiskLevel 是 否 Uint64 风险等级
示例值:
RuleId 是 否 Uint64 规则ID
示例值:
Status 是 否 Uint64 拦截状态,0是观察,1是放行
示例值:
Uri 是 否 String 攻击的Uri
示例值:
UserAgent 是 否 String 攻击者浏览器User Agent
示例值:
Uuid 是 否 String 请求ID
示例值:
RuleName 是 否 String 如果是自定义规则,则显示规则的名字,如果不是则为-
示例值:

MapItem

地图类型

被如下接口引用:DescribeAttackWorldMap

名称 必选 允许NULL 类型 描述
Country 是 否 String 城市
示例值:
Count 是 否 Uint64 数量
示例值:

DonwloadRecordItem

下载记录数据项

被如下接口引用:DescribeAccessDownloadRecords、DescribeAttackDownloadRecord

名称 必选 允许NULL 类型 描述
Name 是 否 String 下载任务名
示例值:
FlowId 是 否 String 任务ID
示例值:
Host 是 否 String 域名
示例值:
CreateTime 是 否 String 创建时间
示例值:
ExpireTime 是 否 String 过期时间
示例值:
Count 是 否 String 记录条数
示例值:
Status 是 否 String 下载状态
示例值:
Url 是 否 String 下载文件URL
示例值:
Id 是 否 String 记录ID
示例值:
Appid 是 否 String 产品ID
示例值:

CopyBotsUCBPreinstallRuleRsp

CopyBotsUCBPreinstallRule接口的返回自

被如下接口引用:CopyBotUCBPreinstallRule

名称 必选 允许NULL 类型 描述
Code 是 否 Int64 0表示成功,其他表示失败
示例值:
ErrMsg 是 否 String 错误信息
示例值:
SuccessNum 是 否 Int64 成功的数目
示例值:
FailedNum 是 否 Int64 失败的数目
示例值:
T 是 否 Array of String 成功的域名列表
示例值:

FiltersItemNew

实例入参过滤器

被如下接口引用:DescribeMainClass、DescribeUserSignatureRule、DescribeUserWhiteRule

名称 必选 允许NULL 类型 描述
Name 是 否 String 字段名
示例值:
Values 是 否 Array of String 过滤值
示例值:
ExactMatch 是 否 Bool 是否精确查找
示例值:

SearchLogsSimpleRsp

SearchLogsSimple的返回值

被如下接口引用:DescribeAccessLogs

名称 必选 允许NULL 类型 描述
Code 是 否 Int64 是否成功执行,0表示成功执行
示例值:
Count 是 否 Int64 日志的数目
示例值:
Context 是 否 String 日志的内容,可以用作游标
示例值:
Data 是 否 Array of String 具体的日志内容
示例值:

Protection

域名配置信息

被如下接口引用:DescribeSpartaProtectionList

名称 必选 允许NULL 类型 描述
Domain 是 否 String 域名
示例值:
DomainId 是 否 String 域名Id
示例值:
Cname 是 否 String cname地址
示例值:
Status 是 否 String waf开关 0表示关闭, 1表示开启
示例值:
State 是 否 String 防护状况:0 正常防护   1 未检测到流量  2 即将到期  3 已到期
示例值:
CreateTime 是 否 String 域名创建时间
示例值:
Mode 是 否 String 防御模式
示例值:
Engine 是 否 String AI防御模式
示例值:
Vip 是 否 Array of String 接入IP列表
示例值:
IsGray 是 否 String 灰度标识,1灰度0不灰度
示例值:
GrayAreas 是 否 Array of String 灰度区域,不灰传no
示例值:
CertType 是 否 String 证书类型,1表示自有证书,2表示腾讯云托管证书
示例值:
Cert 是 否 String 证书内容
示例值:
PrivateKey 是 否 String 证书私钥
示例值:
SSLId 是 否 String 腾讯云托管证书id,当certType=2时有效
示例值:
IsCdn 是 否 String 1有cdn,0无cdn
示例值:
IsHttp2 是 否 String 1开启http2,0不开启
示例值:
IsWebsocket 是 否 String 1开启websocket,0不开启
示例值:
HttpsRewrite 是 否 String 是否http强制跳转https,"1" 是、"0" 否
示例值:
HttpsUpstreamPort 是 否 String https回源端口
示例值:
UpstreamType 是 否 String 回源方式,"0"为ip回源,"1"为域名回源
示例值:
UpstreamDomain 是 否 String 回源域名
示例值:
UpstreamScheme 是 否 String 回源协议
示例值:
Cls 是 否 String 日志包
示例值:
CCList 是 否 Array of String CC列表
示例值:
LoadBalance 是 否 String 负载均衡算法,0表示轮询,1表示ip hash,默认为0
示例值:
Ports 是 否 Array of PortItem 服务端口配置
示例值:查看
RsList 是 否 Array of String 回源ip
示例值:
SrcList 是 否 Array of String ip列表
示例值:

MainClassItem

主类信息

被如下接口引用:DescribeMainClass

名称 必选 允许NULL 类型 描述
MainClassID 否 否 String 主类id
示例值:
MainClassName 否 否 String 主类名字
示例值:
Description 否 否 String 描述
示例值:
SubClass 否 是 Array of SubClassItem 子类
示例值:查看
RuleCount 否 是 Uint64 当前主类的规则个数
示例值:

BotsDomainAggStatStyledItem

GetBotsDomainAggStatStyled接口的返回数组的元素类型

被如下接口引用:DescribeBotAggregateDomainStat

名称 必选 允许NULL 类型 描述
Key 是 否 String 域名
示例值:
Value 是 否 Int64 攻击次数
示例值:

DescribeCustomRulesRspRuleListItem

DescribeCustomRules接口回包中的复杂类型

被如下接口引用:DescribeCustomRules

名称 必选 允许NULL 类型 描述
ActionType 是 否 String 动作类型
示例值:
Bypass 是 否 String 跳过的策略
示例值:
CreateTime 是 否 String 创建时间
示例值:
ExpireTime 是 否 String 过期时间
示例值:
Name 是 否 String 策略名称
示例值:
Redirect 是 否 String 重定向地址
示例值:
RuleId 是 否 String 策略ID
示例值:
SortId 是 否 String 优先级
示例值:
Status 是 否 String 状态
示例值:
Strategies 是 否 Array of Strategy 策略详情
示例值:查看

GlobalWhiteCond

全局白名单规则项

被如下接口引用:AddUserWhiteRule、DescribeUserWhiteRule、ModifyUserWhiteRule

名称 必选 允许NULL 类型 描述
Target 是 否 String 匹配目标,HTTP-Method,Host,URI,FULL-URL,Parameter,Cookie,HTTP-Header,JSON-Elements
示例值:
Operation 是 否 String 匹配操作,String-Match 字符串匹配,支持通配符,例如/floder1/  /floder1//index.htm;Regular-Expression-Match 正则表达式匹配, Include 包含(HTTP-Method),Exclude 不包含(HTTP-Method)
示例值:
HttpMethodList 否 否 Array of String 方法列表,"GET", "POST", "HEAD"
示例值:
Name 否 否 String 变量名称, 适用于Parameter,Cookie,HTTP-Header,JSON-Elements
示例值:
CheckValue 否 否 Uint64 是否检查变量值,0:disable, 1: enable。 适用于Parameter,Cookie,HTTP-Header,JSON-Elements
示例值:
Value 否 否 String 变量值,适用于Host,URI,FULL-URL,Parameter,Cookie,HTTP-Header,JSON-Elements
示例值:
Concatenate 否 否 String 条件之间的链接方式,可以为AND/OR。AND 表示与上一个条件与的关系,OR表示与上一个条件是或的关系。多个条件之间的链接关系如下: C1.AND C2.AND C3.OR C4.OR C5.AND C6.AND, 则组合的逻辑关系是: c1 and (c2 or c3 or c4) and c5 and c6
示例值:

ClsPackage

clb-waf 日志套餐

被如下接口引用:DescribeSpartUserInfo、DescribeUserInfo

名称 必选 允许NULL 类型 描述
ResourceIds 是 否 String 资源ID
示例值:
ValidTime 是 否 String 过期时间
示例值:
AutoRenew 是 否 Int64 是否自动续费,1:自动续费,0:不自动续费
示例值:
Count 是 否 Int64 套餐个数
示例值:
Region 是 否 String 地域,目前在clb-waf中没有用到
示例值:

BotListData

bot列表数据封装

被如下接口引用:DescribeBotTCBRecords、DescribeBotUBRecords、DescribeBotUCBRecords

名称 必选 允许NULL 类型 描述
Res 是 是 Array of BotItemsListItem bot列表
示例值:查看
TotalCount 是 否 Uint64 统计总数
示例值:

DescribeDNSDetectDomainListDomainListItem

DescribeDNSDetectDomainList返回值的元素

被如下接口引用:DescribeDNSDetectDomainList

名称 必选 允许NULL 类型 描述
Id 是 否 String id
示例值:
Domain 是 否 String 域名
示例值:
HijackRecords 是 否 String hijackRecords
示例值:
HijackRegions 是 否 String hijackRegions
示例值:
CreateTime 是 否 String 创建时间
示例值:
AuthIP 是 否 Array of String 授权的IP
示例值:

InstancePriceItem

商品价格询价结果

被如下接口引用:InquiryPriceWafInstance

名称 必选 允许NULL 类型 描述
Pid 是 否 Int64 商品的编码
示例值:
RealTotalCost 是 否 Int64 折扣后的价格
示例值:
TotalCost 是 否 Int64 折扣前的价格
示例值:

WafGetDomainEngineTypeData

WafGetDomainEngineType返回参数

被如下接口引用:WafGetDomainEngineType

名称 必选 允许NULL 类型 描述
EngineType 否 否 String 引擎类型
示例值:
Domain 否 否 String 域名
示例值:

UserSignatureRule

用户特征规则描述

被如下接口引用:DescribeUserSignatureRule

名称 必选 允许NULL 类型 描述
ID 否 否 String 特征ID
示例值:
Status 否 否 Int64 规则开关
示例值:
MainClassID 否 否 String 主类ID
示例值:
SubClassID 否 否 String 子类ID
示例值:
CveID 否 否 String CVE ID
示例值:
CreateTime 否 否 Datetime_iso 创建时间
示例值:
ModifyTime 否 否 Datetime_iso 更新时间
示例值:
MainClassName 否 否 String 主类名字,根据Language字段输出中文/英文
示例值:
SubClassName 否 否 String 子类名字,根据Language字段输出中文/英文,若子类id为00000000,此字段为空
示例值:
Description 否 否 String 规则描述
示例值:

PeakPointsItem

PeakPoints数组项

被如下接口引用:DescribePeakPoints

名称 必选 允许NULL 类型 描述
Time 是 否 Uint64 秒级别时间戳
示例值:
Access 是 否 Uint64 QPS
示例值:
Up 是 否 Uint64 上行带宽峰值,单位B
示例值:
Down 是 否 Uint64 下行带宽峰值,单位B
示例值:
Attack 是 否 Uint64 Web攻击次数
示例值:
Cc 是 否 Uint64 CC攻击次数
示例值:

LoadBalancer

负载均衡的监听器

被如下接口引用:CreateHost、DescribeHost、DescribeHosts、DescribeWafInfo、ModifyHost

名称 必选 允许NULL 类型 描述
LoadBalancerId 是 否 String 负载均衡LD的ID
示例值:
LoadBalancerName 是 否 String 负载均衡LD的名称
示例值:
ListenerId 是 否 String 负载均衡监听器的ID
示例值:
ListenerName 是 否 String 负载均衡监听器的名称
示例值:
Vip 是 否 String 负载均衡实例的IP
示例值:
Vport 是 否 Uint64 负载均衡实例的端口
示例值:
Region 是 否 String 负载均衡LD的地域
示例值:
Protocol 是 否 String 监听器协议,http、https
示例值:
Zone 是 否 String 负载均衡监听器所在的zone
示例值:
NumericalVpcId 是 是 Int64 网络
示例值:
LoadBalancerType 是 是 String 网络类型
示例值:

RuleUpdateLog

tiga引擎规则更新动态日志

被如下接口引用:DescribeRuleUpdateLog

名称 必选 允许NULL 类型 描述
Id 否 否 Uint64 id值
示例值:
CreateTime 否 否 Datetime_iso 创建时间
示例值:
ModifyTime 否 否 Datetime_iso 修改时间
示例值:
Detail 否 否 String 详细修改动态
示例值:
Language 否 否 String en/cn 描述信息语言
示例值:
LogVersion 否 否 String 版本信息
示例值:

SpartaProtectionPort

waf斯巴达-编辑防护域名中的端口结构

被如下接口引用:ModifySpartaProtection

名称 必选 允许NULL 类型 描述
NginxServerId 是 否 Uint64 nginx Id
示例值:
Port 是 否 String 端口
示例值:
Protocol 是 否 String 协议
示例值:
UpstreamPort 是 否 String 后端端口
示例值:
UpstreamProtocol 是 否 String 后端协议
示例值:

SessionData

参数包装

被如下接口引用:DescribeSession

名称 必选 允许NULL 类型 描述
Res 是 否 Array of SessionItem session定义
示例值:查看

DNSDetectHijackData

DNS劫持检测的劫持记录结构体

被如下接口引用:DescribeDNSDetectHijackData

名称 必选 允许NULL 类型 描述
Domain 是 否 String 被劫持的域名
示例值:
HijackIP 是 否 String 被劫持后的IP
示例值:
Operator 是 否 String 被劫持后的IP的运营商
示例值:
HijackRegions 是 否 Uint64 被劫持的地域数
示例值:
HijackUsers 是 否 Uint64 被劫持的用户数
示例值:
AuthIP 是 否 String 权威记录
示例值: