数据结构

AccessFieldValueRatioInfo

DescribeAccessFastAnalysis接口的出参

被如下接口引用：DescribeAccessFastAnalysis。

名称	类型	描述
Count	Integer	日志条数 示例值：100
Ratio	Float	对应的Value值的百分比 示例值：0.2711782671596206
Value	String	字段对应的值 示例值：info

AccessFullTextInfo

DescribeAccessIndex

被如下接口引用：DescribeAccessIndex。

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

AccessHistogramItem

用于接口DescribeAccessHistogram 的出参

被如下接口引用：DescribeAccessHistogram。

名称	类型	描述
Count	Integer	日志条数 示例值：100
BeginTime	Integer	时间，单位ms 示例值：1625387904000

AccessKeyValueInfo

用于 DescribeAccessIndex 的出参

被如下接口引用：DescribeAccessIndex。

名称	类型	描述
Key	String	需要配置键值或者元字段索引的字段 示例值："method"
Value	AccessValueInfo	字段的索引描述信息 示例值：{"Type":"text","Tokenizer":"token","SqlFlag":true,"ContainZH":false}

AccessLogInfo

单条日志数据描述

被如下接口引用：SearchAccessLog。

名称	类型	描述
Time	Integer	日志时间，单位ms 示例值：1625395948532
TopicId	String	日志主题ID 示例值："1ae37c76-df99-4e2b-998c-20f39eba6226"
TopicName	String	日志主题名称 示例值：waf-topic
Source	String	日志来源IP 示例值：1.1.1.1
FileName	String	日志文件名称 示例值：name
PkgId	String	日志上报请求包的ID 示例值：pkg
PkgLogId	String	请求包内日志的ID 示例值：log-id
LogJson	String	日志内容的Json序列化字符串 注意：此字段可能返回 null，表示取不到有效值。 示例值："{"ipinfo_province":"共享地址","schema":"http","referer":\

AccessRuleInfo

DescribeAccessIndex接口的出参数

被如下接口引用：DescribeAccessIndex。

