数据结构
最近更新时间: 2024-10-18 10:38:29
BotListScore
拨通列表得分字段
被如下接口引用：DescribeBotTCBRecords、DescribeBotUBRecords、DescribeBotUCBRecords
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Total | 是 | 否 | Int64 | 得分 |
BotUCBPreinstallRuleData
BotUCBPreinstallRule封装
被如下接口引用：DescribeBotUCBPreinstallRule
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Res | 是 | 否 | Array of BotUCBPreinstallRule | 参数封装 |
DomainBotStatusData
封装参数
被如下接口引用：DescribeBotStatus
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Res | 是 | 否 | Array of DomainBotStatus | 数据 |
StrategyForAntiInfoLeak
防信息泄露的匹配条件结构体
被如下接口引用：AddAntiInfoLeakRules、ModifyAntiInfoLeakRules
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Field | 是 | 否 | String | 匹配字段 |
| CompareFunc | 是 | 否 | String | 逻辑符号 |
| Content | 是 | 否 | String | 匹配内容 |
CopyBotsUCBFeatureRuleRsp
CopyBotsUCBFeatureRule的返回值
被如下接口引用：CopyBotUCBFeatureRules
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Code | 是 | 否 | Int64 | 0表示成功，其他表示失败 |
| ErrMsg | 是 | 否 | String | 错误信息 |
| SuccessNum | 是 | 否 | Int64 | 成功的数目 |
| FailedNum | 是 | 否 | Int64 | 失败的数目 |
| T | 是 | 否 | Array of String | 成功的域名列表 |
BotUCBPreinstallRule
bot内置类型自定义策略
被如下接口引用：DescribeBotUCBPreinstallRule
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 动作 |
| AdditionArg | 是 | 否 | String | 附加参数 |
| Name | 是 | 否 | String | 名称 |
| OnOff | 是 | 否 | String | 开关 |
| Timestamp | 是 | 否 | Uint64 | 时间戳 |
| ValidTime | 是 | 否 | Uint64 | 有效时间 |
Data
API2.0的返回参数
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AutoRenew | 是 | 否 | String | {"data":{"AutoRenew":"false"}}} |
SessionItem
session定义
被如下接口引用：DescribeSession
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Category | 是 | 否 | String | 匹配类型 |
| KeyOrStartMat | 是 | 否 | String | 起始模式 |
| EndMat | 是 | 否 | String | 结束模式 |
| StartOffset | 是 | 否 | String | 起始偏移 |
| EndOffset | 是 | 否 | String | 结束偏移 |
| Source | 是 | 否 | String | 数据源 |
| TsVersion | 是 | 否 | String | 更新时间戳 |
MenshenDomainWhiteRule
门神-白名单规则列表
被如下接口引用：DescribeDomainWhiteRules
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 是 | Uint64 | Id |
| Rules | 是 | 是 | Array of Uint64 | 规则id列表 |
| Url | 是 | 是 | String | 地址 |
| Function | 是 | 是 | String | 比较方法 |
| Status | 是 | 是 | Uint64 | 状态 |
| Time | 是 | 是 | Datetime | 时间 |
SearchItem
接入列表查询复杂条件
被如下接口引用：DescribeHosts
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ClsStatus | 否 | 否 | String | 日志开关 |
| Status | 否 | 否 | String | waf开关 |
| FlowMode | 否 | 否 | String | 流量模式 |
AppIdDetail
clb-waf AppId对应的详情
被如下接口引用：DescribeUserInfo
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Level | 是 | 否 | Uint64 | 套餐版本，跟saas保持一致 |
| AutoRenew | 是 | 否 | Uint64 | 是否自动续费，1：自动续费，0：不自动续费 |
| BeginTime | 是 | 否 | String | 套餐的购买时间 |
| Cls | 是 | 是 | ClsPackage | 购买的日志套餐 |
| ValidTime | 是 | 否 | String | 过期时间 |
| DomainLimit | 是 | 否 | Uint64 | 套餐子域名限制个数 |
| DomainCount | 是 | 否 | Uint64 | 套餐子域名已经使用的个数 |
| MainDomainCount | 是 | 否 | Uint64 | 套餐主域名已经使用的个数 |
| MainDomainLimit | 是 | 否 | Uint64 | 套餐主域名限制个数 |
| RegionLimit | 是 | 否 | Uint64 | 套餐的地域限制个数 |
| LbLimit | 是 | 否 | Uint64 | 套餐的监听器限制个数 |
| QPS | 是 | 是 | QPSPackage | 购买的QPS套餐 |
| MaxQPS | 是 | 否 | Uint64 | 当前的QPS峰值 |
| ResourceIds | 是 | 否 | String | 资源ID |
| Type | 是 | 是 | String | 暂时未用到 |
| DomainPkg | 是 | 是 | DomainPackage | 购买的域名套餐 |
| AllowRegions | 是 | 是 | String | 账号开通了clbwaf的地域白名单，如果为空则表示开通了全部地域，否则则开通的地域以,串接。 |
| CCGuardRegions | 是 | 是 | String | 账号开通了clbwaf的清洗模式的地域白名单，如果为空则表示没有地域开启了清洗模式，否则则开通的地域以,串接。 |
DomainBotStatus
DomainBotStatus
被如下接口引用：DescribeBotStatus
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Category | 是 | 否 | String | 类别 |
| Domain | 是 | 否 | String | 域名 |
| Status | 是 | 否 | Uint64 | 状态 |
CacheUrlItem
防篡改url元素
被如下接口引用：DescribeAntiFakeUrl
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 否 | String | Id |
| Name | 是 | 否 | String | 名称 |
| Domain | 是 | 否 | String | 域名 |
| Uri | 是 | 否 | String | uri |
| Protocol | 是 | 否 | String | 协议 |
| Status | 是 | 否 | String | 状态 |
Protection
域名配置信息
被如下接口引用：DescribeSpartaProtectionList
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Domain | 是 | 否 | String | 域名 |
| DomainId | 是 | 否 | String | 域名Id |
| Cname | 是 | 否 | String | cname地址 |
| Status | 是 | 否 | String | waf开关 0表示关闭, 1表示开启 |
| State | 是 | 否 | String | 防护状况：0 正常防护 1 未检测到流量 2 即将到期 3 已到期 |
| CreateTime | 是 | 否 | String | 域名创建时间 |
| Mode | 是 | 否 | String | 防御模式 |
| Engine | 是 | 否 | String | AI防御模式 |
| Vip | 是 | 否 | Array of String | 接入IP列表 |
| IsGray | 是 | 否 | String | 灰度标识，1灰度0不灰度 |
| GrayAreas | 是 | 否 | Array of String | 灰度区域，不灰传no |
| CertType | 是 | 否 | String | 证书类型，1表示自有证书，2表示腾讯云托管证书 |
| Cert | 是 | 否 | String | 证书内容 |
| PrivateKey | 是 | 否 | String | 证书私钥 |
| SSLId | 是 | 否 | String | 腾讯云托管证书id，当certType=2时有效 |
| IsCdn | 是 | 否 | String | 1有cdn，0无cdn |
| IsHttp2 | 是 | 否 | String | 1开启http2，0不开启 |
| IsWebsocket | 是 | 否 | String | 1开启websocket，0不开启 |
| HttpsRewrite | 是 | 否 | String | 是否http强制跳转https，"1" 是、"0" 否 |
| HttpsUpstreamPort | 是 | 否 | String | https回源端口 |
| UpstreamType | 是 | 否 | String | 回源方式，"0"为ip回源，"1"为域名回源 |
| UpstreamDomain | 是 | 否 | String | 回源域名 |
| UpstreamScheme | 是 | 否 | String | 回源协议 |
| Cls | 是 | 否 | String | 日志包 |
| CCList | 是 | 否 | Array of String | CC列表 |
| LoadBalance | 是 | 否 | String | 负载均衡算法，0表示轮询，1表示ip hash，默认为0 |
| Ports | 是 | 否 | Array of PortItem | 服务端口配置 |
| RsList | 是 | 否 | Array of String | 回源ip |
| SrcList | 是 | 否 | Array of String | ip列表 |
UserSignatureRule
用户特征规则描述
被如下接口引用：DescribeUserSignatureRule
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ID | 否 | 否 | String | 特征ID |
| Status | 否 | 否 | Int64 | 规则开关 |
| MainClassID | 否 | 否 | String | 主类ID |
| SubClassID | 否 | 否 | String | 子类ID |
| CveID | 否 | 否 | String | CVE ID |
| CreateTime | 否 | 否 | Datetime_iso | 创建时间 |
| ModifyTime | 否 | 否 | Datetime_iso | 更新时间 |
| MainClassName | 否 | 否 | String | 主类名字，根据Language字段输出中文/英文 |
| SubClassName | 否 | 否 | String | 子类名字，根据Language字段输出中文/英文，若子类id为00000000，此字段为空 |
| Description | 否 | 否 | String | 规则描述 |
IpAccessControlData
数据封装
被如下接口引用：DescribeIpAccessControl
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Res | 是 | 是 | Array of IpAccessControlItem | ip黑白名单 |
| TotalCount | 是 | 否 | Uint64 | 计数 |
PageForDescribeSpartaProtectionList
PageForDescribeSpartaProtectionList接口专用的翻页结构体
被如下接口引用：DescribeSpartaProtectionList
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Count | 是 | 否 | Uint64 | 每页个数 |
| Index | 是 | 否 | Uint64 | 页码 |
RuleUpdateLog
tiga引擎规则更新动态日志
被如下接口引用：DescribeRuleUpdateLog
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 否 | 否 | Uint64 | id值 |
| CreateTime | 否 | 否 | Datetime_iso | 创建时间 |
| ModifyTime | 否 | 否 | Datetime_iso | 修改时间 |
| Detail | 否 | 否 | String | 详细修改动态 |
| Language | 否 | 否 | String | en/cn 描述信息语言 |
| LogVersion | 否 | 否 | String | 版本信息 |
ResponseCode
响应体的返回码
被如下接口引用：DeleteHost、DescribeHostLimit、ModifyHostFlowMode、ModifyHostMode、ModifyHostStatus、ModifyPackageRenew、ModifyWebshellStatus
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Code | 是 | 否 | String | 如果成功则返回Success，失败则返回yunapi定义的错误码 |
| Message | 是 | 否 | String | 如果成功则返回Success，失败则返回WAF定义的二级错误码 |
ActionedIpData
封装数据
被如下接口引用：DescribeActionedIp
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Res | 是 | 是 | Array of ActionedIpItem | ip数据 |
| TotalCount | 是 | 否 | Uint64 | 计数 |
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 | 时间戳 |
QPSPackage
clb-waf QPS套餐
被如下接口引用：DescribeSpartUserInfo、DescribeUserInfo
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ResourceIds | 是 | 否 | String | 资源ID |
| ValidTime | 是 | 否 | String | 过期时间 |
| AutoRenew | 是 | 否 | Int64 | 是否自动续费，1：自动续费，0：不自动续费 |
| Count | 是 | 否 | Int64 | 套餐购买个数 |
| Region | 是 | 否 | String | 套餐购买地域，clb-waf暂时没有用到 |
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 |
ActionedIpItem
ip查询参数
被如下接口引用：DescribeActionedIp
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | Uint64 | 动作 |
| Category | 是 | 否 | String | 类别 |
| Ip | 是 | 否 | String | ip |
| Name | 是 | 否 | String | 策略名称 |
| Note | 是 | 否 | String | 备注 |
| TsVersion | 是 | 否 | Uint64 | 更新时间戳 |
| ValidTs | 是 | 否 | Uint64 | 有效时间戳 |
DNSDetectRecord
DNS劫持检测的记录
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 否 | Uint64 | 记录的ID |
| Domain | 是 | 否 | String | 域名 |
| HijackRecords | 是 | 否 | Uint64 | 被劫持的记录数 |
| HijackRegions | 是 | 否 | Uint64 | 劫持的地域数 |
| CreateTime | 是 | 否 | String | 记录新建时间 |
| AuthIP | 是 | 否 | Array of String | 权威记录数组 |
SubClassItem
子类信息
被如下接口引用：DescribeMainClass
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SubClassID | 否 | 否 | String | 子类id |
| SubClassName | 否 | 否 | String | 子类名字 |
| Description | 否 | 否 | String | 描述 |
CustomPayload
waf自定义载荷
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Category | 是 | 否 | String | 载荷类别 |
| Id | 是 | 否 | String | 数据库id |
| LearnStat | 是 | 否 | String | 学习状态 |
| Remark | 是 | 否 | String | 备注 |
| Source | 是 | 否 | String | 来源 |
| Timestamp | 是 | 否 | Uint64 | 更新时间戳 |
| Value | 是 | 否 | String | 载荷值 |
BotRecordItemRes
bot访问详情序列
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Items | 是 | 否 | String | 访问序列数据 |
DomainPackage
clb-waf 域名扩展套餐
被如下接口引用：DescribeUserInfo
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ResourceIds | 是 | 否 | String | 资源ID |
| ValidTime | 是 | 否 | String | 过期时间 |
| AutoRenew | 是 | 否 | Uint64 | 是否自动续费，1：自动续费，0：不自动续费 |
| Count | 是 | 否 | Uint64 | 套餐购买个数 |
| Region | 是 | 否 | String | 套餐购买地域，clb-waf暂时没有用到 |
AddSpartaWafRuleReqStrategy
自定义参数的策略
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Field | 是 | 否 | String | 匹配字段 |
| CompareFunc | 是 | 否 | String | 匹配参数 |
| Content | 是 | 否 | String | 逻辑符号 |
| Arg | 是 | 否 | String | 匹配内容 |
DescribeAntiInfoLeakRulesStrategyItem
DescribeAntiInfoLeakRules返回的规则元素中的具体的规则元素
被如下接口引用：DescribeAntiInfoLeakRules
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Field | 是 | 否 | String | 字段 |
| CompareFunc | 是 | 否 | String | 条件 |
| Content | 是 | 否 | String | 内容 |
PageInfoForInt
分页参数复杂结构体
被如下接口引用：DescribeDNSDetectDomainList
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| PageNumber | 是 | 否 | Uint64 | 页码 |
| PageSize | 是 | 否 | Uint64 | 每页个数 |
PiechartItem
饼图数据类型
被如下接口引用：DescribeAttackType
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Type | 是 | 否 | String | 类型 |
| Count | 是 | 否 | Uint64 | 数量 |
AttackExportJobInfo
攻击日志导出任务基本信息
被如下接口引用：DescribeExportAttackDetailJobs
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 否 | Uint64 | ID |
| CreateTime | 是 | 否 | Datetime | 创建时间 |
| FileName | 是 | 否 | String | 任务名称 |
| LogsCount | 是 | 否 | Uint64 | 日志总数量 |
| UploadCount | 是 | 否 | Uint64 | 日志已导出数量 |
| UploadProgress | 是 | 否 | String | 日志导出进度 |
| DeleteFlag | 是 | 否 | Uint64 | cos删除标志 0为未删除,1为已删除 |
| ExpiredDays | 是 | 否 | Uint64 | 过期天数 |
| ExpiredTime | 是 | 否 | Datetime | 过期时间 |
| FileDownloadUrl | 是 | 否 | String | cos文件下载地址 |
| TaskType | 是 | 否 | Uint64 | 任务类型 0租户端 1运营端 |
| TaskStatus | 是 | 否 | Uint64 | 任务状态 0、进行中 1、完成 2、失败 |
| QueryParams | 是 | 否 | String | 查询参数 |
| AppId | 是 | 否 | Uint64 | Appid |
| Uin | 是 | 否 | Uint64 | 账号 |
UserWhiteRule
全局规则白名单
被如下接口引用：DescribeUserWhiteRule
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 否 | 否 | Uint64 | 序号 |
| Name | 否 | 否 | String | 规则名称 |
| Domain | 否 | 否 | String | 域名 |
| SignatureId | 否 | 否 | String | 特征序号 |
| Status | 否 | 否 | Uint64 | 规则开关 |
| CreateTime | 否 | 否 | Datetime_iso | 创建时间 |
| ModifyTime | 否 | 否 | Datetime_iso | 修改时间 |
| Rules | 否 | 否 | Array of GlobalWhiteCond | 规则详细 |
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 | 公开类型附加参数 |
RuleVersionData
数组
被如下接口引用：DescribeRuleVersion
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 否 | Int64 | 出参 |
| Appid | 是 | 是 | Int64 | 出参 |
| Version | 是 | 是 | String | 出参 |
| Rules | 是 | 是 | Int64 | 出参 |
| Description | 是 | 是 | String | 出参 |
| CreateTime | 是 | 是 | String | 出参 |
| ModifyTime | 是 | 是 | String | 出参 |
IpHitItemsData
封装参数
被如下接口引用：DescribeIpHitItems
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Res | 是 | 否 | Array of IpHitItem | 数组封装 |
| TotalCount | 是 | 否 | Uint64 | 总数目 |
KVInt
Key-Value的形式，Value为Int
被如下接口引用：DescribeTopAttackDomain
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Key | 是 | 否 | String | Key |
| Value | 是 | 否 | Uint64 | Value |
BotRecordItem
Bot_V2 bot记录访问详情元素结构
被如下接口引用：DescribeBotRecordItems
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Items | 是 | 否 | String | 压缩的字符串 |
MenshenDomainRule
门神域名规则列表
被如下接口引用：DescribeDomainRules
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 是 | Uint64 | Id |
| Type | 是 | 是 | String | 规则类型 |
| Level | 是 | 是 | String | 等级 |
| Description | 是 | 是 | String | 描述 |
| CVE | 是 | 是 | String | CVE |
| Status | 是 | 是 | String | 状态 |
| ModifyTime | 是 | 是 | Datetime | 修改时间 |
| TypeEn | 是 | 是 | String | 规则类型英文 |
| LevelEn | 是 | 是 | String | 等级英文 |
| DescriptionEn | 是 | 是 | String | 描述英文 |
WebshellStatus
域名的webshell开启状态
被如下接口引用：ModifyWebshellStatus
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Domain | 是 | 否 | String | 域名 |
| Status | 是 | 否 | Uint64 | webshell开关，1：开。0：关。2：观察 |
BotTcbRuleData
封装使用
被如下接口引用：DescribeBotTCBRule
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Res | 是 | 否 | Array of String | tcb规则 |
IpAccessControlItem
ip黑白名单
被如下接口引用：DescribeIpAccessControl
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ActionType | 是 | 否 | Uint64 | 动作 |
| Ip | 是 | 否 | String | ip |
| Note | 是 | 否 | String | 备注 |
| Source | 是 | 否 | String | 来源 |
| TsVersion | 是 | 是 | Uint64 | 更新时间戳 |
| ValidTs | 是 | 否 | Uint64 | 有效截止时间戳 |
HostRecord
clb-waf防护域名
被如下接口引用：CreateHost、DescribeHost、DescribeHosts、ModifyHost
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Domain | 是 | 否 | String | 域名 |
| DomainId | 是 | 否 | String | 域名ID |
| MainDomain | 是 | 否 | String | 主域名，入参时为空 |
| Mode | 是 | 否 | Uint64 | waf模式，同saas waf保持一致 |
| Status | 是 | 否 | Uint64 | waf和LD的绑定，0：没有绑定，1：绑定 |
| State | 是 | 否 | Uint64 | 域名状态，0：正常，1：未检测到流量，2：即将过期，3：过期 |
| Engine | 是 | 否 | Uint64 | 使用的规则，同saas waf保持一致 |
| IsCdn | 是 | 否 | Uint64 | 是否开启代理，0：不开启，1：开启 |
| LoadBalancerSet | 是 | 否 | Array of LoadBalancer | 绑定的LB列表 |
| Region | 是 | 否 | String | 域名绑定的LB的地域，以,分割多个地域 |
| Edition | 是 | 否 | String | 产品分类，取值为：sparta-waf、clb-waf、cdn-waf |
| FlowMode | 是 | 否 | Uint64 | WAF的流量模式，1：清洗模式，0：镜像模式 |
| ClsStatus | 是 | 否 | Uint64 | 是否开启访问日志，1：开启，0：关闭 |
| NetworkType | 是 | 否 | String | 网络类型 |
| Level | 是 | 否 | Uint64 | 门神防护等级 |
IpHitItem
ip封堵状态数据
被如下接口引用：DescribeIpHitItems
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | Uint64 | 动作 |
| Category | 是 | 否 | String | 类别 |
| Ip | 是 | 否 | String | ip |
| Name | 是 | 否 | String | 规则名称 |
| TsVersion | 是 | 否 | Uint64 | 时间戳 |
| ValidTs | 是 | 否 | 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 | 如果是自定义规则，则显示规则的名字，如果不是则为- |
MonitorDomainItem
云监控域名字段
被如下接口引用：DescribeMonitorDomains
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Domain | 是 | 否 | String | 域名 |
| Appid | 是 | 否 | Uint64 | 用户自己的Appid |
| Edition | 是 | 否 | Int64 | 域名对应的版本信息，0代表saas，1代表clb |
| DomainId | 是 | 否 | String | 域名ID |
Strategy
自定义规则的匹配条件结构体
被如下接口引用：AddCustomRule、DescribeCustomRules、ModifyCustomRule
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Field | 是 | 否 | String | 匹配字段 |
| CompareFunc | 是 | 否 | String | 逻辑符号 |
| Content | 是 | 否 | String | 匹配内容 |
| Arg | 是 | 否 | String | 匹配参数 |
DescribeCachePathPaging
DescribeCachePath翻页参数
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Index | 是 | 否 | String | 起始页 |
| Count | 是 | 否 | String | 页数目 |
DescribeAntiFakeUrlPaging
DescribeAntiFakeUrl翻页参数
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Index | 是 | 否 | String | 页码 |
| Count | 是 | 否 | String | 页条目数量 |
PeakPointsItem
PeakPoints数组项
被如下接口引用：DescribePeakPoints
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Time | 是 | 否 | Uint64 | 秒级别时间戳 |
| Access | 是 | 否 | Uint64 | QPS |
| Up | 是 | 否 | Uint64 | 上行带宽峰值，单位B |
| Down | 是 | 否 | Uint64 | 下行带宽峰值，单位B |
| Attack | 是 | 否 | Uint64 | Web攻击次数 |
| Cc | 是 | 否 | Uint64 | CC攻击次数 |
CCRuleData
数据封装
被如下接口引用：DescirbeCCRule
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Res | 是 | 否 | Array of CCRuleItem | cc规则 |
| TotalCount | 是 | 否 | Int64 | 规则数目 |
AttackIpInfo
攻击者ip信息，ip，城市，攻击次数
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Ip | 是 | 是 | String | 攻击者IP |
| Count | 是 | 是 | Int64 | 攻击次数 |
| City | 是 | 是 | String | 攻击者所在城市json形式字符串 |
CreateAccessDownloadRecordRsp
CreateAccessDownloadRecord接口的返回值
被如下接口引用：CreateAccessDownloadRecord
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Code | 是 | 否 | Int64 | 是否成功，正常情况为0 |
| Flow | 是 | 否 | String | 下载记录编号 |
DescribeSpartaProtectionListItem
DescribeSpartaProtectionList的入参
被如下接口引用：DescribeSpartaProtectionList
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| IsCdn | 否 | 否 | String | 是否是cdn |
| Status | 否 | 否 | String | 状态 |
| LogStatus | 否 | 否 | String | 日志开关 |
| Mode | 否 | 否 | String | AI模式 |
| State | 否 | 否 | String | 状态 |
MapItem
地图类型
被如下接口引用：DescribeAttackWorldMap
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Country | 是 | 否 | String | 城市 |
| Count | 是 | 否 | Uint64 | 数量 |
BotTCBRuleItem
bot tcb规则的动作和数量统计
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 动作 |
| Count | 是 | 否 | Int64 | 数目 |
ClbHostsParams
CLB回调WAF接口（获取、删除）的参数
被如下接口引用：DescribeWafInfo
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| LoadBalancerId | 是 | 否 | String | 负载均衡实例ID，如果不传次参数则默认认为操作的是整个AppId的监听器，如果此参数不为空则认为操作的是对应负载均衡实例。 |
| ListenerId | 否 | 否 | String | 负载均衡监听器ID，，如果不传次参数则默认认为操作的是整个负载均衡实例，如果此参数不为空则认为操作的是对应负载均衡监听器。 |
| DomainId | 否 | 否 | String | WAF实例ID，，如果不传次参数则默认认为操作的是整个负载均衡监听器实例，如果此参数不为空则认为操作的是对应负载均衡监听器的某一个具体的域名。 |
PortItem
防护域名端口配置信息
被如下接口引用：AddSpartaProtection、DescribeSpartaProtectionInfo、DescribeSpartaProtectionList
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Port | 是 | 否 | String | 监听端口配置 |
| Protocol | 是 | 否 | String | 与Port一一对应，表示端口对应的协议 |
| UpstreamPort | 是 | 否 | String | 与Port一一对应, 表示回源端口 |
| UpstreamProtocol | 是 | 否 | String | 与Port一一对应, 表示回源协议 |
| NginxServerId | 是 | 否 | String | Nginx的服务器ID |
DescribePieChartRsp
DescribePieChart的返回值
被如下接口引用：DescribePieChart
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Piechart | 是 | 是 | Array of String | 详细的内容 |
MenshenRulesInfo
门神-规则库描述信息
被如下接口引用：DescribeRulesInfo
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Date | 是 | 是 | Date | 日期 |
| Version | 是 | 是 | String | 版本 |
| Memos | 是 | 是 | Array of String | 描述信息 |
| MemosEng | 是 | 是 | Array of String | 描述标题 |
MainClassItem
主类信息
被如下接口引用：DescribeMainClass
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| MainClassID | 否 | 否 | String | 主类id |
| MainClassName | 否 | 否 | String | 主类名字 |
| Description | 否 | 否 | String | 描述 |
| SubClass | 否 | 是 | Array of SubClassItem | 子类 |
| RuleCount | 否 | 是 | Uint64 | 当前主类的规则个数 |
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：镜像模式（默认） |
DescribeBotUCBFeatureRuleRsp
DescribeBotUCBFeatureRule的返回参数
被如下接口引用：DescribeBotUCBFeatureRule
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TotalCount | 是 | 否 | Int64 | 规则数目 |
| Res | 是 | 否 | Array of String | 详细的规则 |
WafGetDomainEngineTypeData
WafGetDomainEngineType返回参数
被如下接口引用：WafGetDomainEngineType
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| EngineType | 否 | 否 | String | 引擎类型 |
| Domain | 否 | 否 | String | 域名 |
DescribeAreaBanAreasRsp
DescribeAreaBanAreas接口的回包
被如下接口引用：DescribeAreaBanAreas
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Status | 是 | 否 | String | 状态 "0"：未开启地域封禁 "1"：开启地域封禁 |
| Areas | 是 | 否 | Array of String | 字符串数据，配置的地域列表 |
DescribeCustomRulesRspRuleListItem
DescribeCustomRules接口回包中的复杂类型
被如下接口引用：DescribeCustomRules
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ActionType | 是 | 否 | String | 动作类型 |
| Bypass | 是 | 否 | String | 跳过的策略 |
| CreateTime | 是 | 否 | String | 创建时间 |
| ExpireTime | 是 | 否 | String | 过期时间 |
| Name | 是 | 否 | String | 策略名称 |
| Redirect | 是 | 否 | String | 重定向地址 |
| RuleId | 是 | 否 | String | 策略ID |
| SortId | 是 | 否 | String | 优先级 |
| Status | 是 | 否 | String | 状态 |
| Strategies | 是 | 否 | Array of Strategy | 策略详情 |
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 |
GlobalWhiteCond
全局白名单规则项
被如下接口引用：AddUserWhiteRule、DescribeUserWhiteRule、ModifyUserWhiteRule
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Target | 是 | 否 | String | 匹配目标，HTTP-Method,Host,URI,FULL-URL,Parameter,Cookie,HTTP-Header,JSON-Elements |
| Operation | 是 | 否 | String | 匹配操作，String-Match 字符串匹配，支持通配符，例如/floder1/* /floder1/*/index.htm；Regular-Expression-Match 正则表达式匹配， Include 包含（HTTP-Method），Exclude 不包含（HTTP-Method） |
| HttpMethodList | 否 | 否 | Array of String | 方法列表，"GET", "POST", "HEAD" |
| Name | 否 | 否 | String | 变量名称, 适用于Parameter,Cookie,HTTP-Header,JSON-Elements |
| CheckValue | 否 | 否 | Uint64 | 是否检查变量值，0:disable, 1: enable。 适用于Parameter,Cookie,HTTP-Header,JSON-Elements |
| Value | 否 | 否 | String | 变量值，适用于Host,URI,FULL-URL,Parameter,Cookie,HTTP-Header,JSON-Elements |
| Concatenate | 否 | 否 | String | 条件之间的链接方式，可以为AND/OR。AND 表示与上一个条件与的关系，OR表示与上一个条件是或的关系。多个条件之间的链接关系如下： C1.AND C2.AND C3.OR C4.OR C5.AND C6.AND, 则组合的逻辑关系是： c1 and (c2 or c3 or c4) and c5 and c6 |
DescribeCustomRulesPagingInfo
DescribeCustomRules接口的翻页参数
被如下接口引用：DescribeCustomRules
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Offset | 是 | 否 | Int64 | 当前页码 |
| Limit | 是 | 否 | Int64 | 当前页的最大数据条数 |
PageInfo
公共翻页参数
被如下接口引用：DescribeAntiFakeUrl、DescribeAntiInfoLeakRules、DescribeCachePath、DescribeDNSDetectHijackData
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| PageNumber | 是 | 否 | String | 页码 |
| PageSize | 是 | 否 | String | 页条目数量 |
LoadBalancer
负载均衡的监听器
被如下接口引用：CreateHost、DescribeHost、DescribeHosts、DescribeWafInfo、ModifyHost
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| LoadBalancerId | 是 | 否 | String | 负载均衡LD的ID |
| LoadBalancerName | 是 | 否 | String | 负载均衡LD的名称 |
| ListenerId | 是 | 否 | String | 负载均衡监听器的ID |
| ListenerName | 是 | 否 | String | 负载均衡监听器的名称 |
| Vip | 是 | 否 | String | 负载均衡实例的IP |
| Vport | 是 | 否 | Uint64 | 负载均衡实例的端口 |
| Region | 是 | 否 | String | 负载均衡LD的地域 |
| Protocol | 是 | 否 | String | 监听器协议，http、https |
| Zone | 是 | 否 | String | 负载均衡监听器所在的zone |
| NumericalVpcId | 是 | 是 | Int64 | 网络 |
| LoadBalancerType | 是 | 是 | String | 网络类型 |
HistogramItem
柱状图
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| IP | 是 | 是 | String | IP |
| Time | 是 | 是 | Float | 响应时间 |
| Url | 是 | 是 | String | URL |
| City | 是 | 是 | String | 城市 |
CustomPayloadData
封装参数
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Res | 是 | 否 | Array of CustomPayload | 载荷 |
| TotalCount | 是 | 否 | Uint64 | 计数 |
StatisticType
攻击类型统计
被如下接口引用：DescribeStatisticTypes
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Type | 是 | 否 | String | 攻击类型 |
| Count | 是 | 否 | Int64 | 攻击类型数目 |
CopyBotsUCBPreinstallRuleRsp
CopyBotsUCBPreinstallRule接口的返回自
被如下接口引用：CopyBotUCBPreinstallRule
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Code | 是 | 否 | Int64 | 0表示成功，其他表示失败 |
| ErrMsg | 是 | 否 | String | 错误信息 |
| SuccessNum | 是 | 否 | Int64 | 成功的数目 |
| FailedNum | 是 | 否 | Int64 | 失败的数目 |
| T | 是 | 否 | Array of String | 成功的域名列表 |
DNSDetectHijackData
DNS劫持检测的劫持记录结构体
被如下接口引用：DescribeDNSDetectHijackData
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Domain | 是 | 否 | String | 被劫持的域名 |
| HijackIP | 是 | 否 | String | 被劫持后的IP |
| Operator | 是 | 否 | String | 被劫持后的IP的运营商 |
| HijackRegions | 是 | 否 | Uint64 | 被劫持的地域数 |
| HijackUsers | 是 | 否 | Uint64 | 被劫持的用户数 |
| AuthIP | 是 | 否 | String | 权威记录 |
HostDel
CLB-WAF删除域名参数
被如下接口引用：DeleteHost
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Domain | 是 | 否 | String | 域名 |
| DomainId | 是 | 否 | String | 域名ID |
SpartaProtectionPort
waf斯巴达-编辑防护域名中的端口结构
被如下接口引用：ModifySpartaProtection
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| NginxServerId | 是 | 否 | Uint64 | nginx Id |
| Port | 是 | 否 | String | 端口 |
| Protocol | 是 | 否 | String | 协议 |
| UpstreamPort | 是 | 否 | String | 后端端口 |
| UpstreamProtocol | 是 | 否 | String | 后端协议 |
BotRecordItemsData
bot访问序列数据封装
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Res | 是 | 否 | BotRecordItemRes | 数据 |
ClsPackage
clb-waf 日志套餐
被如下接口引用：DescribeSpartUserInfo、DescribeUserInfo
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ResourceIds | 是 | 否 | String | 资源ID |
| ValidTime | 是 | 否 | String | 过期时间 |
| AutoRenew | 是 | 否 | Int64 | 是否自动续费，1：自动续费，0：不自动续费 |
| Count | 是 | 否 | Int64 | 套餐个数 |
| Region | 是 | 否 | String | 地域，目前在clb-waf中没有用到 |
DescribeDNSDetectDomainListDomainListItem
DescribeDNSDetectDomainList返回值的元素
被如下接口引用：DescribeDNSDetectDomainList
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 否 | String | id |
| Domain | 是 | 否 | String | 域名 |
| HijackRecords | 是 | 否 | String | hijackRecords |
| HijackRegions | 是 | 否 | String | hijackRegions |
| CreateTime | 是 | 否 | String | 创建时间 |
| AuthIP | 是 | 否 | Array of String | 授权的IP |
BanAreaItem
单个被封禁的地址
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| EnAbbr | 是 | 是 | String | 地址的其他英文缩写 |
| EN | 是 | 否 | String | 地址的英文缩写 |
| ZH | 是 | 否 | String | 地址的中文名 |
CCRuleItem
cc规则
被如下接口引用：DescirbeCCRule
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ActionType | 是 | 否 | Uint64 | 动作 |
| Advance | 是 | 否 | Uint64 | 高级模式 |
| Interval | 是 | 否 | Uint64 | 时间周期 |
| Limit | 是 | 否 | Uint64 | 限制次数 |
| MatchFunc | 是 | 否 | Uint64 | 匹配方法 |
| Name | 是 | 否 | String | 名称 |
| Priority | 是 | 否 | Uint64 | 优先级 |
| Status | 是 | 否 | Int64 | 状态 |
| TsVersion | 是 | 否 | Uint64 | 更新时间戳 |
| Url | 是 | 否 | String | 匹配url |
| ValidTime | 是 | 否 | Uint64 | 策略动作有效时间 |
| OptionsArr | 是 | 是 | String | 高级参数 |
BotListStat
bot列表的stat数据
被如下接口引用：DescribeBotTCBRecords、DescribeBotUBRecords、DescribeBotUCBRecords
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AvgSpeed | 是 | 否 | Float | 平均速度 |
SessionData
参数包装
被如下接口引用：DescribeSession
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Res | 是 | 否 | Array of SessionItem | session定义 |
DescribeAntiInfoLeakRulesRuleItem
DescribeAntiInfoLeakRules返回的规则列表元素
被如下接口引用：DescribeAntiInfoLeakRules
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| RuleId | 是 | 否 | String | 规则ID |
| Name | 是 | 否 | String | 规则名称 |
| Status | 是 | 否 | String | 规则状态 |
| ActionType | 是 | 否 | String | 规则动作类型 |
| CreateTime | 是 | 否 | String | 规则创建时间 |
| Strategies | 是 | 否 | Array of DescribeAntiInfoLeakRulesStrategyItem | 详细的规则 |
ReqUserRule
用户规则更新输出规则子项
被如下接口引用：ModifyUserSignatureRule
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 否 | String | 特征序号 |
| Status | 是 | 否 | Int64 | 规则开关 0：关 1：开 2：只告警 |
| Reason | 否 | 否 | Int64 | 修改原因 0：无(兼容记录为空) 1：业务自身特性 |
CopyBotTCBRuleRsp
CopyBotTCBRule函数的返回值
被如下接口引用：CopyBotTCBRule
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Code | 是 | 否 | Int64 | 0表示成功，其他表示失败 |
| ErrMsg | 是 | 否 | String | 错误信息 |
| SuccessNum | 是 | 否 | Int64 | 成功的数目 |
| FailedNum | 是 | 否 | Int64 | 失败的数目 |
| T | 是 | 否 | Array of String | 成功的域名列表 |
SearchLogsSimpleRsp
SearchLogsSimple的返回值
被如下接口引用：DescribeAccessLogs
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Code | 是 | 否 | Int64 | 是否成功执行，0表示成功执行 |
| Count | 是 | 否 | Int64 | 日志的数目 |
| Context | 是 | 否 | String | 日志的内容，可以用作游标 |
| Data | 是 | 否 | Array of String | 具体的日志内容 |
BotListData
bot列表数据封装
被如下接口引用：DescribeBotTCBRecords、DescribeBotUBRecords、DescribeBotUCBRecords
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Res | 是 | 是 | Array of BotItemsListItem | bot列表 |
| TotalCount | 是 | 否 | Uint64 | 统计总数 |
DescribeDNSDetectDataMapRspItem
DescribeDNSDetectDataMap返回值的元素
被如下接口引用：DescribeDNSDetectDataMap
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Key | 是 | 否 | String | 地域 |
| Value | 是 | 否 | String | 地域的劫持数量 |
HostStatus
设置WAF状态的结构体
被如下接口引用：ModifyHostStatus
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Domain | 是 | 否 | String | 域名 |
| DomainId | 是 | 否 | String | 域名ID |
| Status | 是 | 否 | Uint64 | WAF的开关，1：开，0：关 |
FiltersItemNew
实例入参过滤器
被如下接口引用：DescribeMainClass、DescribeUserSignatureRule、DescribeUserWhiteRule
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Name | 是 | 否 | String | 字段名 |
| Values | 是 | 否 | Array of String | 过滤值 |
| ExactMatch | 是 | 否 | Bool | 是否精确查找 |
BotsDomainAggStatStyledItem
GetBotsDomainAggStatStyled接口的返回数组的元素类型
被如下接口引用：DescribeBotAggregateDomainStat
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Key | 是 | 否 | String | 域名 |
| Value | 是 | 否 | Int64 | 攻击次数 |
BotsGeoStatStyledItem
GetBotsGeoStatStyled接口的返回数据的元素类型
被如下接口引用：DescribeBotRegionsStat
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Key | 是 | 否 | String | 地域 |
| Value | 是 | 否 | Int64 | 值 |
InstancePriceItem
商品价格询价结果
被如下接口引用：InquiryPriceWafInstance
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Pid | 是 | 否 | Int64 | 商品的编码 |
| RealTotalCost | 是 | 否 | Int64 | 折扣后的价格 |
| TotalCost | 是 | 否 | Int64 | 折扣前的价格 |
MenshenRuleType
门神-规则类型信息
被如下接口引用：DescribeRuleTypes
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 是 | Uint64 | Id |
| Name | 是 | 是 | String | 规则类型名称 |
| Description | 是 | 是 | String | 规则类型描述 |
| Count | 是 | 是 | Uint64 | 规则数量 |
| DescriptionEn | 是 | 是 | String | 规则类型描述英文 |
| NameEn | 是 | 是 | String | 规则类型名称英文 |
ReturnData
API2.0的返回值
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Data | 是 | 是 | Data | "returnData":{"data":{"AutoRenew":"false"}} |
DescribeCachePathRspListItem
DescribeCachePath返回值中的类型
被如下接口引用：DescribeCachePath
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 否 | String | ID |
| Domain | 是 | 否 | String | 域名 |
| Name | 是 | 否 | String | 名称 |
| State | 是 | 否 | String | 状态 |
| Path | 是 | 否 | String | 路径 |
| CreateTime | 是 | 否 | String | 创建时间 |
| ModifyTime | 是 | 否 | String | 修改时间 |