tenyun

/// <reference types="node" /> import { AxiosPromise, AxiosRequestConfig } from "axios"; /** DescribeAccessFastAnalysis接口的出参 */ declare interface AccessFieldValueRatioInfo { /** 日志条数 */ Count?: number; /** 对应的Value值的百分比 */ Ratio?: number; /** 字段对应的值 */ Value?: string; } /** DescribeAccessIndex */ declare interface AccessFullTextInfo { /** 是否大小写敏感 */ CaseSensitive?: boolean; /** 全文索引的分词符，字符串中每个字符代表一个分词符 */ Tokenizer?: string; /** 是否包含中文 */ ContainZH?: boolean; } /** 用于接口DescribeAccessHistogram 的出参 */ declare interface AccessHistogramItem { /** 时间，单位ms */ BTime?: number; /** 日志条数 */ Count?: number; /** 时间，单位ms */ BeginTime?: number; } /** 用于 DescribeAccessIndex 的出参 */ declare interface AccessKeyValueInfo { /** 需要配置键值或者元字段索引的字段 */ Key?: string; /** 字段的索引描述信息 */ Value?: AccessValueInfo; } /** 单条日志数据描述 */ declare interface AccessLogInfo { /** 日志时间，单位ms */ Time?: number; /** 日志主题ID */ TopicId?: string; /** 日志主题名称 */ TopicName?: string; /** 日志来源IP */ Source?: string; /** 日志文件名称 */ FileName?: string; /** 日志上报请求包的ID */ PkgId?: string; /** 请求包内日志的ID */ PkgLogId?: string; /** 日志内容的Json序列化字符串 */ LogJson?: string; } /** 日志KeyValue对 */ declare interface AccessLogItem { /** 日记Key */ Key?: string; /** 日志Value */ Value?: string; } /** 日志KeyValue对数组，用于搜索访问日志 */ declare interface AccessLogItems { /** 分析结果返回的KV数据对 */ Data?: AccessLogItem[]; } /** DescribeAccessIndex接口的出参数 */ declare interface AccessRuleInfo { /** 全文索引配置 */ FullText?: AccessFullTextInfo; /** 键值索引配置 */ KeyValue?: AccessRuleKeyValueInfo; /** 元字段索引配置 */ Tag?: AccessRuleTagInfo; } /** DescribeAccessIndex接口的出参 */ declare interface AccessRuleKeyValueInfo { /** 是否大小写敏感 */ CaseSensitive?: boolean; /** 需要建立索引的键值对信息；最大只能配置100个键值对 */ KeyValues?: AccessKeyValueInfo[]; } /** DescribeAccessIndex接口的出参 */ declare interface AccessRuleTagInfo { /** 是否大小写敏感 */ CaseSensitive?: boolean; /** 标签索引配置中的字段信息 */ KeyValues?: AccessKeyValueInfo[]; } /** 用于DescribeAccessIndex接口的出参 */ declare interface AccessValueInfo { /** 字段类型，目前支持的类型有：long、text、double */ Type?: string; /** 字段的分词符，只有当字段类型为text时才有意义；输入字符串中的每个字符代表一个分词符 */ Tokenizer?: string; /** 字段是否开启分析功能 */ SqlFlag?: boolean; /** 是否包含中文 */ ContainZH?: boolean; } /** 免鉴权信息 */ declare interface AnonymousInfo { /** 操作列表，支持trackLog(JS/HTTP上传日志 )和realtimeProducer(kafka协议上传日志) */ Operations?: string[]; /** 条件列表 */ Conditions?: ConditionInfo[]; } /** api列表 */ declare interface ApiAsset { /** 域名 */ Domain?: string; /** 请求方法 */ Method?: string; /** api名称 */ ApiName?: string; /** 场景 */ Scene?: string; /** 数据标签 */ Label?: string[]; /** 过去7天是否活跃 */ Active?: boolean; /** 最近更新时间 */ Timestamp?: number; /** api发现时间 */ InsertTime?: number; /** 资产状态，1:新发现，2，确认中，3，已确认，4，已下线，5，已忽略 */ Mode?: string; /** 风险等级，100,200,300对应低中高 */ Level?: string; /** 近30天调用量 */ Count?: number; /** 备注 */ Remark?: string; /** 是否鉴权，1标识是，0表示否 */ IsAuth?: number; /** 如果添加了api入参检测规则，则此id返回值不为0 */ ApiRequestRuleId?: number; /** 如果添加了api限流规则，则此id返回值不为0 */ ApiLimitRuleId?: number; /** 对象接入和泛域名接入时，展示host列表 */ HostList?: string[]; } /** api资产列表过滤器 */ declare interface ApiDataFilter { /** 数据标签，是否活跃，功能场景 */ Entity: string; /** 等于 */ Operator: string; /** 日期，手机号，邮箱等 */ Value: string; /** 风险等级 */ ValueList?: string[]; } /** api历史样例返回结构体 */ declare interface ApiDetailSampleHistory { /** 样例名称 */ SampleNme?: string; /** 请求样例 */ RepLog?: string; /** 响应样例 */ RspLog?: string; } /** 带有请求方式的apiname结构体 */ declare interface ApiNameMethod { /** api名称 */ ApiName?: string; /** api请求方式 */ Method?: string; /** api近30天请求数量 */ Count?: number; /** api标签 */ Label?: string[]; } /** 带有匹配方式的apiname列表 */ declare interface ApiNameOp { /** 匹配值列表 */ Value?: string[]; /** 匹配方式，如属于和正则等 */ Op?: string; /** 手动筛选的时候，要传该结构体 */ ApiNameMethod?: ApiNameMethod[]; } /** api请求参数类型 */ declare interface ApiParameterType { /** 参数名称 */ ParameterName?: string; /** 参数类型 */ Type?: string; /** 参数位置 */ Location?: string; /** 数据标签(敏感字段) */ Label?: string[]; /** 时间戳 */ Timestamp?: number; /** 备注信息 */ Remark?: string; /** 来源是请求或者响应 */ Source?: string; /** 是否需要泛化，0表示不需要，1表示需要 */ IsPan?: number; /** 是否鉴权，1表示是，0表示否 */ IsAuth?: number; } /** API安全资源信息 */ declare interface ApiPkg { /** 资源id */ ResourceIds?: string; /** 状态 */ Status?: number; /** 地域 */ Region?: number; /** 开始时间 */ BeginTime?: string; /** 结束时间 */ EndTime?: string; /** 申请数量 */ InquireNum?: number; /** 使用数量 */ UsedNum?: number; /** 续费标志 */ RenewFlag?: number; /** 计费项 */ BillingItem?: string; /** api安全7天试用标识。1试用。0没试用 */ IsAPISecurityTrial?: number; } /** api安全自定义事件规则结构体 */ declare interface ApiSecCustomEventRule { /** 规则名称 */ RuleName: string; /** 开关，1：开，0:关 */ Status: number; /** api匹配列表 */ ApiNameOp?: ApiNameOp[]; /** 事件详情 */ Description?: string; /** 时间戳，出参有该值，入参不需要传没有 */ UpdateTime?: number; /** 匹配规则列表 */ MatchRuleList?: ApiSecSceneRuleEntry[]; /** 统计规则列表 */ StatRuleList?: ApiSecSceneRuleEntry[]; /** 访问频次，第一个字段表示次数，第二个字段表示分钟 */ ReqFrequency?: number[]; /** 风险等级，取值为100,200,300，分别表示低位、中危、高危 */ RiskLevel?: string; /** 规则来源 */ Source?: string; } /** api安全客户自定义敏感检测规则 */ declare interface ApiSecCustomSensitiveRule { /** 参数位置 */ Position: string[]; /** 匹配条件 */ MatchKey: string; /** 匹配值 */ MatchValue: string[]; /** 风险等级 */ Level: string; /** 匹配符号，当匹配条件为关键字匹配和字符匹配的时候传该值,可传多个 */ MatchCond?: string[]; /** 规则是否泛化，默认0表示不泛化 */ IsPan?: number; } /** api提取规则内容 */ declare interface ApiSecExtractRule { /** 规则名称 */ RuleName?: string; /** api名称 */ ApiName?: string; /** 请求方法列表 */ Methods?: string[]; /** 开关状态，0是关，1是开 */ Status?: number; /** 正则匹配内容 */ Regex?: string; /** 10更新时间戳 */ UpdateTime?: number; } /** api列表 */ declare interface ApiSecKey { /** api名称 */ ApiName: string; /** 域名 */ Domain: string; /** 请求方法 */ Method: string; } /** 自定义api鉴权规则 */ declare interface ApiSecPrivilegeRule { /** 规则名称，不可重复 */ RuleName: string; /** 1:开，0:关 */ Status: number; /** 最多输入20个api */ ApiName?: string[]; /** 鉴权位置 */ Position?: string; /** 鉴权参数列表 */ ParameterList?: string[]; /** 更新时间戳 */ UpdateTime?: number; /** 规则来源 */ Source?: string; /** 带有匹配方式的api列表 */ ApiNameOp?: ApiNameOp[]; /** 应用对象取值，1表示手动填写，2表示从api资产中获取 */ Option?: number; } /** api安全自定义场景规则 */ declare interface ApiSecSceneRule { /** 场景名称 */ RuleName?: string; /** 开关状态，1表示开，0表示关 */ Status?: number; /** 更新时间，10位时间戳 */ UpdateTime?: number; /** 规则列表 */ RuleList?: ApiSecSceneRuleEntry[]; /** 规则来源，系统内置:OS客户自定义：custom */ Source?: string; } /** api安全用户自定义场景规则结构体 */ declare interface ApiSecSceneRuleEntry { /** 匹配字段 */ Key?: string; /** 匹配值 */ Value?: string[]; /** 操作符 */ Operate?: string; /** 当匹配字段是get参数值，post参数值，cookie参数值，header参数值，rsp参数值的时候，可填充此字段 */ Name?: string; } /** 地域信息 */ declare interface Area { /** 国家，除了标准的国家外还支持国内、国外这两个特殊的标识 */ Country: string; /** 省份 */ Region?: string; /** 城市 */ City?: string; } /** 地域封禁规则详情 */ declare interface AreaBanRule { /** 状态 0：未开启地域封禁、1：开启地域封禁 */ Status?: number; /** 数据来源 custom：自定义(默认)、batch：批量防护 */ Source?: string; /** 配置的地域列表 */ Areas?: Area[]; /** 规则执行的方式，TimedJob为定时执行，CronJob为周期执行 */ JobType?: string; /** 定时任务配置 */ JobDateTime?: JobDateTime; /** 如果是周期任务类型，那么表示周期的类型，支持 Week：按周、Month：按月 */ CronType?: string; /** 地域信息的语言，支持cn、en，默认为中文cn */ Lang?: string; } /** 攻击日志详情 */ declare interface AttackLogInfo { /** 攻击日志的详情内容 */ Content?: string; /** CLS返回内容 */ FileName?: string; /** CLS返回内容 */ Source?: string; /** CLS返回内容 */ TimeStamp?: string; } /** Waf 攻击自动封禁详情 */ declare interface AutoDenyDetail { /** 攻击封禁类型标签 */ AttackTags: string[]; /** 攻击次数阈值 */ AttackThreshold: number; /** 自动封禁状态 */ DefenseStatus: number; /** 攻击时间阈值 */ TimeThreshold: number; /** 自动封禁时间 */ DenyTimeThreshold: number; /** 最后更新时间 */ LastUpdateTime?: string; } /** 批量防护失败的域名以及对应的原因。 */ declare interface BatchDomainResult { /** 批量操作中失败的域名 */ Domain?: string; /** 操作失败的原因 */ Message?: string; } /** 多域名黑白名单describe返回 */ declare interface BatchIpAccessControlData { /** 总数 */ TotalCount?: number; /** 黑白名单条目 */ Res?: BatchIpAccessControlItem[]; } /** 批量多域名黑白名单列表Ip */ declare interface BatchIpAccessControlItem { /** mongo表自增Id */ Id?: string; /** 黑名单42或白名单40 */ ActionType?: number; /** 黑白名单的IP */ Ip?: string; /** 备注 */ Note?: string; /** batch为批量域名，batch-group为防护对象组 */ Source?: string; /** 修改时间 */ TsVersion?: number; /** 超时时间 */ ValidTs?: number; /** 域名列表 */ Hosts?: string[]; /** 55101145 */ RuleId?: number; /** IP列表 */ IpList?: string[]; /** 创建时间 */ CreateTime?: number; /** 定时任务类型 */ JobType?: string; /** 周期任务类型 */ CronType?: string; /** 定时任务配置详情 */ JobDateTime?: JobDateTime; /** 生效状态 */ ValidStatus?: number; /** 防护对象组ID列表，如果绑定的是防护对象组 */ GroupIds?: number[]; } /** 动作策略的匹配规则实体 */ declare interface BotActionScopeRuleEntry { /** 参数 */ Key?: string; /** 匹配符 */ Op?: string; /** 参数值 */ Value?: string; /** 对于头部字段匹配value的时候指定的头部名 */ Name?: string; /** 470后使用此字段存储多值 */ ValueArray?: string[]; } /** BOT-ID规则信息 */ declare interface BotIdConfig { /** 规则ID */ RuleId: string; /** 规则开关 */ Status: boolean; /** 动作配置 */ Action: string; /** 规则名称 */ BotId?: string; /** 重定向路径 */ Redirect?: string; } /** BOT安全监测资源信息 */ declare interface BotMonitorPkg { /** 资源id */ ResourceIds?: string; /** 状态 */ Status?: number; /** 地域 */ Region?: number; /** 开始时间 */ BeginTime?: string; /** 结束时间 */ EndTime?: string; /** 申请数量 */ InquireNum?: number; /** 使用数量 */ UsedNum?: number; /** 续费标志 */ RenewFlag?: number; /** 计费项 */ BillingItem?: string; } /** Bot资源信息 */ declare interface BotPkg { /** 资源id */ ResourceIds?: string; /** 状态 */ Status?: number; /** 地域 */ Region?: number; /** 开始时间 */ BeginTime?: string; /** 结束时间 */ EndTime?: string; /** 申请数量 */ InquireNum?: number; /** 使用数量 */ UsedNum?: number; /** 子产品code */ Type?: string; /** 续费标志 */ RenewFlag?: number; /** 购买页bot6折 */ BotCPWaf?: number; /** 控制台买bot5折 */ BotNPWaf?: number; /** 7天bot试用标识 1 试用 0 没有试用 */ IsBotTrial?: number; } /** bot的qps详情 */ declare interface BotQPS { /** 资源id */ ResourceIds: string; /** 有效时间 */ ValidTime: string; /** 资源数量 */ Count: number; /** 资源所在地区 */ Region: string; /** 使用qps的最大值 */ MaxBotQPS: number; /** 续费标志 */ RenewFlag: number; } /** 获取场景动作策略列表时的动作策略实体 */ declare interface BotSceneActionRule { /** 动作策略ID */ RuleId?: string; /** 动作策略名称 */ RuleName?: string; /** 策略优先级 */ Priority?: number; /** 策略生效状态 */ Status?: boolean; /** 分数范围 */ Score?: BotScoreRuleEntry[]; /** 100-宽松、200-中等、300-严格、0-自定义 */ Level?: string; /** 生效范围，为空表示全部范围 */ Scope?: BotActionScopeRuleEntry[]; /** default：默认创建 custom：自定义创建 */ Type?: string; /** 匹配范围类型：全局匹配 or 自定义匹配范围 */ ScopeType?: string; /** 匹配条件间的与或关系 */ ActionMatchType?: string; } /** 场景的详细配置信息 */ declare interface BotSceneInfo { /** 场景ID */ SceneId?: string; /** 场景类型，default:默认场景,custom:非默认场景 */ Type?: string; /** 场景名 */ SceneName?: string; /** 更新时间 */ UpdateTime?: number; /** 场景模板类型，登录: login 秒杀:seckill 爬内容：crawl 自定义: custom */ BusinessType?: string[]; /** 客户端类型，浏览器/H5 : browser 小程序: miniApp App: */ ClientType?: string[]; /** 优先级 */ Priority?: number; /** 匹配范围 */ MatchCondition?: BotSceneMatchCondition[]; /** 场景开关 */ SceneStatus?: boolean; /** 前端对抗开关 */ JsInjectStatus?: boolean; /** AI开关 */ AIStatus?: boolean; /** TI开关 */ TIStatus?: boolean; /** 智能统计开关 */ StatisticStatus?: boolean; /** 动作策略数量 */ ActionRuleCount?: number; /** 自定义规则数量 */ UCBCount?: number; /** 场景的匹配范围，global-全部匹配 custom-自定义匹配范围 */ MatchType?: string; /** 匹配条件间的与或关系 */ ActionMatchType?: string; /** UA模块开关 */ UAStatus?: boolean; /** 简易模式场景：前端对抗对应mysql的记录id */ JsInjectRuleId?: number; /** 简易模式场景：前端对抗配置动作 */ JsInjectAction?: number; /** 简易模式场景：前端对抗重定向路径 */ JsInjectRedirect?: string; /** 简易模式场景：动作策略信息 PS:简易模式只有一个动作策略 */ ActionRuleList?: BotSceneActionRule[]; /** 简易模式场景：monitor-观察 intercept-拦截 custom-自定义 */ BotIdPattern?: string; /** 简易模式场景：bot_id规则总数 */ BotIdCount?: number; /** 简易模式场景：观察动作的规则总数 */ BotIdMonitorCount?: number; /** 简易模式场景：拦截动作的规则总数 */ BotIdInterceptCount?: number; /** 创建场景时选择的规则集 */ RuleSetSelection?: string[]; /** 改场景的bot token列表 */ TokenList?: BotToken[]; /** 简易模式场景：重定向动作的规则总数 */ BotIdRedirectCount?: number; /** 简易模式场景：人机识别动作的规则总数 */ BotIdCaptchaCount?: number; /** 简易模式场景：防护等级 */ BotIdProtectLevel?: string; /** 简易模式场景：全局重定向路径 */ BotIdGlobalRedirect?: string; /** 简易模式场景：JS校验动作的规则总数 */ BotIdJsChallengeCount?: number; } /** 场景匹配条件 */ declare interface BotSceneMatchCondition { /** 匹配参数 */ Key: string; /** 匹配符 */ Op: string; /** 匹配值 */ Value: string; /** 对于头部字段匹配value的时候指定的头部名 */ Name?: string; /** 470后使用此入参存在多值 */ ValueArray?: string[]; } /** 动作策略的一条分数段实体 */ declare interface BotScoreRuleEntry { /** 分数区间上限 */ Upper: string; /** 分数区间下限 */ Lower: string; /** 处置动作 */ Action: string; /** 流量标签 */ Label: string; /** 重定向 */ Redirect?: string; } /** BOT安全护航资源信息 */ declare interface BotSecurityPkg { /** 资源id */ ResourceIds?: string; /** 状态 */ Status?: number; /** 地域 */ Region?: number; /** 开始时间 */ BeginTime?: string; /** 结束时间 */ EndTime?: string; /** 申请数量 */ InquireNum?: number; /** 使用数量 */ UsedNum?: number; /** 续费标志 */ RenewFlag?: number; /** 计费项 */ BillingItem?: string; } /** bot的趋势图对象 */ declare interface BotStatPointItem { /** 横坐标 */ TimeStamp: string; /** value的所属对象 */ Key: string; /** 纵列表 */ Value: number; /** Key对应的页面展示内容 */ Label: string; } /** bot-token配置 */ declare interface BotToken { /** 会话名称 */ Name?: string; /** 会话描述 */ Description?: string; /** 会话id */ Id?: string; /** 策略的开关状态 */ Status?: boolean; /** 会话位置 */ Location?: string; /** 会话key */ Key?: string; /** 会话匹配方式，前缀匹配、后缀匹配等 */ Operator?: string; /** 会话更新的时间戳 */ Timestamp?: number; /** 场景列表，内容为空表示全部场景应用 */ Scene?: string[]; /** 优先级 */ Priority?: number; /** token有效性配置信息 */ TokenValidation?: TokenValidation; } /** 数据封装 */ declare interface CCRuleData { /** cc规则 */ Res?: CCRuleItem[]; /** 规则数目 */ TotalCount?: number; } /** cc规则 */ declare interface CCRuleItem { /** 动作，20表示观察，21表示人机识别，22表示拦截，23表示精准拦截，24表示JS校验 */ ActionType?: number; /** 高级模式 */ Advance?: number; /** 时间周期 */ Interval?: number; /** 限制次数 */ Limit?: number; /** 匹配方法 */ MatchFunc?: number; /** 名称 */ Name?: string; /** 优先级 */ Priority?: number; /** 状态 */ Status?: number; /** 更新时间戳 */ TsVersion?: number; /** 匹配url */ Url?: string; /** 策略动作有效时间 */ ValidTime?: number; /** 高级参数 */ OptionsArr?: string; /** url长度 */ Length?: number; /** 规则ID */ RuleId?: number; /** 事件id */ EventId?: string; /** 关联的Session规则 */ SessionApplied?: number[]; /** 创建时间 */ CreateTime?: number; } /** CC规则详情 */ declare interface CCRuleItems { /** 名字 */ Name?: string; /** 状态 */ Status?: number; /** 模式 */ Advance?: number; /** 限制 */ Limit?: number; /** 范围 */ Interval?: number; /** 网址 */ Url?: string; /** 匹配类型 */ MatchFunc?: number; /** 动作，20表示观察，21表示人机识别，22表示拦截，23表示精准拦截，24表示JS校验 */ ActionType?: number; /** 优先级 */ Priority?: number; /** 有效时间 */ ValidTime?: number; /** 版本 */ TsVersion?: number; /** key为匹配字段；args为base64编码后的参数，等于号前为匹配参数，等于号后为匹配内容；match为逻辑符号；encodeflag为参数内容是否编码 */ Options?: string; /** 规则ID */ RuleId?: number; /** 事件id */ EventId?: string; /** 关联的Session规则 */ SessionApplied?: number[]; /** 创建时间 */ CreateTime?: number; /** 限频方式 */ LimitMethod?: string; /** cel表达式 */ CelRule?: string; /** 逻辑操作符 */ LogicalOp?: string; /** 页面ID */ PageId?: string; /** 动作灰度比例，默认值100 */ ActionRatio?: number; /** 批量cc规则配置的批量域名 */ Domains?: string[]; /** 批量cc规则使用的批量防护组 */ GroupIds?: number[]; /** 定时任务类型 */ JobType?: string; /** 定时任务配置 */ JobDateTime?: JobDateTime; /** 定时任务类型：month or week */ CronType?: string; /** 过期时间 */ ExpireTime?: number; /** 是否生效 */ ValidStatus?: number; /** 来源：批量还是单个规则 */ Source?: string; } /** CC规则总览 */ declare interface CCRuleLists { /** 总数 */ TotalCount?: number; /** 规则 */ Res?: CCRuleItems[]; /** 规则限制总数 */ Limit?: number; /** 规则剩余多少可用 */ Available?: number; } /** 防篡改url元素 */ declare interface CacheUrlItems { /** 标识 */ Id?: number; /** 名字 */ Name?: string; /** 域名 */ Domain?: string; /** 网址 */ Uri?: string; /** 协议 */ Protocol?: string; /** 状态 */ Status?: number; /** 修改时间 */ ModifyTime?: string; /** 创建时间 */ CreateTime?: string; } /** CDC场景下负载均衡WAF的集群信息 */ declare interface CdcCluster { /** cdc的集群id */ Id: string; /** cdc的集群名称 */ Name: string; } /** CDC场景下负载均衡WAF的地域信息 */ declare interface CdcRegion { /** 地域 */ Region: string; /** 该地域对应的集群信息 */ Clusters: CdcCluster[]; } /** 负载均衡型WAF域名详情 */ declare interface ClbDomainsInfo { /** 域名 */ Domain?: string; /** 域名唯一ID */ DomainId?: string; /** 域名所属实例ID */ InstanceId?: string; /** 域名所属实例名 */ InstanceName?: string; /** 域名所属实例类型 */ Edition?: string; /** waf前是否部署有七层代理服务。 0：没有部署代理服务 1：有部署代理服务，waf将使用XFF获取客户端IP 2：有部署代理服务，waf将使用remote_addr获取客户端IP 3：有部署代理服务，waf将使用ip_headers中的自定义header获取客户端IP */ IsCdn?: number; /** 负载均衡类型为clb时，对应的负载均衡器信息 */ LoadBalancerSet?: LoadBalancerPackageNew[]; /** 负载均衡型WAF的流量模式，1：清洗模式，0：镜像模式 */ FlowMode?: number; /** 域名绑定负载均衡器状态 */ State?: number; /** 负载均衡类型，clb或者apisix */ AlbType?: string; /** IsCdn=3时，表示自定义header */ IpHeaders?: string[]; /** cdc-clb-waf类型WAF的CDC集群信息 */ CdcClusters?: string; /** 云类型:public:公有云；private:私有云;hybrid:混合云 */ CloudType?: string; /** 域名备注信息 */ Note?: string; /** 域名标签 */ Labels?: string[]; /** clbwaf接入状态，0代表“尚无流量接入”，1代表“流量接入”，2代表“CLB监听器已注销”，3代表“配置生效中”，4代表“配置下发失败中” */ AccessStatus?: number; } /** Clb类型防护对象 */ declare interface ClbObject { /** 对象ID */ ObjectId?: string; /** 实例ID */ InstanceId?: string; /** 实例名称 */ InstanceName?: string; /** 精准域名列表 */ PreciseDomains?: string[]; /** WAF功能开关状态，0关闭1开启 */ Status?: number; /** WAF日志开关状态，0关闭1开启 */ ClsStatus?: number; /** CLB对象对应的虚拟域名 */ VirtualDomain?: string; /** 对象名称 */ ObjectName?: string; /** 公网地址 */ PublicIp?: string[]; /** 内网地址 */ PrivateIp?: string[]; /** VPC名称 */ VpcName?: string; /** VPC ID */ Vpc?: string; /** waf实例等级，如果未绑定实例为0 */ InstanceLevel?: number; /** clb投递开关 */ PostCLSStatus?: number; /** kafka投递开关 */ PostCKafkaStatus?: number; /** 对象类型：CLB:负载均衡器，TSE:云原生网关 */ Type?: string; /** 对象地域 */ Region?: string; /** 代理状态: 0:不开启,1:以XFF的第一个IP地址作为客户端IP,2:以remote_addr作为客户端IP,3:从指定的头部字段获取客户端IP，字段通过IpHeaders字段给出 */ Proxy?: number; /** 指定获取客户端IP的头部字段列表。IsCdn为3时有效 */ IpHeaders?: string[]; /** bot防护开关 */ BotStatus?: number; /** api防护开关 */ ApiStatus?: number; /** 对象接入模式，0表示镜像模式，1表示清洗模式，2表示体检模式，默认为清洗模式 */ ObjectFlowMode?: number; /** 数值形式的私有网络 ID */ NumericalVpcId?: number; /** 修改时间 */ ModifyTime?: string; /** 创建时间 */ AddTime?: string; /** 跨账号时，表示成员账号的appid */ MemberAppId?: number; /** 跨账号时，表示成员账号的uin */ MemberUin?: string; /** 跨账号时，表示成员账号的昵称 */ MemberNickName?: string; } /** Clb-waf地域信息 */ declare interface ClbWafRegionItem { /** 地域ID */ Id?: string; /** 地域中文说明 */ Text?: string; /** 地域英文全拼 */ Value?: string; /** 地域编码 */ Code?: string; } /** 日志分析的列属性 */ declare interface Column { /** 列的名字 */ Name?: string; /** 列的属性 */ Type?: string; } /** 通用返回 */ declare interface CommonRspData { /** 操作结果 */ Code?: number; /** 输出信息 */ Msg?: string; } /** 免鉴权条件信息 */ declare interface ConditionInfo { /** 条件属性，目前只支持VpcID */ Attributes?: string; /** 条件规则，1:等于，2:不等于 */ Rule?: number; /** 对应条件属性的值 */ ConditionValue?: string; } /** 计费下单接口出入参Goods */ declare interface CreateDealsGoods { /** 商品数量 */ GoodsNum: number; /** 商品明细 */ GoodsDetail: CreateDealsGoodsDetail; /** 订单类型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(变配) */ GoodsCategoryId?: number; /** 购买waf实例区域ID1 表示购买大陆资源;9表示购买非中国大陆资源 */ RegionId?: number; } /** 产品明细 */ declare interface CreateDealsGoodsDetail { /** 时间间隔 */ TimeSpan?: number; /** 单位，支持购买d、m、y 即（日、月、年） */ TimeUnit?: string; /** 子产品标签,。新购，续费必传，变配时放在oldConfig newConfig里面Saas 高级版：sp_wsm_waf_premiumSaas企业版：sp_wsm_waf_enterpriseSaas旗舰版：sp_wsm_waf_ultimateSaas 业务扩展包：sp_wsm_waf_qpsepSaas 域名扩展包：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 */ SubProductCode?: string; /** 业务产品申请的pid（对应一个定价公式），通过pid计费查询到定价模型高级版：1000827企业版：1000830旗舰版：1000832域名包 : 1000834业务扩展包 : 1000481高级版-CLB:1001150企业版-CLB : 1001152旗舰版-CLB:1001154域名包-CLB: 1001156业务扩展包-CLB : 1001160 */ Pid?: number; /** waf实例名 */ InstanceName?: string; /** 1:自动续费，0:不自动续费 */ AutoRenewFlag?: number; /** waf购买的实际地域信息 */ RealRegion?: number; /** 计费细项标签数组Saas 高级版 sv_wsm_waf_package_premium Saas 企业版 sv_wsm_waf_package_enterpriseSaas 旗舰版 sv_wsm_waf_package_ultimate Saas 非中国大陆高级版 sv_wsm_waf_package_premium_intlSaas 非中国大陆企业版 sv_wsm_waf_package_enterprise_intlSaas 非中国大陆旗舰版 sv_wsm_waf_package_ultimate _intlSaas 业务扩展包 sv_wsm_waf_qps_epSaas 域名扩展包 sv_wsm_waf_domain高级版CLB sv_wsm_waf_package_premium_clb企业版CLB sv_wsm_waf_package_enterprise_clb旗舰版CLB sv_wsm_waf_package_ultimate_clb非中国大陆高级版 CLB sv_wsm_waf_package_premium_clb_intl非中国大陆企业版CLB sv_wsm_waf_package_premium_clb_intl非中国大陆旗舰版CLB sv_wsm_waf_package_ultimate_clb _intl业务扩展包CLB sv_wsm_waf_qps_ep_clb域名扩展包CLB sv_wsm_waf_domain_clb */ LabelTypes?: string[]; /** 计费细项标签数量，一般和SvLabelType一一对应 */ LabelCounts?: number[]; /** 变配使用，实例到期时间 */ CurDeadline?: string; /** 对存在的实例购买bot 或api 安全 */ InstanceId?: string; /** 资源id */ ResourceId?: string; } /** 规则周期执行的数据结构 */ declare interface CronJob { /** 每个月的几号执行 */ Days?: number[]; /** 每个星期的星期几执行 */ WDays?: number[]; /** 开始时间 */ StartTime?: string; /** 结束时间 */ EndTime?: string; } /** 计费下单响应实体 */ declare interface DealData { /** 订单号列表，元素个数与请求包的goods数组的元素个数一致，商品详情与订单按顺序对应 */ DealNames?: string[]; /** 大订单号，一个大订单号下可以有多个子订单，说明是同一次下单[{},{}] */ BigDealId?: string; } /** DescribeAntiInfoLeakRules返回的规则元素中的具体的规则元素 */ declare interface DescribeAntiInfoLeakRulesStrategyItem { /** 字段 */ Field?: string; /** 条件 */ CompareFunc?: string; /** 内容 */ Content?: string; } /** 出参 */ declare interface DescribeAntiLeakageItem { /** 规则ID */ RuleId?: number; /** 名称 */ Name?: string; /** 状态值 */ Status?: number; /** 动作 */ Action?: string; /** 创建时间 */ CreateTime?: string; /** 匹配条件 */ Strategies?: DescribeAntiInfoLeakRulesStrategyItem[]; /** 匹配的URL */ Uri?: string; /** 修改时间 */ ModifyTime?: string; } /** DescribeAreaBanAreas接口的回包 */ declare interface DescribeAreaBanAreasRsp { /** 状态 "0"：未开启地域封禁 "1"：开启地域封禁 */ Status?: string; /** 数据来源 custom-自定义(默认)、batch-批量防护 */ Source?: string; /** 字符串数据，配置的地域列表 */ Areas?: string[]; /** 定时任务类型 */ JobType?: string; /** 定时任务详细配置 */ JobDateTime?: JobDateTime; /** 周期任务配置 */ CronType?: string; } /** 获取自定义规则列表时的出参 */ declare interface DescribeBotUCBRuleRsp { /** 规则列表 */ Res?: InOutputBotUCBRule[]; /** 规则总数 */ TotalCount?: number; } /** DescribeCustomRules接口回包中的复杂类型 */ declare interface DescribeCustomRulesRspRuleListItem { /** 动作类型，1代表阻断，2代表人机识别，3代表观察，4代表重定向，5代表JS校验 */ ActionType?: string; /** 跳过的策略 */ Bypass?: string; /** 创建时间 */ CreateTime?: string; /** 过期时间 */ ExpireTime?: string; /** 策略名称 */ Name?: string; /** 重定向地址 */ Redirect?: string; /** 策略ID */ RuleId?: string; /** 优先级 */ SortId?: string; /** 状态 */ Status?: string; /** 策略详情 */ Strategies?: Strategy[]; /** 事件id */ EventId?: string; /** 修改时间 */ ModifyTime?: string; /** 生效状态 */ ValidStatus?: number; /** 来源 */ Source?: string; /** 定时任务类型 */ JobType?: string; /** 定时任务配置信息 */ JobDateTime?: JobDateTime; /** 周期任务粒度 */ CronType?: string; /** 自定义标签，风控规则用，用来表示是内置规则还是用户自定义的 */ Label?: string; /** 拦截页面id */ PageId?: string; /** 域名 */ Domain?: string; /** 匹配条件的逻辑关系，支持and、or，分别表示多个逻辑匹配条件是与、或的关系 */ LogicalOp?: string; /** 规则灰度的比例，默认是100，不灰度 */ ActionRatio?: number; } /** domain列表 */ declare interface DomainInfo { /** 域名 */ Domain: string; /** 域名ID */ DomainId: string; /** 实例ID */ InstanceId: string; /** cname地址 */ Cname: string; /** 域名所属实例类型。sparta-waf：SaaS型WAF实例clb-waf：负载均衡型WAF实例cdc-clb-waf：CDC环境下负载均衡型WAF实例 */ Edition: 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" */ Region: string; /** 实例名 */ InstanceName: string; /** 访问日志开关状态。0：关闭1：开启 */ ClsStatus: number; /** 负载均衡型WAF使用模式。0：镜像模式 1：清洗模式 */ FlowMode: number; /** waf开关状态。0：关闭 1：开启 */ Status: number; /** 规则引擎防护模式。0：观察模式 1：拦截模式 */ Mode: number; /** 规则引擎和AI引擎防护模式联合状态。1:初始状态,规则引擎拦截&&AI引擎未操作开关状态10：规则引擎观察&&AI引擎关闭模式 11：规则引擎观察&&AI引擎观察模式 12：规则引擎观察&&AI引擎拦截模式 20：规则引擎拦截&&AI引擎关闭模式 21：规则引擎拦截&&AI引擎观察模式 22：规则引擎拦截&&AI引擎拦截模式 */ Engine: number; /** 沙箱集群回源出口IP列表 */ CCList: string[]; /** 生产集群回源出口IP列表 */ RsList: string[]; /** 服务端口配置 */ Ports: PortInfo[]; /** 负载均衡器相关配置 */ LoadBalancerSet: LoadBalancerPackageNew[]; /** 用户id */ AppId: number; /** SAAS型WAF域名状态：-2：配置下发失败-1：配置下发中0：DNS解析中1：无DNS解析记录，请接入WAF10：DNS解析未知，域名启用了代理11：DNS解析异常，使用A记录接入WAF IP200：检测源站不可达220：源站不支持长连接311：证书过期312：证书即将过期310：证书异常316：备案异常5：WAF回源已变更负载均衡型WAF域名LB监听器状态：0：操作成功 4：正在绑定LB 6：正在解绑LB 7：解绑LB失败 8：绑定LB失败 10：内部错误 */ State: number; /** 创建时间 */ CreateTime?: string; /** Ipv6开关状态。0：关闭 1：开启 */ Ipv6Status?: number; /** BOT开关状态。0：关闭 1：关闭2：开启3：开启 */ BotStatus?: number; /** 实例版本信息。101：小微敏捷版 102：小微超轻版2：高级版3：企业版4：旗舰版6：独享版 */ Level?: number; /** 投递CLS状态。0：关闭 1：开启 */ PostCLSStatus?: number; /** 投递CKafka状态。0：关闭 1：开启 */ PostCKafkaStatus?: number; /** cdc实例域名接入的集群信息,非cdc实例忽略。 */ CdcClusters?: string; /** api安全开关状态。0：关闭 1：开启 */ ApiStatus?: number; /** 应用型负载均衡类型，默认clb。clb：七层负载均衡器类型apisix：apisix网关型 */ AlbType?: string; /** 安全组状态。0：不展示1：非腾讯云源站2：安全组绑定失败3：安全组发生变更 */ SgState?: number; /** 安全组状态的详细解释 */ SgDetail?: string; /** 域名云环境。hybrid：混合云域名public：公有云域名 */ CloudType?: string; /** 域名备注信息 */ Note?: string; /** SAASWAF源站IP列表 */ SrcList?: string[]; /** SAASWAF源站域名列表 */ UpstreamDomainList?: string[]; /** 安全组ID */ SgID?: string; /** clbwaf接入状态，0代表“尚无流量接入”，1代表“流量接入”，2代表“CLB监听器已注销”，3代表“配置生效中”，4代表“配置下发失败中” */ AccessStatus?: number; /** 域名标签 */ Labels?: string[]; } /** waf 域名扩展套餐 */ declare interface DomainPackageNew { /** 资源ID */ ResourceIds: string; /** 过期时间 */ ValidTime: string; /** 是否自动续费，1：自动续费，0：不自动续费 */ RenewFlag: number; /** 套餐购买个数 */ Count: number; /** 套餐购买地域，clb-waf暂时没有用到 */ Region: string; } /** 域名-规则id结构体 */ declare interface DomainRuleId { /** 域名 */ Domain?: string; /** 规则id */ RuleId?: string; } /** 唯一定位Domain */ declare interface DomainURI { /** 域名 */ Domain: string; /** 版本 */ Edition: string; /** 实例ID */ InstanceID?: string; } /** SaaS型WAF域名详情 */ declare interface DomainsPartInfo { /** 域名 */ Domain?: string; /** 域名唯一ID */ DomainId?: string; /** 域名所属实例唯一ID */ InstanceId?: string; /** 域名所属实例类型 */ Edition?: string; /** 域名所属实例名 */ InstanceName?: string; /** 证书 */ Cert?: string; /** 创建时间 */ CreateTime?: string; /** 规则引擎和AI引擎防护模式联合状态。1:初始状态,规则引擎拦截&&AI引擎未操作开关状态10：规则引擎观察&&AI引擎关闭模式 11：规则引擎观察&&AI引擎观察模式 12：规则引擎观察&&AI引擎拦截模式 20：规则引擎拦截&&AI引擎关闭模式 21：规则引擎拦截&&AI引擎观察模式 22：规则引擎拦截&&AI引擎拦截模式 */ Engine?: number; /** 是否开启HTTP强制跳转到HTTPS。0：不强制跳转1：开启强制跳转 */ HttpsRewrite?: number; /** HTTPS回源端口 */ HttpsUpstreamPort?: string; /** waf前是否部署有七层代理服务。0：没有部署代理服务1：有部署代理服务，waf将使用XFF获取客户端IP2：有部署代理服务，waf将使用remote_addr获取客户端IP3：有部署代理服务，waf将使用ip_headers中的自定义header获取客户端IP */ IsCdn?: number; /** 是否开启灰度。 */ IsGray?: number; /** 是否开启HTTP2，需要开启HTTPS协议支持。0：关闭1：开启 */ IsHttp2?: number; /** 是否开启WebSocket支持。0：关闭1：开启 */ IsWebsocket?: number; /** 回源负载均衡策略。0：轮询1：IP hash2：加权轮询 */ LoadBalance?: number; /** 防护模式。0：观察模式1：拦截模式 */ Mode?: number; /** 自有证书的私钥 */ PrivateKey?: string; /** CertType为2时，需要填充此参数，表示腾讯云SSL平台托管的证书id */ SSLId?: string; /** 域名回源时的回源域名。UpstreamType为1时，需要填充此字段 */ UpstreamDomain?: string; /** 回源类型。0：通过IP回源1：通过域名回源 */ UpstreamType?: number; /** IP回源时的回源IP列表。UpstreamType为0时，需要填充此字段 */ SrcList?: string[]; /** 域名端口配置 */ Ports?: PortInfo[]; /** 证书类型。0：仅配置HTTP监听端口，没有证书1：证书来源为自有证书2：证书来源为托管证书 */ CertType?: number; /** 服务配置有HTTPS端口时，HTTPS的回源协议。http：使用http协议回源，和HttpsUpstreamPort配合使用https：使用https协议回源 */ UpstreamScheme?: string; /** 日志包是否开启。0：关闭1：开启 */ Cls?: number; /** 接入Cname，SaaS型域名使用此Cname进行接入 */ Cname?: string; /** 是否开启长连接。0：短连接1：长连接 */ IsKeepAlive?: number; /** 是否开启主动健康检测。0：不开启1：开启 */ ActiveCheck?: number; /** TLS版本信息 */ TLSVersion?: number; /** 自定义的加密套件列表。CipherTemplate为3时需要填此字段，表示自定义的加密套件，值通过DescribeCiphersDetail接口获取。 */ Ciphers?: number[]; /** 加密套件模板。0：不支持选择，使用默认模板 1：通用型模板 2：安全型模板3：自定义模板 */ CipherTemplate?: number; /** WAF与源站的连接超时，默认10s。 */ ProxyConnectTimeout?: number; /** WAF与源站的读超时时间，默认300s。 */ ProxyReadTimeout?: number; /** WAF与源站的写超时时间，默认300s。 */ ProxySendTimeout?: number; /** WAF回源时的SNI类型。0：关闭SNI，不配置client_hello中的server_name1：开启SNI，client_hello中的server_name为防护域名2：开启SNI，SNI为域名回源时的源站域名3：开启SNI，SNI为自定义域名 */ SniType?: number; /** SniType为3时，需要填此参数，表示自定义的SNI； */ SniHost?: string; /** 回源IP权重 */ Weights?: string[]; /** IsCdn=3时，表示自定义header */ IpHeaders?: string[]; /** 是否开启XFF重置。0：关闭1：开启 */ XFFReset?: number; /** 域名备注信息 */ Note?: string; /** 自定义回源Host。默认为空字符串，表示使用防护域名作为回源Host。 */ UpstreamHost?: string; /** 防护规则 */ Level?: string; /** 是否开启缓存 0-关闭 1-开启 */ ProxyBuffer?: number; /** 国密选项。0：不开启国密 1：在原有TLS选项的基础上追加支持国密 2：开启国密并仅支持国密客户端访问 */ GmType?: number; /** 国密证书类型。0：无国密证书 1：证书来源为自有国密证书 2：证书来源为托管国密证书 */ GmCertType?: number; /** GmCertType为1时，需要填充此参数，表示自有国密证书的证书链 */ GmCert?: string; /** GmCertType为1时，需要填充此参数，表示自有国密证书的私钥 */ GmPrivateKey?: string; /** GmCertType为1时，需要填充此参数，表示自有国密证书的加密证书 */ GmEncCert?: string; /** GmCertType为1时，需要填充此参数，表示自有国密证书的加密证书的私钥 */ GmEncPrivateKey?: string; /** GmCertType为2时，需要填充此参数，表示腾讯云SSL平台托管的证书id */ GmSSLId?: string; /** 域名标签 */ Labels?: string[]; /** 拨测状态。 0: 禁用拨测, 1: 启用拨测 */ ProbeStatus?: number; /** 回源策略。0：负载均衡回源1：分流回源 */ UpstreamPolicy?: number; /** 分流回源策略 */ UpstreamRules?: UpstreamRule[]; /** 业务场景。0：默认值，表示常规业务场景 1：大模型业务场景 */ UseCase?: number; /** gzip开关。0：关闭 1：默认值，打开。 */ Gzip?: number; /** SAAS型WAF域名状态：-2：配置下发失败-1：配置下发中0：DNS解析中1：无DNS解析记录，请接入WAF10：DNS解析未知，域名启用了代理11：DNS解析异常，使用A记录接入WAF IP200：检测源站不可达220：源站不支持长连接311：证书过期312：证书即将过期310：证书异常316：备案异常5：WAF回源已变更负载均衡型WAF域名LB监听器状态：0：操作成功 4：正在绑定LB 6：正在解绑LB 7：解绑LB失败 8：绑定LB失败 10：内部错误 */ State?: number; } /** 下载攻击日志记录数据项 */ declare interface DownloadAttackRecordInfo { /** 记录ID */ Id?: number; /** 下载任务名 */ TaskName?: string; /** 任务ID */ TaskId?: string; /** 域名 */ Host?: string; /** 当前下载任务的日志条数 */ Count?: number; /** 下载任务运行状态：-1-下载超时，0-下载等待，1-下载完成，2-下载失败，4-正在下载 */ Status?: number; /** 下载文件URL */ Url?: string; /** 创建时间 */ CreateTime?: string; /** 最后更新修改时间 */ ModifyTime?: string; /** 过期时间 */ ExpireTime?: string; /** 下载任务需下载的日志总条数 */ TotalCount?: number; } /** EnableLimitRuleItem */ declare interface EnableLimitRuleItem { /** 规则ID */ LimitRuleId?: number; /** 规则开关，0开启，1关闭 */ Status?: number; } /** DescribeAccessExports接口 */ declare interface ExportAccessInfo { /** 日志导出任务ID */ ExportId?: string; /** 日志导出查询语句 */ Query?: string; /** 日志导出文件名 */ FileName?: string; /** 日志文件大小 */ FileSize?: number; /** 日志导出时间排序 */ Order?: string; /** 日志导出格式 */ Format?: string; /** 日志导出数量 */ Count?: number; /** 日志下载状态。Processing:导出正在进行中，Complete:导出完成，Failed:导出失败，Expired:日志导出已过期（三天有效期） */ Status?: string; /** 日志导出起始时间 */ From?: number; /** 日志导出结束时间 */ To?: number; /** 日志导出路径 */ CosPath?: string; /** 日志导出创建时间 */ CreateTime?: string; } /** 日志导出信息 */ declare interface ExportInfo { /** 日志主题ID */ TopicId?: string; /** 日志导出任务ID */ ExportId?: string; /** 日志导出查询语句 */ Query?: string; /** 日志导出文件名 */ FileName?: string; /** 日志文件大小 */ FileSize?: number; /** 日志导出时间排序 */ Order?: string; /** 日志导出格式 */ Format?: string; /** 日志导出数量 */ Count?: number; /** 日志下载状态。Processing:导出正在进行中，Completed:导出完成，Failed:导出失败，Expired:日志导出已过期(三天有效期), Queuing 排队中 */ Status?: string; /** 日志导出起始时间 */ From?: number; /** 日志导出结束时间 */ To?: number; /** 日志导出路径,有效期一个小时，请尽快使用该路径下载。 */ CosPath?: string; /** 日志导出创建时间 */ CreateTime?: string; /** 语法规则。默认值为0。0：Lucene语法，1：CQL语法。 */ SyntaxRule?: number; /** 导出字段 */ DerivedFields?: string[] | null; } /** 设置哪些字段是否存储或转发 */ declare interface FieldWriteConfig { /** 1:开启 0:不开启 */ EnableHeaders?: number; /** 1:开启 0:不开启 */ EnableBody?: number; /** 1:开启 0:不开启 */ EnableBot?: number; } /** 过滤器 */ declare interface FilterCls { /** 需要过滤的字段。 */ Key: string; /** 需要过滤的值。 */ Values: string[]; } /** 过滤数组 */ declare interface FiltersItemNew { /** 字段名；过滤子订单号过滤通过name 为：DealName； value为子订单号 */ Name: string; /** 过滤值 */ Values: string[]; /** 是否精确查找 */ ExactMatch: boolean; } /** 域名列表 */ declare interface FindAllDomainDetail { /** 用户id */ Appid?: number; /** 域名 */ Domain?: string; /** 域名ip */ Ips?: string[]; /** 发现时间 */ FindTime?: string; /** 实例id */ InstanceId?: string; /** 域名id */ DomainId?: string; /** waf类型 */ Edition?: string; /** 是否接入waf */ IsWafDomain?: number; } /** 业务安全资源信息 */ declare interface FraudPkg { /** 资源id */ ResourceIds?: string; /** 状态 */ Status?: number; /** 地域 */ Region?: number; /** 开始时间 */ BeginTime?: string; /** 结束时间 */ EndTime?: string; /** 申请数量 */ InquireNum?: number; /** 使用数量 */ UsedNum?: number; /** 续费标志 */ RenewFlag?: number; } /** 当前开启的、匹配范围为全局、优先级最高的场景信息 */ declare interface GlobalSceneInfo { /** 场景ID */ SceneId?: string; /** 场景名称 */ SceneName?: string; /** 场景优先级 */ Priority?: number; /** 场景更新时间 */ UpdateTime?: number; } /** 计费下单接口出入参Goods */ declare interface GoodNews { /** 商品数量 */ GoodsNum: number; /** 商品明细 */ GoodsDetail: GoodsDetailNew; /** 订单类型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(变配) */ GoodsCategoryId?: number; /** 购买waf实例区域ID1 表示购买大陆资源;9表示购买非中国大陆资源 */ RegionId?: number; } /** 计费下单接口出入参Goods */ declare interface Goods { /** 付费类型，1:预付费，0:后付费 */ PayMode: number; /** 商品数量 */ GoodsNum: number; /** 商品明细 */ GoodsDetail: GoodsDetail; /** 默认为0 */ ProjectId: number; /** 计费类目ID，对应cid */ GoodsCategoryId?: number; /** 平台类型，默认1 */ Platform?: number; /** 购买waf实例区域ID */ RegionId?: number; } /** 产品明细 */ declare interface GoodsDetail { /** 时间间隔 */ TimeSpan: number; /** 单位，支持m、y、d */ TimeUnit: string; /** 产品码 */ ProductCode: string; /** 二级产品码 */ SubProductCode: string; /** 计费策略id */ Pid: number; /** waf产品码 */ ProductInfo?: ProductInfo[]; /** waf实例名 */ InstanceName?: string; /** QPS数量 */ ElasticQps?: number; /** 弹性账单 */ FlexBill?: number; /** 1:自动续费，0:不自动续费 */ AutoRenewFlag?: number; /** waf购买的实际地域信息 */ RealRegion?: number; /** Waf实例对应的二级产品码 */ Type?: string; /** 计费细项标签数组 */ LabelTypes?: string[]; /** 计费细项标签数量，一般和SvLabelType一一对应 */ LabelCounts?: number[]; /** 变配使用，实例到期时间 */ CurDeadline?: string; /** 对存在的实例购买bot 或api 安全 */ InstanceId?: string; } /** 产品明细 */ declare interface GoodsDetailNew { /** 时间间隔 */ TimeSpan?: number; /** 单位，支持购买d、m、y 即（日、月、年） */ TimeUnit?: string; /** 子产品标签,。新购，续费必传，变配时放在oldConfig newConfig里面Saas 高级版：sp_wsm_waf_premiumSaas企业版：sp_wsm_waf_enterpriseSaas旗舰版：sp_wsm_waf_ultimateSaas 业务扩展包：sp_wsm_waf_qpsepSaas 域名扩展包：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 */ SubProductCode?: string; /** 业务产品申请的pid（对应一个定价公式），通过pid计费查询到定价模型高级版：1000827企业版：1000830旗舰版：1000832域名包 : 1000834业务扩展包 : 1000481高级版-CLB:1001150企业版-CLB : 1001152旗舰版-CLB:1001154域名包-CLB: 1001156业务扩展包-CLB : 1001160 */ Pid?: number; /** waf实例名 */ InstanceName?: string; /** 1:自动续费，0:不自动续费 */ AutoRenewFlag?: number; /** waf购买的实际地域信息 */ RealRegion?: number; /** 计费细项标签数组Saas 高级版 sv_wsm_waf_package_premium Saas 企业版 sv_wsm_waf_package_enterpriseSaas 旗舰版 sv_wsm_waf_package_ultimate Saas 非中国大陆高级版 sv_wsm_waf_package_premium_intlSaas 非中国大陆企业版 sv_wsm_waf_package_enterprise_intlSaas 非中国大陆旗舰版 sv_wsm_waf_package_ultimate _intlSaas 业务扩展包 sv_wsm_waf_qps_epSaas 域名扩展包 sv_wsm_waf_domain高级版CLB sv_wsm_waf_package_premium_clb企业版CLB sv_wsm_waf_package_enterprise_clb旗舰版CLB sv_wsm_waf_package_ultimate_clb非中国大陆高级版 CLB sv_wsm_waf_package_premium_clb_intl非中国大陆企业版CLB sv_wsm_waf_package_premium_clb_intl非中国大陆旗舰版CLB sv_wsm_waf_package_ultimate_clb _intl业务扩展包CLB sv_wsm_waf_qps_ep_clb域名扩展包CLB sv_wsm_waf_domain_clb */ LabelTypes?: string[]; /** 计费细项标签数量，一般和SvLabelType一一对应 */ LabelCounts?: number[]; /** 变配使用，实例到期时间 */ CurDeadline?: string; /** 对存在的实例购买bot 或api 安全 */ InstanceId?: string; /** 资源id */ ResourceId?: string; /** 模式clb-waf或者saas-waf */ MicroVersion?: string; } /** 直方图详细信息 */ declare interface HistogramInfo { /** 统计周期内的日志条数 */ Count?: number; /** 按 period 取整后的 unix timestamp：单位毫秒 */ BTime?: number; } /** CLB-WAF删除域名参数 */ declare interface HostDel { /** 域名 */ Domain: string; /** 域名ID */ DomainId: string; /** 实例类型 */ InstanceID?: string; } /** 负载均衡型WAF域名信息 */ declare interface HostRecord { /** 域名 */ Domain: string; /** 域名唯一ID */ DomainId: string; /** 主域名，入参时为空 */ MainDomain: string; /** 规则引擎防护模式。0：观察模式1：拦截模式 */ Mode: number; /** waf和负载均衡器的绑定关系。0：未绑定1：已绑定 */ Status: number; /** clbwaf域名监听器状态。0：操作成功4：正在绑定LB6：正在解绑LB 7：解绑LB失败 8：绑定LB失败 10：内部错误 */ State: number; /** 规则引擎和AI引擎防护模式联合状态。1:初始状态,规则引擎拦截&&AI引擎未操作开关状态10：规则引擎观察&&AI引擎关闭模式 11：规则引擎观察&&AI引擎观察模式 12：规则引擎观察&&AI引擎拦截模式 20：规则引擎拦截&&AI引擎关闭模式 21：规则引擎拦截&&AI引擎观察模式 22：规则引擎拦截&&AI引擎拦截模式 */ Engine: number; /** waf前是否部署有七层代理服务。 0：没有部署代理服务 1：有部署代理服务，waf将使用XFF获取客户端IP 2：有部署代理服务，waf将使用remote_addr获取客户端IP 3：有部署代理服务，waf将使用ip_headers中的自定义header获取客户端IP */ IsCdn: number; /** 绑定的负载均衡器信息列表 */ LoadBalancerSet: LoadBalancer[]; /** 域名绑定的LB的地域，以逗号分割多个地域 */ Region: string; /** 域名所属实例类型。负载均衡型WAF为"clb-waf" */ Edition: string; /** 负载均衡型WAF域名的流量模式。1：清洗模式0：镜像模式 */ FlowMode: number; /** 是否开启访问日志。1：开启0：关闭 */ ClsStatus: number; /** 防护等级，可选值100,200,300 */ Level?: number; /** 域名需要下发到的cdc集群列表。仅CDC场景下填充 */ CdcClusters?: string[]; /** 应用型负载均衡类型，默认clb。 clb：七层负载均衡器类型 apisix：apisix网关型tsegw：云原生API网关scf：云函数 */ AlbType?: string; /** IsCdn=3时，需要填此参数，表示自定义header */ IpHeaders?: string[]; /** 规则引擎类型。1: menshen2: tiga */ EngineType?: number; /** 云类型。public:公有云private:私有云hybrid:混合云 */ CloudType?: string; /** 域名备注信息 */ Note?: string; } /** 设置WAF状态的结构体 */ declare interface HostStatus { /** 域名 */ Domain: string; /** 域名ID */ DomainId: string; /** WAF的开关，1：开，0：关 */ Status: number; /** 实例ID */ InstanceID?: string; } /** 混合云节点资源信息 */ declare interface HybridPkg { /** 资源id */ ResourceIds?: string; /** 状态 */ Status?: number; /** 地域 */ Region?: number; /** 开始时间 */ BeginTime?: string; /** 结束时间 */ EndTime?: string; /** 申请数量 */ InquireNum?: number; /** 使用数量 */ UsedNum?: number; /** 续费标志 */ RenewFlag?: number; } /** 修改/新增自定义规则的入参，查询自定义规则列表时的出参 */ declare interface InOutputBotUCBRule { /** 域名 */ Domain: string; /** 规则名称 */ Name: string; /** UCB的具体规则项 */ Rule: InOutputUCBRuleEntry[]; /** 处置动作 */ Action: string; /** 规则开关 */ OnOff: string; /** 规则类型 */ RuleType: number; /** 规则优先级 */ Prior: number; /** 修改时间戳 */ Timestamp: number; /** 标签 */ Label: string; /** 入参ID */ Id?: string; /** 场景ID */ SceneId?: string; /** 生效时间 */ ValidTime?: number; /** 传入的appid */ Appid?: number; /** 额外参数 */ AdditionArg?: string; /** 规则描述 */ Desc?: string; /** 规则ID */ RuleId?: string; /** true-系统预设规则 false-自定义规则 */ PreDefine?: boolean; /** 定时任务类型 */ JobType?: string; /** 定时任务配置 */ JobDateTime?: JobDateTime; /** 生效截止时间 */ ExpireTime?: number; /** 生效-1,失效-0 */ ValidStatus?: number; /** 自定义拦截页面ID */ BlockPageId?: number; /** 当Action=intercept时，此字段必填 */ ActionList?: UCBActionProportion[]; /** 惩罚时间 */ DelayTime?: number; } /** 自定义规则UCB的Rule生效条件 */ declare interface InOutputUCBRuleEntry { /** 键 */ Key?: string; /** 操作符 */ Op?: string; /** 值 */ Value?: UCBEntryValue; /** 可选的补充操作符 */ OpOp?: string; /** 可选的补充参数 */ OpArg?: string[]; /** 可选的补充值 */ OpValue?: number; /** Header参数值时使用 */ Name?: string; /** 区域选择 */ Areas?: Area[]; /** 语言环境 */ Lang?: string; /** 参数匹配 */ ParamCompareList?: ParamCompareList[]; } /** 一个实例的详细信息 */ declare interface InstanceInfo { /** 实例唯一ID */ InstanceId: string; /** 实例名称 */ InstanceName: string; /** 实例对应资源ID，计费使用 */ ResourceIds: string; /** 实例所属地域 */ Region: string; /** 付费模式 */ PayMode: number; /** 自动续费标识。0：关闭1：开启 */ RenewFlag: number; /** 弹性计费开关。0：关闭1：开启 */ Mode: number; /** 实例套餐版本。101：小微版102：超轻版2：高级版3：企业版4：旗舰版6：独享版 */ Level: number; /** 实例过期时间 */ ValidTime: string; /** 实例开始时间 */ BeginTime: string; /** 已配置域名个数 */ DomainCount: number; /** 域名数量上限 */ SubDomainLimit: number; /** 已配置主域名个数 */ MainDomainCount: number; /** 主域名数量上限 */ MainDomainLimit: number; /** 实例30天内QPS峰值 */ MaxQPS: number; /** qps扩展包信息 */ QPS: QPSPackageNew; /** 域名扩展包信息 */ DomainPkg: DomainPackageNew; /** 用户appid */ AppId: number; /** clb或saas */ Edition: string; /** 业务安全包 */ FraudPkg?: FraudPkg; /** Bot资源包 */ BotPkg?: BotPkg; /** bot的qps详情 */ BotQPS?: BotQPS; /** qps弹性计费上限 */ ElasticBilling?: number; /** 攻击日志投递开关 */ AttackLogPost?: number; /** 带宽峰值，单位为B/s(字节每秒) */ MaxBandwidth?: number; /** api安全是否购买 */ APISecurity?: number; /** 购买的qps规格 */ QpsStandard?: number; /** 购买的带宽规格 */ BandwidthStandard?: number; /** 实例状态 */ Status?: number; /** 实例沙箱qps值 */ SandboxQps?: number; /** 是否api 安全试用 */ IsAPISecurityTrial?: number; /** 重保包 */ MajorEventsPkg?: MajorEventsPkg; /** 混合云子节点包 */ HybridPkg?: HybridPkg; /** API安全资源包 */ ApiPkg?: ApiPkg; /** 小程序安全加速包 */ MiniPkg?: MiniPkg; /** 小程序qps规格 */ MiniQpsStandard?: number; /** 小程序qps峰值 */ MiniMaxQPS?: number; /** 最近一次超量时间 */ LastQpsExceedTime?: string; /** 小程序安全接入ID数量扩张包 */ MiniExtendPkg?: MiniExtendPkg; /** 计费项 */ BillingItem?: string; /** 实例延期释放标识 */ FreeDelayFlag?: number; /** 最近3天最大qps */ Last3MaxQPS?: number; /** 最近3天最大带宽 */ Last3MaxBandwidth?: number; /** 重保增强包 */ MajorEventsProPkg?: MajorEventsProPkg; /** 1是基础2025版本；0不是 */ BasicFlag?: number; /** 实例的网络配置 */ NetworkConfig?: NetworkConfig; /** RCE设备安全信息包 */ RCEPkg?: RCEPkg; /** 超量策略。0：超量沙箱1：超量限流 */ ExceedPolicy?: number; /** 大模型安全信息包 */ LLMPkg?: LLMPkg; /** 弹性资源Id */ ElasticResourceId?: string; /** 预付费大模型安全信息包 */ LLMMonPkg?: LLMMonPkg; /** 地域id */ RegionId?: number; /** BOT安全护航信息 */ BotSecurityPkg?: BotSecurityPkg; /** BOT安全监测资源信息 */ BotMonitorPkg?: BotMonitorPkg; } /** 数据封装 */ declare interface IpAccessControlData { /** ip黑白名单 */ Res?: IpAccessControlItem[]; /** 计数 */ TotalCount?: number; } /** ip黑白名单 */ declare interface IpAccessControlItem { /** mongo表自增Id */ Id?: string; /** 动作 */ ActionType?: number; /** ip */ Ip?: string; /** 备注 */ Note?: string; /** 来源 */ Source?: string; /** 更新时间戳 */ TsVersion?: number; /** 有效截止时间戳 */ ValidTs?: number; /** 生效状态 */ ValidStatus?: number; /** 55000001 */ RuleId?: number; /** IP列表 */ IpList?: string[]; /** 规则创建时间 */ CreateTime?: number; /** 定时任务类型 */ JobType?: string; /** 周期任务类型 */ CronType?: string; /** 定时任务配置详情 */ JobDateTime?: JobDateTime; } /** IP黑白名单参数结构体，主要用于IP黑白名单的导入。 */ declare interface IpAccessControlParam { /** IP列表 */ IpList: string[]; /** valid_ts为有效日期，值为秒级时间戳（（如1680570420代表2023-04-04 09:07:00）） */ ValidTs: number; /** 42为黑名单，40为白名单 */ ActionType: number; /** 备注 */ Note?: string; } /** ip封堵状态数据 */ declare interface IpHitItem { /** 动作 */ Action?: number; /** 类别 */ Category?: string; /** ip */ Ip?: string; /** 规则名称 */ Name?: string; /** 时间戳 */ TsVersion?: number; /** 有效截止时间戳 */ ValidTs?: number; } /** 封装参数 */ declare interface IpHitItemsData { /** 数组封装 */ Res?: IpHitItem[]; /** 总数目 */ TotalCount?: number; } /** 当用户选择JWS/JWE会话管理方式的时候，上传的配置信息以及校验规则 */ declare interface JWTConfig { /** 密钥信息 */ SecretInfo?: SecretInfo; /** Payload校验规则集合 */ PayloadRule?: TokenRuleEntry[]; } /** 规则执行的时间结构体 */ declare interface JobDateTime { /** 定时执行的时间参数 */ Timed?: TimedJob[]; /** 周期执行的时间参数 */ Cron?: CronJob[]; /** 时区 */ TimeTZone?: string; } /** Key-Value的形式，Value为Int */ declare interface KVInt { /** Key */ Key?: string; /** Value */ Value?: number; } /** 有效预付费大模型安全包信息 */ declare interface LLMMonPkg { /** 资源id */ ResourceIds?: string; /** 状态 */ Status?: number; /** 地域 */ Region?: number; /** 开始时间 */ BeginTime?: string; /** 结束时间 */ EndTime?: string; /** 计费项 */ InquireKey?: string; /** 预付费大模型安全续费标识0 手动续费；1自动续费；2 到期不续 */ RenewFlag?: number; /** 大模型安全Token使用量 */ UseToken?: number; /** 实例id */ InstanceId?: string; } /** 有效大模型安全包信息 */ declare interface LLMPkg { /** 资源id */ ResourceIds?: string; /** 状态 */ Status?: number; /** 地域 */ Region?: number; /** 开始时间 */ BeginTime?: string; /** 结束时间 */ EndTime?: string; /** 计费项 */ InquireKey?: string; } /** 限流Header数据结构 */ declare interface LimitHeader { /** key */ Key?: string | null; /** value */ Value?: string | null; /** 匹配方式，支持EXACT(等于), REGEX（正则） , IN（属于） , NOT_IN（不属于）, CONTAINS（包含）, NOT_CONTAINS（不包含） */ Type?: string | null; } /** 限流Header参数名 */ declare interface LimitHeaderName { /** 参数名 */ ParamsName?: string | null; /** 操作符号,支持REGEX(正则),IN(属于),NOT_IN(不属于), EACH(每个参数值) */ Type?: string | null; } /** 限流方法数据结构 */ declare interface LimitMethod { /** 需要限流的请求方式 */ Method?: string | null; /** 匹配方式，支持EXACT(等于), REGEX（正则） , IN（属于） , NOT_IN（不属于）, CONTAINS（包含）, NOT_CONTAINS（不包含） */ Type?: string | null; } /** 限流Path */ declare interface LimitPath { /** 限流路径 */ Path?: string | null; /** 匹配方式 */ Type?: string | null; } /** 自研版限流规则数据结构 */ declare interface LimitRuleV2 { /** 规则ID */ LimitRuleID?: number; /** 规则名 */ Name?: string; /** 优先级 */ Priority?: number; /** 规则开关，0表示关闭，1表示开启 */ Status?: number; /** 时间戳 */ TsVersion?: number; /** 限流对象，API或Domain */ LimitObject?: string; /** 限流方法名 */ LimitMethod?: LimitMethod | null; /** 路径 */ LimitPaths?: LimitPath | null; /** Header参数 */ LimitHeaders?: LimitHeader[] | null; /** 限流窗口 */ LimitWindow?: LimitWindow; /** 限流策略，0:观察,1:拦截，2:人机 */ LimitStrategy?: number; /** Header参数名 */ LimitHeaderName?: LimitHeaderName | null; /** Get参数名 */ GetParamsName?: MatchOption | null; /** Get参数值 */ GetParamsValue?: MatchOption | null; /** Post参数名 */ PostParamsName?: MatchOption | null; /** Post参数值 */ PostParamsValue?: MatchOption | null; /** Ip属地 */ IpLocation?: MatchOption | null; /** 重定向信息，当LimitStrategy为2时，此字段不为空 */ RedirectInfo?: RedirectInfo | null; /** 拦截页面，0表示429，否则为BlockPageID */ BlockPage?: number; /** 限流对象来源，0：手动填写，1：API资产 */ ObjectSrc?: number; /** 是否共享配额，只有当对象为URL时有效，false表示URL独享配额，true表示所有URL共享配额 */ QuotaShare?: boolean; /** 路径选项,可配置每个路径的请求方法 */ PathsOption?: PathItem[] | null; /** 574新增需求，限流执行顺序，0：默认情况，限流优先，1：安全防护优先 */ Order?: number; } /** 限流窗口大小 */ declare interface LimitWindow { /** 每秒允许通过的最大请求数 */ Second?: number | null; /** 每分钟允许通过的最大请求数 */ Minute?: number | null; /** 每小时允许通过的最大请求数 */ Hour?: number | null; /** 是否共享配额，只有当对象为URL时有效，false表示URL独享配额，true表示所有URL共享配额 */ QuotaShare?: boolean | null; } /** 负载均衡的监听器 */ declare interface LoadBalancer { /** 负载均衡LD的ID */ LoadBalancerId: string; /** 负载均衡LD的名称 */ LoadBalancerName: string; /** 负载均衡监听器的ID */ ListenerId: string; /** 负载均衡监听器的名称 */ ListenerName: string; /** 负载均衡实例的端口 */ Vport: number; /** 负载均衡LD的地域 */ Region: string; /** 监听器协议，http、https */ Protocol: string