数据结构

ConfigDeliveryData

ConfigDeliveryData数据

被如下接口引用：QueryConfigDelivery

名称	必选	允许NULL	类型	描述
CheckAppId	否	是	Uint64	查询AppId
Domain	否	是	String	域名
Module	否	是	String	模块
DeliveryState	否	是	Uint64	配置下发状态 1-成功、2-失败
DeliveryStateName	否	是	String	配置下发状态名称
DeliveryMsg	否	是	String	下发提示语
DbVersion	否	是	Uint64	DB版本
DbVersionTs	否	是	Uint64	DbVersion时间
DbVersionTsStr	否	是	String	DbVersion时间标准格式
RedisList	否	是	Array of RedisVersionItem	[{"Region":"cd","Version":21}]
InstanceList	否	是	Array of InstanceItem	实例列表

ApiSecIpAbnormalSource

api安全事件攻击ip异常列表

被如下接口引用：DescribeApiSecAttackSourceList

名称	必选	允许NULL	类型	描述
IpSection	否	是	String	异常ip段
StartTime	否	是	Int64	开始时间
EndTime	否	是	Int64	结束时间

BotHttpHeader

bot模块的HttpHeader信息

被如下接口引用：DescribeBotDetail

名称	必选	允许NULL	类型	描述
AcceptExist	是	是	Bool	accept存在性信息
AcceptLanguageExist	是	是	Bool	AcceptLanguage存在性
AcceptEncodingExist	是	是	Bool	AcceptEncoding存在性
ConnectionExist	是	是	Bool	Connection存在性

BotDetail

bot详情

被如下接口引用：DescribeBotDetail

名称	必选	允许NULL	类型	描述
Id	是	是	String	该记录的唯一id
BotId	是	是	String	bot_id保留字段
SrcIp	是	是	String	源ip
BotAction	是	是	String	bot的动作
Stat	是	是	BotStat	bot统计信息
RuleName	是	是	String	规则名称
Score	是	是	BotScore	分数
SessionDuration	是	是	Float	会话时长
Timestamp	是	是	Uint64	时间戳
BotFeature	是	是	Array of String	string数组
IpInfo	是	是	IpInfo	ip信息

CdcResource

运营后台参数，CDC资源信息

被如下接口引用：DescribeCdcResource

名称	必选	允许NULL	类型	描述
Id	是	否	Uint64	资源id
Status	是	否	Uint64	规则状态，0/1
OpAppId	是	否	Uint64	用户id
ClusterId	是	否	String	集群id
Ip	是	否	String	IP地址
Port	是	否	Uint64	端口
Auth	是	否	String	认证信息
CreateTime	是	否	Datetime_iso	创建时间
ModifyTime	是	否	Datetime_iso	修改时间
Type	是	否	String	资源类型

FindAllDomainDetail

域名列表

被如下接口引用：DescribeFindDomainList

名称	必选	允许NULL	类型	描述
Appid	是	否	Uint64	用户id
Domain	是	否	String	域名
Ips	是	否	Array of String	域名ip
FindTime	是	否	String	发现时间
InstanceId	是	否	String	实例id
DomainId	是	否	String	域名id
Edition	是	否	String	waf类型
IsWafDomain	是	否	Uint64	是否接入waf

BotModuleStatusEntry

bot 开启模块开关列表

被如下接口引用：DescribeBotRuleOverview

名称	必选	允许NULL	类型	描述
AiStatus	是	否	Bool	bot -ai模块开关状态
TiStatus	是	否	Bool	bot -威胁情报开关状态
JsInjectStatus	是	否	Bool	bot- 前端对抗模块开关
AutoStatisticStatus	是	否	Bool	bot- 智能统计模块开关

BotScore

bot分数

被如下接口引用：DescribeBotDetail、DescribeBotItems

名称	必选	允许NULL	类型	描述
Total	是	是	Uint64	总分数

LimitRule

限流规则

被如下接口引用：DescribeRateLimits

名称	必选	允许NULL	类型	描述
RuleName	是	是	String	规则名
Domain	否	否	String	域名
Id	否	否	String	规则ID
ApiPaths	否	是	Array of String	api路径列表
Amount	是	是	Amount	限流配额，包含限流周期和配额总数，可配置多个
Arguments	否	是	Array of MatchArgument	请求参数匹配条件，需全匹配才通过
Priority	否	是	Int64	优先级
LimitStrategy	否	是	Int64	限流效果，支持REJECT（直接拒绝）,UNIRATE（匀速排队），默认REJECT
LimitObject	否	是	String	限流对象，支持API,DOMAIN
Status	否	是	Int64	是否启用该限流规则，默认为1（启用）
Timestamp	否	是	Int64	修改时间戳

PolicyDetail

计费询价出参政策明细

被如下接口引用：DescribePrice

名称	必选	允许NULL	类型	描述
Total	是	是	Float	总数
User	是	是	Float	用户
Common	是	是	Float	通用
Activity	是	是	Float	激活

HostRecord

clb-waf防护域名

被如下接口引用：CreateHost、CreateHostInner、DescribeHost、DescribeHosts、ModifyHost、ModifyHostInner

名称	必选	允许NULL	类型	描述
Domain	是	否	String	域名
DomainId	是	否	String	域名ID
MainDomain	是	否	String	主域名，入参时为空
Mode	是	否	Uint64	规则引擎防护模式，0 观察模式，1拦截模式
Status	是	否	Uint64	waf和LD的绑定，0：没有绑定，1：绑定
State	是	否	Uint64	域名状态，0：正常，1：未检测到流量，2：即将过期，3：过期
Engine	是	否	Uint64	规则引擎和AI引擎防护模式联合状态,10规则引擎观察&&AI引擎关闭模式 11规则引擎观察&&AI引擎观察模式 12规则引擎观察&&AI引擎拦截模式 20规则引擎拦截&&AI引擎关闭模式 21规则引擎拦截&&AI引擎观察模式 22规则引擎拦截&&AI引擎拦截模式
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：关闭
Level	否	是	Uint64	防护等级，可选值100,200,300
CdcClusters	否	是	Array of String	域名需要下发到的cdc集群列表
AlbType	否	是	String	应用型负载均衡类型: clb或者apisix，默认clb
IpHeaders	否	是	Array of String	IsCdn=3时，需要填此参数，表示自定义header
EngineType	否	是	Int64	规则引擎类型， 1: menshen, 2:tiga
CloudType	否	是	String	云类型:public:公有云；private:私有云;hybrid:混合云

DescribeCachePathPaging

DescribeCachePath翻页参数

被如下接口引用：

名称	必选	允许NULL	类型	描述
Index	是	否	String	起始页
Count	是	否	String	页数目

MiniProgramItem

小程序报表趋势数据

被如下接口引用：DescribeMiniProgramPeakPoint

名称	必选	允许NULL	类型	描述
Time	否	否	Uint64	秒级别时间戳
AccessBefore	否	是	Uint64	原生防护前总量
AccessAfter	否	是	Uint64	原生防护后总量
QpsBefore	否	是	Uint64	原生防护前QPS
QpsAfter	否	是	Uint64	原生防护后QPS
BandWidth	否	是	Uint64	带宽
Attack	否	是	Uint64	web安全拦截量
CC	否	是	Uint64	CC拦截量

AccessKeyValueInfo

用于 DescribeAccessIndex 的出参

被如下接口引用：DescribeAccessIndex

名称	必选	允许NULL	类型	描述
Key	是	是	String	需要配置键值或者元字段索引的字段
Value	是	是	AccessValueInfo	字段的索引描述信息

BotUCBPreinstallRule

bot内置类型自定义策略

被如下接口引用：DescribeBotUCBPreinstallRule

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

DomainPackage

clb-waf 域名扩展套餐

被如下接口引用：DescribeUserInfo、DescribeUserInstances

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

SpartaProtectionPort

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

被如下接口引用：ModifySpartaProtection

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

WebshellStatus

域名的webshell开启状态

被如下接口引用：ModifyWebshellStatus

名称	必选	允许NULL	类型	描述
Domain	是	否	String	域名
Status	是	否	Uint64	webshell开关，1：开。0：关。2：观察

ResponseCode

响应体的返回码

被如下接口引用：AddCustomRule、AddCustomWhiteRule、AddPocTestTask、CreateCopyCustomWhiteRule、CreateWhiteList、DeleteCustomWhiteRule、DeleteHost、DeleteHostInner、DeletePocTestTask、DeleteWhiteList、DescribeHostLimit、ModifyCertificatedDomain、ModifyCustomRuleStatus、ModifyCustomWhiteRule、ModifyCustomWhiteRuleStatus、ModifyHostFlowMode、ModifyHostFlowModeInner、ModifyHostMode、ModifyHostStatus、ModifyHostStatusInner、ModifyJsInjectRule、ModifyJsInjectRuleStatus、ModifyPackageRenew、ModifyPocTestAuthorization、ModifyWafAutoDenyRules、ModifyWebshellStatus、ModifyWhiteList

名称	必选	允许NULL	类型	描述
Code	是	否	String	如果成功则返回Success，失败则返回云api定义的错误码
Message	是	否	String	如果成功则返回Success，失败则返回WAF定义的二级错误码

OpUserSignaturePolicy

用户防护规则

被如下接口引用：DescribeOpUserSignaturePolicy

名称	必选	允许NULL	类型	描述
OpAppId	是	否	Uint64	appid
OpDomain	是	否	String	域名
Level	是	否	Int64	防护等级 300=标准 400=扩展
Status	是	否	Int64	防护状态 0=关闭，1=开启
ModifyTime	是	否	Datetime_iso	修改时间

OptionalGroup

目标集群信息

被如下接口引用：DescribeVIPRS

名称	必选	允许NULL	类型	描述
Id	是	是	Int64	集群ID
Name	是	是	String	集群描述

AccessRuleKeyValueInfo

DescribeAccessIndex接口的出参

被如下接口引用：DescribeAccessIndex

名称	必选	允许NULL	类型	描述
CaseSensitive	是	是	Bool	是否大小写敏感
KeyValues	是	是	Array of AccessKeyValueInfo	需要建立索引的键值对信息；最大只能配置100个键值对

BotWhiteInfo

goodbot 的开关列表

被如下接口引用：DescribeBotWhiteStatus

名称	必选	允许NULL	类型	描述
Name	是	否	String	策略名称
Status	是	否	Bool	策略开关
Timestamp	是	否	Int64	时间戳
WhiteInfo	是	是	String	策略描述

DescribeApiRule

用户查询一条api规则

被如下接口引用：DescribeApiRule

名称	必选	允许NULL	类型	描述
Domain	是	否	String	用户要查询的api规则的域名
Description	是	是	String	该条api规则的描述
Method	是	否	String	该条api的请求方式
Status	是	否	Uint64	该条api的开关状态
Action	是	否	Uint64	该条api对应的动作，包括观察和拦截
RuleList	是	否	Array of AddApiRule	apid对应的具体的参数信息

ExportAccessInfo

DescribeAccessExports接口

被如下接口引用：DescribeAccessExports

名称	必选	允许NULL	类型	描述
ExportId	是	是	String	日志导出任务ID
Query	是	是	String	日志导出查询语句
FileName	是	是	String	日志导出文件名
FileSize	是	否	Int64	日志文件大小
Order	是	是	String	日志导出时间排序
Format	是	是	String	日志导出格式
Count	是	是	Uint64	日志导出数量
Status	是	否	String	日志下载状态。Processing:导出正在进行中，Complete:导出完成，Failed:导出失败，Expired:日志导出已过期（三天有效期）
From	是	否	Int64	日志导出起始时间
To	是	否	Int64	日志导出结束时间
CosPath	是	否	String	日志导出路径
CreateTime	是	否	String	日志导出创建时间

BotListData

bot列表数据封装

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

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

ClsPackageNew

clb-waf 日志套餐 New

被如下接口引用：

名称	必选	允许NULL	类型	描述
ResourceIds	是	否	String	资源ID
ValidTime	是	否	String	过期时间
RenewFlag	是	否	Int64	是否自动续费，1：自动续费，0：不自动续费
Count	是	否	Int64	套餐个数
Region	是	否	String	地域，目前在clb-waf中没有用到
Used	是	否	Float	已经使用的cls

DomainCustomRuleInfoData

查询域名自定义规则信息Data

被如下接口引用：QueryDomainCustomRuleInfo

名称	必选	允许NULL	类型	描述
CustomRule	否	是	DomainCustomRuleInfoItem	自定义规则
BatchDomainRule	否	是	DomainCustomRuleInfoItem	批量域名规则

ApiParameterType

api请求参数类型

被如下接口引用：DescribeApiDetail

名称	必选	允许NULL	类型	描述
ParameterName	是	是	String	参数名称
Type	是	是	String	参数类型
Location	是	是	String	参数位置
Label	是	是	Array of String	数据标签(敏感字段)
Timestamp	是	是	Uint64	时间戳
Remark	是	是	String	备注信息
Source	是	是	String	来源是请求或者响应

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

BotAccessItemTwo

bot流量分析页 日志列表显示字段

被如下接口引用：DescribeBotAccessLogTwo

名称	必选	允许NULL	类型	描述
ClientIp	否	否	String	访问ip
BotToken	否	是	String	访问会话ID
Domain	否	是	String	访问域名
Url	否	是	String	访问url
Method	否	是	String	请求方式
BotLabel	否	是	String	Bot标签
BotAction	否	是	String	Bot动作
BotModule	否	是	String	命中模块
BotScore	否	是	Int64	bot得分
City	否	是	String	ip所在城市
BotTime	否	是	Int64	命中时间
BotTi	否	是	Int64	是否命中威胁情报
BotAi	否	是	Int64	是否命中Ai评估
BotStat	否	是	Int64	是否命中智能统计
BotTiIdc	否	是	String	命中威胁情报的IDC信息
BotTiCategory	否	是	String	威胁情报库分类
BotTiUa	否	是	String	威胁情报UserAgent分类
TotalCount	否	否	Int64	日志条数
BotStatAvgSpeed	否	是	Int64	是否命中智能统计平均速度异常
BotStatNums	否	是	Int64	是否命中智能统计的数量异常
BotStatSessionDuration	否	是	Int64	是否命中智能统计的时间会话异常
BotStatReqUrlKind	否	是	Int64	是否命中智能统计的url种类异常
BotStatUaKindNums	否	是	Int64	是否命中智能统计的ua种类异常
BotStatCookieKindNums	否	是	Int64	是否命中智能统计的cookie种类异常
BotStatReferKindNums	否	是	Int64	是否命中智能统计的refer种类异常
BotRuleId	否	是	String	规则id
BotSceneId	否	是	String	场景ID
BotSceneName	否	是	String	场景名称
BotSceneActionId	否	是	String	场景动作策略ID
BotSceneActionName	否	是	String	场景动作策略名称
BotUa	否	是	Int64	是否命中UA策略模块

SearchLogsSimpleRsp

SearchLogsSimple的返回值

被如下接口引用：DescribeAccessLogs

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

AccessLogItems

日志KeyValue对数组，用于搜索访问日志

被如下接口引用：SearchAccessLog

名称	必选	允许NULL	类型	描述
Data	是	是	Array of AccessLogItem	分析结果返回的KV数据对

InstancePriceItem

商品价格询价结果

被如下接口引用：InquiryPriceWafInstance

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

BotStatSt

bot出参相关

被如下接口引用：DescribeBotItems

名称	必选	允许NULL	类型	描述
Count	是	是	Uint64	会话数量
AvgSpeed	是	是	Float	平均速度

RuleUpdateLog

tiga引擎规则更新动态日志

被如下接口引用：DescribeOpRuleUpdateLog、DescribeRuleUpdateLog

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

WhiteListItem

业务白名单

被如下接口引用：DescribeJsInjectRule

名称	必选	允许NULL	类型	描述
Domain	是	否	String	白名单对应的域名
Id	否	否	Int64	白名单ID
Content	是	否	String	白名单内容
Comment	否	否	String	白名单的备注
Status	是	否	Int64	白名单的开关状态，0：关闭，1：开启
Type	是	否	String	白名单的类型，jsinject_req：动态风控的请求白名单，jsinject_rsp：动态风控的响应白名单

DescribeDNSDetectDomainListDomainListItem

DescribeDNSDetectDomainList返回值的元素

被如下接口引用：DescribeDNSDetectDomainList

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

DNSDetectHijackData

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

被如下接口引用：DescribeDNSDetectHijackData

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

RuleEn

规则列表详情

被如下接口引用：DescribeDomainRulesEn

名称	必选	允许NULL	类型	描述
Id	否	否	Uint64	规则id
Type	否	是	String	规则类型
Level	否	否	String	规则等级
Description	否	是	String	规则描述
CVE	否	是	String	规则防护的CVE编号
Status	否	否	Uint64	规则的状态
ModifyTime	否	否	String	规则修改的时间
TypeEng	否	是	String	规则类型英文
LevelEng	否	是	String	规则等级英文
DescriptionEng	否	是	String	规则描述英文
AddTime	否	是	String	门神规则新增/更新时间

BotScoreEntry

score分布

被如下接口引用：DescribeBotActionRule、DescribeBotLevel、ModifyBotActionRule

名称	必选	允许NULL	类型	描述
Upper	否	否	String	起始分数
Lower	否	否	String	结束分数
Action	否	否	String	分数段对应的动作
Label	否	否	String	分数段对应的bot标签
Redirect	否	是	String	重定向地址

BotRecordItemsData

bot访问序列数据封装

被如下接口引用：

名称	必选	允许NULL	类型	描述
Res	是	否	BotRecordItemRes	数据

ThreatIntelligenceStatus

情报项的开、关设置

被如下接口引用：ModifyThreatIntelligenceStatus

名称	必选	允许NULL	类型	描述
Value	是	否	String	情报内容
Status	是	否	Bool	true：开启、false：关闭
Type	是	否	String	情报分类

HybridClusterNode

混合云集群节点

被如下接口引用：DescribeHybridClusterNodes

名称	必选	允许NULL	类型	描述
NodeId	否	是	String	节点ID
Name	否	是	String	节点名称
Type	否	是	String	节点类型
IP	否	是	String	节点IP
Ports	否	是	Array of String	端口列表
State	否	是	Int64	节点状态
StateDetail	否	是	String	节点异常原因
CreateTime	否	是	String	创建时间
LatestUpdateTime	否	是	String	最新时间

ExpiredQPSPackage

clb-waf QPS套餐 New

被如下接口引用：DescribeExpiredInstances

名称	必选	允许NULL	类型	描述
ResourceIds	是	否	String	资源ID
RenewFlag	是	否	Int64	是否自动续费，1：自动续费，0：不自动续费

LogAnalysisInfo

攻击日志聚合分析详情

被如下接口引用：GetAttackAnalysis

名称	必选	允许NULL	类型	描述
Count	是	否	Int64	日志条目数
Ratio	是	否	Float	百分比
Value	是	否	String	Key对应的分类值

DataSorter

排序结构体

被如下接口引用：DescribeBotDetailDownloadTask、ModifyBotDetailDownloadTask

名称	必选	允许NULL	类型	描述
Entity	是	否	String	排序字段
Value	是	否	Int64	1:降序 -1:升序

DownloadAttackRecordInfo

下载攻击日志记录数据项

被如下接口引用：GetAttackDownloadRecords