名称	类型	描述
FullText	AccessFullTextInfo	全文索引配置 注意：此字段可能返回 null，表示取不到有效值。 示例值：{"CaseSensitive":false,"Tokenizer":"token","ContainZH":false}
KeyValue	AccessRuleKeyValueInfo	键值索引配置 注意：此字段可能返回 null，表示取不到有效值。 示例值：{"CaseSensitive":false,"KeyValues":[{"Key":"bot_action","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"bot_ai","Value":{"Type":"long","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"bot_label","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"bot_module","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"bot_scene_id","Value":{"Type":"text","Tokenizer":"","SqlFlag":false,"ContainZH":false}},{"Key":"bot_score","Value":{"Type":"long","Tokenizer":"","SqlFlag":false,"ContainZH":false}},{"Key":"bot_stat","Value":{"Type":"long","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"bot_ti_tags","Value":{"Type":"text","Tokenizer":"","SqlFlag":false,"ContainZH":false}},{"Key":"bot_token","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"bot_ua","Value":{"Type":"long","Tokenizer":"","SqlFlag":false,"ContainZH":false}},{"Key":"bytes_sent","Value":{"Type":"long","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"client","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"cookie","Value":{"Type":"text","Tokenizer":"","SqlFlag":false,"ContainZH":false}},{"Key":"domain","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"headers","Value":{"Type":"text","Tokenizer":"","SqlFlag":false,"ContainZH":false}},{"Key":"host","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"instance","Value":{"Type":"text","Tokenizer":"","SqlFlag":false,"ContainZH":false}},{"Key":"ipinfo_city","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"ipinfo_isp","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"ipinfo_nation","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"ipinfo_province","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"ipinfo_state","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"method","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"query","Value":{"Type":"text","Tokenizer":"","SqlFlag":false,"ContainZH":false}},{"Key":"referer","Value":{"Type":"text","Tokenizer":"","SqlFlag":false,"ContainZH":false}},{"Key":"request_time","Value":{"Type":"double","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"schema","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"sec_chain","Value":{"Type":"text","Tokenizer":"","SqlFlag":false,"ContainZH":false}},{"Key":"status","Value":{"Type":"long","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"ua_goodbot","Value":{"Type":"long","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"ua_type","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"upstream","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"upstream_connect_time","Value":{"Type":"double","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"upstream_response_time","Value":{"Type":"double","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"upstream_status","Value":{"Type":"long","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"url","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"user_agent","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"uuid","Value":{"Type":"text","Tokenizer":"","SqlFlag":false,"ContainZH":false}},{"Key":"x_forwarded_for","Value":{"Type":"text","Tokenizer":"","SqlFlag":false,"ContainZH":false}}]}
Tag	AccessRuleTagInfo	元字段索引配置 注意：此字段可能返回 null，表示取不到有效值。 示例值：{"CaseSensitive":false}

AccessRuleKeyValueInfo

DescribeAccessIndex接口的出参

被如下接口引用：DescribeAccessIndex。

名称	类型	描述
CaseSensitive	Boolean	是否大小写敏感 示例值：false
KeyValues	Array of AccessKeyValueInfo	需要建立索引的键值对信息；最大只能配置100个键值对 示例值：[{"Key":"method"}]

AccessRuleTagInfo

DescribeAccessIndex接口的出参

被如下接口引用：DescribeAccessIndex。

名称	类型	描述
CaseSensitive	Boolean	是否大小写敏感 示例值：false
KeyValues	Array of AccessKeyValueInfo	标签索引配置中的字段信息 示例值：[{"Key":"bot_action","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"bot_ai","Value":{"Type":"long","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"bot_label","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"bot_module","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"bot_scene_id","Value":{"Type":"text","Tokenizer":"","SqlFlag":false,"ContainZH":false}},{"Key":"bot_score","Value":{"Type":"long","Tokenizer":"","SqlFlag":false,"ContainZH":false}},{"Key":"bot_stat","Value":{"Type":"long","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"bot_ti_tags","Value":{"Type":"text","Tokenizer":"","SqlFlag":false,"ContainZH":false}},{"Key":"bot_token","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"bot_ua","Value":{"Type":"long","Tokenizer":"","SqlFlag":false,"ContainZH":false}},{"Key":"bytes_sent","Value":{"Type":"long","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"client","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"cookie","Value":{"Type":"text","Tokenizer":"","SqlFlag":false,"ContainZH":false}},{"Key":"domain","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"headers","Value":{"Type":"text","Tokenizer":"","SqlFlag":false,"ContainZH":false}},{"Key":"host","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"instance","Value":{"Type":"text","Tokenizer":"","SqlFlag":false,"ContainZH":false}},{"Key":"ipinfo_city","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"ipinfo_isp","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"ipinfo_nation","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"ipinfo_province","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"ipinfo_state","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"method","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"query","Value":{"Type":"text","Tokenizer":"","SqlFlag":false,"ContainZH":false}},{"Key":"referer","Value":{"Type":"text","Tokenizer":"","SqlFlag":false,"ContainZH":false}},{"Key":"request_time","Value":{"Type":"double","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"schema","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"sec_chain","Value":{"Type":"text","Tokenizer":"","SqlFlag":false,"ContainZH":false}},{"Key":"status","Value":{"Type":"long","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"ua_goodbot","Value":{"Type":"long","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"ua_type","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"upstream","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"upstream_connect_time","Value":{"Type":"double","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"upstream_response_time","Value":{"Type":"double","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"upstream_status","Value":{"Type":"long","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"url","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"user_agent","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"uuid","Value":{"Type":"text","Tokenizer":"","SqlFlag":false,"ContainZH":false}},{"Key":"x_forwarded_for","Value":{"Type":"text","Tokenizer":"","SqlFlag":false,"ContainZH":false}}]

AccessValueInfo

用于DescribeAccessIndex接口的出参

被如下接口引用：DescribeAccessIndex。

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

ApiAsset

api列表

被如下接口引用：DescribeApiListVersionTwo。

名称	类型	描述
Domain	String	域名 示例值：qcloudwaf.com
Method	String	请求方法 示例值：GET
ApiName	String	api名称 示例值：/user/login
Scene	String	场景 示例值：login
Label	Array of String	数据标签 示例值：["date","phone_num"]
Active	Boolean	过去7天是否活跃 示例值：true,false
Timestamp	Integer	最近更新时间 示例值：121312312
InsertTime	Integer	api发现时间 示例值：121312312
Mode	String	资产状态，1:新发现，2，确认中，3，已确认，4，已下线，5，已忽略 示例值：1
Level	String	风险等级，100,200,300对应低中高 示例值：100
Count	Integer	近30天调用量 示例值：10
Remark	String	备注 示例值：cesi
IsAuth	Integer	是否鉴权，1标识是，0表示否 示例值：1
ApiRequestRuleId	Integer	如果添加了api入参检测规则，则此id返回值不为0 示例值：23423432
ApiLimitRuleId	Integer	如果添加了api限流规则，则此id返回值不为0 示例值：234234
HostList	Array of String	对象接入和泛域名接入时，展示host列表 示例值：["aaa.test.com"]

ApiDataFilter

api资产列表过滤器

被如下接口引用：DescribeApiListVersionTwo。

名称	类型	必选	描述
Entity	String	是	数据标签，是否活跃，功能场景 示例值：label,active, scene
Operator	String	是	等于 示例值：=
Value	String	是	日期，手机号，邮箱等 示例值：date,phone_num,emain

ApiDetailSampleHistory

api历史样例返回结构体

被如下接口引用：DescribeApiDetail。

名称	类型	必选	描述
SampleNme	String	否	样例名称 示例值：ddp1
RepLog	String	否	请求样例 示例值：{"asda"}
RspLog	String	否	响应样例 示例值：{"rsp"}

ApiParameterType

api请求参数类型

被如下接口引用：DescribeApiDetail。

名称	类型	描述
ParameterName	String	参数名称 示例值：user_id
Type	String	参数类型 示例值：int
Location	String	参数位置 示例值：Header
Label	Array of String	数据标签(敏感字段) 示例值：phone_num
Timestamp	Integer	时间戳 示例值：3242324
Remark	String	备注信息 示例值：备注信息
Source	String	来源是请求或者响应 示例值：request or response
IsPan	Integer	是否需要泛化 ，0表示不需要，1表示需要 示例值：0
IsAuth	Integer	是否鉴权，1表示是，0表示否 示例值：1

ApiPkg

API安全资源信息

被如下接口引用：DescribeInstances。

名称	类型	必选	描述
ResourceIds	String	否	资源id 示例值：sada
Status	Integer	否	状态 示例值：1
Region	Integer	否	地域 示例值：1
BeginTime	String	否	开始时间 示例值：2021-01-05
EndTime	String	否	结束时间 示例值：2021-01-05
InquireNum	Integer	否	申请数量 示例值：1
UsedNum	Integer	否	使用数量 示例值：0
RenewFlag	Integer	否	续费标志 示例值：1
BillingItem	String	否	计费项 示例值：sv_wsm_waf_scene_major_events_basic
IsAPISecurityTrial	Integer	否	api安全7天试用标识。1试用。0没试用 示例值：1

ApiSecKey

api列表

被如下接口引用：ModifyApiSecEventChange。

名称	类型	必选	描述
ApiName	String	是	api名称 示例值：waf
Domain	String	是	域名 示例值：qcloudwaf.com
Method	String	是	请求方法 示例值：POST

AttackLogInfo

攻击日志详情

被如下接口引用：SearchAttackLog。

名称	类型	描述
Content	String	攻击日志的详情内容 示例值：cont
FileName	String	CLS返回内容 示例值：name
Source	String	CLS返回内容 示例值：src
TimeStamp	Timestamp	CLS返回内容 示例值：2023-11-15 19:23:06

AutoDenyDetail

Waf 攻击自动封禁详情

被如下接口引用：DescribeWafAutoDenyStatus。

名称	类型	必选	描述
AttackTags	Array of String	是	攻击封禁类型标签 示例值：idc
AttackThreshold	Integer	是	攻击次数阈值 示例值：1
DefenseStatus	Integer	是	自动封禁状态 示例值：1
TimeThreshold	Integer	是	攻击时间阈值 示例值：1
DenyTimeThreshold	Integer	是	自动封禁时间 示例值：1
LastUpdateTime	Timestamp ISO8601	否	最后更新时间 示例值：2023-04-13T15:30:00.000Z

BatchIpAccessControlData

多域名黑白名单describe返回

被如下接口引用：DescribeBatchIpAccessControl。

名称	类型	描述
TotalCount	Integer	总数 示例值：1
Res	Array of BatchIpAccessControlItem	黑白名单条目 示例值：[ { "ActionType": 42, "Ip": "1.1.1.1", "Note": "", "Source": "custom", "TsVersion": 1579074751421, "ValidTs": 1579017599, "Hosts": [ "www.q.com", "www.b.com" ] } ]

BatchIpAccessControlItem

批量多域名黑白名单列表Ip

被如下接口引用：DescribeBatchIpAccessControl。

名称	类型	描述
Id	String	mongo表自增Id 示例值：64f9ad91ca22cf647117e44d
ActionType	Integer	黑名单42或白名单40 示例值：42
Ip	String	黑白名单的IP 示例值：1.1.1.1
Note	String	备注 示例值：备注
Source	String	添加路径 示例值：batch
TsVersion	Integer	修改时间 示例值：1651044385000
ValidTs	Integer	超时时间 示例值：2019571199
Hosts	Array of String	域名列表 示例值："www.a.com","www.b.com"
RuleId	Integer	55101145 示例值：规则ID
IpList	Array of String	IP列表 示例值：["192.168.1.1","10.23.102.1"]
CreateTime	Integer	创建时间 示例值：1651044385000
JobType	String	定时任务类型 示例值：TimedJob
CronType	String	周期任务类型 示例值：week
JobDateTime	JobDateTime	定时任务配置详情 示例值：{ "Timed": [ { "StartDateTime": 0, "EndDateTime": 0 } ], "Cron": null, "TimeTZone": "UTC+8" }
ValidStatus	Integer	生效状态 示例值：1

BotPkg

Bot资源信息

被如下接口引用：DescribeInstances。

名称	类型	必选	描述
ResourceIds	String	否	资源id 示例值：waf_insr3ws8sdbdf833s
Status	Integer	否	状态 示例值：1
Region	Integer	否	地域 示例值：16
BeginTime	String	否	开始时间 示例值：2021-01-05
EndTime	String	否	结束时间 示例值：2021-01-05
InquireNum	Integer	否	申请数量 示例值：1
UsedNum	Integer	否	使用数量 示例值：0
Type	String	否	子产品code 示例值：sp_wsm_waf_bot
RenewFlag	Integer	否	续费标志 示例值：1
BotCPWaf	Integer	否	购买页bot6折 示例值：1
BotNPWaf	Integer	否	控制台买bot5折 示例值：1
IsBotTrial	Integer	否	7天bot试用标识 1 试用 0 没有试用 示例值：1

BotQPS

bot的qps详情

被如下接口引用：DescribeInstances。

名称	类型	必选	描述
ResourceIds	String	是	资源id 示例值：waf_2kuj8hls00b7bo99_bot
ValidTime	String	是	有效时间 示例值：2022-08-11 17:39:53
Count	Integer	是	资源数量 示例值：1
Region	String	是	资源所在地区 示例值：gz
MaxBotQPS	Integer	是	使用qps的最大值 示例值：0
RenewFlag	Integer	是	续费标志 示例值：1

BotStatPointItem

bot的趋势图对象

被如下接口引用：DescribeFlowTrend。

名称	类型	描述
TimeStamp	String	横坐标 示例值：2021-04-22 20:30:00
Key	String	value的所属对象 示例值：/api/cf/v4/user/get-info
Value	Integer	纵列表 示例值：15
Label	String	Key对应的页面展示内容 示例值：/api/cf/v4/user/get-info

CCRuleData

数据封装

被如下接口引用：DescribeCCRule。

名称	类型	描述
Res	Array of CCRuleItem	cc规则 示例值：[ { "Name": "0428CC", "Status": 0, "Advance": 0, "Limit": 60, "Interval": 60, "Url": "/test", "Length": 0, "MatchFunc": 0, "ActionType": 22, "Priority": 50, "ValidTime": 600, "TsVersion": 1715406671183, "CreateTime": 0, "Options": "[]", "RuleId": 1900150355, "EventId": "", "SessionApplied": [] }, { "Name": "0425cc", "Status": 1, "Advance": 0, "Limit": 60, "Interval": 60, "Url": "/def", "Length": 0, "MatchFunc": 0, "ActionType": 26, "Priority": 50, "ValidTime": 600, "TsVersion": 1714293727784, "CreateTime": 0, "Options": "[]", "RuleId": 1900149963, "EventId": "", "SessionApplied": [] } ]
TotalCount	Integer	规则数目 示例值：2

CCRuleItem

cc规则

被如下接口引用：DescribeCCRule。

名称	类型	描述
ActionType	Integer	动作，20表示观察，21表示人机识别，22表示拦截，23表示精准拦截，24表示JS校验 示例值：22
Advance	Integer	高级模式 示例值：1
Interval	Integer	时间周期 示例值：1
Limit	Integer	限制次数 示例值：1
MatchFunc	Integer	匹配方法 示例值：1
Name	String	名称 示例值：test.com
Priority	Integer	优先级 示例值：1
Status	Integer	状态 示例值：1
TsVersion	Integer	更新时间戳 示例值：1
Url	String	匹配url 示例值：/url
ValidTime	Integer	策略动作有效时间 示例值：600
OptionsArr	String	高级参数 示例值：test.com
Length	Integer	url长度 示例值：10
RuleId	Integer	规则ID 示例值：11011
EventId	String	事件id 示例值：api_aaa
SessionApplied	Array of Integer	关联的Session规则 示例值：[0,200000001]
CreateTime	Integer	创建时间 示例值：0

CCRuleItems

CC规则详情

被如下接口引用：DescribeCCRuleList。

名称	类型	描述
Name	String	名字 示例值：ruleItemName
Status	Integer	状态 示例值：0
Advance	Integer	模式 示例值：0
Limit	Integer	限制 示例值：60
Interval	Integer	范围 示例值：60
Url	String	网址 示例值：/ccurl
MatchFunc	Integer	匹配类型 示例值：0
ActionType	Integer	动作，20表示观察，21表示人机识别，22表示拦截，23表示精准拦截，24表示JS校验 示例值：22
Priority	Integer	优先级 示例值：50
ValidTime	Integer	有效时间 示例值：600
TsVersion	Integer	版本 示例值：1715406671183
Options	String	规则详情 示例值："[]"
RuleId	Integer	规则ID 示例值：1900150355
EventId	String	事件id 示例值：0x11101
SessionApplied	Array of Integer	关联的Session规则 示例值：[0,200000001]
CreateTime	Integer	创建时间 示例值：0

CCRuleLists

CC规则总览

被如下接口引用：DescribeCCRuleList。

名称	类型	描述
TotalCount	Integer	总数 示例值：2
Res	Array of CCRuleItems	规则 示例值：[ { "Name": "0428CC", "Status": 0, "Advance": 0, "Limit": 60, "Interval": 60, "Url": "/test", "Length": 0, "MatchFunc": 0, "ActionType": 22, "Priority": 50, "ValidTime": 600, "TsVersion": 1715406671183, "CreateTime": 0, "Options": "[]", "RuleId": 1900150355, "EventId": "", "SessionApplied": [] }, { "Name": "0425cc", "Status": 1, "Advance": 0, "Limit": 60, "Interval": 60, "Url": "/def", "Length": 0, "MatchFunc": 0, "ActionType": 26, "Priority": 50, "ValidTime": 600, "TsVersion": 1714293727784, "CreateTime": 0, "Options": "[]", "RuleId": 1900149963, "EventId": "", "SessionApplied": [] } ]

CacheUrlItems

防篡改url元素

被如下接口引用：DescribeAntiFakeRules。

名称	类型	描述
Id	Integer	标识 示例值：1201
Name	String	名字 示例值：name
Domain	String	域名 示例值：www.test.com
Uri	String	网址 示例值：path
Protocol	String	协议 示例值：http
Status	Integer	状态 示例值：0
ModifyTime	String	修改时间 示例值：2023-11-15 19:23:06
CreateTime	String	创建时间 示例值：2023-11-15 19:23:06

CdcCluster

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

被如下接口引用：DescribeUserCdcClbWafRegions。

名称	类型	必选	描述
Id	String	是	cdc的集群id 示例值："cluster-123456"
Name	String	是	cdc的集群名称 示例值："光明测试环境"

CdcRegion

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

被如下接口引用：DescribeUserCdcClbWafRegions。

名称	类型	必选	描述
Region	String	是	地域 示例值："gz"
Clusters	Array of CdcCluster	是	该地域对应的集群信息 示例值：["cluster-o41khj88"]

ClbDomainsInfo

负载均衡型WAF域名详情

被如下接口引用：DescribeDomainDetailsClb。

名称	类型	描述
Domain	String	域名 示例值：test.qcloud.com
DomainId	String	域名唯一ID 示例值：waf-d4foqwZy
InstanceId	String	域名所属实例ID 示例值：waf_2kxtpov80s9z6skb
InstanceName	String	域名所属实例名 示例值：TEST实例
Edition	String	域名所属实例类型 示例值：clb-waf
IsCdn	Integer	waf前是否部署有七层代理服务。 0：没有部署代理服务 1：有部署代理服务，waf将使用XFF获取客户端IP 2：有部署代理服务，waf将使用remote_addr获取客户端IP 3：有部署代理服务，waf将使用ip_headers中的自定义header获取客户端IP 示例值：1
LoadBalancerSet	Array of LoadBalancerPackageNew	负载均衡类型为clb时，对应的负载均衡器信息 示例值：详见数据结构各字段示例
FlowMode	Integer	负载均衡型WAF的流量模式，1：清洗模式，0：镜像模式 示例值：1
State	Integer	域名绑定负载均衡器状态 示例值：1
AlbType	String	负载均衡类型，clb或者apisix 示例值：clb
IpHeaders	Array of String	IsCdn=3时，表示自定义header 示例值：["x-real-ip"]
CdcClusters	String	cdc-clb-waf类型WAF的CDC集群信息 示例值："cluster-asd"
CloudType	String	云类型:public:公有云；private:私有云;hybrid:混合云 示例值："public”
Note	String	域名备注信息 示例值：备注
Labels	Array of String	域名标签 示例值：["label1","label2"]

ClbObject

Clb类型防护对象

被如下接口引用：DescribeObjects。

名称	类型	描述
ObjectId	String	对象ID 示例值：lb-70mdt3it
InstanceId	String	实例ID 示例值：waf_2kuil2ft02vqm7z3
InstanceName	String	实例名称 示例值：gz-high-level
PreciseDomains	Array of String	精准域名列表 示例值：["zunhua.qcloudwaf.com"]
Status	Integer	WAF功能开关状态，0关闭1开启 示例值：0
ClsStatus	Integer	WAF日志开关状态，0关闭1开启 示例值：0
VirtualDomain	String	CLB对象对应的虚拟域名 示例值：lb-70mdt3it.clb-default.qcloudwaf.com
ObjectName	String	对象名称 示例值：zunhua-multi-tt_pjk1
PublicIp	Array of String	公网地址 示例值：["139.186.100.71"]
PrivateIp	Array of String	内网地址 示例值：["121.123.11.7"]
VpcName	String	VPC名称 示例值：MyonlyWaf-VPC
Vpc	String	VPC ID 示例值：vpc-jl1cw1e8
InstanceLevel	Integer	waf实例等级，如果未绑定实例为0 示例值：3
PostCLSStatus	Integer	clb投递开关 示例值：0
PostCKafkaStatus	Integer	kafka投递开关 示例值：0
Type	String	对象类型：CLB:负载均衡器，TSE:云原生网关 示例值：CLB
Region	String	对象地域 示例值：gz
Proxy	Integer	代理状态: 0:不开启,1:以XFF的第一个IP地址作为客户端IP,2:以remote_addr作为客户端IP,3:从指定的头部字段获取客户端IP，字段通过IpHeaders字段给出 示例值：0
IpHeaders	Array of String	指定获取客户端IP的头部字段列表。IsCdn为3时有效 示例值：["spheader","myheader"]
BotStatus	Integer	bot防护开关 示例值：0
ApiStatus	Integer	api防护开关 示例值：0
ObjectFlowMode	Integer	对象接入模式，0表示镜像模式，1表示清洗模式，2表示体检模式，默认为清洗模式 示例值：0
NumericalVpcId	Integer	数值形式的私有网络 ID 示例值：416562

ClbWafRegionItem

Clb-waf地域信息

被如下接口引用：DescribeUserClbWafRegions。

名称	类型	描述
Id	String	地域ID 示例值："gz"
Text	String	地域中文说明 示例值："广州"
Value	String	地域英文全拼 示例值："ap-guangzhou"
Code	String	地域编码 示例值：“1”

CreateDealsGoods

计费下单接口出入参Goods

被如下接口引用：CreateDeals。

名称	类型	必选	描述
GoodsNum	Integer	是	商品数量 示例值：1
GoodsDetail	CreateDealsGoodsDetail	是	商品明细 示例值：GoodsDetail
GoodsCategoryId	Integer	否	订单类型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(变配) 示例值：101201
RegionId	Integer	否	购买waf实例区域ID 1 表示购买大陆资源; 9表示购买非中国大陆资源 示例值：1

CreateDealsGoodsDetail

产品明细

被如下接口引用：CreateDeals。

名称	类型	必选	描述
TimeSpan	Integer	否	时间间隔 示例值：1
TimeUnit	String	否	单位，支持购买d、m、y 即（日、月、年） 示例值：m
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 示例值：sp_wsm_waf_ultimate_clb
Pid	Integer	否	业务产品申请的pid（对应一个定价公式），通过pid计费查询到定价模型 高级版 ：1000827 企业版 ：1000830 旗舰版 ：1000832 域名包 : 1000834 业务扩展包 : 1000481 高级版-CLB:1001150 企业版-CLB : 1001152 旗舰版-CLB:1001154 域名包-CLB: 1001156 业务扩展包-CLB : 1001160 示例值：1000830
InstanceName	String	否	waf实例名 示例值：waf_122345
AutoRenewFlag	Integer	否	1:自动续费，0:不自动续费 示例值：1
RealRegion	Integer	否	waf购买的实际地域信息 示例值：9
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 业务扩展包 svwsm_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 svwsm_waf_qps_ep_clb 域名扩展包CLB sv_wsm_waf_domain_clb 示例值：["sv_wsm_waf_package_ultimate_clb"]
LabelCounts	Array of Integer	否	计费细项标签数量，一般和SvLabelType一一对应 示例值：[1]
CurDeadline	String	否	变配使用，实例到期时间 示例值：2023-02-28 17:38:59
InstanceId	String	否	对存在的实例购买bot 或api 安全 示例值：waf_swdq23
ResourceId	String	否	资源id 示例值：waf_2kxtlvk40hsvdnw7

CronJob

规则周期执行的数据结构

被如下接口引用：AddAreaBanAreas, AddCustomRule, AddCustomWhiteRule, CreateIpAccessControl, ModifyAreaBanAreas, ModifyCustomRule, ModifyCustomWhiteRule, ModifyIpAccessControl。

名称	类型	必选	描述
Days	Array of Integer	否	每个月的几号执行 示例值：[2, 13]
WDays	Array of Integer	否	每个星期的星期几执行 示例值：[4, 0]
StartTime	String	否	开始时间 示例值：19:21
EndTime	String	否	结束时间 示例值：21:00

DealData

计费下单响应实体

被如下接口引用：CreateDeals, GenerateDealsAndPayNew, ModifyGenerateDeals。

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

DescribeAntiInfoLeakRulesStrategyItem

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

被如下接口引用：DescribeAntiInfoLeakageRules。

名称	类型	描述
Field	String	字段 示例值：information
CompareFunc	String	条件 示例值：contains
Content	String	内容 示例值：bankcard

DescribeAntiLeakageItem

出参

被如下接口引用：DescribeAntiInfoLeakageRules。

名称	类型	描述
RuleId	Integer	规则ID 示例值：1101
Name	String	名称 示例值：lsc
Status	Integer	状态值 示例值：1
Action	String	动作 示例值：1
CreateTime	String	创建时间 示例值："2021-09-18T20:26:06+08:00"
Strategies	Array of DescribeAntiInfoLeakRulesStrategyItem	匹配条件 示例值：[{"Field":"ua","CompareFunc":"rematch","Content":"luffy"}]
Uri	String	匹配的URL 示例值："/test1"
ModifyTime	String	修改时间 示例值："2021-09-18T20:26:06+08:00"

DescribeAreaBanAreasRsp

DescribeAreaBanAreas接口的回包

被如下接口引用：DescribeAreaBanAreas。

名称	类型	描述
Status	String	状态 "0"：未开启地域封禁 "1"：开启地域封禁 示例值："0"
Source	String	数据来源 custom-自定义(默认)、batch-批量防护 示例值：custom
Areas	Array of String	字符串数据，配置的地域列表 示例值：["广州"]
JobType	String	定时任务类型 示例值：TimedJob
JobDateTime	JobDateTime	定时任务详细配置 示例值：{ "Timed": [ { "StartDateTime": 1711618518, "EndDateTime": 1711918518 } ], "Cron": [ { "Day": 12, "WDay": 2, "StartTime": "12:11", "EndTime": "21:00" } ], "TimeTZone": "UTC+8" }
CronType	String	周期任务配置 示例值：week

DescribeCustomRulesRspRuleListItem

DescribeCustomRules接口回包中的复杂类型

被如下接口引用：DescribeCustomRuleList, DescribeCustomWhiteRule。

名称	类型	描述
ActionType	String	动作类型，1代表阻断，2代表人机识别，3代表观察，4代表重定向，5代表JS校验 示例值：1
Bypass	String	跳过的策略 示例值：cc
CreateTime	String	创建时间 示例值：2023-10-09T16:03:14+08:00
ExpireTime	String	过期时间 示例值：2023-10-09T16:03:14+08:00
Name	String	策略名称 示例值：anti
Redirect	String	重定向地址 示例值：/redirect_url
RuleId	String	策略ID 示例值：12211
SortId	String	优先级 示例值：10
Status	String	状态 示例值：0
Strategies	Array of Strategy	策略详情 示例值：[ { "Field": "ARGS_HEADER", "CompareFunc": "rematch", "Content": "W15hLXpBLVowLTktXQ==", "Arg": "x-wx-call-id", "CaseNotSensitive": 0 } ]
EventId	String	事件id 示例值：11102
ModifyTime	String	修改时间 示例值：2023-10-09T16:03:14+08:00
ValidStatus	Integer	生效状态 示例值：1
Source	String	来源 示例值：custom
JobType	String	定时任务类型 示例值：TimedJob
JobDateTime	JobDateTime	定时任务配置信息 示例值：2023-10-09T16:03:14+08:00
CronType	String	周期任务粒度 示例值：week
Label	String	自定义标签，风控规则用，用来表示是内置规则还是用户自定义的 示例值：label
PageId	String	拦截页面id 示例值：1101
Domain	String	域名 示例值：www.test.com

DomainInfo

domain列表

被如下接口引用：DescribeDomains。

名称	类型	必选	描述
Domain	String	是	域名 示例值：randy.qcloudwaf.com
DomainId	String	是	域名ID 示例值：11c88f0f292a5fd4a3002344271367b2
InstanceId	String	是	实例ID 示例值：waf_2kw60jgy0908e8j3
Cname	String	是	cname地址 示例值：dae1cae7d48ec31c7727a86a5c1a2a62.qcloudzygj.com
Edition	String	是	域名所属实例类型。 sparta-waf：SaaS型WAF实例 clb-waf：负载均衡型WAF实例 cdc-clb-waf：CDC环境下负载均衡型WAF实例 示例值：sparta_waf
Region	String	是	地域。 "多伦多": "ca" "广州": "gz" "成都": "cd" "福州": "fzec" "深圳": "szx" "印度": "in" "济南": "jnec" "重庆": "cq" "天津": "tsn" "欧洲东北": "ru" "南京": "nj" "美国硅谷": "usw" "泰国": "th" "广州Open": "gzopen" "深圳金融": "szjr" "法兰克福": "de" "日本": "jp" "弗吉尼亚": "use" "北京": "bj" "中国香港": "hk" "杭州": "hzec" "北京金融": "bjjr" "上海金融": "shjr" "台北": "tpe" "首尔": "kr" "上海": "sh" "新加坡": "sg" "清远": "qy" 示例值：gz
InstanceName	String	是	实例名 示例值：广州主实例
ClsStatus	Integer	是	访问日志开关状态。 0：关闭 1：开启 示例值：1
FlowMode	Integer	是	负载均衡型WAF使用模式。 0：镜像模式 1：清洗模式 示例值：1
Status	Integer	是	waf开关状态。 0：关闭 1：开启 示例值：1
Mode	Integer	是	规则引擎防护模式。 0：观察模式 1：拦截模式 示例值：1
Engine	Integer	是	规则引擎和AI引擎防护模式联合状态。 1:初始状态,规则引擎拦截&&AI引擎未操作开关状态 10：规则引擎观察&&AI引擎关闭模式 11：规则引擎观察&&AI引擎观察模式 12：规则引擎观察&&AI引擎拦截模式 20：规则引擎拦截&&AI引擎关闭模式 21：规则引擎拦截&&AI引擎观察模式 22：规则引擎拦截&&AI引擎拦截模式 示例值：10
CCList	Array of String	是	沙箱集群回源出口IP列表 示例值：["129.101.25.0/24","129.101.20.0/24"]
RsList	Array of String	是	生产集群回源出口IP列表 示例值：["134.175.221.0/24""2402:4e00:1020:1707::/64"]
Ports	Array of PortInfo	是	服务端口配置 示例值：[{"NginxServerId":257856,"Port":"80","Protocol":"http","UpstreamPort":"80","UpstreamProtocol":"http"}]
LoadBalancerSet	Array of LoadBalancerPackageNew	是	负载均衡器相关配置 示例值：[{"ListenerId":"lbl-2ngb9pkz","ListenerName":"evantest.qcloudwaf.com","LoadBalancerId":"lb-3fty24fb","LoadBalancerName":"lb-60da87b4","Protocol":"HTTP","Region":"bj","Vip":"81.70.116.9","Vport":80,"Zone":"ap-beijing-7","NumericalVpcId":1060819,"LoadBalancerType":"OPEN","LoadBalancerDomain":""}]
AppId	Integer	是	用户id 示例值：323345279
State	Integer	是	负载均衡型WAF域名LB监听器状态。 0：操作成功 4：正在绑定LB 6：正在解绑LB 7：解绑LB失败 8：绑定LB失败 10：内部错误 示例值：0
CreateTime	String	否	创建时间 示例值：2018-10-16 08:53:47
Ipv6Status	Integer	否	Ipv6开关状态。 0：关闭 1：开启 示例值：1
BotStatus	Integer	否	BOT开关状态。 0：关闭 1：关闭 2：开启 3：开启 示例值：1
Level	Integer	否	实例版本信息。 101：小微敏捷版 102：小微超轻版 2：高级版 3：企业版 4：旗舰版 6：独享版 示例值：1
PostCLSStatus	Integer	否	投递CLS状态。 0：关闭 1：开启 示例值：1
PostCKafkaStatus	Integer	否	投递CKafka状态。 0：关闭 1：开启 示例值：1
CdcClusters	String	否	cdc实例域名接入的集群信息,非cdc实例忽略。 示例值："cluster-asdfas"
ApiStatus	Integer	否	api安全开关状态。 0：关闭 1：开启 示例值：1
AlbType	String	否	应用型负载均衡类型，默认clb。 clb：七层负载均衡器类型 apisix：apisix网关型 示例值："clb"
SgState	Integer	否	安全组状态。 0：不展示 1：非腾讯云源站 2：安全组绑定失败 3：安全组发生变更 示例值：1
SgDetail	String	否	安全组状态的详细解释 示例值：“因为超出安全组数量，添加失败”
CloudType	String	否	域名云环境。hybrid：混合云域名 public：公有云域名 示例值：public
Note	String	否	域名备注信息 示例值：备注
SrcList	Array of String	否	SAASWAF源站IP列表 示例值：["36.25.14.3","23.25.37.156"]
UpstreamDomainList	Array of String	否	SAASWAF源站域名列表 示例值：["upstream1.com","upstream2.com"]
SgID	String	否	安全组ID 示例值：sg-dasxs1
AccessStatus	Integer	否	clbwaf接入状态 示例值：1
Labels	Array of String	否	域名标签 示例值：["label1","label2"]

DomainPackageNew

waf 域名扩展套餐

被如下接口引用：DescribeInstances。

名称	类型	必选	描述
ResourceIds	String	是	资源ID 示例值：waf_2kw60zgy0908e8j3
ValidTime	String	是	过期时间 示例值：2024-12-01 15:27:23
RenewFlag	Integer	是	是否自动续费，1：自动续费，0：不自动续费 示例值：1
Count	Integer	是	套餐购买个数 示例值：1
Region	String	是	套餐购买地域，clb-waf暂时没有用到 示例值：gz

DomainRuleId

域名-规则id结构体

被如下接口引用：DeleteCustomRule, ModifyCustomRuleStatus。

名称	类型	必选	描述
Domain	String	否	域名 示例值：www.test.com
RuleId	String	否	规则id 示例值：1231

DomainURI

唯一定位Domain

被如下接口引用：ModifyDomainsCLSStatus。

名称	类型	必选	描述
Domain	String	是	域名 示例值：luca.qcloud.com
Edition	String	是	版本 示例值：clb-waf
InstanceID	String	否	实例ID 示例值：waf_2kxu92323432d

DomainsPartInfo

SaaS型WAF域名详情

被如下接口引用：DescribeDomainDetailsSaas。

名称	类型	描述
Domain	String	域名 示例值：randy.qcloudwaf.com
DomainId	String	域名唯一ID 示例值：7d58ebf3db7e5f7e8a9145b0a7c6a7b31
InstanceId	String	域名所属实例唯一ID 示例值：waf_000q6ntyb21sdlk
Edition	String	域名所属实例类型 示例值：sparta-waf
InstanceName	String	域名所属实例名 示例值：防护主实例
Cert	String	证书 示例值：-----BEGIN CERTIFICATE----- xxx -----END CERTIFICATE-----
CreateTime	String	创建时间 示例值：2023-12-04 19:52:24
Engine	Integer	规则引擎和AI引擎防护模式联合状态。 1:初始状态,规则引擎拦截&&AI引擎未操作开关状态 10：规则引擎观察&&AI引擎关闭模式 11：规则引擎观察&&AI引擎观察模式 12：规则引擎观察&&AI引擎拦截模式 20：规则引擎拦截&&AI引擎关闭模式 21：规则引擎拦截&&AI引擎观察模式 22：规则引擎拦截&&AI引擎拦截模式 示例值：10
HttpsRewrite	Integer	是否开启HTTP强制跳转到HTTPS。 0：不强制跳转 1：开启强制跳转 示例值：1
HttpsUpstreamPort	String	HTTPS回源端口 示例值：80
IsCdn	Integer	waf前是否部署有七层代理服务。 0：没有部署代理服务 1：有部署代理服务，waf将使用XFF获取客户端IP 2：有部署代理服务，waf将使用remote_addr获取客户端IP 3：有部署代理服务，waf将使用ip_headers中的自定义header获取客户端IP 示例值：0
IsGray	Integer	是否开启灰度，已废弃。 示例值：1
IsHttp2	Integer	是否开启HTTP2，需要开启HTTPS协议支持。 0：关闭 1：开启 示例值：1
IsWebsocket	Integer	是否开启WebSocket支持。 0：关闭 1：开启 示例值：1
LoadBalance	Integer	回源负载均衡策略。 0：轮询 1：IP hash 2：加权轮询 示例值：0
Mode	Integer	防护模式。 0：观察模式 1：拦截模式 示例值：1
PrivateKey	String	自有证书的私钥 示例值：-----BEGIN RSA PRIVATE KEY----- xxx -----END RSA PRIVATE KEY-----
SSLId	String	CertType为2时，需要填充此参数，表示腾讯云SSL平台托管的证书id 示例值：cKnKQLJ
UpstreamDomain	String	域名回源时的回源域名。UpstreamType为1时，需要填充此字段 示例值：www.qq.com
UpstreamType	Integer	回源类型。 0：通过IP回源 1：通过域名回源 示例值：1
SrcList	Array of String	IP回源时的回源IP列表。UpstreamType为0时，需要填充此字段 示例值：["26.35.125.29","86.236.39.87"]
Ports	Array of PortInfo	域名端口配置 示例值：[{"NginxServerId":231056,"Port":"80","Protocol":"http","UpstreamPort":"80","UpstreamProtocol":"http"},{"NginxServerId":321607,"Port":"443","Protocol":"https","UpstreamPort":"80","UpstreamProtocol":"http"}]
CertType	Integer	证书类型。 0：仅配置HTTP监听端口，没有证书 1：证书来源为自有证书 2：证书来源为托管证书 示例值：1
UpstreamScheme	String	服务配置有HTTPS端口时，HTTPS的回源协议。 http：使用http协议回源，和HttpsUpstreamPort配合使用 https：使用https协议回源 示例值：https
Cls	Integer	日志包是否开启。 0：关闭 1：开启 示例值：1
Cname	String	接入Cname，SaaS型域名使用此Cname进行接入 示例值：940f377475e9155caa96623ccad545a78.qcloudwzgj.com
IsKeepAlive	Integer	是否开启长连接。 0： 短连接 1： 长连接 示例值：1
ActiveCheck	Integer	是否开启主动健康检测。 0：不开启 1：开启 示例值：1
TLSVersion	Integer	TLS版本信息 示例值：1
Ciphers	Array of Integer	自定义的加密套件列表。CipherTemplate为3时需要填此字段，表示自定义的加密套件，值通过DescribeCiphersDetail接口获取。 示例值：[1,2]
CipherTemplate	Integer	加密套件模板。 0：不支持选择，使用默认模板 1：通用型模板 2：安全型模板 3：自定义模板 示例值：0
ProxyReadTimeout	Integer	WAF与源站的读超时时间，默认300s。 示例值：300
ProxySendTimeout	Integer	WAF与源站的写超时时间，默认300s。 示例值：300
SniType	Integer	WAF回源时的SNI类型。 0：关闭SNI，不配置client_hello中的server_name 1：开启SNI，client_hello中的server_name为防护域名 2：开启SNI，SNI为域名回源时的源站域名 3：开启SNI，SNI为自定义域名 示例值：2
SniHost	String	SniType为3时，需要填此参数，表示自定义的SNI； 示例值：randy.testwaf.com
Weights	Array of String	回源IP权重 示例值：[ "1","1" ]
IpHeaders	Array of String	IsCdn=3时，表示自定义header 示例值：["x-real-ip"]
XFFReset	Integer	是否开启XFF重置。 0：关闭 1：开启 示例值：0
Note	String	域名备注信息 示例值：备注
UpstreamHost	String	自定义回源Host。默认为空字符串，表示使用防护域名作为回源Host。 示例值：www.qq.com
Level	String	防护规则 示例值：10
ProxyBuffer	Integer	是否开启缓存 0-关闭 1-开启 示例值：0
GmType	Integer	国密选项。0：不开启国密 1：在原有TLS选项的基础上追加支持国密 2：开启国密并仅支持国密客户端访问 示例值：0
GmCertType	Integer	国密证书类型。0：无国密证书 1：证书来源为自有国密证书 2：证书来源为托管国密证书 示例值：0
GmCert	String	GmCertType为1时，需要填充此参数，表示自有国密证书的证书链 示例值：-----BEGIN CERTIFICATE----- xxx -----END CERTIFICATE-----
GmPrivateKey	String	GmCertType为1时，需要填充此参数，表示自有国密证书的私钥 示例值：-----BEGIN PRIVATE KEY----- xxx -----END PRIVATE KEY-----
GmEncCert	String	GmCertType为1时，需要填充此参数，表示自有国密证书的加密证书 示例值：-----BEGIN CERTIFICATE----- xxx -----END CERTIFICATE-----
GmEncPrivateKey	String	GmCertType为1时，需要填充此参数，表示自有国密证书的加密证书的私钥 示例值：-----BEGIN PRIVATE KEY----- xxx -----END PRIVATE KEY-----
GmSSLId	String	GmCertType为2时，需要填充此参数，表示腾讯云SSL平台托管的证书id 示例值：aKnKQLJ
Labels	Array of String	域名标签 示例值：["label1","label2"]
ProbeStatus	Integer	拨测状态。 0: 禁用拨测, 1: 启用拨测 示例值：1

DownloadAttackRecordInfo

下载攻击日志记录数据项

被如下接口引用：GetAttackDownloadRecords。

名称	类型	描述
Id	Integer	记录ID 示例值：1
TaskName	String	下载任务名 示例值：task-name
TaskId	String	任务ID 示例值：task-id
Host	String	域名 示例值：waf.com
Count	Integer	当前下载任务的日志条数 示例值：10
Status	Integer	下载任务运行状态：-1-下载超时，0-下载等待，1-下载完成，2-下载失败，4-正在下载 示例值：1
Url	String	下载文件URL 示例值：/url
CreateTime	Timestamp	创建时间 示例值：2024-10-24 22:15:00
ModifyTime	Timestamp	最后更新修改时间 示例值：2024-10-24 22:15:00
ExpireTime	Timestamp	过期时间 示例值：2024-10-24 22:15:00
TotalCount	Integer	下载任务需下载的日志总条数 示例值：10

ExportAccessInfo

DescribeAccessExports接口

被如下接口引用：DescribeAccessExports。

名称	类型	描述
ExportId	String	日志导出任务ID 示例值："export-61daca5c-f341-4796-aeb3-4f2f598a06c7"
Query	String	日志导出查询语句 示例值：bot:1
FileName	String	日志导出文件名 示例值：name
FileSize	Integer	日志文件大小 示例值：0
Order	String	日志导出时间排序 示例值："desc"
Format	String	日志导出格式 示例值："json"
Count	Integer	日志导出数量 示例值：6221
Status	String	日志下载状态。Processing:导出正在进行中，Complete:导出完成，Failed:导出失败，Expired:日志导出已过期（三天有效期） 示例值："Processing"
From	Integer	日志导出起始时间 示例值：1625395948532
To	Integer	日志导出结束时间 示例值：1626000748532
CosPath	String	日志导出路径 示例值：/path
CreateTime	String	日志导出创建时间 示例值："2021-07-13 19:07:15"

FiltersItemNew

过滤数组

被如下接口引用：DescribeAntiFakeRules, DescribeAntiInfoLeakageRules, DescribeAttackWhiteRule, DescribeBatchIpAccessControl, DescribeCCRuleList, DescribeCustomRuleList, DescribeCustomWhiteRule, DescribeDomains, DescribeInstances, DescribeObjects, DescribeUserSignatureRule。

名称	类型	必选	描述
Name	String	是	字段名； 过滤 子订单号过滤通过name 为：DealName； value为子订单号 示例值：InstanceType
Values	Array of String	是	过滤值 示例值：["clb","saas"]
ExactMatch	Boolean	是	是否精确查找 示例值：true

FindAllDomainDetail

域名列表

被如下接口引用：DescribeFindDomainList。

名称	类型	描述
Appid	Integer	用户id 示例值：1302199257
Domain	String	域名 示例值：yshch.qcloudwaf.com
Ips	Array of String	域名ip 示例值：["127.1.1.1","22.121.13.1"]
FindTime	String	发现时间 示例值："2022-12-30 14:14:52"
InstanceId	String	实例id 示例值："waf_txt6556006u0c11"
DomainId	String	域名id 示例值："waf-i37RmbFW"
Edition	String	waf类型 示例值："clb-waf"
IsWafDomain	Integer	是否接入waf 示例值：1

FraudPkg

业务安全资源信息

被如下接口引用：DescribeInstances。

名称	类型	必选	描述
ResourceIds	String	否	资源id 示例值：waf_insr3ws8sdbdf833s
Status	Integer	否	状态 示例值：1
Region	Integer	否	地域 示例值：1
BeginTime	String	否	开始时间 示例值：2021-01-05
EndTime	String	否	结束时间 示例值：2021-01-05
InquireNum	Integer	否	申请数量 示例值：1
UsedNum	Integer	否	使用数量 示例值：0
RenewFlag	Integer	否	续费标志 示例值：1

GoodNews

计费下单接口出入参Goods

被如下接口引用：GenerateDealsAndPayNew。

名称	类型	必选	描述
GoodsNum	Integer	是	商品数量 示例值：1
GoodsDetail	GoodsDetailNew	是	商品明细 示例值：GoodsDetail
GoodsCategoryId	Integer	否	订单类型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(变配) 示例值：101201
RegionId	Integer	否	购买waf实例区域ID 1 表示购买大陆资源; 9表示购买非中国大陆资源 示例值：1

Goods

计费下单接口出入参Goods

被如下接口引用：ModifyGenerateDeals。

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

GoodsDetail

产品明细

被如下接口引用：ModifyGenerateDeals。

名称	类型	必选	描述
TimeSpan	Integer	是	时间间隔 示例值：1
TimeUnit	String	是	单位，支持m、y、d 示例值：m
ProductCode	String	是	产品码 示例值：p_wsm_waf
SubProductCode	String	是	二级产品码 示例值：sp_wsm_waf_ultimate_clb
Pid	Integer	是	计费策略id 示例值：1066775
ProductInfo	Array of ProductInfo	否	waf产品码 示例值：[{"Name":"n","Value":"v"}]
InstanceName	String	否	waf实例名 示例值：waf_122345
ElasticQps	Integer	否	QPS数量 示例值：1
FlexBill	Integer	否	弹性账单 示例值：10543
AutoRenewFlag	Integer	否	1:自动续费，0:不自动续费 示例值：1
RealRegion	Integer	否	waf购买的实际地域信息 示例值：9
Type	String	否	Waf实例对应的二级产品码 示例值：sp_wsm_waf_ultimate_clb
LabelTypes	Array of String	否	计费细项标签数组 示例值：["sv_wsm_waf_package_ultimate_clb"]
LabelCounts	Array of Integer	否	计费细项标签数量，一般和SvLabelType一一对应 示例值：[1]
CurDeadline	String	否	变配使用，实例到期时间 示例值：2023-02-28 17:38:59
InstanceId	String	否	对存在的实例购买bot 或api 安全 示例值：waf_swdq23

GoodsDetailNew

产品明细

被如下接口引用：GenerateDealsAndPayNew。

名称	类型	必选	描述
TimeSpan	Integer	否	时间间隔 示例值：1
TimeUnit	String	否	单位，支持购买d、m、y 即（日、月、年） 示例值：m
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 示例值：sp_wsm_waf_ultimate_clb
Pid	Integer	否	业务产品申请的pid（对应一个定价公式），通过pid计费查询到定价模型 高级版 ：1000827 企业版 ：1000830 旗舰版 ：1000832 域名包 : 1000834 业务扩展包 : 1000481 高级版-CLB:1001150 企业版-CLB : 1001152 旗舰版-CLB:1001154 域名包-CLB: 1001156 业务扩展包-CLB : 1001160 示例值：1000830
InstanceName	String	否	waf实例名 示例值：waf_122345
AutoRenewFlag	Integer	否	1:自动续费，0:不自动续费 示例值：1
RealRegion	Integer	否	waf购买的实际地域信息 示例值：9
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 业务扩展包 svwsm_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 svwsm_waf_qps_ep_clb 域名扩展包CLB sv_wsm_waf_domain_clb 示例值：["sv_wsm_waf_package_ultimate_clb"]
LabelCounts	Array of Integer	否	计费细项标签数量，一般和SvLabelType一一对应 示例值：[1]
CurDeadline	String	否	变配使用，实例到期时间 示例值：2023-02-28 17:38:59
InstanceId	String	否	对存在的实例购买bot 或api 安全 示例值：waf_swdq23
ResourceId	String	否	资源id 示例值：waf_2kxtlvk40hsvdnw7
MicroVersion	String	否	模式clb-waf或者saas-waf 示例值：clb-waf

HostDel

CLB-WAF删除域名参数

被如下接口引用：DeleteHost。

名称	类型	必选	描述
Domain	String	是	域名 示例值："txwafwx.qcloudwaf.com"
DomainId	String	是	域名ID 示例值："waf-SdN1ajkf"
InstanceID	String	否	实例类型 示例值："waf_1xf2vsq6ntyb"

HostRecord

负载均衡型WAF域名信息

被如下接口引用：CreateHost, DescribeHost, DescribeHosts, ModifyHost。

名称	类型	必选	描述
Domain	String	是	域名 示例值："txwafqq.qcloudwaf.com"
DomainId	String	是	域名唯一ID 示例值："waf-Bz0Wntsz"
MainDomain	String	是	主域名，入参时为空 示例值："qcloudwaf.com"
Mode	Integer	是	规则引擎防护模式。 0：观察模式 1：拦截模式 示例值：1
Status	Integer	是	waf和负载均衡器的绑定关系。 0：未绑定 1：已绑定 示例值：1
State	Integer	是	clbwaf域名监听器状态。 0：操作成功 4：正在绑定LB 6：正在解绑LB 7：解绑LB失败 8：绑定LB失败 10：内部错误 示例值：1
Engine	Integer	是	规则引擎和AI引擎防护模式联合状态。 1:初始状态,规则引擎拦截&&AI引擎未操作开关状态 10：规则引擎观察&&AI引擎关闭模式 11：规则引擎观察&&AI引擎观察模式 12：规则引擎观察&&AI引擎拦截模式 20：规则引擎拦截&&AI引擎关闭模式 21：规则引擎拦截&&AI引擎观察模式 22：规则引擎拦截&&AI引擎拦截模式 示例值：20
IsCdn	Integer	是	waf前是否部署有七层代理服务。 0：没有部署代理服务 1：有部署代理服务，waf将使用XFF获取客户端IP 2：有部署代理服务，waf将使用remote_addr获取客户端IP 3：有部署代理服务，waf将使用ip_headers中的自定义header获取客户端IP 示例值：0
LoadBalancerSet	Array of LoadBalancer	是	绑定的负载均衡器信息列表 示例值：[ { "Protocol": "HTTP", "Zone": "1", "Region": "cd", "LoadBalancerName": "80lb", "ListenerId": "lbl-2k0gmnv1", "Vip": "112.12.2.5", "ListenerName": "80http", "LoadBalancerId": "lb-mhb5j9gt", "Vport": "80" } ]
Region	String	是	域名绑定的LB的地域，以逗号分割多个地域 示例值："gz"
Edition	String	是	域名所属实例类型。负载均衡型WAF为"clb-waf" 示例值："clb-waf"
FlowMode	Integer	是	负载均衡型WAF域名的流量模式。 1：清洗模式 0：镜像模式 示例值：1
ClsStatus	Integer	是	是否开启访问日志。 1：开启 0：关闭 示例值：1
Level	Integer	否	防护等级，可选值100,200,300 示例值：100
CdcClusters	Array of String	否	域名需要下发到的cdc集群列表。仅CDC场景下填充 示例值：["cluster-o41khj88"," cluster-o41khj99"]
AlbType	String	否	应用型负载均衡类型，默认clb。 clb：七层负载均衡器类型 apisix：apisix网关型 tsegw：云原生API网关 scf：云函数 示例值：clb
IpHeaders	Array of String	否	IsCdn=3时，需要填此参数，表示自定义header 示例值：["x-real-ip"]
EngineType	Integer	否	规则引擎类型。 1: menshen 2: tiga 示例值：1
CloudType	String	否	云类型。 public:公有云 private:私有云 hybrid:混合云 示例值："public"
Note	String	否	域名备注信息 示例值：备注

HostStatus

设置WAF状态的结构体

被如下接口引用：ModifyHostStatus。

名称	类型	必选	描述
Domain	String	是	域名 示例值："test.qcloudwaf.com"
DomainId	String	是	域名ID 示例值："waf_011ntyb"
Status	Integer	是	WAF的开关，1：开，0：关 示例值：1
InstanceID	String	否	实例ID 示例值："waf_000q6ntyb"

HybridPkg

混合云节点资源信息

被如下接口引用：DescribeInstances。

名称	类型	必选	描述
ResourceIds	String	否	资源id 示例值：sada
Status	Integer	否	状态 示例值：1
Region	Integer	否	地域 示例值：1
BeginTime	String	否	开始时间 示例值：2021-01-05
EndTime	String	否	结束时间 示例值：2021-01-05
InquireNum	Integer	否	申请数量 示例值：1
UsedNum	Integer	否	使用数量 示例值：0
RenewFlag	Integer	否	续费标志 示例值：1

InstanceInfo

一个实例的详细信息

被如下接口引用：DescribeInstances。

名称	类型	必选	描述
InstanceId	String	是	实例唯一ID 示例值：waf_2kufmr9u71ae5dz7
InstanceName	String	是	实例名称 示例值：TEST实例
ResourceIds	String	是	实例对应资源ID，计费使用 示例值：waf_2kufmr9u71ae5dz7
Region	String	是	实例所属地域 示例值：gz
PayMode	Integer	是	付费模式 示例值：1
RenewFlag	Integer	是	自动续费标识。 0：关闭 1：开启 示例值：1
Mode	Integer	是	弹性计费开关。 0：关闭 1：开启 示例值：1
Level	Integer	是	实例套餐版本。 101：小微版 102：超轻版 2：高级版 3：企业版 4：旗舰版 6：独享版 示例值：2
ValidTime	String	是	实例过期时间 示例值：2023-11-15 19:23:06
BeginTime	String	是	实例开始时间 示例值：2023-11-15 19:23:06
DomainCount	Integer	是	已配置域名个数 示例值：4
SubDomainLimit	Integer	是	域名数量上限 示例值：5
MainDomainCount	Integer	是	已配置主域名个数 示例值：4
MainDomainLimit	Integer	是	主域名数量上限 示例值：5
MaxQPS	Integer	是	实例30天内QPS峰值 示例值：10000
QPS	QPSPackageNew	是	qps扩展包信息 示例值：{"ResourceIds":"","ValidTime":"","RenewFlag":0,"Count":0,"Region":"","BillingItem":""}
DomainPkg	DomainPackageNew	是	域名扩展包信息 示例值：{"ResourceIds":"","ValidTime":"","RenewFlag":0,"Count":0,"Region":""}
AppId	Integer	是	用户appid 示例值：129873089
Edition	String	是	clb或saas 示例值：sparta-waf
FraudPkg	FraudPkg	否	业务安全包 示例值：{"ResourceIds":"","Status":0,"Region":0,"BeginTime":"","EndTime":"","InquireNum":0,"UsedNum":0,"RenewFlag":0}
BotPkg	BotPkg	否	Bot资源包 示例值：{"ResourceIds":"waf_2kuil2fm02vqm7z3","Status":1,"Region":1,"BeginTime":"2022-01-05 15:38:04","EndTime":"2022-01-15 15:38:04","Type":"sv_wsm_waf_scene_bot","InquireNum":1,"UsedNum":0,"RenewFlag":0,"BotCPWaf":0,"BotNPWaf":0,"IsBotTrial":0}
BotQPS	BotQPS	否	bot的qps详情 示例值：{"ResourceIds":"","ValidTime":"","Count":0,"Region":"","MaxBotQPS":20,"RenewFlag":0}
ElasticBilling	Integer	否	qps弹性计费上限 示例值：10000
AttackLogPost	Integer	否	攻击日志投递开关 示例值：0
MaxBandwidth	Integer	否	带宽峰值，单位为B/s(字节每秒) 示例值：1024
APISecurity	Integer	否	api安全是否购买 示例值：1
QpsStandard	Integer	否	购买的qps规格 示例值：10000
BandwidthStandard	Integer	否	购买的带宽规格 示例值：500
Status	Integer	否	实例状态 示例值：1
SandboxQps	Integer	否	实例沙箱qps值 示例值：30000
IsAPISecurityTrial	Integer	否	是否api 安全试用 示例值：1
MajorEventsPkg	MajorEventsPkg	否	重保包 示例值：{"ResourceIds":"","Status":0,"Region":0,"BeginTime":"","EndTime":"","InquireNum":0,"UsedNum":0,"BillingItem":"","RenewFlag":0,"HWState":0}
HybridPkg	HybridPkg	否	混合云子节点包 示例值：{"ResourceIds":"","Status":0,"Region":0,"BeginTime":"","EndTime":"","InquireNum":0,"UsedNum":0,"RenewFlag":0}
ApiPkg	ApiPkg	否	API安全资源包 示例值：{"ResourceIds":"waf_2kw60zgy0908e8j3_0_api","Status":1,"Region":1,"BeginTime":"2024-04-23 00:01:51","EndTime":"2024-12-01 00:01:51","InquireNum":1,"UsedNum":0,"BillingItem":"sv_wsm_waf_scene_ent","RenewFlag":1,"APICPWaf":0,"APINPWaf":0,"IsAPISecurityTrial":0}
MiniPkg	MiniPkg	否	小程序安全加速包 示例值：{"ResourceIds":"waf_2kw60zgy0908e8j3_1_mini","Status":1,"Region":1,"BeginTime":"2024-04-11 11:31:01","EndTime":"2024-12-01 11:31:01","Count":5,"BillingItem":"sv_wsm_waf_scene_mini","RenewFlag":1,"AccessAppidNum":4,"DdosThreshold":300,"ElasticMode":1,"ElasticBilling":473000}
MiniQpsStandard	Integer	否	小程序qps规格 示例值：100
MiniMaxQPS	Integer	否	小程序qps峰值 示例值：50
LastQpsExceedTime	String	否	最近一次超量时间 示例值：2023-11-15 19:23:06
MiniExtendPkg	MiniExtendPkg	否	小程序安全接入ID数量扩张包 示例值：{"ResourceIds":"waf_2kw60zgy0908e8j3_0_mini_extend","Status":1,"Region":1,"BeginTime":"2024-05-30 23:35:08","EndTime":"2024-12-01 23:35:08","Count":1,"BillingItem":"sv_wsm_waf_exp_exp","RenewFlag":1}
BillingItem	String	否	计费项 示例值：sv_wsm_waf_package_ultimate
FreeDelayFlag	Integer	否	实例延期释放标识 示例值：1

IpAccessControlData

数据封装

被如下接口引用：DescribeIpAccessControl。

名称	类型	描述
Res	Array of IpAccessControlItem	ip黑白名单 示例值：[ { "Id": "66a341dd8f33c805d65f4765", "RuleId": 5501526871, "IpList": [ "113.108.77.69" ], "ActionType": 42, "Ip": "113.108.77.69", "Note": "", "Source": "custom", "TsVersion": 1721975261208, "CreateTime": 1721975261208, "ValidTs": 2019571199, "JobType": "TimedJob", "JobDateTime": { "Timed": [ { "StartDateTime": 0, "EndDateTime": 0 } ], "Cron": null, "TimeTZone": "UTC+8" }, "CronType": "-", "ValidStatus": 1 }]
TotalCount	Integer	计数 示例值：1

IpAccessControlItem

ip黑白名单

被如下接口引用：DescribeIpAccessControl。

名称	类型	描述
Id	String	mongo表自增Id 示例值：64f9ad91ca22cf647117e44d
ActionType	Integer	动作 示例值：0
Ip	String	ip 示例值：1.1.1.1
Note	String	备注 示例值：备注
Source	String	来源 示例值：batch
TsVersion	Integer	更新时间戳 示例值：1721739582944
ValidTs	Integer	有效截止时间戳 示例值：1719630832
ValidStatus	Integer	生效状态 示例值：0
RuleId	Integer	55000001 示例值：规则ID
IpList	Array of String	IP列表 示例值：["12.65.102.1","102.66.89.0"]
CreateTime	Integer	规则创建时间 示例值：0
JobType	String	定时任务类型 示例值：TimedJob
CronType	String	周期任务类型 示例值：week
JobDateTime	JobDateTime	定时任务配置详情 示例值：{ "Timed": [ { "StartDateTime": 0, "EndDateTime": 1719630832 } ], "Cron": null, "TimeTZone": "UTC+8" }

IpAccessControlParam

IP黑白名单参数结构体，主要用于IP黑白名单的导入。

被如下接口引用：ImportIpAccessControl。

名称	类型	必选	描述
IpList	Array of String	是	IP列表 示例值：["192.168.1.1","192.168.1.2"]
ValidTs	Integer	是	valid_ts为有效日期，值为秒级时间戳（（如1680570420代表2023-04-04 09:07:00）） 示例值：1680570420
ActionType	Integer	是	42为黑名单，40为白名单 示例值：42
Note	String	否	备注 示例值：备注

IpHitItem

ip封堵状态数据

被如下接口引用：DescribeAutoDenyIP, DescribeIpHitItems。

名称	类型	描述
Action	Integer	动作 示例值：32
Category	String	类别 示例值：CC
Ip	String	ip 示例值：192.168.1.1
Name	String	规则名称 示例值：rulename
TsVersion	Integer	时间戳 示例值：1730625888
ValidTs	Integer	有效截止时间戳 示例值：1730625888

IpHitItemsData

封装参数

被如下接口引用：DescribeAutoDenyIP, DescribeIpHitItems。

名称	类型	描述
Res	Array of IpHitItem	数组封装 示例值：[{"Action":32,"Category":"cc","Ip":"192.168.1.1","Name":"name","TsVersion":1730625888,"ValidTs":1730625888}]
TotalCount	Integer	总数目 示例值：1

JobDateTime

规则执行的时间结构体

被如下接口引用：AddAreaBanAreas, AddCustomRule, AddCustomWhiteRule, CreateIpAccessControl, DescribeAreaBanAreas, DescribeBatchIpAccessControl, DescribeCustomRuleList, DescribeCustomWhiteRule, DescribeIpAccessControl, ModifyAreaBanAreas, ModifyCustomRule, ModifyCustomWhiteRule, ModifyIpAccessControl。

名称	类型	必选	描述
Timed	Array of TimedJob	否	定时执行的时间参数 示例值：[{"StartDateTime":1711618518 ,"EndDateTime":1711918518}]
Cron	Array of CronJob	否	周期执行的时间参数 示例值：[{"Day":12,"WDay":2,"StartTime":"12:11","EndTime":"21:00"}]
TimeTZone	String	否	时区 示例值：UTC+8

KVInt

Key-Value的形式，Value为Int

被如下接口引用：DescribeTopAttackDomain。

名称	类型	描述
Key	String	Key 示例值：clbwaf-shjr.qcloudwaf.com
Value	Integer	Value 示例值：93

LoadBalancer

负载均衡的监听器

被如下接口引用：CreateHost, DescribeHost, DescribeHosts, ModifyHost。

名称	类型	必选	描述
LoadBalancerId	String	是	负载均衡LD的ID 示例值：lb-jbtq6mm8
LoadBalancerName	String	是	负载均衡LD的名称 示例值：randy-clb-waf
ListenerId	String	是	负载均衡监听器的ID 示例值：lbl-hw2avhk0
ListenerName	String	是	负载均衡监听器的名称 示例值：waftest
Vip	String	是	负载均衡实例的IP 示例值：136.51.67.104
Vport	Integer	是	负载均衡实例的端口 示例值：80
Region	String	是	负载均衡LD的地域 示例值：gz
Protocol	String	是	监听器协议，http、https 示例值：http
Zone	String	是	负载均衡监听器所在的zone 示例值：ap-guangzhou-3
NumericalVpcId	Integer	否	负载均衡的VPCID，公网为-1，内网按实际填写 示例值：546585
LoadBalancerType	String	否	负载均衡的网络类型。OPEN： 公网 INTERNAL ：内网 示例值：OPEN
LoadBalancerDomain	String	否	负载均衡的域名 示例值：lb-jbtq6mm8-vo1x4syum7jtqz5n.clb.ap-guangzhou.tencentclb.com

LoadBalancerPackageNew

负载均衡器

被如下接口引用：DescribeDomainDetailsClb, DescribeDomains。

名称	类型	必选	描述
ListenerId	String	是	监听id 示例值：lbl-2ngb9pkz
ListenerName	String	是	监听名 示例值：门户
LoadBalancerId	String	是	负载均衡id 示例值：lb-3fty24ab
LoadBalancerName	String	是	负载均衡名 示例值：门户
Protocol	String	是	协议 示例值：HTTP
Region	String	是	地区 "多伦多": "ca", "广州": "gz", "成都": "cd", "福州": "fzec", "深圳": "szx", "印度": "in", "济南": "jnec", "重庆": "cq", "天津": "tsn", "欧洲东北": "ru", "南京": "nj", "美国硅谷": "usw", "泰国": "th", "广州Open": "gzopen", "深圳金融": "szjr", "法兰克福": "de", "日本": "jp", "弗吉尼亚": "use", "北京": "bj", "中国香港": "hk", "杭州": "hzec", "北京金融": "bjjr", "上海金融": "shjr", "台北": "tpe", "首尔": "kr", "上海": "sh", "新加坡": "sg", "清远": "qy" 示例值：gz
Vip	String	是	接入IP 示例值：81.70.116.92
Vport	Integer	是	接入端口 示例值：80
Zone	String	是	地域 示例值：ap-beijing-1
NumericalVpcId	Integer	是	VPCID 示例值：6123
LoadBalancerType	String	是	CLB类型 示例值：open
LoadBalancerDomain	String	否	负载均衡器的域名 示例值：randy.qcloudwaf.com

LogHistogramInfo

攻击日志统计详情

被如下接口引用：GetAttackHistogram。

名称	类型	描述
Count	Integer	日志条数 示例值：10
TimeStamp	Integer	时间戳 示例值：1720616514

MajorEventsPkg

重保防护资源信息

被如下接口引用：DescribeInstances。

名称	类型	必选	描述
ResourceIds	String	否	资源id 示例值：sada
Status	Integer	否	状态 示例值：1
Region	Integer	否	地域 示例值：1
BeginTime	String	否	开始时间 示例值：2021-01-05
EndTime	String	否	结束时间 示例值：2021-01-05
InquireNum	Integer	否	申请数量 示例值：1
UsedNum	Integer	否	使用数量 示例值：0
RenewFlag	Integer	否	续费标志 示例值：1
BillingItem	String	否	计费项 示例值：sv_wsm_waf_scene_major_events_basic
HWState	Integer	否	护网包状态 示例值：1

MiniExtendPkg

小程序安全接入ID扩展资源信息

被如下接口引用：DescribeInstances。

名称	类型	必选	描述
ResourceIds	String	否	资源id 示例值：sada
Status	Integer	否	状态 示例值：1
Region	Integer	否	地域 示例值：1
BeginTime	String	否	开始时间 示例值：2021-01-05
EndTime	String	否	结束时间 示例值：2021-01-05
Count	Integer	否	购买数量 示例值：1
RenewFlag	Integer	否	续费标志 示例值：1
BillingItem	String	否	计费项 示例值：sv_wsm_waf_scene_major_events_basic

MiniPkg

小程序安全资源信息

被如下接口引用：DescribeInstances。

名称	类型	必选	描述
ResourceIds	String	否	资源id 示例值：waf_2kw60zgy0908e8j3_1_mini
Status	Integer	否	状态 示例值：1
Region	Integer	否	地域 示例值：1
BeginTime	String	否	开始时间 示例值：2021-01-05
EndTime	String	否	结束时间 示例值：2021-01-05
Count	Integer	否	购买数量 示例值：1
RenewFlag	Integer	否	续费标志 示例值：1
BillingItem	String	否	计费项 示例值：sv_wsm_waf_scene_major_events_basic

PeakPointsItem

PeakPoints数组项

被如下接口引用：DescribePeakPoints。

名称	类型	描述
Time	Integer	秒级别时间戳 示例值：2
Access	Integer	QPS 示例值：1
Up	Integer	上行带宽峰值，单位B 示例值：4
Down	Integer	下行带宽峰值，单位B 示例值：7
Attack	Integer	Web攻击次数 示例值：8
Cc	Integer	CC攻击次数 示例值：9
BotAccess	Integer	Bot qps 示例值：100
StatusServerError	Integer	WAF返回给客户端状态码5xx次数 示例值：1
StatusClientError	Integer	WAF返回给客户端状态码4xx次数 示例值：1
StatusRedirect	Integer	WAF返回给客户端状态码302次数 示例值：2
StatusOk	Integer	WAF返回给客户端状态码202次数 示例值：3
UpstreamServerError	Integer	源站返回给WAF状态码5xx次数 示例值：4
UpstreamClientError	Integer	源站返回给WAF状态码4xx次数 示例值：5
UpstreamRedirect	Integer	源站返回给WAF状态码302次数 示例值：6
BlackIP	Integer	黑名单次数 示例值：1
Tamper	Integer	防篡改次数 示例值：1
Leak	Integer	信息防泄露次数 示例值：1
ACL	Integer	访问控制 示例值：1
WxAccess	Integer	小程序 qps 示例值：1
WxCount	Integer	小程序请求数 示例值：1
WxUp	Integer	小程序上行带宽峰值，单位B 示例值：1
WxDown	Integer	小程序下行带宽峰值，单位B 示例值：1

PiechartItem

饼图数据类型

被如下接口引用：DescribeAttackType。

名称	类型	描述
Type	String	类型 示例值：attack
Count	Integer	数量 示例值：10

PortInfo

服务端口配置

被如下接口引用：DescribeDomainDetailsSaas, DescribeDomains。

名称	类型	必选	描述
NginxServerId	Integer	是	Nginx的服务器id 示例值：257856
Port	String	是	监听端口配置 示例值：80
Protocol	String	是	与端口对应的协议 示例值：http
UpstreamPort	String	是	回源端口 示例值：80
UpstreamProtocol	String	是	回源协议 示例值：http

PortItem

防护域名端口配置信息

被如下接口引用：AddSpartaProtection, DescribeSpartaProtectionInfo。

名称	类型	必选	描述
Port	String	是	监听端口配置 示例值：80
Protocol	String	是	与Port一一对应，表示端口对应的协议 示例值：http
UpstreamPort	String	是	与Port一一对应, 表示回源端口 示例值：80
UpstreamProtocol	String	是	与Port一一对应, 表示回源协议 示例值：http
NginxServerId	String	是	Nginx的服务器ID,新增域名时填"0" 示例值："0"

ProductInfo

waf产品

被如下接口引用：ModifyGenerateDeals。

名称	类型	必选	描述
Name	String	否	产品名称 示例值：Web应用防火墙
Value	String	否	版本 示例值：旗舰版

QPSPackageNew

clb-waf QPS套餐 New

被如下接口引用：DescribeInstances。

名称	类型	必选	描述
ResourceIds	String	是	资源ID 示例值：waf_000q6ntyb
ValidTime	String	是	过期时间 示例值：2024-12-01 15:27:23
RenewFlag	Integer	是	是否自动续费，1：自动续费，0：不自动续费 示例值：1
Count	Integer	是	套餐购买个数 示例值：1
Region	String	是	套餐购买地域，clb-waf暂时没有用到 示例值：gz
BillingItem	String	否	计费项 示例值：sv_wsm_waf_package_enterprise

QpsData

获取弹性qps的默认相关值

被如下接口引用：GetInstanceQpsLimit。

名称	类型	描述
ElasticBillingDefault	Integer	弹性qps默认值 示例值：3333
ElasticBillingMin	Integer	弹性qps最小值 示例值：100
ElasticBillingMax	Integer	弹性qps最大值 示例值：100000
QPSExtendMax	Integer	业务扩展包最大qps 示例值：10000
QPSExtendIntlMax	Integer	境外业务扩展包最大qps 示例值：10000

ReqUserRule

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

被如下接口引用：ModifyUserSignatureRule, ModifyUserSignatureRuleV2。

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

ResponseCode

响应体的返回码

被如下接口引用：AddCustomRule, AddCustomWhiteRule, DeleteCustomRule, DeleteCustomWhiteRule, DeleteHost, DescribeHostLimit, ModifyCustomRule, ModifyCustomRuleStatus, ModifyCustomWhiteRule, ModifyCustomWhiteRuleStatus, ModifyHostFlowMode, ModifyHostMode, ModifyHostStatus, ModifyWafAutoDenyRules, ModifyWebshellStatus。

名称	类型	描述
Code	String	如果成功则返回Success，失败则返回云api定义的错误码 示例值：Success
Message	String	如果成功则返回Success，失败则返回WAF定义的二级错误码 示例值：Success

Rule

规则列表详情

被如下接口引用：DescribeDomainRules。

名称	类型	必选	描述
Id	Integer	否	规则id 示例值：16
Type	String	否	规则类型 示例值：61
Level	String	否	规则等级 示例值：200
Description	String	否	规则描述 示例值：rule description
CVE	String	否	规则防护的CVE编号 示例值：CVE-2017-3506
Status	Integer	否	规则的状态 示例值：1
ModifyTime	String	否	规则修改的时间 示例值：1730688849
AddTime	String	否	门神规则新增/更新时间 示例值：1730688849

RuleList

规则白名单

被如下接口引用：DescribeDomainWhiteRules。

名称	类型	描述
Id	Integer	规则Id 示例值：1
Rules	Array of Integer	规则列表的id 示例值：1
Url	String	请求url 示例值：path
Function	String	请求的方法 示例值：fun
Time	String	时间戳 示例值：1719994565
Status	Integer	开关状态 示例值：1
CreateTime	String	创建时间 示例值：2023-11-15 19:23:06

ScanIpInfo

扫描ip信息

被如下接口引用：DescribeScanIp。

名称	类型	描述
Bussiness	String	所属业务 示例值：微信小程序安全检测
Target	String	扫描对象 示例值：提审小程序后台服务器
IpList	Array of String	ip列表 示例值：["1.1.1.1","101.226.103.0/25"]
Descibe	String	扫描说明 示例值：微信平台对提审的小程序进行安全检测，以协助开发者提升小程序服务的安全性。
Referer	String	官方公告 示例值：https://developers.weixin.qq.com/community/minihome/doc/0008ea401c89c02cff2d1345051001?blockType=99
UpdateTime	Integer	更新时间 示例值：2024-10-29 09:41:01

SearchItem

接入列表查询复杂条件

被如下接口引用：DescribeHosts。

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

SessionData

参数包装

被如下接口引用：DescribeSession。

名称	类型	描述
Res	Array of SessionItem	session定义 示例值：[{"SessionId": 2000003356,"SessionName": "test-session","Category": "match","KeyOrStartMat": "PHPSESSID=","EndMat": ";","StartOffset": "-1","EndOffset": "-1","Source": "cookie","TsVersion": "1727147589924","SessionInUsed": false,"RelatedRuleID": []}]

SessionItem

session定义

被如下接口引用：DescribeSession。

名称	类型	描述
Category	String	匹配类型 示例值：match
KeyOrStartMat	String	起始模式 示例值：PHPSESSID=
EndMat	String	结束模式 示例值：;
StartOffset	String	起始偏移 示例值：-1
EndOffset	String	结束偏移 示例值：-1
Source	String	数据源 示例值：cookie
TsVersion	String	更新时间戳 示例值：1719988467123
SessionId	Integer	SessionID 示例值：2000003356
SessionName	String	Session名 示例值：test-session
SessionInUsed	Boolean	Session是否正在被启用 示例值：false
RelatedRuleID	Array of Integer	Session关联的CC规则ID 示例值：0

SpartaProtectionPort

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

被如下接口引用：ModifySpartaProtection。

名称	类型	必选	描述
NginxServerId	Integer	是	分配的服务器id 示例值：36582
Port	String	是	端口 示例值：80
Protocol	String	是	协议 示例值：http
UpstreamPort	String	是	后端端口 示例值：80
UpstreamProtocol	String	是	后端协议 示例值：http

Strategy

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

被如下接口引用：AddCustomRule, AddCustomWhiteRule, DescribeCustomRuleList, DescribeCustomWhiteRule, ModifyCustomRule, ModifyCustomWhiteRule。

名称	类型	必选	描述
Field	String	是	匹配字段 匹配字段不同，相应的匹配参数、逻辑符号、匹配内容有所不同具体如下所示： 匹配字段 匹配参数 逻辑符号 匹配内容 IP（来源IP） 不支持参数 ipmatch（匹配） ipnmatch（不匹配） 多个IP以英文逗号隔开,最多20个 IPV6（来源IPv6） 不支持参数 ipmatch（匹配） ipnmatch（不匹配） 支持单个IPV6地址 Referer（Referer） 不支持参数 empty（内容为空） null（不存在） eq（等于） neq（不等于） contains（包含） ncontains（不包含） len_eq（长度等于） len_gt（长度大于） len_lt（长度小于） strprefix（前缀匹配） strsuffix（后缀匹配） rematch（正则匹配） 请输入内容,512个字符以内 URL（请求路径） 不支持参数 eq（等于） neq（不等于） contains（包含） ncontains（不包含） len_eq（长度等于） len_gt（长度大于） len_lt（长度小于） strprefix（前缀匹配） strsuffix（后缀匹配） rematch（正则匹配） 请以/开头,512个字符以内 UserAgent（UserAgent） 不支持参数 同匹配字段Referer逻辑符号 请输入内容,512个字符以内 HTTP_METHOD（HTTP请求方法） 不支持参数 eq（等于） neq（不等于） 请输入方法名称,建议大写 QUERY_STRING（请求字符串） 不支持参数 同匹配字段请求路径逻辑符号 请输入内容,512个字符以内 GET（GET参数值） 支持参数录入 contains（包含） ncontains（不包含） len_eq（长度等于） len_gt（长度大于） len_lt（长度小于） strprefix（前缀匹配） strsuffix（后缀匹配） 请输入内容,512个字符以内 GET_PARAMS_NAMES（GET参数名） 不支持参数 exsit（存在参数） nexsit（不存在参数） len_eq（长度等于） len_gt（长度大于） len_lt（长度小于） strprefix（前缀匹配） strsuffix（后缀匹配） 请输入内容,512个字符以内 POST（POST参数值） 支持参数录入 同匹配字段GET参数值逻辑符号 请输入内容,512个字符以内 GET_POST_NAMES（POST参数名） 不支持参数 同匹配字段GET参数名逻辑符号 请输入内容,512个字符以内 POST_BODY（完整BODY） 不支持参数 同匹配字段请求路径逻辑符号 请输入BODY内容,512个字符以内 COOKIE（Cookie） 不支持参数 empty（内容为空） null（不存在） rematch（正则匹配） 暂不支持 GET_COOKIES_NAMES（Cookie参数名） 不支持参数 同匹配字段GET参数名逻辑符号 请输入内容,512个字符以内 ARGS_COOKIE（Cookie参数值） 支持参数录入 同匹配字段GET参数值逻辑符号 请输入内容,512个字符以内 GET_HEADERS_NAMES（Header参数名） 不支持参数 exsit（存在参数） nexsit（不存在参数） len_eq（长度等于） len_gt（长度大于） len_lt（长度小于） strprefix（前缀匹配） strsuffix（后缀匹配） rematch（正则匹配） 请输入内容,建议小写,512个字符以内 ARGS_HEADER（Header参数值） 支持参数录入 contains（包含） ncontains（不包含） len_eq（长度等于） len_gt（长度大于） len_lt（长度小于） strprefix（前缀匹配） strsuffix（后缀匹配） rematch（正则匹配） 请输入内容,512个字符以内 示例值：IP-来源IP
CompareFunc	String	是	逻辑符号 逻辑符号一共分为以下几种类型： empty （ 内容为空） null （不存在） eq （ 等于） neq （ 不等于） contains （ 包含） ncontains （ 不包含） strprefix （ 前缀匹配） strsuffix （ 后缀匹配） len_eq （ 长度等于） len_gt （ 长度大于） len_lt （ 长度小于） ipmatch （ 属于） ipnmatch （ 不属于） 各匹配字段对应的逻辑符号不同，详见上述匹配字段表格 示例值：contains - 包含
Content	String	是	匹配内容 目前 当匹配字段为COOKIE（Cookie）时，不需要输入 匹配内容其他都需要 示例值：/url
Arg	String	是	匹配参数 配置参数一共分2种类型 不支持参数与支持参数 当匹配字段为以下4个时，匹配参数才能录入，否则不支持该参数 GET（GET参数值） POST（POST参数值） ARGS_COOKIE（Cookie参数值） ARGS_HEADER（Header参数值） 示例值：argvalue
CaseNotSensitive	Integer	否	0：大小写敏感 1：大小写不敏感 示例值：0

StrategyForAntiInfoLeak

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

被如下接口引用：AddAntiInfoLeakRules, ModifyAntiInfoLeakRules。

名称	类型	必选	描述
Field	String	是	匹配条件，returncode（响应码）、keywords（关键字）、information（敏感信息） 示例值：returncode
CompareFunc	String	是	逻辑符号，固定取值为contains 示例值：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时由用户自己输入匹配内容。 示例值：value

TLSCiphers

TLS 加密套件

被如下接口引用：DescribeCiphersDetail。

名称	类型	描述
VersionId	Integer	TLS版本ID 示例值：1
CipherId	Integer	加密套件ID 示例值：1
CipherName	String	加密套件 示例值：TLS_ECDHE_RSA_WITH_AES_MD5

TLSVersion

TLS信息

被如下接口引用：DescribeTlsVersion。

名称	类型	描述
VersionId	Integer	TLSVERSION的ID 示例值：1
VersionName	String	TLSVERSION的NAME 示例值：TLSV1.0

TargetEntity

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

被如下接口引用：ModifyApiAnalyzeStatus。

名称	类型	必选	描述
InstanceId	String	否	实例ID 示例值：waf_xasda
Domain	String	否	域名 示例值：testwaf.com

TigaMainClassMode

Tiga引擎中Mainclass的TypeID和防护模式

被如下接口引用：DescribeProtectionModes。

名称	类型	必选	描述
TypeID	String	否	MainclassID 示例值：010000000
Mode	Integer	否	防护模式，0表示观察，1表示拦截 示例值：0

TimedJob

规则定时任务数据结构

被如下接口引用：AddAreaBanAreas, AddCustomRule, AddCustomWhiteRule, CreateIpAccessControl, ModifyAreaBanAreas, ModifyCustomRule, ModifyCustomWhiteRule, ModifyIpAccessControl。

名称	类型	必选	描述
StartDateTime	Integer	否	开始时间戳，单位为秒 示例值：1711618518
EndDateTime	Integer	否	结束时间戳，单位为秒 示例值：1711618518

UserDomainInfo

saas和clb信息

被如下接口引用：DescribeUserDomainInfo。

名称	类型	描述
Appid	Integer	用户id 示例值：125670321
Domain	String	域名 示例值：randy.qcloudwaf.com
DomainId	String	域名id 示例值：waf-lOu59Dut
InstanceId	String	实例id 示例值：waf_2kze90gy0pkqxp5t
InstanceName	String	实例名 示例值：bj-Default
Edition	String	waf类型 示例值：clb-waf
Level	String	版本 示例值：3
WriteConfig	String	指定域名访问日志字段的开关 示例值：{"EnableBody": 1,"EnableHeaders":1}
Cls	Integer	指定域名是否写cls的开关 1:写 0:不写 示例值：1
CloudType	String	标记是否是混合云接入。hybrid表示混合云接入域名 示例值："hybrid"
AlbType	String	标记clbwaf类型 示例值："clb"
BotStatus	Integer	BOT开关状态 示例值：0
ApiStatus	Integer	API开关状态 示例值：0

UserSignatureRule

用户特征规则描述

被如下接口引用：DescribeUserSignatureRule。

名称	类型	描述
ID	String	特征ID 示例值：010000001
Status	Integer	规则开关 示例值：1
MainClassID	String	主类ID 示例值：010000000
SubClassID	String	子类ID 示例值：000000000
CveID	String	CVE ID 示例值：reference item1 <#BID-28277::http://www.securityfocus.com/bid/28
CreateTime	Timestamp ISO8601	创建时间 示例值：2021-11-24 19:55:55
ModifyTime	Timestamp ISO8601	更新时间 示例值：2021-11-24 19:55:55
MainClassName	String	主类名字，根据Language字段输出中文/英文 示例值：Cross Site Scripting
SubClassName	String	子类名字，根据Language字段输出中文/英文，若子类id为00000000，此字段为空 示例值：Signatures for Database
Description	String	规则描述 示例值：rule description
Reason	Integer	0/1 示例值：reason
RiskLevel	Integer	1: 高危 2:中危 3:低危 示例值：1

UserWhiteRule

用户规则白名单

被如下接口引用：DescribeAttackWhiteRule。

名称	类型	描述
WhiteRuleId	Integer	白名单的id 示例值：1
SignatureId	String	规则id 示例值：010000030
Status	Integer	状态 示例值：1
MatchField	String	匹配域 示例值：URL
MatchParams	String	匹配参数 示例值：params_a
MatchMethod	String	匹配方法 示例值：eq
MatchContent	String	匹配内容 示例值：/api
CreateTime	Timestamp ISO8601	创建时间 示例值：2021-11-19T19:53:53+08:00
ModifyTime	Timestamp ISO8601	修改时间 示例值：2021-11-19T19:53:53+08:00
SignatureIds	Array of String	规则ID列表 示例值：["010000030", "010000031"]
TypeIds	Array of String	大类规则ID列表 示例值：["010000000","020000000"]
TypeId	String	大类规则ID 示例值：010000000
Mode	Integer	0:按照特定规则ID加白, 1:按照规则类型加白 示例值：0
Name	String	规则名 示例值：testRule
MatchInfo	Array of UserWhiteRuleItem	匹配规则列表 示例值：[{"MatchField": "URL","MatchParams": "","MatchMethod": "eq","MatchContent": "/urlvalue"}]
MatchInfoStr	String	MatchInfo字符串 示例值：[{"MatchField":"URL","MatchParams":"","MatchMethod":"eq","MatchContent":"/urlvalue"}]

UserWhiteRuleItem

用户规则白名单规则子项

被如下接口引用：AddAttackWhiteRule, DescribeAttackWhiteRule, ModifyAttackWhiteRule。

名称	类型	必选	描述
MatchField	String	是	匹配域 示例值：URL
MatchMethod	String	是	匹配方法 示例值：eq
MatchContent	String	是	匹配内容 示例值：/api
MatchParams	String	否	匹配参数名 示例值：keya

VipInfo

Vip信息

被如下接口引用：DescribeVipInfo。

名称	类型	描述
Vip	String	VIP地址 示例值：81.69.35.236
InstanceId	String	waf实例id 示例值：waf_ina46sf56saghf1
InstanceCreateTime	Timestamp ISO8601	创建时间 示例值：2022-10-31T19:18:19+08:00
Region	String	地域 示例值：ap-guangzhou
RegionId	Integer	地域ID 示例值：1
ISP	String	ip运营商类型 示例值：BGP
VipType	String	ip类型 示例值：ipv4
AddressName	String	域名信息 示例值：6f4389f9e386da9b-cl2.qcloudwaf.com

WafRuleLimit

waf模块的规格

被如下接口引用：DescribeRuleLimit。

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

WafThreatenIntelligenceDetails

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

被如下接口引用：DescribeWafThreatenIntelligence, ModifyWafThreatenIntelligence。

名称	类型	必选	描述
Tags	Array of String	否	封禁属性标签 示例值：tags
DefenseStatus	Integer	否	封禁模组启用状态 示例值：[11101,1109]
LastUpdateTime	Timestamp ISO8601	否	最后更新时间 示例值：2023-04-13T15:30:00.000Z

WebshellStatus

域名的webshell开启状态

被如下接口引用：ModifyWebshellStatus。

名称	类型	必选	描述
Domain	String	是	域名 示例值：www.test.com
Status	Integer	是	webshell开关，1：开。0：关。2：观察 示例值：1