UNPKG

tencentcloud-sdk-nodejs

Version:
2,776 lines (2,768 loc) 410 kB
/** * api安全自定义事件规则结构体 */ export interface ApiSecCustomEventRule { /** * 规则名称 */ RuleName: string; /** * 开关,1:开,0:关 */ Status: number; /** * api匹配列表 */ ApiNameOp?: Array<ApiNameOp>; /** * 事件详情 */ Description?: string; /** * 时间戳,出参有该值,入参不需要传没有 */ UpdateTime?: number; /** * 匹配规则列表 */ MatchRuleList?: Array<ApiSecSceneRuleEntry>; /** * 统计规则列表 */ StatRuleList?: Array<ApiSecSceneRuleEntry>; /** * 访问频次,第一个字段表示次数,第二个字段表示分钟 */ ReqFrequency?: Array<number | bigint>; /** * 风险等级,取值为100,200,300,分别表示低位、中危、高危 */ RiskLevel?: string; /** * 规则来源 */ Source?: string; } /** * DeleteOwaspWhiteRule请求参数结构体 */ export interface DeleteOwaspWhiteRuleRequest { /** * 规则白名单ID列表 */ Ids: Array<number | bigint>; /** * 域名 */ Domain: string; } /** * ModifyUserLevel返回参数结构体 */ export interface ModifyUserLevelResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 事件变更内容 */ export interface ApiSecEventChange { /** * 变更人 */ UserName: string; /** * 变更的状态 */ Mode: string; /** * 时间戳 */ Timestamp: number; /** * 备注 */ Remark?: string; } /** * DescribeLogHistogram请求参数结构体 */ export interface DescribeLogHistogramRequest { /** * 要查询的日志的起始时间,Unix时间戳,单位ms */ From: number; /** * 要查询的日志的结束时间,Unix时间戳,单位ms */ To: number; /** * 查询语句,进行base64编码 */ Query: string; /** * 日志主题ID,可以通过DescribeTopics接口获取,访问日志主题ID和攻击日志主题ID方式不同,注意DescribeTopics接口使用方法 */ TopicId?: string; /** * 时间间隔: 单位ms 限制性条件:(To-From) / interval <= 200 */ Interval?: number; /** * 检索语法规则,默认值为0。 0:Lucene语法,1:CQL语法。 详细说明参见<a href="https://cloud.tencent.com/document/product/614/47044#RetrievesConditionalRules" target="_blank">检索条件语法规则</a> */ SyntaxRule?: number; } /** * DescribeSkillSecScanResult返回参数结构体 */ export interface DescribeSkillSecScanResultResponse { /** * <p>检测结果</p> */ Data?: SkillScanQueryData; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateBatchIpAccessControl返回参数结构体 */ export interface CreateBatchIpAccessControlResponse { /** * 添加失败的域名列表,如果非空则表示有域名添加失败,整个批量规则添加失败,否则则表示批量规则添加成功。 */ Failed?: Array<BatchDomainResult>; /** * 添加成功的批量规则ID */ RuleId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyWebshellStatus请求参数结构体 */ export interface ModifyWebshellStatusRequest { /** * 域名webshell状态 */ Webshell: WebshellStatus; } /** * waf模块的规格 */ export interface WafRuleLimit { /** * 自定义CC的规格 */ CC?: number; /** * 自定义策略的规格 */ CustomRule?: number; /** * 黑白名单的规格 */ IPControl?: number; /** * 信息防泄漏的规格 */ AntiLeak?: number; /** * 防篡改的规格 */ AntiTamper?: number; /** * 紧急CC的规格 */ AutoCC?: number; /** * 地域封禁的规格 */ AreaBan?: number; /** * 自定义CC中配置session */ CCSession?: number; /** * AI的规格 */ AI?: number; /** * 精准白名单的规格 */ CustomWhite?: number; /** * api安全的规格 */ ApiSecurity?: number; /** * 客户端流量标记的规格 */ ClientMsg?: number; /** * 流量标记的规格 */ TrafficMarking?: number; /** * 批量cc */ BatchCC?: number; /** * 批量session */ BatchSession?: number; } /** * DescribeUserClbWafRegions返回参数结构体 */ export interface DescribeUserClbWafRegionsResponse { /** * 地域(标准的ap-格式)列表 */ Data?: Array<string>; /** * 包含详细属性的地域信息 */ RichDatas?: Array<ClbWafRegionItem>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * TLS 加密套件 */ export interface TLSCiphers { /** * TLS版本ID */ VersionId?: number; /** * 加密套件ID */ CipherId?: number; /** * 加密套件 */ CipherName?: string; } /** * AddAntiFakeUrl请求参数结构体 */ export interface AddAntiFakeUrlRequest { /** * 域名 */ Domain: string; /** * 名称 */ Name: string; /** * uri */ Uri: string; } /** * DescribeOwaspWhiteRules返回参数结构体 */ export interface DescribeOwaspWhiteRulesResponse { /** * 规则总数 */ Total?: number; /** * 规则白名单列表 */ List?: Array<OwaspWhiteRule>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeApiListVersionTwo返回参数结构体 */ export interface DescribeApiListVersionTwoResponse { /** * api资产列表 */ Data?: Array<ApiAsset>; /** * 总数 */ Total?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 当前开启的、匹配范围为全局、优先级最高的场景信息 */ export interface GlobalSceneInfo { /** * 场景ID */ SceneId?: string; /** * 场景名称 */ SceneName?: string; /** * 场景优先级 */ Priority?: number; /** * 场景更新时间 */ UpdateTime?: number; } /** * 对象 */ export interface Object { /** * 对象id */ ObjectId?: string; /** * 成员appid */ MemberAppId?: number; /** * 成员uin */ MemberUin?: string; /** * 成员昵称 */ MemberNickName?: string; } /** * DescribePeakValue返回参数结构体 */ export interface DescribePeakValueResponse { /** * QPS峰值 */ Access?: number; /** * 上行带宽峰值,单位B */ Up?: number; /** * 下行带宽峰值,单位B */ Down?: number; /** * Web攻击总数 */ Attack?: number; /** * CC攻击总数 */ Cc?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 指定限流path和对应的method */ export interface PathItem { /** * 请求路径 */ Path?: string; /** * 请求方法 */ Method?: string; } /** * waf产品 */ export interface ProductInfo { /** * 产品名称 */ Name?: string; /** * 版本 */ Value?: string; } /** * 出参 */ export interface DescribeAntiLeakageItem { /** * 规则ID */ RuleId?: number; /** * 名称 */ Name?: string; /** * 状态值 */ Status?: number; /** * 动作 */ Action?: string; /** * 创建时间 */ CreateTime?: string; /** * 匹配条件 */ Strategies?: Array<DescribeAntiInfoLeakRulesStrategyItem>; /** * 匹配的URL */ Uri?: string; /** * 修改时间 */ ModifyTime?: string; } /** * 负载均衡器 */ export interface LoadBalancerPackageNew { /** * 监听id */ ListenerId: string; /** * 监听名 */ ListenerName: string; /** * 负载均衡id */ LoadBalancerId: string; /** * 负载均衡名 */ LoadBalancerName: string; /** * 协议 */ Protocol: 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", "雅加达": "jkt" */ Region: string; /** * 接入IP */ Vip: string; /** * 接入端口 */ Vport: number; /** * 地域 */ Zone: string; /** * VPCID */ NumericalVpcId: number; /** * CLB类型 */ LoadBalancerType: string; /** * 负载均衡器的域名 */ LoadBalancerDomain?: string; /** * 监听器所属appid */ MemberAppId?: number; /** * 监听器自身所属uin */ MemberUin?: string; /** * 监听器被接入的waf账号 */ Appid?: number; /** * 集团账号昵称 */ MemberNickName?: string; } /** * DescribeOwaspWhiteRules请求参数结构体 */ export interface DescribeOwaspWhiteRulesRequest { /** * 需要查询的域名 */ Domain: string; /** * 分页分页,默认为0 */ Offset?: number; /** * 每页容量,默认为10 */ Limit?: number; /** * 排序的字段,支持CreateTime:新建时间、UpdateTime:修改时间 */ By?: string; /** * 排序方式,支持asc、desc */ Order?: string; /** * 筛选条件,支持RuleId:加白规则ID、 Name:规则名称、RuleType:加白的规则类型、Status:规则开关状态、ValidStatus:规则生效状态、TimerType:生效方式、ID:具体的加白id,根据RuleType来判断是规则id还是类型id */ Filters?: Array<FiltersItemNew>; } /** * SearchLog返回参数结构体 */ export interface SearchLogResponse { /** * 透传本次接口返回的Context值,可获取后续更多日志,过期时间1小时。 注意: * 仅适用于单日志主题检索,检索多个日志主题时,请使用Topics中的Context */ Context?: string; /** * 符合检索条件的日志是否已全部返回,如未全部返回可使用Context参数获取后续更多日志 注意:仅当检索分析语句(Query)不包含SQL时有效 */ ListOver?: boolean; /** * 返回的是否为统计分析(即SQL)结果 */ Analysis?: boolean; /** * 匹配检索条件的原始日志 注意:此字段可能返回 null,表示取不到有效值。 */ Results?: Array<LogInfo>; /** * 日志统计分析结果的列名 当UseNewAnalysis为false时生效 注意:此字段可能返回 null,表示取不到有效值。 */ ColNames?: Array<string>; /** * 日志统计分析结果 当UseNewAnalysis为false时生效 注意:此字段可能返回 null,表示取不到有效值。 */ AnalysisResults?: Array<LogItems>; /** * 日志统计分析结果 当UseNewAnalysis为true时生效 注意:此字段可能返回 null,表示取不到有效值。 */ AnalysisRecords?: Array<string>; /** * 日志统计分析结果的列属性 当UseNewAnalysis为true时生效 注意:此字段可能返回 null,表示取不到有效值。 */ Columns?: Array<Column>; /** * 本次统计分析使用的采样率 注意:此字段可能返回 null,表示取不到有效值。 */ SamplingRate?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyUserSignatureClass返回参数结构体 */ export interface ModifyUserSignatureClassResponse { /** * 规则类型ID */ TypeID?: string; /** * 规则类型状态,0:关闭,1:开启 */ Status?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UpdateProtectionModes返回参数结构体 */ export interface UpdateProtectionModesResponse { /** * 操作结果 */ CommonRsp?: CommonRspData; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 大模型安全检测综合结果 */ export interface LLMDetectResult { /** * <p>仅输出侧:涉敏信息</p> */ SensitiveResult?: Array<LLMSensitiveValueLevel>; /** * <p>输入输出均检测:关键词库命中信息</p> */ KeyWordsResult?: Array<KeyWordInfo>; /** * <p>输入输出均检测:数据分类分级结果</p> */ DataCategoryResult?: Array<string>; /** * <p>仅输入侧检出:prompt检测的结果</p> */ PromptInjectionResult?: PromptDetectResult; /** * <p>命中的规则ID</p> */ RuleId?: string; /** * <p>命中的规则名称</p> */ RuleName?: string; /** * <p>规则动作</p> */ Action?: string; /** * <p>攻击payload</p> */ Payload?: string; /** * <p>图片检测结果</p> */ ImageResult?: Array<ImageResult>; /** * <p>要代答的消息id,此消息id用于作为GenerateLLMSecAnswer接口的入参</p> */ MsgID?: string; /** * <p>toolcall的检测结果</p> */ ToolCallResult?: ToolCallResult; /** * <p>意图检测结果</p> */ IntentDetectResult?: IntentDetectResult; } /** * ModifyApiSecSensitiveRule返回参数结构体 */ export interface ModifyApiSecSensitiveRuleResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * cc规则 */ export 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?: Array<number | bigint>; /** * 创建时间 */ CreateTime?: number; } /** * DescribeCertificateVerifyResult返回参数结构体 */ export interface DescribeCertificateVerifyResultResponse { /** * 状态码。 0:证书正常 310:证书异常 311:证书过期 312:证书即将过期 */ Status?: number; /** * 错误详情 */ Detail?: Array<string>; /** * 过期时间 */ NotAfter?: string; /** * 证书是否改变。 0:未变化 1:有变化 */ Changed?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyUserSignatureRule返回参数结构体 */ export interface ModifyUserSignatureRuleResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyInstanceName返回参数结构体 */ export interface ModifyInstanceNameResponse { /** * 修改状态:0为成功 */ ModifyCode?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 实例对象的简略结构,只包含实例ID和实例名 */ export interface InstanceBriefInfo { /** * 实例ID */ ID?: string; /** * 实例名 */ Name?: string; } /** * DescribeWafAutoDenyRules请求参数结构体 */ export interface DescribeWafAutoDenyRulesRequest { /** * 域名 */ Domain: string; /** * 实例Id */ InstanceId?: string; } /** * 重保防护资源信息 */ export interface MajorEventsProPkg { /** * 资源id */ ResourceIds?: string; /** * 状态 */ Status?: number; /** * 地域 */ Region?: number; /** * 开始时间 */ BeginTime?: string; /** * 结束时间 */ EndTime?: string; /** * 申请数量 */ InquireNum?: number; /** * 使用数量 */ UsedNum?: number; /** * 续费标志 */ RenewFlag?: number; /** * 计费项 */ BillingItem?: string; } /** * GenerateDealsAndPayNew请求参数结构体 */ export interface GenerateDealsAndPayNewRequest { /** * 计费下单入参 */ Goods: Array<GoodNews>; } /** * DeleteCustomWhiteRule返回参数结构体 */ export interface DeleteCustomWhiteRuleResponse { /** * 操作的状态码,如果所有的资源操作成功则返回的是成功的状态码,如果有资源操作失败则需要解析Message的内容来查看哪个资源失败 */ Success?: ResponseCode; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyHostMode返回参数结构体 */ export interface ModifyHostModeResponse { /** * 操作的状态码,如果所有的资源操作成功则返回的是成功的状态码,如果有资源操作失败则需要解析Message的内容来查看哪个资源失败 */ Success?: ResponseCode; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyBotSceneStatus返回参数结构体 */ export interface ModifyBotSceneStatusResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAreaBanAreas返回参数结构体 */ export interface DescribeAreaBanAreasResponse { /** * 回包内容 */ Data?: DescribeAreaBanAreasRsp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 免鉴权条件信息 */ export interface ConditionInfo { /** * 条件属性,目前只支持VpcID */ Attributes?: string; /** * 条件规则,1:等于,2:不等于 */ Rule?: number; /** * 对应条件属性的值 */ ConditionValue?: string; } /** * 重保防护资源信息 */ export interface MajorEventsPkg { /** * 资源id */ ResourceIds?: string; /** * 状态 */ Status?: number; /** * 地域 */ Region?: number; /** * 开始时间 */ BeginTime?: string; /** * 结束时间 */ EndTime?: string; /** * 申请数量 */ InquireNum?: number; /** * 使用数量 */ UsedNum?: number; /** * 续费标志 */ RenewFlag?: number; /** * 计费项 */ BillingItem?: string; /** * 护网包状态 */ HWState?: number; } /** * DescribeDomainRules请求参数结构体 */ export interface DescribeDomainRulesRequest { /** * 需要查询的域名 */ Domain?: string; } /** * DescribeScanIp请求参数结构体 */ export interface DescribeScanIpRequest { /** * 要查询的ip地址 */ Ip: string; } /** * DeleteAccessExport返回参数结构体 */ export interface DeleteAccessExportResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeModuleStatus返回参数结构体 */ export interface DescribeModuleStatusResponse { /** * WEB安全规则是否开启 */ WebSecurity?: number; /** * 访问控制规则是否开启 */ AccessControl?: number; /** * CC防护是否开启 */ CcProtection?: number; /** * 网页防篡改是否开启 */ AntiTamper?: number; /** * 信息防泄漏是否开启 */ AntiLeakage?: number; /** * API安全是否开启 */ ApiProtection?: number; /** * 限流模块开关 */ RateLimit?: number; /** * gzip 开关 */ GzipAnalysis?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 用于 DescribeAccessIndex 的出参 */ export interface AccessKeyValueInfo { /** * 需要配置键值或者元字段索引的字段 */ Key?: string; /** * 字段的索引描述信息 */ Value?: AccessValueInfo; } /** * JWT显示设置(只有当校验方式为JWS/JWE的时候才会有该配置信息) */ export interface TokenDisplaySetting { /** * 是否使用payload字段作为显示token */ DisplayWithPayloadEnable?: boolean; /** * 用于显示的payload字段名 */ FieldName?: string; } /** * Key-Value的形式,Value为Int */ export interface KVInt { /** * Key */ Key?: string; /** * Value */ Value?: number; } /** * 防护对象组对象详情 */ export interface ProtectGroupInfo { /** * <p>防护对象组ID</p> */ ID?: number; /** * <p>防护对象组名称</p> */ Name?: string; /** * <p>防护对象组备注</p> */ Remark?: string; /** * <p>防护对象组中绑定的域名详情</p> */ Domains?: Array<ProtectGroupDomainInfo>; /** * <p>关联的批量规则数</p> */ RuleNum?: number; /** * <p>创建时间</p> */ CreateTime?: string; /** * <p>更新时间</p> */ UpdateTime?: string; /** * <p>标签信息</p> */ TagInfos?: Array<TagInfo>; /** * <p>是否绑定了模板</p> 注意:此字段可能返回 null,表示取不到有效值。 */ BoundTemplate?: boolean; } /** * AddAntiInfoLeakRules请求参数结构体 */ export interface AddAntiInfoLeakRulesRequest { /** * 域名 */ Domain: string; /** * 规则名称 */ Name: string; /** * 动作,0(告警)、1(替换)、2(仅显示前四位)、3(仅显示后四位)、4(阻断) */ ActionType: number; /** * 策略详情 */ Strategies: Array<StrategyForAntiInfoLeak>; /** * 网址 */ Uri?: string; } /** * bot-token配置 */ export interface BotToken { /** * 会话名称 */ Name?: string; /** * 会话描述 */ Description?: string; /** * 会话id */ Id?: string; /** * 策略的开关状态 */ Status?: boolean; /** * 会话位置 */ Location?: string; /** * 会话key */ Key?: string; /** * 会话匹配方式,前缀匹配、后缀匹配等 */ Operator?: string; /** * 会话更新的时间戳 */ Timestamp?: number; /** * 场景列表,内容为空表示全部场景应用 */ Scene?: Array<string>; /** * 优先级 */ Priority?: number; /** * token有效性配置信息 */ TokenValidation?: TokenValidation; /** * 1表示开启了禁用嵌套功能 */ DisableMultiJson?: number; } /** * UpdateRateLimitV2请求参数结构体 */ export interface UpdateRateLimitV2Request { /** * 域名 */ Domain: string; /** * 规则ID */ LimitRuleId: number; /** * 规则名 */ Name: string; /** * 优先级 */ Priority: number; /** * 开关,0关闭,1开启 */ Status: number; /** * 支持API,Domain。如果基于API,则LimitPaths不能为空,否则LimitPaths为空 */ LimitObject: string; /** * 限流策略,0:观察,1:拦截,2:人机 */ LimitStrategy: number; /** * 基于Header参数名限流 */ LimitHeaderName?: LimitHeaderName; /** * 限流方法 */ LimitMethod?: LimitMethod; /** * 限流路径 */ LimitPaths?: LimitPath; /** * 限流Headers */ LimitHeaders?: Array<LimitHeader>; /** * 限流窗口 */ LimitWindow?: LimitWindow; /** * 基于Get参数名限流 */ GetParamsName?: MatchOption; /** * 基于Get参数值限流 */ GetParamsValue?: MatchOption; /** * 基于Post参数名限流 */ PostParamsName?: MatchOption; /** * 基于Post参数值限流 */ PostParamsValue?: MatchOption; /** * 基于IP归属地限流 */ IpLocation?: MatchOption; /** * 重定向信息,当LimitStrategy为重定向时,此字段必填 */ RedirectInfo?: RedirectInfo; /** * 拦截页面,0表示429,否则填写blockPageID */ BlockPage?: number; /** * 限流对象来源,0:手动填写,1:API资产 */ ObjectSrc?: number; /** * 是否共享配额,只有当对象为URL时有效,false表示URL独享配额,true表示所有URL共享配额 */ QuotaShare?: boolean; /** * 路径选项,可配置每个路径的请求方法 */ PathsOption?: Array<PathItem>; /** * 限流执行顺序,0:默认情况,限流优先,1:安全防护优先 */ Order?: number; } /** * DeleteAttackWhiteRule返回参数结构体 */ export interface DeleteAttackWhiteRuleResponse { /** * 删除失败的规则序号组 */ FailIds?: Array<number | bigint>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * LLMRisks */ export interface LLMRisks { /** * 分数 */ Risks?: Array<ClawRiskItem>; } /** * CreateProtectGroup返回参数结构体 */ export interface CreateProtectGroupResponse { /** * <p>防护对象组的ID</p> */ GroupId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeWebshellStatus请求参数结构体 */ export interface DescribeWebshellStatusRequest { /** * 域名 */ Domain: string; } /** * LogItem的数组 */ export interface LogItems { /** * 分析结果返回的KV数据对 */ Data?: Array<LogItem>; } /** * GetAttackHistogram返回参数结构体 */ export interface GetAttackHistogramResponse { /** * 统计详情 */ Data?: Array<LogHistogramInfo>; /** * 时间段大小 */ Period?: number; /** * 统计的条目数 */ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 大模型安全检测敏感词库命中信息结构体 */ export interface KeyWordInfo { /** * 命中的词库id */ Id?: string; /** * 命中的词库名称 */ Name?: string; } /** * 过滤数组 */ export interface FiltersItemNew { /** * 字段名; 过滤 子订单号过滤通过name 为:DealName; value为子订单号 */ Name: string; /** * 过滤值 */ Values: Array<string>; /** * 是否精确查找 */ ExactMatch: boolean; } /** * DeleteExport返回参数结构体 */ export interface DeleteExportResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 饼图数据类型 */ export interface PiechartItem { /** * 类型 */ Type?: string; /** * 数量 */ Count?: number; } /** * DeleteHost返回参数结构体 */ export interface DeleteHostResponse { /** * 域名删除结果。Code表示状态码,Message表示详细信息。 */ Success?: ResponseCode; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyApiAnalyzeStatus返回参数结构体 */ export interface ModifyApiAnalyzeStatusResponse { /** * 已经开启的数量,如果返回值为3(大于支持的域名开启数量),则表示开启失败 */ Count?: number; /** * 不支持开启的域名列表 */ UnSupportedList?: Array<string>; /** * 开启/关闭失败的域名列表 */ FailDomainList?: Array<string>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RemoveBypassAllRule返回参数结构体 */ export interface RemoveBypassAllRuleResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyProtectGroup返回参数结构体 */ export interface ModifyProtectGroupResponse { /** * 防护对象组的ID */ GroupId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyAttackWhiteRule请求参数结构体 */ export interface ModifyAttackWhiteRuleRequest { /** * 规则序号 */ RuleId: number; /** * 域名 */ Domain: string; /** * 规则状态 */ Status: number; /** * 匹配规则项列表 */ Rules: Array<UserWhiteRuleItem>; /** * 规则Id */ SignatureId?: string; /** * 编辑的加白的规则ID列表 */ SignatureIds?: Array<string>; /** * 加白的大类规则ID */ TypeIds?: Array<string>; /** * 0表示按照特定规则ID加白, 1表示按照规则类型加白 */ Mode?: number; /** * 规则名 */ Name?: string; } /** * DeleteBatchCustomRule请求参数结构体 */ export interface DeleteBatchCustomRuleRequest { /** * 数据类型 "custom-rule"-自定义规则、"custom-white-rule"-精准白名单 */ DataType: string; /** * 0-指定Id删除、1-删除全部(除部分排除的Id) */ IsDeleteAll: number; /** * 具体Ids 由IsDeleteAll而定 */ Ids: Array<number | bigint>; /** * 筛选条件 */ Filters: Array<FiltersItemNew>; } /** * 获取自定义规则列表时的出参 */ export interface DescribeBotUCBRuleRsp { /** * 规则列表 */ Res?: Array<InOutputBotUCBRule>; /** * 规则总数 */ TotalCount?: number; } /** * ModifyObjects请求参数结构体 */ export interface ModifyObjectsRequest { /** * 修改对象标识 */ ObjectId: Array<string>; /** * 改动作类型:InstanceId绑定实例;UnbindInstance解绑实例。 */ OpType: string; /** * 新的实例ID,如果和已绑定的实例相同认为修改成功 */ InstanceId?: string; /** * 对象列表,仅跨账号接入使用 */ Objects?: Array<Object>; } /** * 小程序安全资源信息 */ export interface MiniPkg { /** * 资源id */ ResourceIds?: string; /** * 状态 */ Status?: number; /** * 地域 */ Region?: number; /** * 开始时间 */ BeginTime?: string; /** * 结束时间 */ EndTime?: string; /** * 购买数量 */ Count?: number; /** * 续费标志 */ RenewFlag?: number; /** * 计费项 */ BillingItem?: string; /** * 小程序网关类型 1新网关;0老网关 */ GatewayType?: number; } /** * 批量防护失败的域名以及对应的原因。 */ export interface BatchDomainResult { /** * 批量操作中失败的域名 */ Domain?: string; /** * 操作失败的原因 */ Message?: string; } /** * ModifyAreaBanStatus请求参数结构体 */ export interface ModifyAreaBanStatusRequest { /** * 需要修改的域名 */ Domain: string; /** * 状态值,0表示关闭,1表示开启 */ Status: number; } /** * waf斯巴达-编辑防护域名中的端口结构 */ export interface SpartaProtectionPort { /** * 分配的服务器id。首次接入的域名和端口该参数填0,已接入的域名和端口分配的id可以通过DescribeDomainDetailsSaas或DescribeDomains接口获取。 */ NginxServerId: number; /** * 端口 */ Port: string; /** * 协议 */ Protocol: string; /** * 后端端口 */ UpstreamPort: string; /** * 后端协议 */ UpstreamProtocol: string; } /** * ModifyOwaspWhiteRule请求参数结构体 */ export interface ModifyOwaspWhiteRuleRequest { /** * 规则ID */ RuleId: number; /** * 规则名称 */ Name: string; /** * 域名 */ Domain: string; /** * 规则匹配策略列表 */ Strategies: Array<Strategy>; /** * 加白的规则ID列表 */ Ids: Array<number | bigint>; /** * 加白的类型,0:按照特定规则ID加白, 1:按照规则类型加白 */ Type: number; /** * 规则执行的方式,TimedJob为定时执行,CronJob为周期执行 */ JobType: string; /** * 定时任务配置 */ JobDateTime: JobDateTime; /** * 如果没有设置JobDateTime字段则用此字段,0表示永久生效,其它表示定时生效的截止时间(单位为秒) */ ExpireTime: number; /** * 规则状态,0:关闭、1:开启,默认为开启 */ Status?: number; /** * 匹配条件的逻辑关系,支持and、or,分别表示多个逻辑匹配条件是与、或的关系 */ LogicalOp?: string; } /** * api安全客户自定义敏感检测规则 */ export interface ApiSecCustomSensitiveRule { /** * 参数位置 */ Position: Array<string>; /** * 匹配条件 */ MatchKey: string; /** * 匹配值 */ MatchValue: Array<string>; /** * 风险等级 */ Level: string; /** * 匹配符号,当匹配条件为关键字匹配和字符匹配的时候传该值,可传多个 */ MatchCond?: Array<string>; /** * 规则是否泛化,默认0表示不泛化 */ IsPan?: number; } /** * DescribeSession请求参数结构体 */ export interface DescribeSessionRequest { /** * 域名 */ Domain: string; /** * clb-waf或者sparta-waf */ Edition?: string; } /** * DescribePolicyStatus请求参数结构体 */ export interface DescribePolicyStatusRequest { /** * 域名 */ Domain: string; /** * clb-waf或者saas-waf */ Edition: string; } /** * BOT安全护航资源信息 */ export interface BotSecurityPkg { /** * 资源id */ ResourceIds?: string; /** * 状态 */ Status?: number; /** * 地域 */ Region?: number; /** * 开始时间 */ BeginTime?: string; /** * 结束时间 */ EndTime?: string; /** * 申请数量 */ InquireNum?: number; /** * 使用数量 */ UsedNum?: number; /** * 续费标志 */ RenewFlag?: number; /** * 计费项 */ BillingItem?: string; } /** * DescribeAccessFastAnalysis请求参数结构体 */ export interface DescribeAccessFastAnalysisRequest { /** * 要查询的日志的起始时间,Unix时间戳,单位ms */ From: number; /** * 要查询的日志的结束时间,Unix时间戳,单位ms */ To: number; /** * 查询语句,语句长度最大为4096,由于本接口是分析接口,如果无过滤条件,必须传 * 表示匹配所有,参考CLS的分析统计语句的文档 */ Query: string; /** * 需要分析统计的字段名 */ FieldName: string; /** * 客户要查询的日志主题ID,每个客户都有对应的一个主题 * @deprecated */ TopicId?: string; /** * 排序字段,升序asc,降序desc,默认降序desc */ Sort?: string; /** * 返回的top数,默认返回top5 */ Count?: number; } /** * bot自定义规则动作灰度 */ export interface UCBActionProportion { /** * 动作 */ Action?: string; /** * 比例 */ Proportion?: number; } /** * DeleteIpAccessControl请求参数结构体 */ export interface DeleteIpAccessControlRequest { /** * 域名,当操作对象为全局规则时,Domain参数应填写为"global" */ Domain: string; /** * 删除的ip数组 */ Items: Array<string>; /** * 若IsId字段为True,则Items列表元素需为Id,否则为IP */ IsId?: boolean; /** * 是否删除对应的域名下的所有黑/白IP名单,true表示全部删除,false表示只删除指定ip名单 */ DeleteAll?: boolean; /** * 用于按数据来源删除黑白名单记录,非必填,默认为custom。 custom(自定义),用户在控制台手动添加的黑白名单规则 cc(CC 防护 ),由 CC 防护模块自动添加的 IP 黑白名单 bot(Bot 防护),由 Bot 防护模块自动添加的 IP 黑白名单 batch(批量域名防护),批量域名维度添加的黑白名单规则 */ SourceType?: string; /** * IP黑白名单类型,40为IP白名单,42为IP黑名单 */ ActionType?: number; } /** * DeleteRateLimitsV2请求参数结构体 */ export interface DeleteRateLimitsV2Request { /** * 域名 */ Domain: string; /** * 要删除的限流ID列表 */ LimitRuleIds: Array<number | bigint>; } /** * DescribeDomainCountInfo返回参数结构体 */ export interface DescribeDomainCountInfoResponse { /** * 域名总数 */ AllDomain?: number; /** * 最近发现时间 */ UpdateTime?: string; /** * 接入域名总数 */ WafDomainCount?: number; /** * 剩下配额 */ LeftDomainCount?: number; /** * 开启防护域名数 */ OpenWafDomain?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyHostMode请求参数结构体 */ export interface ModifyHostModeRequest { /** * 域名 */ Domain: string; /** * 域名ID */ DomainId: string; /** * 防护状态: 10:规则观察&&AI关闭模式,11:规则观察&&AI观察模式,12:规则观察&&AI拦截模式 20:规则拦截&&AI关闭模式,21:规则拦截&&AI观察模式,22:规则拦截&&AI拦截模式 */ Mode: number; /** * 0:修改防护模式,1:修改AI */ Type?: number; /** * 实例ID */ InstanceID?: string; /** * 实例类型 */ Edition?: string; } /** * ModifyAntiInfoLeakRuleStatus请求参数结构体 */ export interface ModifyAntiInfoLeakRuleStatusRequest { /** * 域名 */ Domain: string; /** * 规则 */ RuleId: number; /** * 状态 */ Status: number; } /** * DescribeCiphersDetail返回参数结构体 */ export interface DescribeCiphersDetailResponse { /** * 加密套件信息 */ Ciphers?: Array<TLSCiphers>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeCustomRuleList请求参数结构体 */ export interface DescribeCustomRuleListRequest { /** * 域名 */ Domain: string; /** * 偏移 */ Offset: number; /** * 容量 */ Limit: number; /** * 过滤数组,name可以是如下的值: RuleID,RuleName,Match */ Filters?: Array<FiltersItemNew>; /** * asc或者desc */ Order?: string; /** * exp_ts或者mod_ts */ By?: string; /** * 查询的域名列表,访问控制页面不用传 */ DomainList?: Array<string>; } /** * DeleteIpAccessControlV2返回参数结构体 */ export interface DeleteIpAccessControlV2Response { /** * 在批量删除的时候表示删除失败的条数 */ FailedCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * PostAttackDownloadTask返回参数结构体 */ export interface PostAttackDownloadTaskResponse { /** * 任务task id */ Flow?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ClawRiskItem */ export interface ClawRiskItem { /** * 风险类别 */ RiskType?: string; /** * 规则id */ RuleId?: string; /** * 规则名称 */ RuleName?: string; /** * 分数 */ Score?: number; } /** * DescribeOwaspRules返回参数结构体 */ export interface DescribeOwaspRulesResponse { /** * 规则总数 */ Total?: number; /** * 规则列表 */ List?: Array<OwaspRule>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 防信息泄露的匹配条件结构体 */ export interface StrategyForAntiInfoLeak { /** * 匹配条件,returncode(响应码)、keywords(关键字)、information(敏感信息) */ Field: string; /** * 逻辑符号,固定取值为contains */ CompareFunc: 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时由用户自己输入匹配内容。 */ Content: string; } /** * AddSpartaProtection返回参数结构体 */ export interface AddSpartaProtectionResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeUserDomainInfo请求参数结构体 */ export type DescribeUserDomainInfoRequest = null; /** * 混合云节点资源信息 */ export interface HybridPkg { /** * 资源id */ ResourceIds?: string; /** * 状态 */ Status?: number; /** * 地域 */ Region?: number; /** * 开始时间 */ BeginTime?: string; /** * 结束时间 */ EndTime?: string; /** * 申请数量 */ InquireNum?: number; /** * 使用数量 */ UsedNum?: number; /** * 续费标志 */ RenewFlag?: number; } /** * 数据封装 */ export interface IpAccessControlData { /** * ip黑白名单 */ Res?: Array<IpAccessControlItem>; /** * 计数 */ TotalCount?: number; } /** * PostAttackDownloadTask请求参数结构体 */ export interface PostAttackDownloadTaskRequest { /** * 查询的域名,所有域名使用all */ Domain: string; /** * 查询起始时间 */ StartTime: string; /** * 查询结束时间 */ EndTime: string; /** * Lucene语法 */ QueryString: string; /** * 任务名称 */ TaskName: string; /** * 默认为desc,可以取值desc和asc */ Sort?: string; /** * 下载的日志条数 */ Count?: number; } /** * 对话消息结构体 */ export interface SSEClientMessage { /** * <p>对话角色,填user</p> */ Role: string; /** * <p>prompt内容</p> */ Content: string; /** * <p>检测类型,0是文本内容代答,目前只支持0,可以不传,默认值是0</p><p>枚举值:</p><ul><li>0: 文件内容代答</li></ul> */ ContentType?: number; } /** * DeleteBatchCustomWhiteRule请求参数结构体 */ export interface DeleteBatchCustomWhiteRuleRequest { /** * 要删除的规则ID列表 */ Ids: Array<number | bigint>; } /** * api安全自定义场景规则 */ export interface ApiSecSceneRule { /** * 场景名称 */ RuleName?: string; /** * 开关状态,1表示开,0表示关 */ Status?: number; /** * 更新时间,10位时间戳 */ UpdateTime?: number; /** * 规则列表 */ RuleList?: Array<ApiSecSceneRuleEntry>; /** * 规则来源,系统内置:OS 客户自定义:custom */ Source?: string; } /** * DescribeHost返回参数结构体 */ export interface DescribeHostResponse { /** * 域名详情 */ Host?: HostRecord; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 限流相关通用返回 */ export interface RateLimitCommonRsp { /** * 响应码 */ Code?: number; /** * 提示信息 */ Info?: string; } /** * AddBypassAllRule返回参数结构体 */ export interface AddBypassAllRuleResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyWafAutoDenyRules返回参数结构体 */ export interface ModifyWafAutoDenyRulesResponse { /** * 成功的状态码,需要JSON解码后再使用,返回的格式是{"域名":"状态"},成功的状态码为Success,其它的为失败的状态码(yunapi定义的错误码) */ Success?: ResponseCode; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeUserSignatureRule返回参数结构体 */ export interface DescribeUserSignatureRuleResponse { /** * 规则总数 */ Total?: number; /** * 规则列表 */ Rules?: Array<UserSignatureRule>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 用于DescribeAccessIndex接口的出参 */ export interface AccessValueInfo { /** * 字段类型,目前支持的类型有:long、text、double */ Type?: string; /** * 字段的分词符,只有当字段类型为text时才有意义;输入字符串中的每个字符代表一个分词符 */ Tokenizer?: string; /** * 字段是否开启分析功能 */ SqlFlag?: boolean; /** * 是否包含中文 注意:此字段可能返回 null,表示取不到有效值。 */ ContainZH?: boolean; } /** * 规则列表详情 */ export interface Rule { /** * 规则id */ Id?: number; /** * 规则类型 */ Type?: string; /** * 规则等级 */ Level?: string; /** * 规则描述 */ Description?: string; /** * 规则防护的CVE编号 */ CVE?: string; /** * 规则的状态 */ Status?: number; /** * 规则修改的时间 */ ModifyTime?: string; /** * 门神规则新增/更新时间 */ AddTime?: string; } /** * DescribePostCKafkaFlows返回参数结构体 */ export interface DescribePostCKafkaFlowsResponse { /** * 客户的投递流列表 */ PostCKafkaFlows?: Array<PostCKafkaFlowInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 规则的匹配条件结构体 */ export interface Strategy { /** * 匹配字段 匹配字段不同,相应的匹配参数、逻辑符号、匹配内容有所不同 具体如下所示: <table> <thead> <tr> <th>匹配字段</th> <th>匹配参数</th> <th>逻辑符号</th> <th>匹配内容</th> </tr> </thead> <tbody> <tr> <td>IP(来源IP)</td> <td>不支持参数</td> <td>ipmatch(匹配)<br />ipnmatch(不匹配)</td> <td>多个IP以英文逗号隔开,最多20个</td> </tr> <tr> <td>IPV6(来源IPv6)</td> <td>不支持参数</td> <td>ipmatch(匹配)<br />ipnmatch(不匹配)</td> <td>支持单个IPV6地址</td> </tr> <tr> <td>Referer(Referer)</td> <td>不支持参数</td> <td>empty(内容为空)<br />null(不存在)<br />eq(等于)<br />neq(不等于)<br />contains(包含)<br />ncontains(不包含)<br/>belong_to(属于)<br/>not_belong_to(不属于)<br />len_eq(长度等于)<br />len_gt(长度大于)<br />len_lt(长度小于)<br />strprefix(前缀匹配)<br />strsuffix(后缀匹配)<br />rematch(正则匹配)</td> <td>请输入内容,512个字符以内</td> </tr> <tr> <td>URL(请求路径)</td> <td>不支持参数</td> <td>eq(等于)<br />neq(不等于)<br />contains(包含)<br />ncontains(不包含)<br />len_eq(长度等于)<br />belong_to(属于)<br />not_belong_to(不属于)<br />len_gt(长度大于)<br />len_lt(长度小于)<br />strprefix(前缀匹配)<br />strsuffix(后缀匹配)<br />rematch(正则匹配)<br /></td> <td>请以/开头,512个字符以内</td> </tr> <tr> <td>UserAgent(UserAgent)</td> <td>不支持参数</td> <td>同匹配字段<font color="Red">Referer</font>逻辑符号</td> <td>请输入内容,512个字符以内</td> </tr> <tr> <td>HTTP_METHOD(HTTP请求方法)</td> <td>不支持参数</td> <td>eq(等于)<br />neq(不等于)<br/>belong_to(属于)<br/>not_belong_to(不属于)</td> <td>请输入方法名称,建议大写</td> </tr> <tr> <td>QUERY_STRING(请求字符串)</td> <td>不支持参数</td> <td>同匹配字段<font color="Red">请求路径</font>逻辑符号</td> <td>请输入内容,512个字符以内</td> </tr> <tr> <td>GET(GET参数值)</td> <td>支持参数录入</td> <td>contains(包含)<br />ncontains(不包含)<br/>belong_to(属于)<br/>not_belong_to(不属于)<br />len_eq(长度等于)<br />len_gt(长度大于)<br />len_lt(长度小于)<br />strprefix(前缀匹配)<br />strsuffix(后缀匹配)</td> <td>请输入内容,512个字符以内</td> </tr> <tr> <td>GET_PARAMS_NAMES(GET参数名)</td> <td>不支持参数</td> <td>exsit(存在参数)<br />nexsit(不存在参数)<br/>belong_to(属于)<br/>not_belong_to(不属于)<br />len_eq(长度等于)<br />len_gt(长度大于)<br />len_lt(长度小于)<br />strprefix(前缀匹配)<br />strsuffix(后缀匹配)</td> <td>请输入内容,512个字符以内</td> </tr> <tr> <td>POST(POST参数值)</td> <td>支持参数录入</td> <td>同匹配字段<font color="Red">GET参数值</font>逻辑符号</td> <td>请输入内容,512个字符以内</td> </tr> <tr> <td>GET_POST_NAMES(POST参数名)</td> <td>不支持参数</td> <td>同匹配字段<font color="Red">GET参数名</font>逻辑符号</td> <td>请输入内容,512个字符以内</td> </tr> <tr> <td>POST_BODY(完整BODY)</td> <td>不支持参数</td> <td>同匹配字段<font color="Red">请求路径</font>逻辑符号</td> <td>请输入BODY内容,512个字符以内</td> </tr> <tr> <td>COOKIE(Cookie)</td> <td>不支持参数</td> <td>empty(内容为空)<br />null(不存在)<br />rematch(正则匹配)</td> <td> <font color="Red">暂不支持</font> </td> </tr> <tr> <td>GET_COOKIES_NAMES(Cookie参数名)</td> <td>不支持参数</td> <td>同匹配字段<font color="Red">GET参数名</font>逻辑符号</td> <td>请输入内容,512个字符以内</td> </tr> <tr> <td>ARGS_COOKIE(Cookie参数值)</td> <td>支持参数录入</td> <td>同匹配字段<font color="Red">GET参数值</font>逻辑符号</td> <td>请输入内容,512个字符以内</td> </tr> <tr> <td>GET_HEADERS_NAMES(Header参数名)</td> <td>不支持参数</td> <td>exsit(存在参数)<br />nexsit(不存在参数)<br />len_eq(长度等于)<br />len_gt(长度大于)<br />len_lt(长度小于)<br />strprefix(前缀匹配)<br />strsuffix(后缀匹配)<br />rematch(正则匹配)</td> <td>请输入内容,建议小写,512个字符以内</td> </tr> <tr> <td>ARGS_HEADER(Header参数值)</td> <td>支持参数录入</td> <td>contains(包含)<br />ncontains(不包含)<br />len_eq(长度等于)<br />len_gt(长度大于)<br />len_lt(长度小于)<br />strprefix(前缀匹配)<br />strsuffix(后缀匹配)<br />rematch(正则匹配)</td> <td>请输入内容,512个字符以内</td> </tr> <tr> <td>CONTENT_LENGTH(Content-length)</td> <td>支持参数录入</td> <td>numgt(数值大于)<br />numlt(数值小于)<br />numeq(数值等于)<br /></td> <td>请输入0-9999999999999之间的整数</td> </tr> <tr> <td>IP_GEO(来源IP归属地)</td> <td>支持参数录入</td> <td>geo_in(属于)<br />geo_not_in(不属于)<br /></td> <td>请输入内容,10240字符以内,格式为序列化的JSON,格式为:[{"Country":"中国","Region":"广东","City":"深圳"}]</td> </tr> <tr> <td>CAPTCHA_RISK(验证码风险)</td> <td>不支持参数</td> <td>eq(等于)<br />neq(不等于)<br />belong(属于)<br />not_belong(不属于)<br />null(不存在)<br />exist(存在)</td> <td>请输入风险等级值,支持数值范围0-255</td> </tr> <tr> <td>CAPTCHA_DEVICE_RISK(验证码设备风险)</td> <td>不支持参数</td> <td>eq(等于)<br />neq(不等于)<br />belong(属于)<br />not_belong(不属于)<br />null(不存在)<br />exist(存在)</td> <td>请输入设备风险代码,支持取值:101、201、301、401、501、601、701</td> </tr> <tr> <td>CAPTCHAR_SCORE(验证码风险评估分)</td> <td>不支持参数</td> <td>numeq(数值等于)<br />numgt(数值大于)<br />numlt(数值小于)<br />numle(数值小于等于)<br />numge(数值大于等于)<br />null(不存在)<br />exist(存在)</td> <td>请输入评估分数,支持数值范围0-100</td> </tr> </tbody> </table> */ Field: string; /** * 逻辑符号 逻辑符号一共分为以下几种类型: empty ( 内容为空) null (不存在) eq ( 等于) neq ( 不等于) contains ( 包含) ncontains ( 不包含) strprefix ( 前缀匹配) strsuffix ( 后缀匹配) len_eq ( 长度等于) len_gt ( 长度大于) len_lt ( 长度小于) ipmatch ( 属于) ipnmatch ( 不属于) numgt ( 数值大于) numlt ( 数值小于) numeq ( 数值等于) numneq ( 数值不等于) numle ( 数值小于等于) numge ( 数值大于等于) belong_to(属于) not_belong_to(不属于) geo_in ( IP地理属于) geo_not_in ( IP地理不属于) 各匹配字段对应的逻辑符号不同,详见上述匹配字段表格 */ CompareFunc: string; /** * 匹配内容 目前 当匹配字段为COOKIE(Cookie)时,不需要输入 匹配内容 其他都需要 */ Content: string; /** * 匹配参数 配置参数一共分2种类型 不支持参数与支持参数 当匹配字段为以下4个时,匹配参数才能录入,否则不支持该参数 GET(GET参数值) POST(POST参数值) ARGS_COOKIE(Cookie参数值) ARGS_HEADER(Header参数值) */ Arg: string; /** * 0:大小写敏感 1:大小写不敏感 */ CaseNotSensitive?: number; } /** * RemoveBypassAllRule请求参数结构体 */ export type RemoveBypassAllRuleRequest = null; /** * ModifyOwaspDomainUpdateStatus请求参数结构体 */ export interface ModifyOwaspDomainUpdateStatusRequest { /** * 域名 */ Domain: string; /** * 新规则状态,0为关闭,1为开启,2为仅观察 */ UpdateStatus: number; } /** * ModifyInstanceAttackLogPost返回参数结构体 */ export interface ModifyInstanceAttackLogPostResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UpsertCCRule返回参数结构体 */ export interface UpsertCCRuleResponse { /** * 一般为null */ Data?: string; /** * 操作的RuleId */ RuleId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeHost请求参数结构体 */ export interface DescribeHostRequest { /** * 域名 */ Domain: string; /** * 域名ID */ DomainId: string; /** * 实例ID */ InstanceID?: string; } /** * GenerateDealsAndPayNew返回参数结构体 */ export interface GenerateDealsAndPayNewResponse { /** * 计费下单响应结构体 */ Data?: DealData; /** * 1:成功,0:失败 */ Status?: number; /** * 返回message */ ReturnMessage?: string; /** * 购买的实例ID */ InstanceId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteCustomRule请求参数结构体 */ export interface DeleteCustomRuleRequest { /** * 删除的域名 */ Domain: string; /** * 删除的规则ID */ RuleId: string; /** * WAF的版本,clb-waf代表负载均衡WAF、sparta-waf代表SaaS WAF,默认是sparta-waf。 */ Edition?: string; /** * 批量删除的规则列表 */ DomainRuleIdList?: Array<DomainRuleId>; } /** * DescribeUserSignatureRuleV2请求参数结构体 */ expo