名称	必选	允许NULL	类型	描述
Id	是	否	Uint64	记录ID
TaskName	是	否	String	下载任务名
TaskId	是	否	String	任务ID
Host	是	否	String	域名
Count	是	否	Uint64	当前下载任务的日志条数
Status	是	否	Int64	下载任务运行状态：-1-下载超时，0-下载等待，1-下载完成，2-下载失败，4-正在下载
Url	是	否	String	下载文件URL
CreateTime	是	否	Datetime	创建时间
ModifyTime	是	否	Datetime	最后更新修改时间
ExpireTime	是	否	Datetime	过期时间
TotalCount	是	否	Uint64	下载任务需下载的日志总条数

PostCLSFlowInfo

CKafka投递流

被如下接口引用：DescribePostCLSFlows

名称	必选	允许NULL	类型	描述
FlowId	否	否	Int64	投递流唯一ID
LogType	否	否	Int64	1-访问日志 2-攻击日志
InsertTime	否	否	Int64	创建时间
ModifyTime	否	否	Int64	最后一次修改时间
Status	否	否	Int64	状态 0-为关闭 1-为启用
CLSRegion	否	否	String	CLS所在区域
LogsetName	否	否	String	CLS日志集合名称
LogsetID	否	否	String	CLS日志集合ID
LogtopicName	否	否	String	CLS日志主题名称
LogtopicID	否	否	String	CLS日志主题ID
Sync	否	否	Int64	0-异步投递，1-同步投递，目前仅支持同步投递
Content	否	否	String	描述信息
Count	否	是	Int64	投递的域名或实例个数

ApiSecSensitiveRule

api安全敏感规则列表

被如下接口引用：DescribeApiSecSensitiveRuleList

名称	必选	允许NULL	类型	描述
RuleName	否	否	String	身份证号，唯一主键
Source	否	是	String	表示OS系统内置，"custom"表示客户自定义
Status	否	是	Uint64	开关状态，0：表示关，1表示开
Level	否	是	String	风险等级，100，200,300表示低中高三个等级
Timestamp	否	是	Uint64	修改时间，默认0，表示没有进行修改
CustomRule	否	是	ApiSecCustomSensitiveRule	自定义规则部分

AccessValueInfo

用于DescribeAccessIndex接口的出参

被如下接口引用：DescribeAccessIndex

名称	必选	允许NULL	类型	描述
Type	是	是	String	字段类型，目前支持的类型有：long、text、double
Tokenizer	是	是	String	字段的分词符，只有当字段类型为text时才有意义；输入字符串中的每个字符代表一个分词符
SqlFlag	是	是	Bool	字段是否开启分析功能
ContainZH	是	是	Bool	是否包含中文注意：此字段可能返回 null，表示取不到有效值。

BatchIpAccessControlData

多域名黑白名单describe返回

被如下接口引用：DescribeBatchIpAccessControl

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Uint64	总数
Res	是	否	Array of BatchIpAccessControlItem	黑白名单条目

FraudPkg

业务安全资源信息

被如下接口引用：DescribeInstances

名称	必选	允许NULL	类型	描述
ResourceIds	否	是	String	资源id
Status	否	是	Int64	状态
Region	否	是	Int64	地域
BeginTime	否	是	String	开始时间
EndTime	否	是	String	结束时间
InquireNum	否	是	Int64	申请数量
UsedNum	否	是	Int64	使用数量
RenewFlag	否	是	Uint64	续费标志

RedisVersionItem

Redis版本信息

被如下接口引用：QueryConfigDelivery

名称	必选	允许NULL	类型	描述
Region	是	否	String	Redis集群地区标识
Version	否	否	Uint64	Redis集群地区版本

PartDetail

计费部件价格信息

被如下接口引用：DescribePrice

名称	必选	允许NULL	类型	描述
Name	是	否	String	计费细项
Value	是	否	PartDetailItem	价格明细项

SwitchApiRules

启用或者停用Api规则的列表

被如下接口引用：SwitchApiRules

名称	必选	允许NULL	类型	描述
Url	是	否	String	启用或者停用api规则的url
Method	是	否	String	启用或者停用api规则的请求方法

MatchArgument

限流中的参数匹配

被如下接口引用：CreateRateLimits、DescribeRateLimits、UpdateRateLimits

名称	必选	允许NULL	类型	描述
Type	是	是	String	参数类型，枚举，支持：CUSTOM，METHOD，HEADER，QUERY，CALLER_SERVICE，CALLER_IP
Key	否	是	String	参数键，对于HEADER、QUERY、CUSTOM，对应的是key值；对于CALLER_SERVICE，对应的是服务的命名空间值
Value	是	是	MatchString	参数值，对于HEADER、QUERY、CUSTOM，对应的是key所关联的value；对于CALLER_SERVICE，对应的是服务名，其他类型则是具体的值

BlockPage

拦截页面

被如下接口引用：DescribeBlockPages

名称	必选	允许NULL	类型	描述
Id	是	否	Uint64	唯一ID
Name	是	否	String	标记名称
Status	是	否	Uint64	HTTP状态码
ContentType	是	否	String	HTTP的Content-Type
Html	否	是	String	Html源码
Mode	是	是	Uint64	0待审核，1审核通过，2审核拒绝
CustomHeaders	否	是	Array of CustomHeader	自定义头部信息

BotSceneActionRule

获取场景动作策略列表时的动作策略实体

被如下接口引用：DescribeBotSceneActionRule、DescribeBotSceneList

名称	必选	允许NULL	类型	描述
RuleId	是	否	String	动作策略ID
RuleName	是	否	String	动作策略名称
Priority	是	否	Int64	策略优先级
Status	是	否	Bool	策略生效状态
Score	是	否	Array of BotScoreRuleEntry	分数范围
Level	是	否	String	100-宽松、200-中等、300-严格、0-自定义
Scope	是	是	Array of BotActionScopeRuleEntry	生效范围，为空表示全部范围
Type	是	是	String	default：默认创建 custom：自定义创建
ScopeType	是	是	String	匹配范围类型：全局匹配 or 自定义匹配范围
ActionMatchType	否	是	String	匹配条件间的与或关系

CountTopNItem

列表

被如下接口引用：DescribeBotDetailCountTopN

名称	必选	允许NULL	类型	描述
SrcValue	否	是	String	要显示的访问源,取值为ip活token的取值
Domain	否	是	String	域名
Count	否	是	Int64	数量
Label	否	是	String	SrcValue对应的类型

PageInfoForInt

分页参数复杂结构体

被如下接口引用：DescribeDNSDetectDomainList

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

PortInfo

服务端口配置

被如下接口引用：DescribeDomainDetailsSaas、DescribeDomains

名称	必选	允许NULL	类型	描述
NginxServerId	是	否	Uint64	Nginx的服务器id
Port	是	否	String	监听端口配置
Protocol	是	否	String	与端口对应的协议
UpstreamPort	是	否	String	回源端口
UpstreamProtocol	是	否	String	回源协议

DeleteApi

api列表，用于用户删除指定api规则

被如下接口引用：DeleteApiRules

名称	必选	允许NULL	类型	描述
Url	是	否	String	用户删除指定url的api
Method	是	否	String	用户删除指定请求方法的api

BotRecordItemRes

bot访问详情序列

被如下接口引用：

名称	必选	允许NULL	类型	描述
Items	是	否	String	访问序列数据

AccessRuleTagInfo

DescribeAccessIndex接口的出参

被如下接口引用：DescribeAccessIndex

名称	必选	允许NULL	类型	描述
CaseSensitive	是	是	Bool	是否大小写敏感
KeyValues	是	是	Array of AccessKeyValueInfo	标签索引配置中的字段信息

InOutputBotUCBRule

修改/新增自定义规则的入参，查询自定义规则列表时的出参

被如下接口引用：DescribeBotSceneUCBRule、ModifyBotSceneUCBRule

名称	必选	允许NULL	类型	描述
Id	否	是	String	入参ID
Domain	是	否	String	域名
SceneId	否	否	String	场景ID
Name	是	否	String	规则名称
Rule	是	否	Array of InOutputUCBRuleEntry	UCB的具体规则项
Action	是	否	String	处置动作
OnOff	是	否	String	规则开关
RuleType	是	否	Int64	规则类型
Prior	是	否	Int64	规则优先级
Timestamp	是	否	Int64	修改时间戳
ValidTime	否	是	Int64	生效时间
Appid	否	否	Uint64	传入的appid
AdditionArg	否	是	String	额外参数
Desc	否	是	String	规则描述
Label	是	否	String	标签
RuleId	否	否	String	规则ID
PreDefine	否	是	Bool	true-系统预设规则 false-自定义规则

CopyBotsUCBPreinstallRuleRsp

CopyBotsUCBPreinstallRule接口的返回自

被如下接口引用：CopyBotUCBPreinstallRule

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

TiInfo

命中的威胁情报信息

被如下接口引用：DescribeBotDetailVersionTwo

名称	必选	允许NULL	类型	描述
Type	否	是	String	情报类别
Value	否	是	String	情报值
Description	否	是	String	情报描述

CCRuleData

数据封装

被如下接口引用：DescirbeCCRule、DescribeCCRule

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

CCRuleItems

CC规则详情

被如下接口引用：DescribeCCRuleList

名称	必选	允许NULL	类型	描述
Name	否	否	String	名字
Status	否	否	Uint64	状态
Advance	否	否	Uint64	模式
Limit	否	否	Uint64	限制
Interval	否	否	Uint64	范围
Url	否	否	String	网址
MatchFunc	否	否	Uint64	匹配类型
ActionType	否	否	Uint64	动作
Priority	否	否	Uint64	优先级
ValidTime	否	否	Uint64	有效时间
TsVersion	否	否	Uint64	版本
Options	否	否	String	规则详情
RuleId	否	否	Uint64	规则ID
EventId	否	是	String	事件id
SessionApplied	否	是	Array of Int64	关联的Session规则

BotsGeoStatStyledItem

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

被如下接口引用：DescribeBotRegionsStat

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

BotKeyValueItem

普通的K-V格式

被如下接口引用：DescribeBotDetail

名称	必选	允许NULL	类型	描述
Key	是	否	String	key值
Value	是	否	Int64	value值

OWASPCustomizedData

防护能力定制Data

被如下接口引用：DescribeHWInfo

名称	必选	允许NULL	类型	描述
Status	否	是	Uint64	状态
Num	否	是	Uint64	数量

DomainConfig

域名大字段日志配置

被如下接口引用：DescribeAccessMeta

名称	必选	允许NULL	类型	描述
Domain	否	是	String	域名
WriteConfig	否	是	FieldWriteConfig	大字段配置

WafThreatenIntelligenceDetails

当前WAF威胁情报封禁模块详情

被如下接口引用：DescribeWafThreatenIntelligence、ModifyWafThreatenIntelligence

名称	必选	允许NULL	类型	描述
Tags	否	是	Array of String	封禁属性标签
DefenseStatus	否	否	Int64	封禁模组启用状态
LastUpdateTime	否	否	Datetime_iso	最后更新时间

ApiSecCustomSensitiveRule

api安全客户自定义敏感检测规则

被如下接口引用：DescribeApiSecSensitiveRuleList、ModifyApiSecSensitiveRule

名称	必选	允许NULL	类型	描述
Position	是	是	Array of String	参数位置
MatchKey	是	是	String	匹配条件
MatchCond	否	是	Array of String	匹配符号，当匹配条件为关键字匹配和字符匹配的时候传该值,可传多个
MatchValue	是	是	Array of String	匹配值
Level	是	是	String	风险等级

RuleInfo

索引规则

被如下接口引用：DescribeAttackIndex

名称	必选	允许NULL	类型	描述
FullText	是	是	FullTextInfo	全文索引的相关配置
KeyValue	是	是	KeyValueInfo	kv 索引的相关配置

BotAiRule

用户配置的ai评估的白名单策略列表

被如下接口引用：DescribeBotAiRule、ModifyBotAiRule

名称	必选	允许NULL	类型	描述
Uri	是	否	String	需要加白的url
Status	是	否	Bool	状态开关
Description	是	是	String	策略描述
Name	是	是	String	策略名称
Timestamp	否	是	Int64	时间戳

BotSceneInfo

场景的详细配置信息

被如下接口引用：DescribeBotSceneList

名称	必选	允许NULL	类型	描述
SceneId	否	否	String	场景ID
Type	否	否	String	场景类型，default:默认场景,custom:非默认场景
SceneName	否	否	String	场景名
UpdateTime	否	否	Int64	更新时间
BusinessType	否	否	Array of String	场景模板类型，登录: login 秒杀:seckill 爬内容：crawl 自定义: custom
ClientType	否	否	Array of String	客户端类型，浏览器/H5 : browser 小程序: miniApp App:
Priority	否	否	Int64	优先级
MatchCondition	否	否	Array of BotSceneMatchCondition	匹配范围
SceneStatus	否	否	Bool	场景开关
JsInjectStatus	否	否	Bool	前端对抗开关
AIStatus	否	否	Bool	AI开关
TIStatus	否	否	Bool	TI开关
StatisticStatus	否	否	Bool	智能统计开关
ActionRuleCount	否	否	Int64	动作策略数量
UCBCount	否	否	Int64	自定义规则数量
MatchType	否	否	String	场景的匹配范围，global-全部匹配 custom-自定义匹配范围
ActionMatchType	否	是	String	匹配条件间的与或关系
UAStatus	否	否	Bool	UA模块开关
JsInjectRuleId	否	是	Int64	简易模式场景：前端对抗对应mysql的记录id
JsInjectAction	否	是	Int64	简易模式场景：前端对抗配置动作
JsInjectRedirect	否	是	String	简易模式场景：前端对抗重定向路径
ActionRuleList	否	是	Array of BotSceneActionRule	简易模式场景：动作策略信息 PS:简易模式只有一个动作策略
BotIdPattern	否	是	String	简易模式场景：monitor-观察 intercept-拦截 custom-自定义
BotIdCount	否	是	Int64	简易模式场景：bot_id规则总数
BotIdMonitorCount	否	是	Int64	简易模式场景：观察动作的规则总数
BotIdInterceptCount	否	是	Int64	简易模式场景：拦截动作的规则总数
RuleSetSelection	否	是	Array of String	创建场景时选择的规则集

Rule

规则列表详情

被如下接口引用：DescribeDomainRules

名称	必选	允许NULL	类型	描述
Id	否	否	Uint64	规则id
Type	否	是	String	规则类型
Level	否	否	String	规则等级
Description	否	是	String	规则描述
CVE	否	是	String	规则防护的CVE编号
Status	否	否	Uint64	规则的状态
ModifyTime	否	否	String	规则修改的时间
AddTime	否	是	String	门神规则新增/更新时间

DomainURI

唯一定位Domain

被如下接口引用：ModifyDomainsCLSStatus

名称	必选	允许NULL	类型	描述
Domain	是	否	String	域名
Edition	是	否	String	版本
InstanceID	否	是	String	实例ID

BotSceneMatchCondition

场景匹配条件

被如下接口引用：DescribeBotSceneList、ModifyBotScene

名称	必选	允许NULL	类型	描述
Key	是	否	String	匹配参数
Op	是	否	String	匹配符
Value	是	否	String	匹配值
Name	否	是	String	对于头部字段匹配value的时候指定的头部名
ValueArray	否	是	Array of String	470后使用此入参存在多值

UserWhiteRule

用户规则白名单

被如下接口引用：DescribeAttackWhiteRule

名称	必选	允许NULL	类型	描述
WhiteRuleId	是	否	Uint64	白名单的id
SignatureId	是	否	String	规则id
Status	是	否	Int64	状态
MatchField	是	否	String	匹配域
MatchMethod	是	否	String	匹配方法
MatchContent	是	否	String	匹配内容
CreateTime	是	否	Datetime_iso	创建时间
ModifyTime	是	否	Datetime_iso	修改时间

WhiteListCondition

新版本云图定义的string类型，api侧规定必须是严格的string，不能使用双引号括起来的json格式数据 可以将参数定义为复杂类型，以前存量接口不受影响

被如下接口引用：DescribeSceneJsInjectRule

名称	必选	允许NULL	类型	描述
Condition	是	否	String	匹配条件：相等、前缀等
Content	是	否	String	匹配的值

ModifyNewOldConfigNew

产品明细

被如下接口引用：GenerateDealsAndPayNew

名称	必选	允许NULL	类型	描述
ProductCode	是	是	String	产品码
SubProductCode	是	是	String	二级产品码
Pid	是	是	Int64	计费策略id
InstanceName	否	是	String	waf实例名
ElasticQps	否	是	Int64	QPS数量
FlexBill	否	是	Int64	弹性账单
AutoRenewFlag	否	是	Int64	1:自动续费，0:不自动续费
RealRegion	否	是	Int64	waf购买的实际地域信息
Type	否	是	String	Waf实例对应的二级产品码
LabelTypes	否	是	Array of String	计费细项标签数组
LabelCounts	否	是	Array of Int64	计费细项标签数量，一般和SvLabelType一一对应
CurDeadline	否	是	String	变配使用，实例到期时间
InstanceId	否	是	String	对存在的实例购买bot 或api 安全
WafPackageMicroClb	否	是	Int64	sv_wsm_waf_package_micro计费项
WafPackageClb	否	是	Int64	sv_wsm_waf_lightpackage_lightpackage
WafPackagePremiumClb	否	是	Int64	sv_wsm_waf_package_premium_clb
WafPackageEnterpriseClb	否	是	Int64	sv_wsm_waf_package_enterprise_clb
WafPackagePremium	否	是	Int64	sv_wsm_waf_package_premium
WafPackageEnterprise	否	是	Int64	sv_wsm_waf_package_enterprise
WafPackageUltimate	否	是	Int64	sv_wsm_waf_package_ultimate
WafSceneBotProtection	否	是	Int64	sv_wsm_waf_scene_bot_protection
WafSceneBotProtectionClb	否	是	Int64	sv_wsm_waf_scene_bot_protection_clb
WafDomain	否	是	Int64	sv_wsm_waf_domain
WafQps	否	是	Int64	sv_wsm_waf_qps_ep
WafCls	否	是	Int64	sv_wsm_waf_scls
WafPackageUltimateClb	否	是	String	sv_wsm_waf_package_ultimate_clb

PageForDescribeSpartaProtectionList

PageForDescribeSpartaProtectionList接口专用的翻页结构体

被如下接口引用：DescribeSpartaProtectionList

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

DNSDetectRecord

DNS劫持检测的记录

被如下接口引用：

名称	必选	允许NULL	类型	描述
Id	是	否	Uint64	记录的ID
Domain	是	否	String	域名
HijackRecords	是	否	Uint64	被劫持的记录数
HijackRegions	是	否	Uint64	劫持的地域数
CreateTime	是	否	String	记录新建时间
AuthIP	是	否	Array of String	权威记录数组

MainClassItem

主类信息

被如下接口引用：DescribeMainClass、DescribeOpMainClass

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

AiInfo

命中的ai特征信息

被如下接口引用：DescribeBotDetailVersionTwo

名称	必选	允许NULL	类型	描述
Key	否	是	String	命中的key，请求特征的维度
Value	否	是	Float	异常值

IpInfo

ip基础信息

被如下接口引用：DescribeBotDetail

名称	必选	允许NULL	类型	描述
SrcIp	是	是	String	攻击源ip
IpOwner	是	是	String	ip所有者
IpType	是	是	String	ip类型
IpArea	是	是	String	ip地域
IpOperator	是	是	String	ip运营商信息

VipInfo

Vip信息

被如下接口引用：DescribeVipInfo

名称	必选	允许NULL	类型	描述
Vip	否	是	String	Virtual IP
InstanceId	否	是	String	waf实例id

LoadBalancerPackageNew

负载均衡器

被如下接口引用：DescribeDomainDetailsClb、DescribeDomains

名称	必选	允许NULL	类型	描述
ListenerId	是	是	String	监听id
ListenerName	是	是	String	监听名
LoadBalancerId	是	是	String	负载均衡id
LoadBalancerName	是	是	String	负载均衡名
Protocol	是	是	String	协议
Region	是	是	String	地区
Vip	是	是	String	接入IP
Vport	是	是	Uint64	接入端口
Zone	是	是	String	地域
NumericalVpcId	是	是	Int64	VPCID
LoadBalancerType	是	是	String	CLB类型
LoadBalancerDomain	否	是	String	负载均衡器的域名

BotScoreRuleEntry

动作策略的一条分数段实体

被如下接口引用：DescribeBotSceneActionRule、DescribeBotSceneList、ModifyBotSceneActionRule

名称	必选	允许NULL	类型	描述
Upper	是	否	String	分数区间上限
Lower	是	否	String	分数区间下限
Action	是	否	String	处置动作
Label	是	否	String	流量标签
Redirect	否	是	String	重定向

AppletAccessDomainV3

小程序接入域名信息

被如下接口引用：DescribeAppletAccessV3、ModifyAppletAccessV3

名称	必选	允许NULL	类型	描述
Domain	是	是	String	域名
Protocol	是	是	String	服务协议
Port	是	是	Uint64	服务端口
AccessStatus	是	是	Uint64	在WAF接入的状态
0: 未接入
1: 已接入

CCRuleItem

cc规则

被如下接口引用：DescirbeCCRule、DescribeCCRule

名称	必选	允许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	高级参数

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

QueryHWDomainStateData

获取实例Id域名列表Data

被如下接口引用：QueryHWDomainState

名称	必选	允许NULL	类型	描述
HWState	否	是	Int64	HWState（1-未购买、2-购买未激活、3-购买已激活、4-已过期）

InstancesResult

一个实例的信息

被如下接口引用：DescribeUserInstances

名称	必选	允许NULL	类型	描述
Level	是	否	Uint64	套餐版本
AutoRenew	是	否	Uint64	是否自动续费，1：自动续费
BeginTime	是	否	String	套餐的购买时间
Cls	是	是	ClsPackage	购买的套餐信息
ValidTime	是	否	String	过期时间
DomainLimit	是	否	Uint64	套餐子域名个数限制
DomainCount	是	否	Uint64	套餐子域名已经使用的个数
MainDomainCount	是	否	Uint64	套餐主域名使用个数
MainDomainLimit	是	否	Uint64	套餐主域名个数限制
QPS	是	是	QPSPackage	qps套餐信息
MaxQPS	是	否	Uint64	当前的qps峰值
DomainPkg	是	是	DomainPackage	购买的域名套餐
ResourceIds	是	否	String	计费id
InstanceId	是	否	String	实例id
PayMode	是	否	Uint64	付费模式
InstanceName	是	否	String	实例名称

BatchIpAccessControlItem

多域名黑白名单列表Ip

被如下接口引用：DescribeBatchIpAccessControl

名称	必选	允许NULL	类型	描述
Id	否	是	String	mongo表自增Id
ActionType	否	否	Int64	黑名单42或白名单40
Ip	否	否	String	黑白名单的IP
Note	否	否	String	备注
Source	否	否	String	添加路径
TsVersion	否	否	Uint64	修改时间
ValidTs	否	否	Int64	超时时间
Hosts	否	否	Array of String	域名列表

MiniPkg

API安全资源信息

被如下接口引用：DescribeInstances

名称	必选	允许NULL	类型	描述
ResourceIds	否	是	String	资源id
Status	否	是	Int64	状态
Region	否	是	Int64	地域
BeginTime	否	是	String	开始时间
EndTime	否	是	String	结束时间
Count	否	是	Int64	购买数量
RenewFlag	否	是	Uint64	续费标志
BillingItem	否	是	String	计费项
AccessAppidNum	否	是	Int64	小程序接入appid数量
DdosThreshold	否	是	Int64	ddos防护阈值

ThreatIntelligenceData

威胁情报Data

被如下接口引用：DescribeHWInfo

名称	必选	允许NULL	类型	描述
Status	否	是	Uint64	状态
IpNum	否	是	Uint64	IP数量

BotReferAnalyzeRes

bot详情 refer详情信息

被如下接口引用：DescribeBotDetail

名称	必选	允许NULL	类型	描述
ReferExist	是	是	Bool	refer存在性
ReferRepeat	是	是	Float	refer重复比
ReferMax	是	是	String	出现最多的refer
ReferValidRate	是	是	Float	refer存在比
ReferKind	是	是	Uint64	refer种类
ReferAbuse	是	是	Bool	refer滥用
ReferScore	是	是	Uint64	refer得分

TLSVersion

TLS信息

被如下接口引用：DescribeTlsVersion

名称	必选	允许NULL	类型	描述
VersionId	是	是	Int64	TLSVERSION的ID
VersionName	是	是	String	TLSVERSION的NAME

ActionedIpItem

ip查询参数

被如下接口引用：DescribeActionedIp

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

VIPStates

VIP迁移状态

被如下接口引用：DescribeVIPState

名称	必选	允许NULL	类型	描述
RecordId	否	是	Int64	无
VIP	否	是	String	无
Type	否	是	String	无
DstGroupIds	否	是	Array of Int64	无
SrcGroupIds	否	是	Array of Int64	无
SrcRSIPs	否	是	Array of String	无
DstRSIPs	否	是	Array of String	无
State	否	是	Int64	无
ErrorMsg	否	是	String	无
LastTime	否	是	String	无
CreateTime	否	是	String	无
Operator	否	是	String	无

SceneWhiteListItem

业务白名单

被如下接口引用：DescribeSceneJsInjectRule

名称	必选	允许NULL	类型	描述
Domain	是	否	String	白名单对应的域名
Id	否	否	Int64	白名单ID
Content	是	否	WhiteListCondition	白名单内容
Comment	否	否	String	白名单的备注
Status	是	否	Int64	白名单的开关状态，0：关闭，1：开启
Type	是	否	String	白名单的类型，jsinject_req：动态风控的请求白名单，jsinject_rsp：动态风控的响应白名单

UAStrategyDetail

UA策略全局配置项实体

被如下接口引用：DescribeBotGlobalUAStrategy

名称	必选	允许NULL	类型	描述
UAType	否	是	Array of String	UA策略项对应的具体类别，UAName:UATyoe = 1：n
NameCN	否	是	String	中文名称
NameEN	否	是	String	英文名称
DescriptionCN	否	是	String	中文描述
DescriptionEN	否	是	String	英文描述
Status	否	是	Bool	开关状态
TimeStamp	否	是	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	如果是自定义规则，则显示规则的名字，如果不是则为-

Amount

限流配额相关

被如下接口引用：CreateRateLimits、DescribeRateLimits、UpdateRateLimits

名称	必选	允许NULL	类型	描述
MaxAmount	是	是	Uint64	周期内最大配额数
ValidDuration	是	是	String	周期描述，支持duration类型的字符串，比如1s, 1m, 1h等

IpHitItemsData

封装参数

被如下接口引用：DescribeAutoDenyIP、DescribeIpHitItems

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

ApiPkg

API安全资源信息

被如下接口引用：DescribeInstances

名称	必选	允许NULL	类型	描述
ResourceIds	否	是	String	资源id
Status	否	是	Int64	状态
Region	否	是	Int64	地域
BeginTime	否	是	String	开始时间
EndTime	否	是	String	结束时间
InquireNum	否	是	Int64	申请数量
UsedNum	否	是	Int64	使用数量
RenewFlag	否	是	Uint64	续费标志
BillingItem	否	是	String	计费项
APICPWaf	否	是	Int64	1 API安全6折
APINPWaf	否	是	Int64	1 表示5折折扣
2 表示4折折扣
IsAPISecurityTrial	否	是	Int64	api安全7天试用标识。1试用。0没试用

DescribeBotUCBFeatureRuleRsp

DescribeBotUCBFeatureRule的返回参数

被如下接口引用：DescribeBotUCBFeatureRule

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

UserDomainInfo

saas和clb信息

被如下接口引用：DescribeUserDomainInfo

名称	必选	允许NULL	类型	描述
Appid	否	否	Uint64	用户id
Domain	否	否	String	域名
DomainId	否	否	String	域名id
InstanceId	否	否	String	实例id
InstanceName	否	否	String	实例名
Edition	否	否	String	waf类型
Level	否	是	String	版本
WriteConfig	否	是	String	指定域名访问日志字段的开关
Cls	否	是	Uint64	指定域名是否写cls的开关 1:写 0:不写
CloudType	否	是	String	标记是否是混合云接入。hybrid表示混合云接入域名

PiechartItem

饼图数据类型

被如下接口引用：DescribeAttackType

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

CopyBotTCBRuleRsp

CopyBotTCBRule函数的返回值

被如下接口引用：CopyBotTCBRule

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

SessionItem

session定义

被如下接口引用：DescribeSession

名称	必选	允许NULL	类型	描述
Category	否	否	String	匹配类型
KeyOrStartMat	否	否	String	起始模式
EndMat	否	否	String	结束模式
StartOffset	否	否	String	起始偏移
EndOffset	否	否	String	结束偏移
Source	否	否	String	数据源
TsVersion	否	否	String	更新时间戳
SessionId	否	是	Int64	SessionID
SessionName	否	是	String	Session名
SessionInUsed	否	是	Bool	Session是否正在被启用
RelatedRuleID	否	是	Array of Int64	Session关联的CC规则ID

BotIdStat

Bot-Id规则统计信息

被如下接口引用：DescribeBotIdRule

名称	必选	允许NULL	类型	描述
Pattern	否	否	String	模式：观察/拦截/自定义
TotalCount	否	否	Int64	规则总数
MonitorCount	否	否	Int64	配置观察的规则数
InterceptCount	否	否	Int64	配置拦截的规则数

ExpiredBotPkg

Bot资源信息

被如下接口引用：DescribeExpiredInstances

名称	必选	允许NULL	类型	描述
ResourceIds	否	是	String	资源id
RenewFlag	否	是	Uint64	续费标志
Type	否	是	String	计费项

PageInfo

公共翻页参数

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

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

ApiSecEventKeyValue

api安全事件分类的key-value格式

被如下接口引用：DescribeApiSecEventTypeList

名称	必选	允许NULL	类型	描述
Key	是	否	String	事件类型
Value	是	否	Uint64	数量

BatchAreaBanAppIdDomainData

查询当前AppId下域名信息数据

被如下接口引用：QueryBatchAreaBanAppIdDomain

名称	必选	允许NULL	类型	描述
Domains	否	是	Array of String	域名列表

ClbHostsParams

CLB回调WAF接口（获取、删除）的参数

被如下接口引用：DescribeWafInfo

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

IpAccessControlData

数据封装

被如下接口引用：DescribeIpAccessControl

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

LoadBalancer

负载均衡的监听器

被如下接口引用：CreateHost、CreateHostInner、DescribeHost、DescribeHosts、DescribeWafInfo、ModifyHost、ModifyHostInner

名称	必选	允许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	负载均衡的VPCID，公网为-1，内网按实际填写
LoadBalancerType	否	是	String	负载均衡的网络类型
LoadBalancerDomain	否	是	String	负载均衡的域名

BotQPS

bot的qps详情

被如下接口引用：DescribeInstances

名称	必选	允许NULL	类型	描述
ResourceIds	是	否	String	资源id
ValidTime	是	否	String	有效时间
Count	是	否	Uint64	资源数量
Region	是	否	String	资源所在地区
MaxBotQPS	是	否	Uint64	使用qps的最大值
RenewFlag	是	是	Uint64	续费标志

ClbWafRegionItem

Clb-waf地域信息

被如下接口引用：DescribeUserClbWafRegions

名称	必选	允许NULL	类型	描述
Id	否	是	String	地域ID
Text	否	是	String	地域中文说明
Value	否	是	String	地域英文全拼
Code	否	是	String	地域编码

HybridPkg

混合云节点资源信息

被如下接口引用：DescribeInstances

名称	必选	允许NULL	类型	描述
ResourceIds	否	是	String	资源id
Status	否	是	Int64	状态
Region	否	是	Int64	地域
BeginTime	否	是	String	开始时间
EndTime	否	是	String	结束时间
InquireNum	否	是	Int64	申请数量
UsedNum	否	是	Int64	使用数量
RenewFlag	否	是	Uint64	续费标志

LoadBalancerInner

负载均衡的监听器

被如下接口引用：

名称	必选	允许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	负载均衡的VPCID，公网为-1，内网按实际填写
LoadBalancerType	否	否	String	负载均衡的网络类型

ClbObject

Clb类型防护对象

被如下接口引用：DescribeObjects

名称	必选	允许NULL	类型	描述
ObjectId	否	否	String	对象ID
InstanceId	否	否	String	实例ID
InstanceName	否	否	String	实例名称
PreciseDomains	否	否	Array of String	精准域名列表
Status	否	否	Int64	WAF功能开关状态，0关闭1开启
ClsStatus	否	否	Int64	WAF日志开关状态，0关闭1开启
VirtualDomain	否	否	String	CLB对象对应的虚拟域名
ObjectName	否	否	String	对象名称
PublicIp	否	否	Array of String	公网地址
PrivateIp	否	否	Array of String	内网地址
VpcName	否	否	String	VPC名称
Vpc	否	否	String	VPC ID
InstanceLevel	否	否	Int64	waf实例等级，如果未绑定实例为0
PostCLSStatus	否	否	Int64	clb投递开关
PostCKafkaStatus	否	否	Int64	kafka投递开关
Type	否	是	String	对象类型：CLB:负载均衡器，TSE:云原生网关
Region	否	是	String	对象地域

ModuleTypeData

ModuleTypeData

被如下接口引用：QueryConstantEnum

名称	必选	允许NULL	类型	描述
ModuleTypeList	否	否	Array of ModuleTypeItem	出参数据

HostStatus

设置WAF状态的结构体

被如下接口引用：ModifyHostStatus、ModifyHostStatusInner

名称	必选	允许NULL	类型	描述
Domain	是	否	String	域名
DomainId	是	否	String	域名ID
Status	是	否	Uint64	WAF的开关，1：开，0：关
InstanceID	否	否	String	实例ID

ApiSecEventChange

事件变更内容

被如下接口引用：DescribeApiSecEventChangeList

名称	必选	允许NULL	类型	描述
UserName	是	否	String	变更人
Mode	是	否	String	变更的状态
Remark	否	是	String	备注
Timestamp	是	否	Uint64	时间戳

AutoDenyDetail

Waf 攻击自动封禁详情

被如下接口引用：DescribeWafAutoDenyStatus、ModifyWafAutoDenyStatus

名称	必选	允许NULL	类型	描述
AttackTags	是	否	Array of String	攻击封禁类型标签
AttackThreshold	是	否	Int64	攻击次数阈值
DefenseStatus	是	否	Int64	自动封禁状态
TimeThreshold	是	否	Int64	攻击时间阈值
LastUpdateTime	否	否	Datetime_iso	最后更新时间
DenyTimeThreshold	是	否	Int64	自动封禁时间

BatchAreaBanListData

批量列表信息数据

被如下接口引用：DescribeBatchAreaBanList

名称	必选	允许NULL	类型	描述
List	否	是	Array of BatchAreaBanListItem	规则列表
Total	否	是	Uint64	列表总数

DomainBotStatusData

封装参数

被如下接口引用：DescribeBotStatus

名称	必选	允许NULL	类型	描述
Res	是	否	Array of DomainBotStatus	数据

Data

API2.0的返回参数

被如下接口引用：

名称	必选	允许NULL	类型	描述
AutoRenew	是	否	String	{"data":{"AutoRenew":"false"}}}

AccessLogItem

日志KeyValue对

被如下接口引用：SearchAccessLog

名称	必选	允许NULL	类型	描述
Key	是	是	String	日记Key
Value	是	是	String	日志Value

LimitRuleStatusUnit

限流相关数据结构，用于批量启用/禁用限流规则

被如下接口引用：EnableRateLimits

名称	必选	允许NULL	类型	描述
Id	是	是	String	规则ID
Status	是	是	Int64	是否启用，0表示不启用，1表示启用

BotIdDetail

BOT-ID规则配置详情

被如下接口引用：DescribeBotIdRule

名称	必选	允许NULL	类型	描述
RuleId	否	是	String	规则ID
BotId	否	是	String	规则名称
Status	否	是	Bool	规则开关
Action	否	是	String	规则动作
Level	否	是	Int64	风险等级
BotIdType	否	是	String	规则类型
ModifyTime	否	是	Int64	修改时间
InsertTime	否	是	Int64	插入时间
Description	否	是	String	规则描述
Influence	否	是	String	影响

AccessFullTextInfo

DescribeAccessIndex

被如下接口引用：DescribeAccessIndex

名称	必选	允许NULL	类型	描述
CaseSensitive	是	是	Bool	是否大小写敏感
Tokenizer	是	是	String	全文索引的分词符，字符串中每个字符代表一个分词符
ContainZH	是	是	Bool	是否包含中文注意：此字段可能返回 null，表示取不到有效值。

BotAutoStatRule

bot模块智能统计 自定义配置

被如下接口引用：DescribeBotAutoStatisticRule、ModifyBotAutoStatisticRule

名称	必选	允许NULL	类型	描述
Feature	是	否	String	策略名称 如avg_speed
Status	是	否	Bool	策略状态
Level	是	否	Int64	策略等级，100（宽松），200（中等），300(严格),0表示智能推荐
Description	是	是	String	特征描述
Timestamp	是	是	Int64	修改时间戳，默认为0，表示没有修改

AccessLogInfo

单条日志数据描述

被如下接口引用：SearchAccessLog

名称	必选	允许NULL	类型	描述
Time	是	是	Int64	日志时间，单位ms
TopicId	是	是	String	日志主题ID
TopicName	是	是	String	日志主题名称
Source	是	是	String	日志来源IP
FileName	是	是	String	日志文件名称
PkgId	是	是	String	日志上报请求包的ID
PkgLogId	是	是	String	请求包内日志的ID
LogJson	是	是	String	日志内容的Json序列化字符串注意：此字段可能返回 null，表示取不到有效值。

OpUserWhiteRule

用户白名单规则的运营后台接口

被如下接口引用：DescribeOpAttackWhiteRule

名称	必选	允许NULL	类型	描述
OpAppId	是	否	String	appid
OpDomain	是	否	String	域名
WhiteRuleId	是	否	Uint64	id
UserId	是	否	Uint64	用户规则策略id
SignatureId	是	否	String	规则id
Status	是	否	Int64	状态
MatchField	是	否	String	匹配域
MatchMethod	是	否	String	匹配方法
MatchContent	是	否	String	匹配内容
CreateTime	是	否	Datetime_iso	创建时间
ModifyTime	是	否	Datetime_iso	修改时间

CustomPayloadData

封装参数

被如下接口引用：

名称	必选	允许NULL	类型	描述
Res	是	否	Array of CustomPayload	载荷
TotalCount	是	否	Uint64	计数

TypeEn

规则类型描述列表

被如下接口引用：DescribeRuleTypesEn

名称	必选	允许NULL	类型	描述
Id	否	否	Uint64	规则id
Name	否	否	String	规则名称
Description	否	否	String	规则描述
Count	否	否	Uint64	规则数量
NameEng	否	是	String	规则英文名称
DescriptionEng	否	是	String	规则类型英文描述

RuleList

规则白名单

被如下接口引用：DescribeDomainWhiteRules

名称	必选	允许NULL	类型	描述
Id	是	否	Uint64	规则Id
Rules	是	否	Array of Uint64	规则列表的id
Url	是	否	String	请求url
Function	是	否	String	请求的方法
Time	是	否	String	时间戳
Status	是	否	Uint64	开关状态

DescribeInstanceDomainListData

获取实例Id域名列表Data

被如下接口引用：DescribeInstanceDomainList

名称	必选	允许NULL	类型	描述
Domains	否	是	Array of String	域名列表

UserInfoQPS

获取用户套餐信息时返回的qps信息

被如下接口引用：DescribeSpartUser

名称	必选	允许NULL	类型	描述
Count	是	是	String	计数
ResourceId	是	是	String	资源id
Deadline	是	是	String	过期时间
Renew	是	是	String	续费标记
Region	是	是	String	区域

AppletAccess

小程序接入详细信息

被如下接口引用：DescribeAppletAccess

名称	必选	允许NULL	类型	描述
Name	否	否	String	小程序接入名称
Type	否	是	Uint64	小程序类型传入 1， 预留扩展用
Domain	否	是	String	小程序源站域名
Port	否	是	Uint64	服务端口
Protocol	否	是	String	服务协议
AppletID	否	是	String	微信小程序ID
Comment	否	是	String	详情
AccessDomain	否	是	String	微信网关接入节点域名
AccessStatus	否	是	Uint64	接入配置阶段的状态,
0 初始状态
100 完成
ClientConfigStatus	否	是	Uint64	客户端配置阶段的状态
0 初始状态
100 完成
ClientTestStatus	否	是	Uint64	客户端测试阶段的状态
0 初始状态（未验证）
1 已验证，待发布
100 完成（已验证，已发布）
LinkTest	否	是	Uint64	是否要进行链路测试 0 不进行测试 1 进行测试
LinkTestStatus	否	是	Uint64	链路探测结果：
0 初始状态 1-99 验证失败编码
100 验证成功
GatewayID	否	是	String	网关ID
AccessID	否	是	String	接入节点ID

DescribeSpartaProtectionListItem

DescribeSpartaProtectionList的入参

被如下接口引用：DescribeSpartaProtectionList

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

IPType

IP类型

被如下接口引用：DescribeIPType

名称	必选	允许NULL	类型	描述
IP	否	是	String	IP地址
Type	否	是	String	IP类型描述

PostPointInfo

投递趋势图 点详情

被如下接口引用：DescribePostPoints

名称	必选	允许NULL	类型	描述
TimePoint	是	否	Int64	该点的时间戳，单位为毫秒
LogCount	是	否	Int64	日志条数
RealTraffic	是	否	Int64	未压缩的日志流量大小，单位为字节
CompressionTraffic	是	否	Int64	压缩后的大小，单位为字节

QpsData

获取弹性qps的默认相关值

被如下接口引用：GetAllQpsConfig、GetInstanceQpsLimit

名称	必选	允许NULL	类型	描述
ElasticBillingDefault	否	是	Uint64	弹性qps默认值
ElasticBillingMin	否	是	Uint64	弹性qps最小值
ElasticBillingMax	否	是	Uint64	弹性qps最大值
QPSExtendMax	否	是	Uint64	业务扩展包最大qps
QPSExtendIntlMax	否	是	Uint64	海外业务扩展包最大qps

GoodsDetailNew

产品明细

被如下接口引用：GenerateDealsAndPayNew

名称	必选	允许NULL	类型	描述
TimeSpan	否	是	Int64	时间间隔
TimeUnit	否	是	String	单位，支持购买d、m、y 即（日、月、年）
ProductCode	否	是	String	产品码
SubProductCode	否	是	String	子产品标签,。新购，续费必传，变配时放在oldConfig newConfig里面

Saas 高级版 ：sp_wsm_waf_premium Saas企业版 ：sp_wsm_waf_enterprise Saas旗舰版 ：sp_wsm_waf_ultimate Saas 业务扩展包：sp_wsm_waf_qpsep Saas 域名扩展包：sp_wsm_waf_domain

高级版-CLB:sp_wsm_waf_premium_clb 企业版-CLB : sp_wsm_waf_enterprise_clb 旗舰版-CLB:sp_wsm_waf_ultimate_clb 业务扩展包-CLB：sp_wsm_waf_qpsep_clb 域名扩展包-CLB：sp_wsm_waf_domain_clb | | Pid| 否 | 是 | Int64 | 业务产品申请的pid（对应一个定价公式），通过pid计费查询到定价模型 高级版 ：1000827 企业版 ：1000830 旗舰版 ：1000832 域名包 : 1000834 业务扩展包 : 1000481 高级版-CLB:1001150 企业版-CLB : 1001152 旗舰版-CLB:1001154 域名包-CLB: 1001156 业务扩展包-CLB : 1001160 | | ProductInfo| 否 | 是 | Array of ProductInfo| waf产品码 | | InstanceName| 否 | 是 | String | waf实例名 | | ElasticQps| 否 | 是 | Int64 | QPS数量 | | FlexBill| 否 | 是 | Int64 | 弹性账单 | | AutoRenewFlag| 否 | 是 | Int64 | 1:自动续费，0:不自动续费 | | RealRegion| 否 | 是 | Int64 | waf购买的实际地域信息 | | Type| 否 | 是 | String | Waf实例对应的二级产品码 | | LabelTypes| 否 | 是 | Array of String | 计费细项标签数组 Saas 高级版 sv_wsm_waf_package_premium Saas 企业版 sv_wsm_waf_package_enterprise Saas 旗舰版 sv_wsm_waf_package_ultimate Saas 非中国大陆高级版 sv_wsm_waf_package_premium_intl Saas 非中国大陆企业版 sv_wsm_waf_package_enterprise_intl Saas 非中国大陆旗舰版 sv_wsm_waf_package_ultimate _intl Saas 业务扩展包 sv_wsm_waf_qps_ep Saas 域名扩展包 sv_wsm_waf_domain

高级版CLB sv_wsm_waf_package_premium_clb 企业版CLB sv_wsm_waf_package_enterprise_clb 旗舰版CLB sv_wsm_waf_package_ultimate_clb 非中国大陆高级版 CLB sv_wsm_waf_package_premium_clb_intl 非中国大陆企业版CLB sv_wsm_waf_package_premium_clb_intl 非中国大陆旗舰版CLB sv_wsm_waf_package_ultimate_clb _intl 业务扩展包CLB sv_wsm_waf_qps_ep_clb 域名扩展包CLB sv_wsm_waf_domain_clb | | LabelCounts| 否 | 是 | Array of Int64 | 计费细项标签数量，一般和SvLabelType一一对应 | | CurDeadline| 否 | 是 | String | 变配使用，实例到期时间 | | InstanceId| 否 | 是 | String | 对存在的实例购买bot 或api 安全 | | WafPackageMicroClb| 否 | 是 | Int64 | sv_wsm_waf_package_micro计费项 | | WafPackageClb| 否 | 是 | Int64 | sv_wsm_waf_lightpackage_lightpackage | | WafPackagePremiumClb| 否 | 是 | Int64 | sv_wsm_waf_package_premium_clb | | WafPackageEnterpriseClb| 否 | 是 | Int64 | sv_wsm_waf_package_enterprise_clb | | WafPackagePremium| 否 | 是 | Int64 | sv_wsm_waf_package_premium | | WafPackageEnterprise| 否 | 是 | Int64 | sv_wsm_waf_package_enterprise | | WafPackageUltimate| 否 | 是 | Int64 | sv_wsm_waf_package_ultimate | | WafSceneBotProtection| 否 | 是 | Int64 | sv_wsm_waf_scene_bot_protection | | WafSceneBotProtectionClb| 否 | 是 | Int64 | sv_wsm_waf_scene_bot_protection_clb | | WafDomain| 否 | 是 | Int64 | sv_wsm_waf_domain | | WafQps| 否 | 是 | Int64 | sv_wsm_waf_qps_ep | | WafCls| 否 | 是 | Int64 | sv_wsm_waf_scls | | WafPackageUltimateClb| 否 | 是 | String | sv_wsm_waf_package_ultimate_clb | | OldConfig| 否 | 是 | ModifyNewOldConfigNew| 老配置 | | NewConfig| 否 | 是 | ModifyNewOldConfigNew| 新配置 | | ResourceId| 否 | 是 | String | 资源id |

MajorEventsPkg

重保防护资源信息

被如下接口引用：DescribeInstances

名称	必选	允许NULL	类型	描述
ResourceIds	否	是	String	资源id
Status	否	是	Int64	状态
Region	否	是	Int64	地域
BeginTime	否	是	String	开始时间
EndTime	否	是	String	结束时间
InquireNum	否	是	Int64	申请数量
UsedNum	否	是	Int64	使用数量
RenewFlag	否	是	Uint64	续费标志
BillingItem	否	是	String	计费项
HWState	否	是	Int64	护网包状态

BotCookieAnalyze

bot的BotCookieAnalyze的参数

被如下接口引用：DescribeBotDetail

名称	必选	允许NULL	类型	描述
CookieMax	是	是	String	出现最多的cookie
CookieRepeat	是	是	Float	cookie重复比
CookieKind	是	否	Uint64	cookie种类
CookieAbuse	是	是	Bool	cookie是否滥用
CookieExist	是	是	Bool	cookie存在性
CookieValidRate	是	否	Float	cookie存在比

DescribeApi

显示api规则列表信息

被如下接口引用：DescribeApiList

名称	必选	允许NULL	类型	描述
RuleId	是	否	Int64	api规则id
Url	是	否	String	api的url路径
Description	是	是	String	该条api规则的描述
Source	是	否	String	该条api规则的来源
Method	是	否	String	该条api规则的请求方法
Parameters	是	否	Array of String	该条api对应的参数列表
Action	是	否	Uint64	该条api对应的动作，包括观察和拦截
Status	是	否	Uint64	该条api对应的开关，包括开和关
Timestamp	是	否	String	该条api添加的时间戳

PriceDetail

计费询价价格明细

被如下接口引用：DescribePrice

名称	必选	允许NULL	类型	描述
SinglePrice	是	是	Float	单价
UsedAmount	是	是	Int64	使用数量
Cost	是	是	Float	价格

DescribePocTestTaskListItem

DescribePocTestTasks接口回包中的复杂类型

被如下接口引用：DescribePocTestTasks

名称	必选	允许NULL	类型	描述
TaskId	是	否	String	动作类型
Progress	是	否	Uint64	任务完成进度
CreateTime	是	否	String	创建时间
ExpireTime	是	否	String	过期时间
FinishTime	是	否	String	任务完成时间
Link	是	否	String	测试结果下载地址
Status	是	否	Uint64	状态

QPSPackage

clb-waf QPS套餐

被如下接口引用：DescribeSpartUserInfo、DescribeUserInfo、DescribeUserInstances

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

ApiSecUaAbnormalSource

api安全事件攻击ua异常列表

被如下接口引用：DescribeApiSecAttackSourceList

名称	必选	允许NULL	类型	描述
UserAgent	否	是	String	ua
UaType	否	是	String	ua类型
StartTime	否	是	Int64	开始时间
EndTime	否	是	Int64	结束时间

BotDataFilter

搜索框内容，冒号前面是key, 冒号是操作，值是最后一位，操作（冒号）默认是相等

被如下接口引用：DescribeApiAggregateTopN、DescribeApiStatPoints、DescribeBotAccessAggregateTopN、DescribeBotAccessLog、DescribeBotAccessLogTwo、DescribeBotAccessStatPoints、DescribeBotAggregateTopN、DescribeBotDetailCountTopN、DescribeBotRequestLog、DescribeBotStatPoints、ModifyBotDetailDownloadTask

名称	必选	允许NULL	类型	描述
Entity	否	否	String	查询维度
Operator	否	否	String	操作符
Value	否	否	String	操作值，多个值用

DescribeAntiInfoLeakRulesStrategyItem

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

被如下接口引用：DescribeAntiInfoLeakRules、DescribeAntiInfoLeakageRules

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

StatisticType

攻击类型统计

被如下接口引用：DescribeStatisticTypes

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

BotStat

bot出参相关

被如下接口引用：DescribeBotDetail

名称	必选	允许NULL	类型	描述
HttpHeader	是	是	BotHttpHeader	http信息
CookieAnalyze	是	是	BotCookieAnalyze	cookie信息
UAInfo	是	是	BotUaInfo	UA信息
ReqAnalyzeRes	是	是	BotReqAnalyzeRes	请求信息
ReferAnalyzeRes	是	是	BotReferAnalyzeRes	refer信息
BotProtocol	是	是	Array of BotKeyValueItem	协议统计
BotStatus	是	是	Array of BotKeyValueItem	状态码统计
BotMethod	是	是	Array of BotKeyValueItem	请求方法统计
ReqVariance	是	是	Float	时序行为异常指数
ReqCCE	是	是	Float	时序熵异常指数
UaNotMatchIP	是	是	Bool	是否公开Bot伪造
SensitiveRequestFlag	是	是	Bool	敏感接口访问

MonitorDomainItem

云监控域名字段

被如下接口引用：DescribeMonitorDomains

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

ExpiredFraudPkg

过期业务安全资源信息

被如下接口引用：DescribeExpiredInstances

名称	必选	允许NULL	类型	描述
ResourceIds	否	是	String	资源id
RenewFlag	否	是	Uint64	续费标志

TsResource

运营后台参数，自研引擎资源信息

被如下接口引用：DescribeTsResource

名称	必选	允许NULL	类型	描述
Id	是	否	Uint64	资源id
Status	是	否	Uint64	规则状态，0/1
SubRegion	是	否	String	子集群id
Ip	是	否	String	IP地址
Port	是	否	Uint64	端口
Auth	是	否	String	认证信息
CreateTime	是	否	Datetime_iso	创建时间
ModifyTime	是	否	Datetime_iso	修改时间
Type	是	否	String	资源类型

DownloadTask

下载任务详情结构体

被如下接口引用：DescribeBotDetailDownloadTask

名称	必选	允许NULL	类型	描述
TaskId	否	是	Int64	任务ID
TaskName	否	是	String	任务名称
State	否	是	Int64	任务状态：1-排队、2-导出中、3-导出完成、4-任务过期、5-导出失败
Process	否	是	Int64	下载进度: 0-100整数
Uri	否	是	String	下载链接
CreateTime	否	是	Int64	创建时间
ExpireTime	否	是	Int64	创建时间
Domain	否	是	String	下载任务的指定域名

LogHistogramInfo

攻击日志统计详情

被如下接口引用：GetAttackHistogram

名称	必选	允许NULL	类型	描述
Count	是	否	Int64	日志条数
TimeStamp	是	否	Int64	时间戳

DomainPackageNew

clb-waf 域名扩展套餐

被如下接口引用：DescribeInstances

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

BanAreaItem

单个被封禁的地址

被如下接口引用：

名称	必选	允许NULL	类型	描述
EnAbbr	是	是	String	地址的其他英文缩写
EN	是	否	String	地址的英文缩写
ZH	是	否	String	地址的中文名

CdcCluster

CDC场景下负载均衡WAF的集群信息

被如下接口引用：DescribeUserCdcClbWafRegions

名称	必选	允许NULL	类型	描述
Id	是	否	String	cdc的集群id
Name	是	是	String	cdc的集群名称

ExpiredDomainPackage

过期域名扩展套餐

被如下接口引用：DescribeExpiredInstances

名称	必选	允许NULL	类型	描述
ResourceIds	是	否	String	资源ID
RenewFlag	是	否	Uint64	是否自动续费，1：自动续费，0：不自动续费

FullTextInfo

全文索引的相关配置

被如下接口引用：DescribeAttackIndex

名称	必选	允许NULL	类型	描述
CaseSensitive	是	否	Bool	是否大小写敏感

GlobalSceneInfo

当前开启的、匹配范围为全局、优先级最高的场景信息

被如下接口引用：DescribeBotSceneOverview

名称	必选	允许NULL	类型	描述
SceneId	是	否	String	场景ID
SceneName	是	否	String	场景名称
Priority	是	否	Int64	场景优先级
UpdateTime	是	否	Int64	场景更新时间

DescribeCustomRulesPagingInfo

DescribeCustomRules接口的翻页参数

被如下接口引用：DescribeCustomRules

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

AllDomainQueryResult

clb和saas waf所有可用域名对象

被如下接口引用：DescribeAllDomain

名称	必选	允许NULL	类型	描述
Clb	是	是	Array of DomainCls	clbwaf列表
Saas	是	是	Array of DomainCls	saaswaf域名列表

AttackIpInfo

攻击者ip信息，ip，城市，攻击次数

被如下接口引用：

名称	必选	允许NULL	类型	描述
Ip	是	是	String	攻击者IP
Count	是	是	Int64	攻击次数
City	是	是	String	攻击者所在城市json形式字符串

ClsPackage

clb-waf 日志套餐

被如下接口引用：DescribeSpartUserInfo、DescribeUserInfo、DescribeUserInstances

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

CacheUrlItem

防篡改url元素

被如下接口引用：DescribeAntiFakeUrl

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

AppletAuthInfoV3

小程序授权信息

被如下接口引用：DescribeAppletAuthorizeV3

名称	必选	允许NULL	类型	描述
AppletID	否	是	String	微信小程序ID
AuthStatus	否	是	Uint64	授权状态
0 未授权
1 已授权

DomainsPartInfo

saas域名详情

被如下接口引用：DescribeDomainDetailsSaas

名称	必选	允许NULL	类型	描述
Domain	否	否	String	域名
DomainId	否	否	String	域名id
InstanceId	否	否	String	实例id
Edition	否	否	String	类型
InstanceName	否	否	String	实例名
Cert	否	否	String	证书
CreateTime	否	否	String	创建时间
Engine	否	否	Uint64	AI防御模式
GrayAreas	否	否	Array of String	是否开启GrayAreas
HttpsRewrite	否	否	Uint64	是否开启httpRewrite
HttpsUpstreamPort	否	否	String	https回源端口
IsCdn	否	否	Uint64	是否是cdn
IsGray	否	否	Uint64	是否开启gray
IsHttp2	否	否	Uint64	是否是http2
IsWebsocket	否	否	Uint64	是否开启websocket
LoadBalance	否	否	Uint64	负载均衡
Mode	否	否	Uint64	防御模式
PrivateKey	否	否	String	私钥
SSLId	否	否	String	ssl id
UpstreamDomain	否	否	String	回源域名
UpstreamType	否	否	Uint64	回源类型
SrcList	否	否	Array of String	回源ip
Ports	否	否	Array of PortInfo	服务端口配置
CertType	否	否	Uint64	证书类型
UpstreamScheme	否	否	String	回源方式
Cls	否	否	Uint64	日志包
Cname	否	否	String	一级cname
IsKeepAlive	否	否	Uint64	是否长连接
ActiveCheck	否	是	Uint64	是否开启主动健康检测，1表示开启，0表示不开启
TLSVersion	否	是	Int64	TLS版本信息
Ciphers	否	是	Array of Int64	加密套件信息
CipherTemplate	否	是	Int64	模板
ProxyReadTimeout	否	是	Int64	300s
ProxySendTimeout	否	是	Int64	300s
SniType	否	是	Int64	0:关闭SNI；1:开启SNI，SNI=源请求host；2:开启SNI，SNI=修改为源站host；3：开启SNI，自定义host，SNI=SniHost；
SniHost	否	是	String	SniType=3时，需要填此参数，表示自定义的host；
Weights	否	是	Array of String	无
IpHeaders	否	是	Array of String	IsCdn=3时，表示自定义header
XFFReset	否	是	Int64	0:关闭xff重置；1:开启xff重置

ApiSecExtractRule

api提取规则内容

被如下接口引用：DescribeApiSecSensitiveRuleList、ModifyApiSecSensitiveRule

名称	必选	允许NULL	类型	描述
RuleName	否	是	String	规则名称
ApiName	否	是	String	api名称
Methods	否	是	Array of String	请求方法列表
Status	否	是	Int64	开关状态，0是关，1是开
Regex	否	是	String	正则匹配内容
UpdateTime	否	是	Int64	10更新时间戳

BotReqAnalyzeRes

bot请求参数信息

被如下接口引用：DescribeBotDetail

名称	必选	允许NULL	类型	描述
ReqQueryRepeatRate	是	是	Float	请求重复比重
ReqMaxUrl	是	是	String	请求最多的url
ReqUrlRepeatRate	是	是	Float	url重复比重
ReqUrlKind	是	是	Int64	url种类
ReqMaxQuery	是	是	String	最多的请求参数
ReqInWeeHours	是	是	Bool	是否发生在凌晨

MatchString

限流中的规则匹配

被如下接口引用：CreateRateLimits、DescribeRateLimits、UpdateRateLimits

名称	必选	允许NULL	类型	描述
Type	是	是	String	匹配类型，枚举，支持：EXACT（全匹配，默认），REGEX（正则表达式匹配），NOT_EQUALS（不等于），IN（包含），NOT_IN（不包含）
Value	否	是	String	匹配的目标值，如果选择的是包含和不包含，则通过逗号分割多个值

BatchCustomRuleListItem

批量自定义规则列表信息Item

被如下接口引用：DescribeBatchCustomRuleList

名称	必选	允许NULL	类型	描述
Id	否	是	Uint64	规则Id
ActionType	否	是	Int64	执行动作
Bypass	否	是	String	加白模块
ExpireTime	否	是	Uint64	有效期
Name	否	是	String	规则名称
Redirect	否	是	String	重定向地址
SortId	否	是	Int64	优先级
Status	否	是	Uint64	开关状态
Domains	否	是	Array of String	域名列表
Remark	否	是	String	备注
Strategies	否	是	Array of Strategy	策略列表
EventId	否	是	String	事件Id
ValidStatus	否	是	Uint64	生效状态
CreateTime	否	是	String	创建时间
UpdateTime	否	是	String	更新时间

InstanceInfo

一个实例的详细信息

被如下接口引用：DescribeInstances

名称	必选	允许NULL	类型	描述
InstanceId	是	否	String	实例唯一ID
InstanceName	是	否	String	实例名称
ResourceIds	是	否	String	实例对应资源ID，计费使用
Region	是	否	String	实例所属地域
PayMode	是	否	Uint64	付费模式
RenewFlag	是	否	Uint64	自动续费标识。
0：关闭
1：开启
Mode	是	否	Uint64	弹性计费开关。
0：关闭
1：开启
Level	是	否	Uint64	实例套餐版本。
101：小微版
102：超轻版
2：高级版
3：企业版
4：旗舰版
6：独享版
ValidTime	是	否	String	实例过期时间
BeginTime	是	否	String	实例开始时间
DomainCount	是	否	Uint64	已配置域名个数
SubDomainLimit	是	否	Uint64	域名数量上限
MainDomainCount	是	否	Uint64	已配置主域名个数
MainDomainLimit	是	否	Uint64	主域名数量上限
MaxQPS	是	否	Uint64	实例30天内QPS峰值
QPS	是	否	QPSPackageNew	qps扩展包信息
DomainPkg	是	否	DomainPackageNew	域名扩展包信息
AppId	是	否	Uint64	用户appid
Edition	是	否	String	clb或saas
FraudPkg	否	是	FraudPkg	业务安全包
BotPkg	否	是	BotPkg	Bot资源包
BotQPS	否	是	BotQPS	bot的qps详情
ElasticBilling	否	是	Uint64	qps弹性计费上限
AttackLogPost	否	是	Int64	攻击日志投递开关
MaxBandwidth	否	是	Uint64	带宽峰值，单位为B/s(字节每秒)
APISecurity	否	否	Uint64	api安全是否购买
QpsStandard	否	是	Uint64	购买的qps规格
BandwidthStandard	否	是	Uint64	购买的带宽规格
Status	否	是	Uint64	实例状态
SandboxQps	否	是	Uint64	实例沙箱qps值
IsAPISecurityTrial	否	是	Uint64	是否api 安全试用
MajorEventsPkg	否	是	MajorEventsPkg	重保包
HybridPkg	否	是	HybridPkg	混合云子节点包
ApiPkg	否	是	ApiPkg	API安全资源包
MiniPkg	否	是	MiniPkg	小程序安全加速包
MiniQpsStandard	否	是	Uint64	小程序qps规格
MiniMaxQPS	否	是	Uint64	小程序qps峰值

CertDomainItem

CertDomain的内嵌字段

被如下接口引用：DescribeCertificatedDomain

名称	必选	允许NULL	类型	描述
Domain	是	否	String	域名
Keepalive	是	否	Int64	0未开启长链接 1 开启长链接
InstanceID	否	是	String	uin
DomainID	否	是	String	域名ID

BatchAreaBanListItem

批量列表信息Item

被如下接口引用：DescribeBatchAreaBanList

名称	必选	允许NULL	类型	描述
Id	否	是	Uint64	规则Id
Name	否	是	String	规则名称
Status	否	是	Uint64	开关状态
Source	否	是	String	数据来源 custom-自定义(默认)、batch-批量防护
Areas	否	是	Array of String	地域列表
Domains	否	是	Array of String	域名列表
Remark	否	是	String	备注
UpdateTime	否	是	String	更新时间

BusinessRisk

业务安全返回实体列表

被如下接口引用：DescribeBusinessRisk

名称	必选	允许NULL	类型	描述
Id	否	是	Int64	规则主键
RuleAction	否	是	Int64	规则动作
Url	否	是	String	拦截url
DomainCode	否	是	String	分域信息
Status	否	是	Int64	策略开关
Host	否	是	String	域名信息
Level	否	是	String	风险等级，业务安全风险类型，包含：reject（高风险），review（人工审核）pass（无风险）
RiskType	否	是	String	风险类型：
"1", "账号信用低"
"11", "低活跃账号"
"2", "垃圾账号"
"21", "疑似小号"
"22", "违规账号"
"3", "无效账号"
"4", "黑名单"
"5", "白名单"
"201", "环境异常"
"2011", "非常用IP"
"2012", "IP异常"
"205", "非公网有效ip"
"206", "设备异常"
"2061", "非常用设备"
"2063", "群控设备"
AccountTypes	否	是	String	账户类型
Extend	否	是	String	条件信息
Options	否	是	String	账号提取规则
Name	否	是	String	规则名称
Uuid	否	是	String	规则UUid
Redirect	否	是	String	重定向链接
Description	否	是	String	规则描述
TsVersion	否	是	Int64	时间版本
ValidTime	否	是	String	生效时间
PublishTime	否	是	String	发布的时间
GmtModify	否	是	String	修改的时间
GmtCreate	否	是	String	创建时间

BotItem

用于bot日志的出参

被如下接口引用：DescribeBotItems

名称	必选	允许NULL	类型	描述
Id	是	是	String	一条日志记录带的id，MongoDB返回
BotId	是	是	String	botd的id
SrcIp	是	是	String	攻击源ip
Action	是	是	String	动作
Stat	是	是	BotStatSt	会话数量
RuleName	是	是	String	规则名称
Score	是	是	BotScore	分数
Timestamp	是	是	Uint64	时间戳
BotFeature	是	是	Array of String	异常
SessionCheckTime	是	是	Uint64	检测时间
Domain	是	是	String	域名

InOutputUCBRuleEntry

自定义规则UCB的Rule生效条件

被如下接口引用：DescribeBotSceneUCBRule、ModifyBotSceneUCBRule

名称	必选	允许NULL	类型	描述
Key	否	是	String	键
Op	否	是	String	操作符
Value	否	是	UCBEntryValue	值
OpOp	否	是	String	可选的补充操作符
OpArg	否	是	Array of String	可选的补充参数
OpValue	否	是	Float	可选的补充值
Name	否	是	String	Header参数值时使用

QueryListItems

描述一个API规则

被如下接口引用：DescribeApiRuleList

名称	必选	允许NULL	类型	描述
Description	是	是	String	API规则的描述
Method	是	否	String	该API规则所使用的方法
Status	是	否	Uint64	该API的开关状态
Action	是	否	Uint64	该条api对应的动作，包括观察和拦截
Url	是	否	String	API的URL地址
RuleId	是	否	Uint64	API的规则id
Source	是	否	String	API的来源
Parameters	是	否	Array of String	API子规则的名称列表
Timestamp	是	否	Uint64	时间戳

Type

规则类型描述列表

被如下接口引用：DescribeRuleTypes

名称	必选	允许NULL	类型	描述
Id	否	否	Uint64	规则id
Name	否	否	String	规则名称
Description	否	否	String	规则描述
Count	否	否	Uint64	规则数量

ApiStatPointItem

api安全的趋势图对象

被如下接口引用：DescribeApiStatPoints

名称	必选	允许NULL	类型	描述
TimeStamp	是	是	String	横坐标
Value	是	是	Uint64	纵坐标
Key	是	是	String	类型

BotTcbRuleData

封装使用

被如下接口引用：DescribeBotTCBRule

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

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的清洗模式的地域白名单，如果为空则表示没有地域开启了清洗模式，否则则开通的地域以,串接。

CopyBotsUCBFeatureRuleRsp

CopyBotsUCBFeatureRule的返回值

被如下接口引用：CopyBotUCBFeatureRules

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

ApiDataFilter

api资产列表过滤器

被如下接口引用：DescribeApiListVersionTwo、DescribeApiSecAttackSourceList、DescribeApiSecEventChangeList、DescribeApiSecEventList、DescribeApiSecEventOverview、DescribeApiSecEventTypeList

名称	必选	允许NULL	类型	描述
Entity	是	否	String	数据标签，是否活跃，功能场景
Operator	是	否	String	等于
Value	是	否	String	日期，手机号，邮箱等

RateLimitCommonRsp

限流相关通用返回

被如下接口引用：CreateRateLimits、DeleteRateLimits、DescribeRateLimits、EnableRateLimits、UpdateRateLimits

名称	必选	允许NULL	类型	描述
Code	否	是	Uint64	响应码
Info	否	是	String	提示信息

CreateAccessDownloadRecordRsp

CreateAccessDownloadRecord接口的返回值

被如下接口引用：CreateAccessDownloadRecord

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

BotsDomainAggStatStyledItem

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

被如下接口引用：DescribeBotAggregateDomainStat

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

ExpiredBotQPS

bot的qps详情

被如下接口引用：DescribeExpiredInstances

名称	必选	允许NULL	类型	描述
ResourceIds	是	否	String	资源id
RenewFlag	否	否	Uint64	续费标志

UserSceneInfo

用户的Domain+Scene+ActionRule信息，用于BOT流量分析，填充筛选下拉框内容

被如下接口引用：DescribeUserSceneInfo

名称	必选	允许NULL	类型	描述
Domain	是	否	String	域名
SceneId	是	否	String	场景ID
SceneName	是	否	String	场景名称
SceneActionList	是	否	Array of ActionRuleInfo	场景的动作策略列表
ScenePriority	是	否	Int64	场景的优先级

BotListStat

bot列表的stat数据

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

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

DomainInfo

domain列表

被如下接口引用：DescribeDomains

名称	必选	允许NULL	类型	描述
Domain	是	否	String	域名
DomainId	是	否	String	域名ID
InstanceId	是	否	String	实例ID
Cname	是	否	String	cname地址
Edition	是	否	String	实例类型,sparta-waf表示saaswaf实例域名,clb-waf表示clbwaf实例域名,cdc-clb-waf表示CDC环境下clbwaf实例域名,cdn-waf表示cdnwaf实例域名
Region	是	否	String	地域
InstanceName	是	否	String	实例名
ClsStatus	是	否	Uint64	日志包
FlowMode	是	否	Uint64	clbwaf使用模式,0镜像模式 1清洗模式
Status	是	否	Uint64	waf开关,0关闭 1开启
Mode	是	否	Uint64	规则引擎防护模式,0观察模式 1拦截模式
Engine	是	否	Uint64	规则引擎和AI引擎防护模式联合状态,10规则引擎观察&&AI引擎关闭模式 11规则引擎观察&&AI引擎观察模式 12规则引擎观察&&AI引擎拦截模式 20规则引擎拦截&&AI引擎关闭模式 21规则引擎拦截&&AI引擎观察模式 22规则引擎拦截&&AI引擎拦截模式
CCList	是	否	Array of String	CC列表
RsList	是	否	Array of String	回源ip
Ports	是	否	Array of PortInfo	服务端口配置
LoadBalancerSet	是	否	Array of LoadBalancerPackageNew	负载均衡器
AppId	是	否	Uint64	用户id
State	是	否	Int64	clbwaf域名监听器状态,0操作成功 4正在绑定LB 6正在解绑LB 7解绑LB失败 8绑定LB失败 10内部错误
CreateTime	否	否	String	创建时间
Ipv6Status	否	否	Int64	Ipv6开关状态,0关闭 1开启
BotStatus	否	否	Int64	BOT开关状态,0关闭 1开启
Level	否	否	Int64	版本信息
PostCLSStatus	否	否	Int64	是否开启投递CLS功能,0关闭 1开启
PostCKafkaStatus	否	否	Int64	是否开启投递CKafka功能,0关闭 1开启
CdcClusters	否	是	String	cdc实例域名接入的集群信息,非cdc实例忽略
ApiStatus	否	是	Int64	api安全开关状态,0关闭 1开启
AlbType	否	是	String	应用型负载均衡类型,clb或者apisix，默认clb
SgState	否	是	Int64	安全组状态,0不展示 1非腾讯云源站 2安全组绑定失败 3安全组发生变更
SgDetail	否	是	String	安全组状态的详细解释
CloudType	否	是	String	域名类型:hybrid表示混合云域名，public表示公有云域名

MaxBodyDetect

防护深度定制Data

被如下接口引用：DescribeHWInfo

名称	必选	允许NULL	类型	描述
Status	否	是	Uint64	状态
Action	否	是	Uint64	执行动作

CCRuleLists

CC规则总览

被如下接口引用：DescribeCCRuleList

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Uint64	总数
Res	是	是	Array of CCRuleItems	规则

ExpiredInstanceInfo

一个实例的详细信息

被如下接口引用：DescribeExpiredInstances

名称	必选	允许NULL	类型	描述
InstanceId	是	否	String	id
ResourceIds	是	否	String	资源id
RenewFlag	是	否	Uint64	自动续费
DomainPkg	是	否	ExpiredDomainPackage	域名套餐
FraudPkg	否	是	ExpiredFraudPkg	业务安全包
BotPkg	否	是	ExpiredBotPkg	Bot资源包
BotQPS	否	是	ExpiredBotQPS	bot的qps详情
QPS	否	是	ExpiredQPSPackage	qps套餐

InstanceIDName

实例id和实例名称对象

被如下接口引用：DescribeDomainInstanceIDs

名称	必选	允许NULL	类型	描述
Name	是	是	String	实例名称
InstanceID	是	是	String	实例id

FieldWriteConfig

设置哪些字段是否存储或转发

被如下接口引用：CreatePostCKafkaFlow、CreatePostCLSFlow、DescribeAccessMeta、ModifyAccessPeriod

名称	必选	允许NULL	类型	描述
EnableHeaders	否	是	Int64	1:开启 0:不开启
EnableBody	否	是	Int64	1:开启 0:不开启

AccessRuleInfo

DescribeAccessIndex接口的出参数

被如下接口引用：DescribeAccessIndex

名称	必选	允许NULL	类型	描述
FullText	是	是	AccessFullTextInfo	全文索引配置注意：此字段可能返回 null，表示取不到有效值。
KeyValue	是	是	AccessRuleKeyValueInfo	键值索引配置注意：此字段可能返回 null，表示取不到有效值。
Tag	是	是	AccessRuleTagInfo	元字段索引配置注意：此字段可能返回 null，表示取不到有效值。

BotListScore

拨通列表得分字段

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

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

WafRuleLimit

waf模块的规格

被如下接口引用：DescribeRuleLimit

名称	必选	允许NULL	类型	描述
CC	是	否	Uint64	自定义CC的规格
CustomRule	是	否	Uint64	自定义策略的规格
IPControl	是	否	Uint64	黑白名单的规格
AntiLeak	是	否	Uint64	信息防泄漏的规格
AntiTamper	是	否	Uint64	防篡改的规格
AutoCC	是	否	Uint64	紧急CC的规格
AreaBan	是	否	Uint64	地域封禁的规格
CCSession	是	否	Uint64	自定义CC中配置session
AI	是	否	Uint64	AI的规格
CustomWhite	是	否	Uint64	精准白名单的规格
ApiSecurity	是	否	Uint64	api安全的规格
ClientMsg	是	否	Uint64	客户端流量标记的规格
TrafficMarking	是	否	Uint64	流量标记的规格

CustomPayload

waf自定义载荷

被如下接口引用：

名称	必选	允许NULL	类型	描述
Category	是	否	String	载荷类别
Id	是	否	String	数据库id
LearnStat	是	否	String	学习状态
Remark	是	否	String	备注
Source	是	否	String	来源
Timestamp	是	否	Uint64	更新时间戳
Value	是	否	String	载荷值

DomainCls

域名和cls开关状态

被如下接口引用：DescribeAllDomain

名称	必选	允许NULL	类型	描述
Domain	是	是	String	域名
Cls	是	是	Uint64	clb开启状态
Status	是	是	Uint64	waf开关
DomainId	是	是	String	对外clbwaf域名id

Info

规则库的描述信息

被如下接口引用：DescribeRulesInfo

名称	必选	允许NULL	类型	描述
Date	否	否	String	日期
Version	否	否	String	版本
Memos	否	否	Array of String	规则描述信息
MemosEng	否	否	Array of String	英文版本的规则描述信息

BotTopItem

bot的topN复杂类型

被如下接口引用：DescribeApiAggregateTopN、DescribeBotAccessAggregateTopN、DescribeBotAggregateTopN

名称	必选	允许NULL	类型	描述
Key	是	否	String	对应的key
Value	是	否	Uint64	对应的值
Label	是	否	String	key对应的展示描述语

ReqUserRule

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

被如下接口引用：ModifyUserSignatureRule

名称	必选	允许NULL	类型	描述
Id	是	否	String	特征序号
Status	是	否	Int64	规则开关0：关1：开2：只告警
Reason	否	是	Int64	修改原因0：无(兼容记录为空)1：业务自身特性误报避免2：规则误报上报3：核心业务规则灰度4：其它

FailedInfo

失败描述

被如下接口引用：AddSpartaProtectionsAuto

名称	必选	允许NULL	类型	描述
Domain	否	是	String	域名
Message	否	是	String	失败信息

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	公开类型附加参数

DescribeAreaBanAreasRsp

DescribeAreaBanAreas接口的回包

被如下接口引用：DescribeAreaBanAreas

名称	必选	允许NULL	类型	描述
Status	否	否	String	状态 "0"：未开启地域封禁 "1"：开启地域封禁
Source	否	是	String	数据来源 custom-自定义(默认)、batch-批量防护
Areas	否	否	Array of String	字符串数据，配置的地域列表

ApiSecKey

api列表

被如下接口引用：ModifyApiSecEventChange

名称	必选	允许NULL	类型	描述
ApiName	是	否	String	api名称
Domain	是	否	String	域名
Method	是	否	String	请求方法

BatchCustomRuleListData

批量自定义规则列表信息数据

被如下接口引用：DescribeBatchCustomRuleList

名称	必选	允许NULL	类型	描述
List	否	是	Array of BatchCustomRuleListItem	规则列表
Total	否	是	Uint64	列表总数

ApiAsset

api列表

被如下接口引用：DescribeApiListVersionTwo

名称	必选	允许NULL	类型	描述
Domain	是	否	String	域名
Method	是	否	String	请求方法
ApiName	是	否	String	api名称
Scene	是	是	String	场景
Label	是	是	Array of String	数据标签
Active	是	是	Bool	过去7天是否活跃
Timestamp	是	否	Uint64	最近更新时间
InsertTime	是	否	Uint64	api发现时间
Mode	是	是	String	资产状态，1:新发现，2，确认中，3，已确认，4，已下线，5，已忽略
Level	是	是	String	风险等级，100,200,300对应低中高

DescribeAntiLeakageItem

出参

被如下接口引用：DescribeAntiInfoLeakageRules

名称	必选	允许NULL	类型	描述
RuleId	是	否	Uint64	规则ID
Name	是	否	String	名称
Status	是	否	Uint64	状态值
Action	是	否	String	动作
CreateTime	是	否	String	创建时间
Strategies	是	是	Array of DescribeAntiInfoLeakRulesStrategyItem	匹配条件
Uri	是	是	String	匹配的URL

ApiSecAttackSource

api安全攻击源详情

被如下接口引用：DescribeApiSecAttackSourceList

名称	必选	允许NULL	类型	描述
SrcIp	否	否	String	攻击来源ip
EventLevel	否	否	String	威胁等级
BotLabel	否	否	String	BOT标签
Timestamp	否	否	Uint64	变更时间
City	否	是	String	地理位置
StartTime	否	是	Uint64	开始时间

BotUCBPreinstallRuleData

BotUCBPreinstallRule封装

被如下接口引用：DescribeBotUCBPreinstallRule

名称	必选	允许NULL	类型	描述
Res	是	否	Array of BotUCBPreinstallRule	参数封装

AutoStat

命中的智能统计信息

被如下接口引用：DescribeBotDetailVersionTwo

名称	必选	允许NULL	类型	描述
Key	否	是	String	命中的维度特征名称
Value	否	是	Float	维度的实时特征值
Threshold	否	是	Float	维度的异常值

ProductInfo

waf产品

被如下接口引用：DescribePrice、GenerateDealsAndPay、GenerateDealsAndPayNew、ModifyAllGenerateDeals、ModifyApiSecurityGenerateDeals、ModifyBotGenerateDeals、ModifyGenerateDeals

名称	必选	允许NULL	类型	描述
Name	否	是	String	产品名称
Value	否	是	String	版本

SearchItem

接入列表查询复杂条件

被如下接口引用：DescribeHosts

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

BotActionScope

bot动作生效范围

被如下接口引用：DescribeBotActionRule、ModifyBotActionRule

名称	必选	允许NULL	类型	描述
Key	是	是	String	要匹配的key
Op	是	是	String	操作符号，包含或者不包含
Value	是	是	String	值

Entry

业务安全风险类型Entry

被如下接口引用：DescribeRiskInfo

名称	必选	允许NULL	类型	描述
Id	是	否	String	key值
Label	是	否	String	value值

BotStatPointItem

bot的趋势图对象

被如下接口引用：DescribeBotAccessStatPoints、DescribeBotStatPoints、DescribeFlowTrend

名称	必选	允许NULL	类型	描述
TimeStamp	是	否	String	横坐标
Key	是	否	String	value的所属对象
Value	是	否	Int64	纵列表
Label	是	否	String	Key对应的页面展示内容

GlobalWhiteRule

全局白名单规则

被如下接口引用：DescribeGlobalWhiteRule

名称	必选	允许NULL	类型	描述
Id	是	否	Uint64	序号
Status	是	否	Int64	规则开关
Name	是	否	String	规则名称
SignatureId	是	否	String	特征序号
CreateTime	是	否	Datetime_iso	创建时间
ModifyTime	是	否	Datetime_iso	更新时间
Rules	是	否	Array of GlobalWhiteCond	详细规则

HybridCluster

混合云集群

被如下接口引用：DescribeHybridCluster、DescribeHybridClusters

名称	必选	允许NULL	类型	描述
ClusterId	否	是	String	集群ID
ClusterName	否	是	String	集群名称
Region	否	是	String	集群地域
ClusterType	否	是	String	集群类型
State	否	是	Int64	集群状态：正常或异常，异常则通过StateStatus给出异常原因
TimeoutThreshold	否	是	Int64	安全检测超时时间
BodyLengthThreshold	否	是	Int64	最大body检测长度
HealthyThreshold	否	是	Float	健康状态阈值
StateDetail	否	是	String	集群异常状态说明
NetType	否	是	String	集群接入方式
InstanceId	否	是	String	实例ID
InstanceName	否	是	String	实例名称
InstanceLevel	否	是	Int64	waf实例等级，如果未绑定实例为0
WafStatus	否	是	Int64	waf防御状态
VirtualDomain	否	是	String	集群对应的虚拟域名
PreciseDomains	否	是	Array of String	精准域名列表
CLSStatus	否	是	Int64	WAF日志开关状态，0关闭1开启
PostCLSStatus	否	是	Int64	clb投递开关
PostCKafkaStatus	否	是	Int64	kafka投递开关
CreateTime	否	是	String	创建时间
LatestUpdateTime	否	是	String	最新时间
ClusterStage	否	是	Int64	1: 初始化 2: 本地部署 3: 完成创建 4: 完成接入 5: 日常运维

BotItemRequestBaseInfo

请求特征信息&会话基础信息

被如下接口引用：DescribeBotDetailVersionTwo

名称	必选	允许NULL	类型	描述
ReqUrlRepeat	否	是	Float	url重复比
ReqQueryRepeat	否	是	Float	请求参数比
CookieAbuse	否	是	Bool	Cookie是否滥用
CookieExist	否	是	Bool	cookie存在性
CookieRepeat	否	是	Float	cookie重复性
UaType	否	是	String	ua类型
UaExist	否	是	Bool	ua存在比
UaKindRandomRate	否	是	Float	ua随机性指数
UaKindNums	否	是	Int64	ua种类
ReferRepeat	否	是	Float	refer重复比
ReferExist	否	是	Bool	Refer存在性
ReferAbuse	否	是	Bool	refer是否滥用
AvgSpeed	否	是	Float	会话平均速度
Nums	否	是	Int64	会话总次数
HasRobots	否	是	Bool	是否存在Robots.txt
SessionDuration	否	是	Float	会话持续时间
CookieValidRate	否	是	Float	cookie有效率
CookieMaxItem	否	是	String	出现最多的cookie
CookieMaxItemRate	否	是	Float	出现最多的cookie比率
UaMaxItem	否	是	String	出现最多的ua
UaMaxItemRate	否	是	Float	出现最多的ua占的比例
UaValidRate	否	是	Float	ua有效比
UaSim	否	是	Float	ua相似率
ReferValidRate	否	是	Float	refer有效比
ReferMaxItem	否	是	String	出现最多的refer
ReferMaxItemRate	否	是	Float	出现最多的refer的比例
ReqUrlKind	否	是	Int64	url种类
UrlMinLevel	否	是	Int64	url最小深度
UrlMaxLevel	否	是	Int64	url最大深度
UrlAvgLevel	否	是	Float	url平均深度
UrlCount	否	是	Int64	url数量
QueryKind	否	是	Int64	请求参数种类
BotItemTokenIp	否	是	Array of BotItemTokenIp	token命中时，对应的ip列表
BotItemTokenIpCount	否	是	Int64	BotItemTokenIp 的数量

BotTCBRuleItem

bot tcb规则的动作和数量统计

被如下接口引用：

名称	必选	允许NULL	类型	描述
Action	是	否	String	动作
Count	是	否	Int64	数目

TargetEntity

需要开启/关闭API安全的 实例+域名 组合实体

被如下接口引用：ModifyApiAnalyzeStatus

名称	必选	允许NULL	类型	描述
InstanceId	否	否	String	实例ID
Domain	否	否	String	域名

DomainBotStatus

DomainBotStatus

被如下接口引用：DescribeBotStatus

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

AccessFieldValueRatioInfo

DescribeAccessFastAnalysis接口的出参

被如下接口引用：DescribeAccessFastAnalysis

名称	必选	允许NULL	类型	描述
Count	是	否	Int64	日志条数
Ratio	是	否	Float	对应的Value值的百分比
Value	是	否	String	字段对应的值

StrategyForAntiInfoLeak

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

被如下接口引用：AddAntiInfoLeakRules、ModifyAntiInfoLeakRules

名称	必选	允许NULL	类型	描述
Field	是	否	String	匹配条件，returncode（响应码）、keywords（关键字）、information（敏感信息）
CompareFunc	是	否	String	逻辑符号，固定取值为contains
Content	是	否	String	匹配内容。
以下三个对应Field为information时可取的匹配内容：
idcard（身份证）、phone（手机号）、bankcard（银行卡）。
以下为对应Field为returncode时可取的匹配内容：
400（状态码400）、403（状态码403）、404（状态码404）、4xx（其它4xx状态码）、500（状态码500）、501（状态码501）、502（状态码502）、504（状态码504）、5xx（其它5xx状态码）。
当对应Field为keywords时由用户自己输入匹配内容。

AiListFilter

筛选框列表

被如下接口引用：DescribeCustomPayloads

名称	必选	允许NULL	类型	描述
Key	否	是	String	筛选字段
Value	否	是	String	筛选值：|分隔，or关系

DescribePieChartRsp

DescribePieChart的返回值

被如下接口引用：DescribePieChart

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

BotUaInfo

bot详情里的ua信息

被如下接口引用：DescribeBotDetail

名称	必选	允许NULL	类型	描述
UaExist	是	是	Bool	ua存在性
UaKindRandomRate	是	是	Float	ua随机数指数
UaKind	是	是	Uint64	ua种类
UaType	是	是	String	ua类型
UaMax	是	是	String	请求最多的ua
UaValidRate	是	是	Float	ua存在比

DescribeCachePathRspListItem

DescribeCachePath返回值中的类型

被如下接口引用：DescribeCachePath

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

IpHitItem

ip封堵状态数据

被如下接口引用：DescribeAutoDenyIP、DescribeIpHitItems

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

AddApiRule

用户手动录入的api规则参数

被如下接口引用：AddApiRule、DescribeApiRule

名称	必选	允许NULL	类型	描述
Name	是	否	String	api名称
Position	是	否	String	api参数位置
Type	是	否	String	api类型
Required	是	否	Bool	参数是否是必须
Description	否	否	String	该参数的描述

InstanceCountKV

各个地域K的实例个数V

被如下接口引用：DescribeUserInstanceCount

名称	必选	允许NULL	类型	描述
Key	是	否	String	地域，如：gz
Value	是	否	Uint64	实例个数

UserSignatureRule

用户特征规则描述

被如下接口引用：DescribeOpSignatureRule、DescribeOpUserSignatureRule、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	规则描述
Reason	是	否	Int64	0/1

GoodNews

计费下单接口出入参Goods

被如下接口引用：GenerateDealsAndPayNew

名称	必选	允许NULL	类型	描述
GoodsCategoryId	否	是	Int64	订单类型ID，用来唯一标识一个业务的一种场景（总共三种场景：新购、配置变更、续费）
高级版: 102375(新购),102376(续费),102377(变配)
企业版 : 102378(新购),102379(续费),102380(变配)
旗舰版 : 102369(新购),102370(续费),102371(变配)
域名包 : 102372(新购),102373(续费),102374(变配)
业务扩展包 : 101040(新购),101041(续费),101042(变配)

高级版-CLB: 新购 101198 续费 101199 变配 101200 企业版-CLB 101204(新购),101205(续费),101206(变配) 旗舰版-CLB : 101201(新购),101202(续费),101203(变配) 域名包-CLB: 101207(新购),101208(续费),101209(变配) 业务扩展包-CLB: 101210(新购),101211(续费),101212(变配) | | PayMode| 否 | 是 | Int64 | 付费类型，1:预付费，0:后付费 | | Platform| 否 | 是 | Int64 | 平台类型，默认1 | | GoodsNum| 是 | 否 | Int64 | 商品数量 | | GoodsDetail| 是 | 否 | GoodsDetailNew| 商品明细 | | RegionId| 否 | 是 | Int64 | 购买waf实例区域ID 1 表示购买大陆资源; 9表示购买非中国大陆资源 | | ProjectId| 否 | 是 | Int64 | 默认为0 |

BotRecordItem

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

被如下接口引用：DescribeBotRecordItems

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

BotRequestLogItem

bot的请求的item

被如下接口引用：DescribeBotRequestLog

名称	必选	允许NULL	类型	描述
TimeStamp	是	是	String	时间戳
Source	是	是	String	来源

PriceData

计费询价出参

被如下接口引用：DescribePrice

名称	必选	允许NULL	类型	描述
HasUserPrice	是	否	Bool	是否有用户价格
Price	是	是	Int64	价格
PartDetail	是	是	Array of PartDetail	部件价格明细
TotalCost	是	是	Int64	总价
Currency	是	是	String	金额单位
TimeUnit	是	是	String	商品的时间单位
TimeSpan	是	是	Int64	商品的时间大小
GoodsNum	是	是	Int64	资源实例个数
FromType	是	是	Int64	来源类型
ProductCode	是	是	String	计费产品码
SubProductCode	是	是	String	计费二级产品码
Pid	是	是	Int64	计费策略id
RealTotalCost	是	是	Int64	优惠后总费用，单位分
AmountUnit	是	是	String	价格单位，pent：分
HighPrecisionPrice	是	是	HighPrecisionPrice	高精度价格 主要用于国际站部分定价低于一分钱的产品购买页展示高精度价格（最大保留到小数点后八位）
Policy	是	是	Float	总的折扣，100表示100%不打折
PolicyDetail	是	是	PolicyDetail	优惠明细
UnitPrice	是	是	Int64	单价

KVInt

Key-Value的形式，Value为Int

被如下接口引用：DescribeTopAttackDomain

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

DomainCustomRuleInfoItem

查询域名自定义规则信息Item

被如下接口引用：QueryDomainCustomRuleInfo

名称	必选	允许NULL	类型	描述
TotalNum	否	否	Uint64	规则总数
ExpiredNum	否	否	Uint64	已过期数
DenyNum	否	否	Uint64	阻断数
CaptchaNum	否	否	Uint64	人机识别数
LogNum	否	否	Uint64	观察数
RedirectNum	否	否	Uint64	重定向数

InstanceEvent

一个实例事件的详细信息

被如下接口引用：DescribeInstanceEvents

名称	必选	允许NULL	类型	描述
InstanceId	是	否	String	实例id
Type	是	否	Int64	实例事件类型，1：带宽事件,2:qps事件
Level	是	否	Int64	实例事件等级：低:：1，中：2，高：3，沙箱：4
EventTime	是	否	String	2022-10-11 00:00:00
Count	是	否	Int64	当天内预警或超限次数
MaxBandwidth	是	否	Uint64	带宽峰值
QPSConf	是	否	Uint64	qps规格；带宽规格=qps规格/40
Edition	是	否	String	实例类型：clb-waf或sparta-waf
MaxQps	否	否	Uint64	qps峰值
InstanceTime	否	否	String	实例购买日期
SandboxValue	否	是	Uint64	沙箱阈值
DayTime	否	是	String	事件日期

UserInfoCls

获取用户接口时返回的Cls信息

被如下接口引用：DescribeSpartUser

名称	必选	允许NULL	类型	描述
Count	是	是	String	计数
Deadline	是	是	String	过期时间
Region	是	是	String	区域
Renew	是	是	String	续费标志
ResourceId	是	是	String	资源ID

DescribeCustomRulesRspRuleListItem

DescribeCustomRules接口回包中的复杂类型

被如下接口引用：DescribeCustomRuleList、DescribeCustomRules、DescribeCustomWhiteRule

名称	必选	允许NULL	类型	描述
ActionType	否	否	String	动作类型
Bypass	否	否	String	跳过的策略
CreateTime	否	否	String	创建时间
ExpireTime	否	否	String	过期时间
Name	否	否	String	策略名称
Redirect	否	否	String	重定向地址
RuleId	否	否	String	策略ID
SortId	否	否	String	优先级
Status	否	否	String	状态
Strategies	否	否	Array of Strategy	策略详情
EventId	否	是	String	事件id
ModifyTime	否	是	String	修改时间
ValidStatus	否	是	Int64	生效状态
Source	否	是	String	来源

RiskInfo

业务安全风险类型返回实体

被如下接口引用：DescribeRiskInfo

名称	必选	允许NULL	类型	描述
RiskLevel	是	否	Array of Entry	风险等级列表业务安全风险类型，包含：reject（高风险），review（人工审核）pass（无风险）
RiskType	是	否	Array of Entry	风险类型列表"1", "账号信用低""11", "低活跃账号""2", "垃圾账号""21", "疑似小号""22", "违规账号""3", "无效账号""4", "黑名单""5", "白名单""201", "环境异常""2011", "非常用IP""2012", "IP异常""205", "非公网有效ip""206", "设备异常""2061", "非常用设备""2063", "群控设备"

DescribeAntiInfoLeakRulesRuleItem

DescribeAntiInfoLeakRules返回的规则列表元素

被如下接口引用：DescribeAntiInfoLeakRules

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

HostDel

CLB-WAF删除域名参数

被如下接口引用：DeleteHost、DeleteHostInner

名称	必选	允许NULL	类型	描述
Domain	是	否	String	域名
DomainId	是	否	String	域名ID
InstanceID	否	否	String	实例类型

PartDetailItem

部件明细项

被如下接口引用：DescribePrice

名称	必选	允许NULL	类型	描述
Pid	是	是	String	计费策略ID
Price	是	是	Int64	价格
Value	是	是	Int64	计费项数量
PriceDetail	是	是	Array of PriceDetail	价格项明细
BillingItemCode	是	是	String	计费项CODE
SubBillingItemCode	是	是	String	计费项二级CODE
TotalCost	是	是	Int64	总价
RealTotalCost	是	是	Int64	真实总价
Policy	是	是	Float	总的折扣，100表示100%不打折
PolicyDetail	是	是	PolicyDetail	折扣明细信息

QpsConfig

获取各个套餐版本的弹性qps配置

被如下接口引用：GetAllQpsConfig

名称	必选	允许NULL	类型	描述
SpWafPremiumC	否	否	QpsData	sp_wsm_waf_premium_clb 类型 弹性qps相关值
SpWafPremium	否	否	QpsData	sp_wsm_waf_premium 类型 弹性qps相关值
SpWafEnterpriseC	否	否	QpsData	sp_wsm_waf_enterprise_clb 类型 弹性qps相关值
SpWafEnterprise	否	否	QpsData	sp_wsm_waf_enterprise 类型 弹性qps相关值
SpWafUltimateC	否	否	QpsData	sp_wsm_waf_ultimate_clb 类型 弹性qps相关值
SpWafUltimate	否	否	QpsData	sp_wsm_waf_ultimate 类型 弹性qps相关值
SpWafExclusive	否	否	QpsData	sp_wsm_waf_exclusive 类型 弹性qps相关值
SpWafHybrid	否	否	QpsData	sp_wsm_waf_hybrid 类型 弹性qps相关值
SpWafHybridEn	否	否	QpsData	sp_wsm_waf_hybriden 类型 弹性qps相关值
SpWafHybridPr	否	否	QpsData	sp_wsm_waf_hybrid_pr 类型 弹性qps相关值

SessionData

参数包装

被如下接口引用：DescribeSession

名称	必选	允许NULL	类型	描述
Res	是	否	Array of SessionItem	session定义

ActionedIpData

封装数据

被如下接口引用：DescribeActionedIp

名称	必选	允许NULL	类型	描述
Res	是	是	Array of ActionedIpItem	ip数据
TotalCount	是	否	Uint64	计数

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列表
IsKeepAlive	是	是	String	是否支持长连接

ThreatIntelligenceEntry

情报对象

被如下接口引用：DescribeBotThreatIntelligence

名称	必选	允许NULL	类型	描述
Status	是	否	Bool	是否开启，true：开启，false：关闭
Text	是	否	String	情报名称，以下是当前的取值以及跟情报内容的对应关系。'Value': 'amazon.com', 'Text': 'Aws''Value': 'microsoft.com', 'Text': 'Azure''Value': 'cloud.google.com', 'Text': 'Google''Value': 'ucloud.cn', 'Text': 'UCloud''Value': 'aliyun.com'), 'Text': '阿里云''Value': 'baidu.com', 'Text': '百度云''Value': 'huawei.com', 'Text': '华为云''Value': 'ksyun.com', 'Text': '金山云''Value': 'pubyun.com', 'Text': '京东云''Value': 'qingcloud.com', 'Text': '青云''Value': 'tencent.com', 'Text': '腾讯云''Value': 'bot', 'Text': '恶意BOT''Value': 'attack', 'Text': 'Web攻击''Value': 'proxy', 'Text': '网络代理'
Description	是	否	String	描述
Value	是	否	String	情报内容，以下是情报内容和情报名称的对应关系。'Value': 'amazon.com', 'Text': 'Aws''Value': 'microsoft.com', 'Text': 'Azure''Value': 'cloud.google.com', 'Text': 'Google''Value': 'ucloud.cn', 'Text': 'UCloud''Value': 'aliyun.com'), 'Text': '阿里云''Value': 'baidu.com', 'Text': '百度云''Value': 'huawei.com', 'Text': '华为云''Value': 'ksyun.com', 'Text': '金山云''Value': 'pubyun.com', 'Text': '京东云''Value': 'qingcloud.com', 'Text': '青云''Value': 'tencent.com', 'Text': '腾讯云''Value': 'bot', 'Text': '恶意BOT''Value': 'attack', 'Text': 'Web攻击''Value': 'proxy', 'Text': '网络代理'
Type	是	否	String	情报分类
Timestamp	是	否	Int64	修改的时间戳，默认0表示没有进行修改
TypeText	是	否	String	type的前端显示

FiltersItemNew

过滤数组

被如下接口引用：DeleteBatchCustomRule、DescribeAntiFakeRules、DescribeAntiInfoLeakageRules、DescribeApiRuleList、DescribeAppletAccess、DescribeAppletAccessV3、DescribeAppletAuthorizeV3、DescribeAttackWhiteRule、DescribeBatchAreaBanList、DescribeBatchCustomRuleList、DescribeBatchIpAccessControl、DescribeCCRuleList、DescribeCdcResource、DescribeCustomRuleList、DescribeCustomWhiteRule、DescribeDomains、DescribeGlobalWhiteRule、DescribeInstances、DescribeMainClass、DescribeObjects、DescribeOpAttackWhiteRule、DescribeOpAttackWhiteRuleNew、DescribeOpMainClass、DescribeOpSignatureRule、DescribeOpUserSignaturePolicy、DescribeOpUserSignatureRule、DescribeRateLimits、DescribeTsResource、DescribeUserSignatureRule、PostDomainsConfigTask

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

IpAccessControlItem

ip黑白名单

被如下接口引用：DescribeIpAccessControl

名称	必选	允许NULL	类型	描述
Id	否	是	String	mongo表自增Id
ActionType	否	否	Uint64	动作
Ip	否	否	String	ip
Note	否	否	String	备注
Source	否	否	String	来源
TsVersion	否	是	Uint64	更新时间戳
ValidTs	否	否	Uint64	有效截止时间戳
ValidStatus	否	是	Int64	生效状态

KeyValueInfo

kv 索引的相关配置

被如下接口引用：DescribeAttackIndex

名称	必选	允许NULL	类型	描述
CaseSensitive	否	否	Bool	是否大小写敏感
Keys	否	否	Array of String	支持检索的key的名字
Tokenizers	否	否	Array of String	字段内容的正则匹配
Types	否	否	Array of String	上面 key 对应的类型，一一对应，目前支持long double text
SqlFlags	否	否	Array of Bool	是否开启统计功能，并用于控制是否支持搜索字段联想
TemplateType	否	是	String	TemplateType模版类型

TIGARuleStatusItem

tiga规则库规则描述

被如下接口引用：DescribeRule

名称	必选	允许NULL	类型	描述
Id	否	是	Int64	规则库的id
Version	否	是	String	规则库版本
InUse	否	是	Int64	是否使用中，1代表使用中，0代表没使用
Source	否	是	Int64	规则库来源，0代表cos
Rollback	否	是	Int64	回滚标记，1代表已经下发回滚，0代表没有下发回滚
Status	否	是	Int64	规则库状态，0代表新建，1代表下发升级，2代表升级中，3代表已完成升级，4代表已删除
Progress	否	是	Int64	升级进度
ErrorCode	否	是	Int64	该规则库的错误码
CreateTime	否	是	Datetime_iso	创建时间
ModifyTime	否	是	Datetime_iso	修改时间
FinishedTime	否	是	Datetime_iso	完成升级时间
Detail	否	是	String	规则库详细
Operator	否	是	String	规则库上次操作人
FileName	否	是	String	规则库文件名

ApiEvent

APi事件列表

被如下接口引用：DescribeApiSecEventList

名称	必选	允许NULL	类型	描述
EventId	是	是	String	事件id
EventType	是	是	String	事件类型
Level	是	是	String	事件等级，100,200,300对应低中高
Domain	是	是	String	域名
Mode	是	是	String	处置状态，1:新发现，2，确认中，3，已确认，4，已下线，5，已忽略
StartTime	是	是	Uint64	发现时间
UpdateTime	是	是	Uint64	更新时间
ApiName	是	是	String	关联的api
Method	是	是	String	请求方式

InstanceItem

Nginx实例信息

被如下接口引用：QueryConfigDelivery

名称	必选	允许NULL	类型	描述
Ip	否	是	String	Redis集群地区版本
Version	否	是	Uint64	版本
Region	否	是	String	nginx地区
InstanceType	否	是	String	实例类型
EngineType	否	是	String	引擎类型
Area	否	是	String	实例大区域 chn(国内)、intl(国际)
Edition	否	是	String	WAF类型 saas、clb、cdn、cdc
Env	否	是	String	实例环境类型 Development、Test、Pre、Production
ReportTimeStr	否	是	String	上报时间

CdcRegion

CDC场景下负载均衡WAF的地域信息

被如下接口引用：DescribeUserCdcClbWafRegions

名称	必选	允许NULL	类型	描述
Region	是	否	String	地域
Clusters	是	是	Array of CdcCluster	该地域对应的集群信息

SceneJsInjectRule

BOT前端对抗规则结构体

被如下接口引用：DescribeSceneJsInjectRule

名称	必选	允许NULL	类型	描述
Domain	是	否	String	规则对应的域名
RuleAction	是	是	Int64	可选的值为：0（放行） 1（阻断） 2（人机识别） 3（观察） 4（重定向）
Redirect	是	是	String	动作为重定向的时候重定向的URL
AutomatedTool	是	是	Bool	是否开启自动化工具识别，true：是，false：否
CrackBehavior	是	是	Bool	是否开启页面防调试，true：是，false：否
GoodBot	是	是	Array of String	搜索引擎白名单，可选的值为：["sogou", "baidu", "yandex", "360", "yahoo", "bing", "google"]
RuleID	是	否	Int64	【场景化版本改为复用字段】前端对抗规则ID
RasSiteID	是	是	String	规则内部ID
Status	是	是	Int64	前端对抗的开关，0（关闭） 1（开启）
ReqWhiteList	是	是	Array of SceneWhiteListItem	请求白名单
RspWhiteList	是	是	Array of SceneWhiteListItem	响应白名单
CheckURL	是	是	String	前端对抗的防护URL，老版本使用，已经废弃
PreventScanner	是	是	Bool	是否拦截扫描工具（目前暂不支持设置）
CheckUrls	是	是	Array of String	前端对抗的防护URL，支持多个URL
SceneId	是	是	String	【场景化新增】当查询全局配置时，为空；否则为具体的场景ID

TLSCiphers

TLS 加密套件

被如下接口引用：DescribeCiphersDetail

名称	必选	允许NULL	类型	描述
VersionId	是	是	Int64	TLS版本ID
CipherId	是	是	Int64	加密套件ID
CipherName	是	是	String	加密套件

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：镜像模式（默认）

DealData

计费下单响应实体

被如下接口引用：GenerateDealsAndPay、GenerateDealsAndPayNew、ModifyAllGenerateDeals、ModifyApiSecurityGenerateDeals、ModifyBotGenerateDeals、ModifyGenerateDeals

名称	必选	允许NULL	类型	描述
DealNames	否	否	Array of String	订单号列表，元素个数与请求包的goods数组的元素个数一致，商品详情与订单按顺序对应
BigDealId	否	否	String	大订单号，一个大订单号下可以有多个子订单，说明是同一次下单[{},{}]

BotIdConfig

BOT-ID规则信息

被如下接口引用：ModifyBotIdRule

名称	必选	允许NULL	类型	描述
RuleId	是	否	String	规则ID
BotId	否	否	String	规则名称
Status	是	否	Bool	规则开关
Action	是	否	String	动作配置

RegionItem

区域列表

被如下接口引用：DescribeTsRegion

名称	必选	允许NULL	类型	描述
MainRegion	是	否	String	一级区域
SubRegion	是	否	String	二级区域
DomainCount	是	否	Uint64	接入域名数
Id	是	否	Uint64	标号
CreateTime	是	否	Datetime_iso	创建时间

ClbDomainsInfo

clb域名详情

被如下接口引用：DescribeDomainDetailsClb

名称	必选	允许NULL	类型	描述
Domain	否	否	String	域名
DomainId	否	否	String	域名id
InstanceId	否	否	String	实例id
InstanceName	否	否	String	实例名
Edition	否	否	String	waf类型
IsCdn	否	否	Uint64	是否是cdn
LoadBalancerSet	否	否	Array of LoadBalancerPackageNew	负载均衡算法
FlowMode	否	否	Uint64	镜像模式
State	否	是	Int64	绑定clb状态
AlbType	否	是	String	负载均衡类型，clb或者apisix
IpHeaders	否	是	Array of String	IsCdn=3时，表示自定义header
CdcClusters	否	是	String	cdc类型会增加集群信息
CloudType	否	是	String	云类型:public:公有云；private:私有云;hybrid:混合云

JsInjectRule

BOT前端对抗规则结构体

被如下接口引用：DescribeJsInjectRule

名称	必选	允许NULL	类型	描述
Domain	是	否	String	规则对应的域名
RuleAction	是	否	Int64	可选的值为：0（放行） 1（阻断） 2（人机识别） 3（观察） 4（重定向）
Redirect	是	否	String	动作为重定向的时候重定向的URL
AutomatedTool	是	否	Bool	是否开启自动化工具识别，true：是，false：否
CrackBehavior	是	否	Bool	是否开启页面防调试，true：是，false：否
GoodBot	是	否	Array of String	搜索引擎白名单，可选的值为：["sogou", "baidu", "yandex", "360", "yahoo", "bing", "google"]
RuleID	是	否	Int64	前端对抗规则ID
RasSiteID	是	否	String	规则内部ID
Status	是	否	Int64	前端对抗的开关，0（关闭） 1（开启）
ReqWhiteList	是	是	Array of WhiteListItem	请求白名单
RspWhiteList	是	是	Array of WhiteListItem	响应白名单
CheckURL	是	否	String	前端对抗的防护URL，多个URL以,串接
PreventScanner	是	是	Bool	是否拦截扫描工具（目前暂不支持设置）

HistogramItem

柱状图

被如下接口引用：

名称	必选	允许NULL	类型	描述
IP	是	是	String	IP
Time	是	是	Float	响应时间
Url	是	是	String	URL
City	是	是	String	城市

CustomHeader

自定义拦截页面的自定义头部信息

被如下接口引用：AddBlockPage、DescribeBlockPages

名称	必选	允许NULL	类型	描述
Key	否	是	String	自定义头部Key信息
Value	否	是	String	自定义头部Value信息
Type	否	是	String	自定义头部类型：default: 内置; custom: 自定义

QPSPackageNew

clb-waf QPS套餐 New

被如下接口引用：DescribeInstances

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

AttackLogInfo

攻击日志详情

被如下接口引用：SearchAttackLog

名称	必选	允许NULL	类型	描述
Content	是	否	String	攻击日志的详情内容
FileName	是	否	String	CLS返回内容
Source	是	否	String	CLS返回内容
TimeStamp	是	否	Datetime	CLS返回内容

ActionRuleInfo

场景的动作策略信息，用于BOT场景流量分析时，做策略ID到策略名称的映射

被如下接口引用：DescribeUserSceneInfo

名称	必选	允许NULL	类型	描述
ActionRuleId	是	否	String	动作策略ID
ActionRuleName	是	否	String	动作策略名称

OpUserWhiteRuleNew

用户白名单规则的运营后台接口

被如下接口引用：DescribeOpAttackWhiteRuleNew

名称	必选	允许NULL	类型	描述
OpAppId	是	否	String	appid
OpDomain	是	否	String	域名
WhiteRuleId	是	否	Uint64	id
SignatureId	是	否	String	规则id
Status	是	否	Int64	状态
MatchField	是	否	String	匹配域
MatchMethod	是	否	String	匹配方法
MatchContent	是	否	String	匹配内容
CreateTime	是	否	Datetime_iso	创建时间
ModifyTime	是	否	Datetime_iso	修改时间

BotPkg

Bot资源信息

被如下接口引用：DescribeInstances

名称	必选	允许NULL	类型	描述
ResourceIds	否	是	String	资源id
Status	否	是	Int64	状态
Region	否	是	Int64	地域
BeginTime	否	是	String	开始时间
EndTime	否	是	String	结束时间
InquireNum	否	是	Int64	申请数量
UsedNum	否	是	Int64	使用数量
Type	否	是	String	子产品code
RenewFlag	否	是	Uint64	续费标志
BotCPWaf	否	是	Int64	购买页bot6折
BotNPWaf	否	是	Int64	控制台买bot5折
IsBotTrial	否	是	Int64	7天bot试用标识 1 试用 0 没有试用

AddSpartaWafRuleReqStrategy

自定义参数的策略

被如下接口引用：

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

GlobalWhiteCond

全局白名单规则项

被如下接口引用：AddGlobalWhiteRule、DescribeGlobalWhiteRule、ModifyGlobalWhiteRule

名称	必选	允许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

CacheUrlItems

防篡改url元素

被如下接口引用：DescribeAntiFakeRules

名称	必选	允许NULL	类型	描述
Id	是	否	Uint64	标识
Name	是	否	String	名字
Domain	是	否	String	域名
Uri	是	否	String	网址
Protocol	是	否	String	协议
Status	是	否	Uint64	状态

DescribeBotUCBRuleRsp

获取自定义规则列表时的出参

被如下接口引用：DescribeBotSceneUCBRule

名称	必选	允许NULL	类型	描述
Res	是	是	Array of InOutputBotUCBRule	规则列表
TotalCount	是	否	Int64	规则总数

UCBEntryValue

云图API改版后, 不支持将复杂json类型编码成string,因此通过此复杂类型识别传入的不同类型参数值

被如下接口引用：DescribeBotSceneUCBRule、ModifyBotSceneUCBRule

名称	必选	允许NULL	类型	描述
BasicValue	否	是	String	string类型值
LogicValue	否	是	Bool	布尔类型值
BelongValue	否	是	Array of String	string数组类型值
ValidKey	否	是	String	指示有效的字段
MultiValue	否	是	Array of String	string数组类型值

VIPStateFilter

VIP查询

被如下接口引用：DescribeVIPState

名称	必选	允许NULL	类型	描述
Name	是	否	String	无
Values	是	否	Array of String	无
ExactMatch	是	否	Bool	无

ModuleTypeItem

模块类型信息

被如下接口引用：QueryConstantEnum

名称	必选	允许NULL	类型	描述
Value	否	是	String	模块名称
Name	否	是	String	模块中文名称

Goods

计费下单接口出入参Goods

被如下接口引用：DescribePrice、GenerateDealsAndPay、ModifyAllGenerateDeals、ModifyApiSecurityGenerateDeals、ModifyBotGenerateDeals、ModifyGenerateDeals

名称	必选	允许NULL	类型	描述
GoodsCategoryId	否	是	Int64	计费类目ID，对应cid
PayMode	是	否	Int64	付费类型，1:预付费，0:后付费
Platform	否	是	Int64	平台类型，默认1
GoodsNum	是	否	Int64	商品数量
GoodsDetail	是	否	GoodsDetail	商品明细
RegionId	否	是	Int64	购买waf实例区域ID
ProjectId	是	是	Int64	默认为0

InstanceIDInfo

实例id对应的地域和实例名称

被如下接口引用：DescribeInstanceIdList

名称	必选	允许NULL	类型	描述
Region	是	否	String	实例地区
InstanceID	是	否	String	实例id
InstanceName	是	否	String	实例名称
ValidTime	是	否	String	过期时间
DomainCount	是	否	Uint64	sub_domain_limit

DescribeDNSDetectDataMapRspItem

DescribeDNSDetectDataMap返回值的元素

被如下接口引用：DescribeDNSDetectDataMap

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

PeakPointsItem

PeakPoints数组项

被如下接口引用：DescribePeakPoints

名称	必选	允许NULL	类型	描述
Time	否	否	Uint64	秒级别时间戳
Access	否	否	Uint64	QPS
Up	否	否	Uint64	上行带宽峰值，单位B
Down	否	否	Uint64	下行带宽峰值，单位B
Attack	否	否	Uint64	Web攻击次数
Cc	否	否	Uint64	CC攻击次数
BotAccess	否	否	Uint64	Bot qps
StatusServerError	否	是	Uint64	WAF返回给客户端状态码5xx次数
StatusClientError	否	是	Uint64	WAF返回给客户端状态码4xx次数
StatusRedirect	否	是	Uint64	WAF返回给客户端状态码302次数
StatusOk	否	是	Uint64	WAF返回给客户端状态码202次数
UpstreamServerError	否	是	Uint64	源站返回给WAF状态码5xx次数
UpstreamClientError	否	是	Uint64	源站返回给WAF状态码4xx次数
UpstreamRedirect	否	是	Uint64	源站返回给WAF状态码302次数
BlackIP	否	是	Uint64	黑名单次数
Tamper	否	是	Uint64	防篡改次数
Leak	否	是	Uint64	信息防泄露次数
ACL	否	是	Uint64	访问控制
WxAccess	否	是	Uint64	小程序 qps

BotToken

bot-token配置

被如下接口引用：DescribeBotToken

名称	必选	允许NULL	类型	描述
Name	是	是	String	会话名称
Description	是	是	String	会话描述
Id	是	是	String	会话id
Status	是	否	Bool	策略的开关状态
Location	是	否	String	会话位置
Key	是	否	String	会话key
Operator	是	否	String	会话匹配方式，前缀匹配、后缀匹配等
Timestamp	是	否	Int64	会话更新的时间戳

BotAccessItem

bot页面日志列表显示

被如下接口引用：DescribeBotAccessLog

名称	必选	允许NULL	类型	描述
ClientIp	是	是	String	源ip
Url	是	是	String	命中的url
Location	是	是	String	地理位置
TotalCount	是	是	Int64	日志总数
BotModule	是	是	String	命中模块
BotAction	是	是	String	动作列表
MaxLogTime	是	否	String	结束时间
MinLogTime	是	否	String	开始时间
AttackCount	是	是	Int64	攻击次数

AccessHistogramItem

用于接口DescribeAccessHistogram 的出参

被如下接口引用：DescribeAccessHistogram

名称	必选	允许NULL	类型	描述
BTime	否	否	Int64	时间，单位ms
Count	否	否	Int64	日志条数
BeginTime	否	否	Int64	时间，单位ms

FirstPurchaseData

waf实例首购Data

被如下接口引用：

名称	必选	允许NULL	类型	描述
Status	是	是	Uint64	状态码，0表示成功，非0表示是比啊
FirstPurchase	是	是	Uint64	是否首购用户，0表示非首购用户，1表示首购用户

BotItemTokenIp

token命中时，对应的ip列表

被如下接口引用：DescribeBotDetailVersionTwo

名称	必选	允许NULL	类型	描述
Count	否	是	Int64	数量
Timestamp	否	是	Int64	时间戳
Key	否	是	String	key，默认为ip地址

HighPrecisionPrice

高精度价格

被如下接口引用：DescribePrice

名称	必选	允许NULL	类型	描述
PriceHigh	是	是	String	价格
TotalCostHigh	是	是	String	使用
RealTotalCostHigh	是	是	String	总价

UAStrategy

UA策略全局配置实体

被如下接口引用：ModifyBotGlobalUAStrategy

名称	必选	允许NULL	类型	描述
UAName	是	否	String	UA策略名称
Status	是	否	Bool	对应开关状态

BotActionScopeRuleEntry

动作策略的匹配规则实体

被如下接口引用：DescribeBotSceneActionRule、DescribeBotSceneList、ModifyBotSceneActionRule

名称	必选	允许NULL	类型	描述
Key	否	是	String	参数
Op	否	是	String	匹配符
Value	否	是	String	参数值
Name	否	是	String	对于头部字段匹配value的时候指定的头部名
ValueArray	否	是	Array of String	470后使用此字段存储多值

UserWhiteRuleItem

用户规则白名单规则子项

被如下接口引用：AddAttackWhiteRule、ModifyAttackWhiteRule

名称	必选	允许NULL	类型	描述
MatchField	是	否	String	匹配域
MatchMethod	是	否	String	匹配方法
MatchContent	是	否	String	匹配内容

AppletAccessV3

小程序接入详细信息

被如下接口引用：DescribeAppletAccessV3

名称	必选	允许NULL	类型	描述
Name	否	是	String	小程序接入名称
AppletID	否	是	String	微信小程序ID
Comment	否	是	String	详情
AccessDomain	否	是	String	微信网关接入节点域名
AuthAccessStatus	否	是	Uint64	授权接入阶段的状态,
0 初始状态
100 完成
ClientTrialStatus	否	是	Uint64	客户体验阶段的状态
0 初始状态
100 完成
ClientPublishStatus	否	是	Uint64	客户发布阶段的状态
0 初始状态
100 完成
EffectiveVersion	否	是	String	小程序接入的生效版本
Domains	否	是	Array of AppletAccessDomainV3	小程序业务域名信息
GatewayID	否	是	String	网关ID
AccessID	否	是	String	接入节点ID

MonitorInstanceItem

实例列表

被如下接口引用：DescribeMonitorInstances

名称	必选	允许NULL	类型	描述
Instance	否	是	String	实例ID
InstanceName	否	是	String	实例名称
Appid	否	是	Uint64	用户自己的Appid
Edition	否	是	Int64	实例对应的版本信息，0代表saas，1代表clb
Region	否	是	String	地域

DownloadAccessRecordInfo

下载攻击日志记录数据项

被如下接口引用：GetAccessDownloadRecords

名称	必选	允许NULL	类型	描述
Id	是	否	Uint64	记录ID
TaskName	是	否	String	下载任务名
TaskId	是	否	String	任务ID
QueryString	是	否	String	查询条件query string
Count	是	否	Uint64	当前下载任务的日志条数
Status	是	否	Int64	下载任务运行状态：-1-下载超时，0-下载等待，1-下载完成，2-下载失败，4-正在下载
Url	是	否	String	下载文件URL
CreateTime	是	否	Datetime	创建时间
ModifyTime	是	否	Datetime	最后更新修改时间
ExpireTime	是	否	Datetime	过期时间
TotalCount	是	否	Uint64	下载任务需下载的日志总条数

SubClassItem

子类信息

被如下接口引用：DescribeMainClass、DescribeOpMainClass

名称	必选	允许NULL	类型	描述
SubClassID	是	否	String	子类id
SubClassName	是	否	String	子类名字
Description	是	否	String	描述

BotIdTypeEntity

bot-id规则类型

被如下接口引用：DescribeBotIdType

名称	必选	允许NULL	类型	描述
Key	否	是	String	类型
Count	否	是	Int64	数量

PostCKafkaFlowInfo

CKafka投递流

被如下接口引用：DescribePostCKafkaFlows

名称	必选	允许NULL	类型	描述
FlowId	否	否	Int64	投递流唯一ID
LogType	否	否	Int64	1-访问日志 2-攻击日志
InsertTime	否	否	Int64	创建时间
ModifyTime	否	否	Int64	最后一次修改时间
Status	否	否	Int64	状态 0-为关闭 1-为启用
CKafkaRegion	否	否	String	CKafka所在区域
CKafkaID	否	否	String	CKafka实例ID
Brokers	否	否	String	ckafka地址信息
Version	否	否	String	ckafka版本号
Topic	否	否	String	主题名称
Compression	否	否	String	压缩算法，支持gzip 和 lz4
SASLEnable	否	否	Int64	是否支持SASL,0-关闭，1-开启
SASLUser	否	否	String	SASL用户名
SASLPassword	否	否	String	SALS密码
Sync	否	否	Int64	0-异步投递，1-同步投递，目前仅支持同步投递
Content	否	否	String	描述信息
VipType	否	否	Int64	1-外网TGW，2-支撑环境，默认为支撑环境
Count	否	是	Int64	投递的域名或实例个数

Strategy

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

被如下接口引用：AddBatchCustomRule、AddCustomRule、AddCustomWhiteRule、DescribeBatchCustomRuleList、DescribeCustomRuleList、DescribeCustomRules、DescribeCustomWhiteRule、ModifyBatchCustomRule、ModifyCustomRule、ModifyCustomWhiteRule

名称	必选	允许NULL	类型	描述
Field	是	是	String	匹配字段

匹配字段不同，相应的匹配参数、逻辑符号、匹配内容有所不同具体如下所示：

<table><thead><tr><th>匹配字段</th><th>匹配参数</th><th>逻辑符号</th><th>匹配内容</th></tr></thead><tbody><tr><td>IP（来源IP）</td><td>不支持参数</td><td>ipmatch（匹配）<br/>ipnmatch（不匹配）</td><td>多个IP以英文逗号隔开,最多20个</td></tr><tr><td>IPV6（来源IPv6）</td><td>不支持参数</td><td>ipmatch（匹配）<br/>ipnmatch（不匹配）</td><td>支持单个IPV6地址</td></tr><tr><td>Referer（Referer）</td><td>不支持参数</td><td>empty（内容为空）<br/>null（不存在）<br/>eq（等于）<br/>neq（不等于）<br/>contains（包含）<br/>ncontains（不包含）<br/>len_eq（长度等于）<br/>len_gt（长度大于）<br/>len_lt（长度小于）<br/>strprefix（前缀匹配）<br/>strsuffix（后缀匹配）<br/>rematch（正则匹配）</td><td>请输入内容,512个字符以内</td></tr><tr><td>URL（请求路径）</td><td>不支持参数</td><td>eq（等于）<br/>neq（不等于）<br/>contains（包含）<br/>ncontains（不包含）<br/>len_eq（长度等于）<br/>len_gt（长度大于）<br/>len_lt（长度小于）<br/>strprefix（前缀匹配）<br/>strsuffix（后缀匹配）<br/>rematch（正则匹配）<br/></td><td>请以/开头,512个字符以内</td></tr><tr><td>UserAgent（UserAgent）</td><td>不支持参数</td><td>同匹配字段<font color="Red">Referer</font>逻辑符号</td><td>请输入内容,512个字符以内</td></tr><tr><td>HTTP_METHOD（HTTP请求方法）</td><td>不支持参数</td><td>eq（等于）<br/>neq（不等于）</td><td>请输入方法名称,建议大写</td></tr><tr><td>QUERY_STRING（请求字符串）</td><td>不支持参数</td><td>同匹配字段<font color="Red">请求路径</font>逻辑符号</td><td>请输入内容,512个字符以内</td></tr><tr><td>GET（GET参数值）</td><td>支持参数录入</td><td>contains（包含）<br/>ncontains（不包含）<br/>len_eq（长度等于）<br/>len_gt（长度大于）<br/>len_lt（长度小于）<br/>strprefix（前缀匹配）<br/>strsuffix（后缀匹配）</td><td>请输入内容,512个字符以内</td></tr><tr><td>GET_PARAMS_NAMES（GET参数名）</td><td>不支持参数</td><td>exsit（存在参数）<br/>nexsit（不存在参数）<br/>len_eq（长度等于）<br/>len_gt（长度大于）<br/>len_lt（长度小于）<br/>strprefix（前缀匹配）<br/>strsuffix（后缀匹配）</td><td>请输入内容,512个字符以内</td></tr><tr><td>POST（POST参数值）</td><td>支持参数录入</td><td>同匹配字段<font color="Red">GET参数值</font>逻辑符号</td><td>请输入内容,512个字符以内</td></tr><tr><td>GET_POST_NAMES（POST参数名）</td><td>不支持参数</td><td>同匹配字段<font color="Red">GET参数名</font>逻辑符号</td><td>请输入内容,512个字符以内</td></tr><tr><td>POST_BODY（完整BODY）</td><td>不支持参数</td><td>同匹配字段<font color="Red">请求路径</font>逻辑符号</td><td>请输入BODY内容,512个字符以内</td></tr><tr><td>COOKIE（Cookie）</td><td>不支持参数</td><td>empty（内容为空）<br/>null（不存在）<br/>rematch（正则匹配）</td><td><font color="Red">暂不支持</font></td></tr><tr><td>GET_COOKIES_NAMES（Cookie参数名）</td><td>不支持参数</td><td>同匹配字段<font color="Red">GET参数名</font>逻辑符号</td><td>请输入内容,512个字符以内</td></tr><tr><td>ARGS_COOKIE（Cookie参数值）</td><td>支持参数录入</td><td>同匹配字段<font color="Red">GET参数值</font>逻辑符号</td><td>请输入内容,512个字符以内</td></tr><tr><td>GET_HEADERS_NAMES（Header参数名）</td><td>不支持参数</td><td>exsit（存在参数）<br/>nexsit（不存在参数）<br/>len_eq（长度等于）<br/>len_gt（长度大于）<br/>len_lt（长度小于）<br/>strprefix（前缀匹配）<br/>strsuffix（后缀匹配）<br/>rematch（正则匹配）</td><td>请输入内容,建议小写,512个字符以内</td></tr><tr><td>ARGS_HEADER（Header参数值）</td><td>支持参数录入</td><td>contains（包含）<br/>ncontains（不包含）<br/>len_eq（长度等于）<br/>len_gt（长度大于）<br/>len_lt（长度小于）<br/>strprefix（前缀匹配）<br/>strsuffix（后缀匹配）<br/>rematch（正则匹配）</td><td>请输入内容,512个字符以内</td></tr></tbody></table> | | CompareFunc| 是 | 是 | String | 逻辑符号

逻辑符号一共分为以下几种类型：
    empty （ 内容为空）
    null （不存在）
    eq （ 等于）
    neq （ 不等于）
    contains （ 包含）
    ncontains （ 不包含）
    strprefix （ 前缀匹配）
    strsuffix （ 后缀匹配）
    len_eq （ 长度等于）
    len_gt （ 长度大于）
    len_lt （ 长度小于）
    ipmatch （ 属于）
    ipnmatch （ 不属于）
各匹配字段对应的逻辑符号不同，详见上述匹配字段表格

| | Content| 是 | 是 | String | 匹配内容

目前 当匹配字段为COOKIE（Cookie）时，不需要输入 匹配内容其他都需要

| | Arg| 是 | 是 | String | 匹配参数

配置参数一共分2种类型 不支持参数与支持参数
当匹配字段为以下4个时，匹配参数才能录入，否则不支持该参数
    GET（GET参数值）        
    POST（POST参数值）        
    ARGS_COOKIE（Cookie参数值）        
    ARGS_HEADER（Header参数值）

|

DescribeAntiFakeUrlPaging

DescribeAntiFakeUrl翻页参数

被如下接口引用：

名称	必选	允许NULL	类型	描述
Index	是	否	String	页码
Count	是	否	String	页条目数量

BotItemRequestBotInfo

bot命中信息

被如下接口引用：DescribeBotDetailVersionTwo

名称	必选	允许NULL	类型	描述
BotModule	否	是	String	命中模块
BotFeature	否	是	String	异常特征信息
BotRuleName	否	是	String	命中策略名称
BotScore	否	是	Int64	bot分数
City	否	是	String	ip城市
Country	否	是	String	ip国家
IpType	否	是	String	ip类型
IpOwner	否	是	String	ip所有者
TiInfo	否	是	Array of TiInfo	命中的威胁情报信息
AiInfo	否	是	Array of AiInfo	命中的ai特征信息
AutoStat	否	是	Array of AutoStat	命中的智能统计信息
BotLabel	否	是	String	bot标签
BotRuleId	否	是	String	命中策略Id

DescribeHWInfoData

获取重保护网配置信息数据

被如下接口引用：DescribeHWInfo

名称	必选	允许NULL	类型	描述
HWState	否	是	Uint64	数据状态
Name	否	是	String	名称
ValidDomainNum	否	是	Uint64	有效域名数
TotalDomainNum	否	是	Uint64	总域名数
IpBlackListLimit	否	是	Uint64	IP黑白名单数上限
TotalStatus	否	是	Uint64	总状态
ValidDomainList	否	是	Array of String	有效域名列表
ThreatIntelligence	否	是	ThreatIntelligenceData	威胁情报
AbilityCustomized	否	是	OWASPCustomizedData	防护能力定制
MaxBodyDetect	否	是	MaxBodyDetect	防护深度定制

GoodsDetail

产品明细

被如下接口引用：DescribePrice、GenerateDealsAndPay、ModifyAllGenerateDeals、ModifyApiSecurityGenerateDeals、ModifyBotGenerateDeals、ModifyGenerateDeals

名称	必选	允许NULL	类型	描述
TimeSpan	是	否	Int64	时间间隔
TimeUnit	是	否	String	单位，支持m、y、d
ProductCode	是	否	String	产品码
SubProductCode	是	否	String	二级产品码
Pid	是	否	Int64	计费策略id
ProductInfo	否	是	Array of ProductInfo	waf产品码
InstanceName	否	是	String	waf实例名
ElasticQps	否	是	Int64	QPS数量
FlexBill	否	是	Int64	弹性账单
AutoRenewFlag	否	是	Int64	1:自动续费，0:不自动续费
RealRegion	否	是	Int64	waf购买的实际地域信息
Type	否	是	String	Waf实例对应的二级产品码
LabelTypes	否	是	Array of String	计费细项标签数组
LabelCounts	否	是	Array of Int64	计费细项标签数量，一般和SvLabelType一一对应
CurDeadline	否	是	String	变配使用，实例到期时间
InstanceId	否	是	String	对存在的实例购买bot 或api 安全

LogSort

bot日志列表排序

被如下接口引用：DescribeBotAccessLogTwo

名称	必选	允许NULL	类型	描述
Key	否	否	String	要排序的对象
Value	否	否	Int64	排序方式

ReturnData

API2.0的返回值

被如下接口引用：

名称	必选	允许NULL	类型	描述
Data	是	是	Data	"returnData":{"data":{"AutoRenew":"false"}}

PortItem

防护域名端口配置信息

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

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

MapItem

地图类型

被如下接口引用：DescribeAttackWorldMap

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

CertDomain

包含证书的域名

被如下接口引用：DescribeCertificatedDomain

名称	必选	允许NULL	类型	描述
Domains	是	否	Array of CertDomainItem	客户的域名列表
CertificateId	是	否	String	该域名列表绑定的sslid

BotTCBRule

bot tcb规则

被如下接口引用：

名称	必选	允许NULL	类型	描述
FeedFetcher	是	否	BotTCBRuleItem	botTCB子类型
LinkChecker	是	否	BotTCBRuleItem	botTCB子类型
Marketing	是	否	BotTCBRuleItem	botTCB子类型
ScreenshotCreator	是	否	BotTCBRuleItem	botTCB子类型
SearchEngineBot	是	否	BotTCBRuleItem	botTCB子类型
SiteMonitor	是	否	BotTCBRuleItem	botTCB子类型
SpeedTester	是	否	BotTCBRuleItem	botTCB子类型
Tool	是	否	BotTCBRuleItem	botTCB子类型
Uncategorised	是	否	BotTCBRuleItem	botTCB子类型
VirusScanner	是	否	BotTCBRuleItem	botTCB子类型
VulnerabilityScanner	是	否	BotTCBRuleItem	botTCB子类型
WebScraper	是	否	BotTCBRuleItem	botTCB子类型
Appid	是	否	Uint64	appid
Domain	是	否	String	域名
Timestamp	是	否	Uint64	时间戳