@nocobase/plugin-verification

/** * 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; } /** * DescribeUserClbWafRegions返回参数结构体 */ export interface DescribeUserClbWafRegionsResponse { /** * 地域（标准的ap-格式）列表注意：此字段可能返回 null，表示取不到有效值。 */ Data?: Array<string>; /** * 包含详细属性的地域信息注意：此字段可能返回 null，表示取不到有效值。 */ RichDatas?: Array<ClbWafRegionItem>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AddAntiFakeUrl请求参数结构体 */ export interface AddAntiFakeUrlRequest { /** * 域名 */ Domain: string; /** * 名称 */ Name: string; /** * uri */ Uri: string; } /** * DescribePeakValue返回参数结构体 */ export interface DescribePeakValueResponse { /** * QPS峰值 */ Access: number; /** * 上行带宽峰值，单位B */ Up: number; /** * 下行带宽峰值，单位B */ Down: number; /** * Web攻击总数 */ Attack: number; /** * CC攻击总数 */ Cc: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * waf产品 */ export interface ProductInfo { /** * 产品名称注意：此字段可能返回 null，表示取不到有效值。 */ Name?: string; /** * 版本注意：此字段可能返回 null，表示取不到有效值。 */ Value?: string; } /** * 出参 */ export interface DescribeAntiLeakageItem { /** * 规则ID */ RuleId: number; /** * 名称 */ Name: string; /** * 状态值 */ Status: number; /** * 动作 */ Action: string; /** * 创建时间 */ CreateTime: string; /** * 匹配条件注意：此字段可能返回 null，表示取不到有效值。 */ Strategies: Array<DescribeAntiInfoLeakRulesStrategyItem>; /** * 匹配的URL 注意：此字段可能返回 null，表示取不到有效值。 */ Uri: string; } /** * 负载均衡器 */ export interface LoadBalancerPackageNew { /** * 监听id 注意：此字段可能返回 null，表示取不到有效值。 */ ListenerId: string; /** * 监听名注意：此字段可能返回 null，表示取不到有效值。 */ ListenerName: string; /** * 负载均衡id 注意：此字段可能返回 null，表示取不到有效值。 */ LoadBalancerId: string; /** * 负载均衡名注意：此字段可能返回 null，表示取不到有效值。 */ LoadBalancerName: string; /** * 协议注意：此字段可能返回 null，表示取不到有效值。 */ Protocol: string; /** * 地区注意：此字段可能返回 null，表示取不到有效值。 */ Region: string; /** * 接入IP 注意：此字段可能返回 null，表示取不到有效值。 */ Vip: string; /** * 接入端口注意：此字段可能返回 null，表示取不到有效值。 */ Vport: number; /** * 地域注意：此字段可能返回 null，表示取不到有效值。 */ Zone: string; /** * VPCID 注意：此字段可能返回 null，表示取不到有效值。 */ NumericalVpcId: number; /** * CLB类型注意：此字段可能返回 null，表示取不到有效值。 */ LoadBalancerType: string; /** * 负载均衡器的域名注意：此字段可能返回 null，表示取不到有效值。 */ LoadBalancerDomain?: string; } /** * DeleteHost请求参数结构体 */ export interface DeleteHostRequest { /** * 删除的域名列表 */ HostsDel: Array<HostDel>; } /** * DescribeCertificateVerifyResult返回参数结构体 */ export interface DescribeCertificateVerifyResultResponse { /** * 状态码 */ Status: number; /** * 错误详情 */ Detail: Array<string>; /** * 过期时间 */ NotAfter: string; /** * 证书是否改变:1有改变，0没有改变注意：此字段可能返回 null，表示取不到有效值。 */ Changed: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyUserSignatureRule返回参数结构体 */ export interface ModifyUserSignatureRuleResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyInstanceName返回参数结构体 */ export interface ModifyInstanceNameResponse { /** * 修改状态：0为成功 */ ModifyCode?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeWafAutoDenyRules请求参数结构体 */ export interface DescribeWafAutoDenyRulesRequest { /** * 域名 */ Domain: string; /** * 实例Id */ InstanceId?: string; } /** * GenerateDealsAndPayNew请求参数结构体 */ export interface GenerateDealsAndPayNewRequest { /** * 计费下单入参 */ Goods: Array<GoodNews>; } /** * DeleteCustomWhiteRule返回参数结构体 */ export interface DeleteCustomWhiteRuleResponse { /** * 操作的状态码，如果所有的资源操作成功则返回的是成功的状态码，如果有资源操作失败则需要解析Message的内容来查看哪个资源失败 */ Success: ResponseCode; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyHostMode返回参数结构体 */ export interface ModifyHostModeResponse { /** * 操作的状态码，如果所有的资源操作成功则返回的是成功的状态码，如果有资源操作失败则需要解析Message的内容来查看哪个资源失败注意：此字段可能返回 null，表示取不到有效值。 */ Success: ResponseCode; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * GetAttackDownloadRecords请求参数结构体 */ export declare type GetAttackDownloadRecordsRequest = null; /** * 重保防护资源信息 */ export interface MajorEventsPkg { /** * 资源id 注意：此字段可能返回 null，表示取不到有效值。 */ ResourceIds?: string; /** * 状态注意：此字段可能返回 null，表示取不到有效值。 */ Status?: number; /** * 地域注意：此字段可能返回 null，表示取不到有效值。 */ Region?: number; /** * 开始时间注意：此字段可能返回 null，表示取不到有效值。 */ BeginTime?: string; /** * 结束时间注意：此字段可能返回 null，表示取不到有效值。 */ EndTime?: string; /** * 申请数量注意：此字段可能返回 null，表示取不到有效值。 */ InquireNum?: number; /** * 使用数量注意：此字段可能返回 null，表示取不到有效值。 */ UsedNum?: number; /** * 续费标志注意：此字段可能返回 null，表示取不到有效值。 */ RenewFlag?: number; /** * 计费项注意：此字段可能返回 null，表示取不到有效值。 */ BillingItem?: string; /** * 护网包状态注意：此字段可能返回 null，表示取不到有效值。 */ HWState?: number; } /** * DescribeDomainRules请求参数结构体 */ export interface DescribeDomainRulesRequest { /** * 需要查询的域名 */ Domain?: string; } /** * DeleteDownloadRecord请求参数结构体 */ export interface DeleteDownloadRecordRequest { /** * 记录id */ Flow: string; } /** * DeleteAccessExport返回参数结构体 */ export interface DeleteAccessExportResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeModuleStatus返回参数结构体 */ export interface DescribeModuleStatusResponse { /** * WEB安全规则是否开启 */ WebSecurity?: number; /** * 访问控制规则是否开启 */ AccessControl?: number; /** * CC防护是否开启 */ CcProtection?: number; /** * 网页防篡改是否开启 */ AntiTamper?: number; /** * 信息防泄漏是否开启 */ AntiLeakage?: number; /** * API安全是否开启 */ ApiProtection?: number; /** * 限流模块开关 */ RateLimit?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 用于 DescribeAccessIndex 的出参 */ export interface AccessKeyValueInfo { /** * 需要配置键值或者元字段索引的字段注意：此字段可能返回 null，表示取不到有效值。 */ Key: string; /** * 字段的索引描述信息注意：此字段可能返回 null，表示取不到有效值。 */ Value: AccessValueInfo; } /** * Key-Value的形式，Value为Int */ export interface KVInt { /** * Key */ Key: string; /** * Value */ Value: number; } /** * AddAntiInfoLeakRules请求参数结构体 */ export interface AddAntiInfoLeakRulesRequest { /** * 域名 */ Domain: string; /** * 规则名称 */ Name: string; /** * 动作，0（告警）、1（替换）、2（仅显示前四位）、3（仅显示后四位）、4（阻断） */ ActionType: number; /** * 策略详情 */ Strategies: Array<StrategyForAntiInfoLeak>; /** * 网址 */ Uri?: string; } /** * DeleteAttackWhiteRule返回参数结构体 */ export interface DeleteAttackWhiteRuleResponse { /** * 删除失败的规则序号组注意：此字段可能返回 null，表示取不到有效值。 */ FailIds: Array<number | bigint>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeWebshellStatus请求参数结构体 */ export interface DescribeWebshellStatusRequest { /** * 域名 */ Domain: string; } /** * GetAttackHistogram返回参数结构体 */ export interface GetAttackHistogramResponse { /** * 统计详情 */ Data?: Array<LogHistogramInfo>; /** * 时间段大小 */ Period?: number; /** * 统计的条目数 */ TotalCount?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 过滤数组 */ export interface FiltersItemNew { /** * 字段名 */ Name: string; /** * 过滤值 */ Values: Array<string>; /** * 是否精确查找 */ ExactMatch: boolean; } /** * DeleteSpartaProtection返回参数结构体 */ export interface DeleteSpartaProtectionResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 饼图数据类型 */ export interface PiechartItem { /** * 类型 */ Type: string; /** * 数量 */ Count: number; } /** * SwitchDomainRules请求参数结构体 */ export interface SwitchDomainRulesRequest { /** * 域名 */ Domain?: string; /** * 规则列表 */ Ids?: Array<number | bigint>; /** * 开关状态，0表示关闭，1表示开启，2表示只观察 */ Status?: number; /** * 设置为观察模式原因， 1表示业务自身原因观察，2表示系统规则误报上报，3表示核心业务灰度观察，4表示其他 */ Reason?: number; } /** * ModifyApiAnalyzeStatus返回参数结构体 */ export interface ModifyApiAnalyzeStatusResponse { /** * 已经开启的数量,如果返回值为3（大于支持的域名开启数量），则表示开启失败注意：此字段可能返回 null，表示取不到有效值。 */ Count?: number; /** * 不支持开启的域名列表注意：此字段可能返回 null，表示取不到有效值。 */ UnSupportedList?: Array<string>; /** * 开启/关闭失败的域名列表注意：此字段可能返回 null，表示取不到有效值。 */ FailDomainList?: Array<string>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyAttackWhiteRule请求参数结构体 */ export interface ModifyAttackWhiteRuleRequest { /** * 规则序号 */ RuleId: number; /** * 域名 */ Domain: string; /** * 规则Id */ SignatureId: string; /** * 规则状态 */ Status: number; /** * 匹配规则项列表 */ Rules: Array<UserWhiteRuleItem>; } /** * clb-waf防护域名 */ export interface HostRecord { /** * 域名 */ Domain: string; /** * 域名ID */ DomainId: string; /** * 主域名，入参时为空 */ MainDomain: string; /** * 规则引擎防护模式，0 观察模式，1拦截模式 */ Mode: number; /** * waf和LD的绑定，0：没有绑定，1：绑定 */ Status: number; /** * 域名状态，0：正常，1：未检测到流量，2：即将过期，3：过期 */ State: number; /** * 规则引擎和AI引擎防护模式联合状态,10规则引擎观察&&AI引擎关闭模式 11规则引擎观察&&AI引擎观察模式 12规则引擎观察&&AI引擎拦截模式 20规则引擎拦截&&AI引擎关闭模式 21规则引擎拦截&&AI引擎观察模式 22规则引擎拦截&&AI引擎拦截模式 */ Engine: number; /** * 是否开启代理，0：不开启，1：开启 */ IsCdn: number; /** * 绑定的LB列表 */ LoadBalancerSet: Array<LoadBalancer>; /** * 域名绑定的LB的地域，以,分割多个地域 */ Region: string; /** * 产品分类，取值为：sparta-waf、clb-waf、cdn-waf */ Edition: string; /** * WAF的流量模式，1：清洗模式，0：镜像模式 */ FlowMode: number; /** * 是否开启访问日志，1：开启，0：关闭 */ ClsStatus: number; /** * 防护等级，可选值100,200,300 注意：此字段可能返回 null，表示取不到有效值。 */ Level?: number; /** * 域名需要下发到的cdc集群列表注意：此字段可能返回 null，表示取不到有效值。 */ CdcClusters?: Array<string>; /** * 应用型负载均衡类型: clb或者apisix，默认clb 注意：此字段可能返回 null，表示取不到有效值。 */ AlbType?: string; /** * IsCdn=3时，需要填此参数，表示自定义header 注意：此字段可能返回 null，表示取不到有效值。 */ IpHeaders?: Array<string>; /** * 规则引擎类型， 1: menshen, 2:tiga 注意：此字段可能返回 null，表示取不到有效值。 */ EngineType?: number; /** * 云类型:public:公有云；private:私有云;hybrid:混合云注意：此字段可能返回 null，表示取不到有效值。 */ CloudType?: string; } /** * ModifyCustomRule返回参数结构体 */ export interface ModifyCustomRuleResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * FreshAntiFakeUrl请求参数结构体 */ export interface FreshAntiFakeUrlRequest { /** * 域名 */ Domain: string; /** * Id */ Id: number; } /** * ModifyAreaBanStatus请求参数结构体 */ export interface ModifyAreaBanStatusRequest { /** * 需要修改的域名 */ Domain: string; /** * 状态值，0表示关闭，1表示开启 */ Status: number; } /** * waf斯巴达-编辑防护域名中的端口结构 */ export interface SpartaProtectionPort { /** * nginx Id */ NginxServerId: number; /** * 端口 */ Port: string; /** * 协议 */ Protocol: string; /** * 后端端口 */ UpstreamPort: string; /** * 后端协议 */ UpstreamProtocol: string; } /** * PeakPoints数组项 */ export interface PeakPointsItem { /** * 秒级别时间戳 */ Time?: number; /** * QPS */ Access?: number; /** * 上行带宽峰值，单位B */ Up?: number; /** * 下行带宽峰值，单位B */ Down?: number; /** * Web攻击次数 */ Attack?: number; /** * CC攻击次数 */ Cc?: number; /** * Bot qps */ BotAccess?: number; /** * WAF返回给客户端状态码5xx次数注意：此字段可能返回 null，表示取不到有效值。 */ StatusServerError?: number; /** * WAF返回给客户端状态码4xx次数注意：此字段可能返回 null，表示取不到有效值。 */ StatusClientError?: number; /** * WAF返回给客户端状态码302次数注意：此字段可能返回 null，表示取不到有效值。 */ StatusRedirect?: number; /** * WAF返回给客户端状态码202次数注意：此字段可能返回 null，表示取不到有效值。 */ StatusOk?: number; /** * 源站返回给WAF状态码5xx次数注意：此字段可能返回 null，表示取不到有效值。 */ UpstreamServerError?: number; /** * 源站返回给WAF状态码4xx次数注意：此字段可能返回 null，表示取不到有效值。 */ UpstreamClientError?: number; /** * 源站返回给WAF状态码302次数注意：此字段可能返回 null，表示取不到有效值。 */ UpstreamRedirect?: number; /** * 黑名单次数注意：此字段可能返回 null，表示取不到有效值。 */ BlackIP?: number; /** * 防篡改次数注意：此字段可能返回 null，表示取不到有效值。 */ Tamper?: number; /** * 信息防泄露次数注意：此字段可能返回 null，表示取不到有效值。 */ Leak?: number; /** * 访问控制注意：此字段可能返回 null，表示取不到有效值。 */ ACL?: number; /** * 小程序 qps 注意：此字段可能返回 null，表示取不到有效值。 */ WxAccess?: number; } /** * Clb类型防护对象 */ export interface ClbObject { /** * 对象ID */ ObjectId?: string; /** * 实例ID */ InstanceId?: string; /** * 实例名称 */ InstanceName?: string; /** * 精准域名列表 */ PreciseDomains?: Array<string>; /** * WAF功能开关状态，0关闭1开启 */ Status?: number; /** * WAF日志开关状态，0关闭1开启 */ ClsStatus?: number; /** * CLB对象对应的虚拟域名 */ VirtualDomain?: string; /** * 对象名称 */ ObjectName?: string; /** * 公网地址 */ PublicIp?: Array<string>; /** * 内网地址 */ PrivateIp?: Array<string>; /** * VPC名称 */ VpcName?: string; /** * VPC ID */ Vpc?: string; /** * waf实例等级，如果未绑定实例为0 */ InstanceLevel?: number; /** * clb投递开关 */ PostCLSStatus?: number; /** * kafka投递开关 */ PostCKafkaStatus?: number; /** * 对象类型：CLB:负载均衡器，TSE:云原生网关注意：此字段可能返回 null，表示取不到有效值。 */ Type?: string; /** * 对象地域注意：此字段可能返回 null，表示取不到有效值。 */ Region?: string; } /** * DescribeSession请求参数结构体 */ export interface DescribeSessionRequest { /** * 域名 */ Domain: string; /** * clb-waf或者sparta-waf */ Edition?: string; } /** * DescribePolicyStatus请求参数结构体 */ export interface DescribePolicyStatusRequest { /** * 域名 */ Domain: string; /** * clb-waf或者saas-waf */ Edition: string; } /** * DescribeAccessFastAnalysis请求参数结构体 */ export interface DescribeAccessFastAnalysisRequest { /** * 客户要查询的日志主题ID，每个客户都有对应的一个主题 */ TopicId: string; /** * 要查询的日志的起始时间，Unix时间戳，单位ms */ From: number; /** * 要查询的日志的结束时间，Unix时间戳，单位ms */ To: number; /** * 查询语句，语句长度最大为4096，由于本接口是分析接口，如果无过滤条件，必须传 * 表示匹配所有，参考CLS的分析统计语句的文档 */ Query: string; /** * 需要分析统计的字段名 */ FieldName: string; /** * 排序字段,升序asc,降序desc，默认降序desc */ Sort?: string; /** * 返回的top数，默认返回top5 */ Count?: number; } /** * DeleteIpAccessControl请求参数结构体 */ export interface DeleteIpAccessControlRequest { /** * 域名 */ Domain: string; /** * 删除的ip数组 */ Items: Array<string>; /** * 若IsId字段为True，则Items列表元素需为Id，否则为IP */ IsId?: boolean; /** * 是否删除对应的域名下的所有黑/白IP名单，true表示全部删除，false表示只删除指定ip名单 */ DeleteAll?: boolean; /** * 是否为多域名黑白名单 */ SourceType?: string; } /** * DescribeDomainCountInfo返回参数结构体 */ export interface DescribeDomainCountInfoResponse { /** * 域名总数 */ AllDomain: number; /** * 最近发现时间 */ UpdateTime: string; /** * 接入域名总数 */ WafDomainCount: number; /** * 剩下配额 */ LeftDomainCount: number; /** * 开启防护域名数 */ OpenWafDomain: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 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; } /** * 公共翻页参数 */ export interface PageInfo { /** * 页码 */ PageNumber: string; /** * 页条目数量 */ PageSize: string; } /** * DescribeCiphersDetail返回参数结构体 */ export interface DescribeCiphersDetailResponse { /** * 加密套件信息注意：此字段可能返回 null，表示取不到有效值。 */ Ciphers?: Array<TLSCiphers>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 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; } /** * PostAttackDownloadTask返回参数结构体 */ export interface PostAttackDownloadTaskResponse { /** * 任务task id */ Flow?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAttackWhiteRule请求参数结构体 */ export interface DescribeAttackWhiteRuleRequest { /** * 需要查询的域名 */ Domain: string; /** * 分页 */ Offset: number; /** * 每页容量 */ Limit: number; /** * 排序字段，支持user_id, signature_id, modify_time */ By?: string; /** * 排序方式 */ Order?: string; /** * 筛选条件，支持SignatureId, MatchContent */ Filters?: Array<FiltersItemNew>; } /** * 防信息泄露的匹配条件结构体 */ 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?: string; } /** * DescribeUserDomainInfo请求参数结构体 */ export declare type DescribeUserDomainInfoRequest = null; /** * 数据封装 */ export interface IpAccessControlData { /** * ip黑白名单注意：此字段可能返回 null，表示取不到有效值。 */ Res: Array<IpAccessControlItem>; /** * 计数 */ TotalCount: number; } /** * DescribeHost返回参数结构体 */ export interface DescribeHostResponse { /** * 域名详情 */ Host: HostRecord; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyWafAutoDenyRules返回参数结构体 */ export interface ModifyWafAutoDenyRulesResponse { /** * 成功的状态码，需要JSON解码后再使用，返回的格式是{"域名":"状态"}，成功的状态码为Success，其它的为失败的状态码（yunapi定义的错误码） */ Success?: ResponseCode; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeUserSignatureRule返回参数结构体 */ export interface DescribeUserSignatureRuleResponse { /** * 规则总数 */ Total: number; /** * 规则列表注意：此字段可能返回 null，表示取不到有效值。 */ Rules: Array<UserSignatureRule>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 用于DescribeAccessIndex接口的出参 */ export interface AccessValueInfo { /** * 字段类型，目前支持的类型有：long、text、double 注意：此字段可能返回 null，表示取不到有效值。 */ Type: string; /** * 字段的分词符，只有当字段类型为text时才有意义；输入字符串中的每个字符代表一个分词符注意：此字段可能返回 null，表示取不到有效值。 */ Tokenizer: string; /** * 字段是否开启分析功能注意：此字段可能返回 null，表示取不到有效值。 */ SqlFlag: boolean; /** * 是否包含中文注意：此字段可能返回 null，表示取不到有效值。注意：此字段可能返回 null，表示取不到有效值。 */ ContainZH: boolean; } /** * 规则列表详情 */ export interface Rule { /** * 规则id */ Id?: number; /** * 规则类型注意：此字段可能返回 null，表示取不到有效值。 */ Type?: string; /** * 规则等级 */ Level?: string; /** * 规则描述注意：此字段可能返回 null，表示取不到有效值。 */ Description?: string; /** * 规则防护的CVE编号注意：此字段可能返回 null，表示取不到有效值。 */ CVE?: string; /** * 规则的状态 */ Status?: number; /** * 规则修改的时间 */ ModifyTime?: string; /** * 门神规则新增/更新时间注意：此字段可能返回 null，表示取不到有效值。 */ AddTime?: 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（匹配） ipnmatch（不匹配）</td><td>多个IP以英文逗号隔开,最多20个</td></tr><tr><td>IPV6（来源IPv6）</td><td>不支持参数</td><td>ipmatch（匹配） ipnmatch（不匹配）</td><td>支持单个IPV6地址</td></tr><tr><td>Referer（Referer）</td><td>不支持参数</td><td>empty（内容为空） null（不存在） eq（等于） neq（不等于） contains（包含） ncontains（不包含） len_eq（长度等于） len_gt（长度大于） len_lt（长度小于） strprefix（前缀匹配） strsuffix（后缀匹配） rematch（正则匹配）</td><td>请输入内容,512个字符以内</td></tr><tr><td>URL（请求路径）</td><td>不支持参数</td><td>eq（等于） neq（不等于） contains（包含） ncontains（不包含） len_eq（长度等于） len_gt（长度大于） len_lt（长度小于） strprefix（前缀匹配） strsuffix（后缀匹配） rematch（正则匹配） </td><td>请以/开头,512个字符以内</td></tr><tr><td>UserAgent（UserAgent）</td><td>不支持参数</td><td>同匹配字段Referer逻辑符号</td><td>请输入内容,512个字符以内</td></tr><tr><td>HTTP_METHOD（HTTP请求方法）</td><td>不支持参数</td><td>eq（等于） neq（不等于）</td><td>请输入方法名称,建议大写</td></tr><tr><td>QUERY_STRING（请求字符串）</td><td>不支持参数</td><td>同匹配字段请求路径逻辑符号</td><td>请输入内容,512个字符以内</td></tr><tr><td>GET（GET参数值）</td><td>支持参数录入</td><td>contains（包含） ncontains（不包含） len_eq（长度等于） len_gt（长度大于） len_lt（长度小于） strprefix（前缀匹配） strsuffix（后缀匹配）</td><td>请输入内容,512个字符以内</td></tr><tr><td>GET_PARAMS_NAMES（GET参数名）</td><td>不支持参数</td><td>exsit（存在参数） nexsit（不存在参数） len_eq（长度等于） len_gt（长度大于） len_lt（长度小于） strprefix（前缀匹配） strsuffix（后缀匹配）</td><td>请输入内容,512个字符以内</td></tr><tr><td>POST（POST参数值）</td><td>支持参数录入</td><td>同匹配字段GET参数值逻辑符号</td><td>请输入内容,512个字符以内</td></tr><tr><td>GET_POST_NAMES（POST参数名）</td><td>不支持参数</td><td>同匹配字段GET参数名逻辑符号</td><td>请输入内容,512个字符以内</td></tr><tr><td>POST_BODY（完整BODY）</td><td>不支持参数</td><td>同匹配字段请求路径逻辑符号</td><td>请输入BODY内容,512个字符以内</td></tr><tr><td>COOKIE（Cookie）</td><td>不支持参数</td><td>empty（内容为空） null（不存在） rematch（正则匹配）</td><td>暂不支持</td></tr><tr><td>GET_COOKIES_NAMES（Cookie参数名）</td><td>不支持参数</td><td>同匹配字段GET参数名逻辑符号</td><td>请输入内容,512个字符以内</td></tr><tr><td>ARGS_COOKIE（Cookie参数值）</td><td>支持参数录入</td><td>同匹配字段GET参数值逻辑符号</td><td>请输入内容,512个字符以内</td></tr><tr><td>GET_HEADERS_NAMES（Header参数名）</td><td>不支持参数</td><td>exsit（存在参数） nexsit（不存在参数） len_eq（长度等于） len_gt（长度大于） len_lt（长度小于） strprefix（前缀匹配） strsuffix（后缀匹配） rematch（正则匹配）</td><td>请输入内容,建议小写,512个字符以内</td></tr><tr><td>ARGS_HEADER（Header参数值）</td><td>支持参数录入</td><td>contains（包含） ncontains（不包含） len_eq（长度等于） len_gt（长度大于） len_lt（长度小于） strprefix（前缀匹配） strsuffix（后缀匹配） rematch（正则匹配）</td><td>请输入内容,512个字符以内</td></tr></tbody></table> 注意：此字段可能返回 null，表示取不到有效值。 */ Field: string; /** * 逻辑符号逻辑符号一共分为以下几种类型： empty （内容为空） null （不存在） eq （等于） neq （不等于） contains （包含） ncontains （不包含） strprefix （前缀匹配） strsuffix （后缀匹配） len_eq （长度等于） len_gt （长度大于） len_lt （长度小于） ipmatch （属于） ipnmatch （不属于）各匹配字段对应的逻辑符号不同，详见上述匹配字段表格注意：此字段可能返回 null，表示取不到有效值。 */ CompareFunc: string; /** * 匹配内容目前当匹配字段为COOKIE（Cookie）时，不需要输入匹配内容其他都需要注意：此字段可能返回 null，表示取不到有效值。 */ Content: string; /** * 匹配参数配置参数一共分2种类型不支持参数与支持参数当匹配字段为以下4个时，匹配参数才能录入，否则不支持该参数 GET（GET参数值） POST（POST参数值） ARGS_COOKIE（Cookie参数值） ARGS_HEADER（Header参数值）注意：此字段可能返回 null，表示取不到有效值。 */ Arg: string; } /** * UpsertCCRule返回参数结构体 */ export interface UpsertCCRuleResponse { /** * 一般为null 注意：此字段可能返回 null，表示取不到有效值。 */ Data?: string; /** * 操作的RuleId */ RuleId?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeHost请求参数结构体 */ export interface DescribeHostRequest { /** * 域名 */ Domain: string; /** * 域名ID */ DomainId: string; /** * 实例ID */ InstanceID?: string; } /** * DescribeAccessIndex */ export interface AccessFullTextInfo { /** * 是否大小写敏感注意：此字段可能返回 null，表示取不到有效值。 */ CaseSensitive: boolean; /** * 全文索引的分词符，字符串中每个字符代表一个分词符注意：此字段可能返回 null，表示取不到有效值。 */ Tokenizer: string; /** * 是否包含中文注意：此字段可能返回 null，表示取不到有效值。注意：此字段可能返回 null，表示取不到有效值。 */ ContainZH: boolean; } /** * DeleteCustomRule请求参数结构体 */ export interface DeleteCustomRuleRequest { /** * 删除的域名 */ Domain: string; /** * 删除的规则ID */ RuleId: string; /** * WAF的版本，clb-waf代表负载均衡WAF、sparta-waf代表SaaS WAF，默认是sparta-waf。 */ Edition?: string; } /** * DescribeHosts请求参数结构体 */ export interface DescribeHostsRequest { /** * 防护域名，如果是要查询某一具体的防护域名则传入此参数，要求是准确的域名，此参数不支持模糊搜索 */ Domain?: string; /** * 防护域名ID，如果是要查询某一具体的防护域名则传入此参数，要求是准确的域名ID，此参数不支持模糊搜索 */ DomainId?: string; /** * 搜索条件，根据此参数对域名做模糊搜索 */ Search?: string; /** * 复杂的搜索条件 */ Item?: SearchItem; /** * 实例id */ InstanceID?: string; } /** * ModifyCustomWhiteRuleStatus请求参数结构体 */ export interface ModifyCustomWhiteRuleStatusRequest { /** * 域名 */ Domain: string; /** * 规则ID */ RuleId: number; /** * 开关的状态，1是开启、0是关闭 */ Status: number; } /** * Clb-waf地域信息 */ export interface ClbWafRegionItem { /** * 地域ID 注意：此字段可能返回 null，表示取不到有效值。 */ Id?: string; /** * 地域中文说明注意：此字段可能返回 null，表示取不到有效值。 */ Text?: string; /** * 地域英文全拼注意：此字段可能返回 null，表示取不到有效值。 */ Value?: string; /** * 地域编码注意：此字段可能返回 null，表示取不到有效值。 */ Code?: string; } /** * DescribeFindDomainList请求参数结构体 */ export interface DescribeFindDomainListRequest { /** * 分页 */ Offset: number; /** * 每页容量 */ Limit: number; /** * 过滤条件 */ Key: string; /** * 是否接入waf */ IsWafDomain: string; /** * 排序参数 */ By?: string; /** * 排序方式 */ Order?: string; } /** * ModifyInstanceElasticMode返回参数结构体 */ export interface ModifyInstanceElasticModeResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 需要开启/关闭API安全的实例+域名组合实体 */ export interface TargetEntity { /** * 实例ID */ InstanceId?: string; /** * 域名 */ Domain?: string; } /** * cc规则 */ export interface CCRuleItem { /** * 动作 */ ActionType: number; /** * 高级模式 */ Advance: number; /** * 时间周期 */ Interval: number; /** * 限制次数 */ Limit: number; /** * 匹配方法 */ MatchFunc: number; /** * 名称 */ Name: string; /** * 优先级 */ Priority: number; /** * 状态 */ Status: number; /** * 更新时间戳 */ TsVersion: number; /** * 匹配url */ Url: string; /** * 策略动作有效时间 */ ValidTime: number; /** * 高级参数注意：此字段可能返回 null，表示取不到有效值。 */ OptionsArr: string; } /** * 混合云节点资源信息 */ export interface HybridPkg { /** * 资源id 注意：此字段可能返回 null，表示取不到有效值。 */ ResourceIds?: string; /** * 状态注意：此字段可能返回 null，表示取不到有效值。 */ Status?: number; /** * 地域注意：此字段可能返回 null，表示取不到有效值。 */ Region?: number; /** * 开始时间注意：此字段可能返回 null，表示取不到有效值。 */ BeginTime?: string; /** * 结束时间注意：此字段可能返回 null，表示取不到有效值。 */ EndTime?: string; /** * 申请数量注意：此字段可能返回 null，表示取不到有效值。 */ InquireNum?: number; /** * 使用数量注意：此字段可能返回 null，表示取不到有效值。 */ UsedNum?: number; /** * 续费标志注意：此字段可能返回 null，表示取不到有效值。 */ RenewFlag?: number; } /** * DescribeCustomWhiteRule返回参数结构体 */ export interface DescribeCustomWhiteRuleResponse { /** * 规则详情 */ RuleList?: Array<DescribeCustomRulesRspRuleListItem>; /** * 规则条数 */ TotalCount?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifySpartaProtection请求参数结构体 */ export interface ModifySpartaProtectionRequest { /** * 域名 */ Domain: string; /** * 域名ID */ DomainId?: string; /** * 证书类型，0表示没有证书，CertType=1表示自有证书,2 为托管证书 */ CertType?: number; /** * CertType=1时，需要填次参数，表示证书内容 */ Cert?: string; /** * CertType=1时，需要填次参数，表示证书的私钥 */ PrivateKey?: string; /** * CertType=2时，需要填次参数，表示证书的ID */ SSLId?: string; /** * 表示是否开启了CDN代理 */ IsCdn?: number; /** * HTTPS回源协议 */ UpstreamScheme?: string; /** * HTTPS回源端口,仅UpstreamScheme为http时需要填当前字段 */ HttpsUpstreamPort?: string; /** * 表示是否强制跳转到HTTPS，1表示开启，0表示不开启 */ HttpsRewrite?: number; /** * 回源类型，0表示通过IP回源,1 表示通过域名回源 */ UpstreamType?: number; /** * UpstreamType=1时，填次字段表示回源域名 */ UpstreamDomain?: string; /** * UpstreamType=0时，填次字段表示回源ip */ SrcList?: Array<string>; /** * 是否开启HTTP2，1表示开启，0表示不开启http2。开启HTTP2需要HTTPS支持 */ IsHttp2?: number; /** * 是否开启WebSocket， 1：开启WebSocket，0：不开启WebSocket */ IsWebsocket?: number; /** * 负载均衡策略，0表示轮徇，1表示IP hash */ LoadBalance?: number; /** * 是否灰度 */ IsGray?: number; /** * WAF版本 */ Edition?: string; /** * 端口信息 */ Ports?: Array<SpartaProtectionPort>; /** * 长短连接标志，仅IP回源时有效 */ IsKeepAlive?: string; /** * 实例id */ InstanceID?: string; /** * 是否为Anycast ip类型：1 Anycast 0 普通ip */ Anycast?: number; /** * src的权重 */ Weights?: Array<number | bigint>; /** * 是否开启源站的主动健康检测，1表示开启，0表示不开启 */ ActiveCheck?: number; /** * TLS版本信息 */ TLSVersion?: number; /** * 加密套件信息 */ Ciphers?: Array<number | bigint>; /** * 0:不支持选择：默认模板 1:通用型模板 2:安全型模板 3:自定义模板 */ CipherTemplate?: number; /** * 300s */ ProxyReadTimeout?: number; /** * 300s */ ProxySendTimeout?: number; /** * 0:关闭SNI；1:开启SNI，SNI=源请求host；2:开启SNI，SNI=修改为源站host；3：开启SNI，自定义host，SNI=SniHost； */ SniType?: number; /** * SniType=3时，需要填此参数，表示自定义的host； */ SniHost?: string; /** * IsCdn=3时，需要填此参数，表示自定义header */ IpHeaders?: Array<string>; /** * 0:关闭xff重置；1:开启xff重置，只有在IsCdn=0时可以开启 */ XFFReset?: number; } /** * DeleteAttackDownloadRecord请求参数结构体 */ export interface DeleteAttackDownloadRecordRequest { /** * 下载任务记录唯一标记 */ Id: number; } /** * DescribeAntiFakeRules请求参数结构体 */ export interface DescribeAntiFakeRulesRequest { /** * 域名 */ Domain: string; /** * 偏移 */ Offset: number; /** * 容量 */ Limit: number; /** * 过滤数组,name可以是如下的值： RuleID,ParamName,Url,Action,Method,Source,Status */ Filters?: Array<FiltersItemNew>; /** * asc或者desc */ Order?: string; /** * 目前支持根据ts排序 */ By?: string; } /** * DescribeVipInfo请求参数结构体 */ export interface DescribeVipInfoRequest { /** * waf实例id列表 */ InstanceIds: Array<string>; } /** * DescribeFindDomainList返回参数结构体 */ export interface DescribeFindDomainListResponse { /** * 域名总数 */ Total: number; /** * 域名信息列表 */ List: Array<FindAllDomainDetail>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteSession返回参数结构体 */ export interface DeleteSessionResponse { /** * 结果注意：此字段可能返回 null，表示取不到有效值。 */ Data?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAccessIndex返回参数结构体 */ export interface DescribeAccessIndexResponse { /** * 是否生效，true表示生效，false表示未生效 */ Status?: boolean; /** * 索引配置信息注意：此字段可能返回 null，表示取不到有效值。注意：此字段可能返回 null，表示取不到有效值。 */ Rule?: AccessRuleInfo; /** * 索引修改时间，初始值为索引创建时间。 */ ModifyTime?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyUserSignatureRule请求参数结构体 */ export interface ModifyUserSignatureRuleRequest { /** * 域名 */ Domain: string; /** * 主类id */ MainClassID?: string; /** * 主类开关0=关闭，1=开启，2=只告警 */ Status?: number; /** * 下发修改的规则列表 */ RuleID?: Array<ReqUserRule>; } /** * ModifyWafThreatenIntelligence返回参数结构体 */ export interface ModifyWafThreatenIntelligenceResponse { /** * 当前WAF威胁情报封禁模块详情 */ WafThreatenIntelligenceDetails?: WafThreatenIntelligenceDetails; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeUserDomainInfo返回参数结构体 */ export interface DescribeUserDomainInfoResponse { /** * saas和clb域名信息 */ UsersInfo: Array<UserDomainInfo>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * TLS信息 */ export interface TLSVersion { /** * TLSVERSION的ID 注意：此字段可能返回 null，表示取不到有效值。 */ VersionId: number; /** * TLSVERSION的NAME 注意：此字段可能返回 null，表示取不到有效值。 */ VersionName: string; } /** * 负载均衡的监听器 */ export interface LoadBalancer { /** * 负载均衡LD的ID */ LoadBalancerId: string; /** * 负载均衡LD的名称 */ LoadBalancerName: string; /** * 负载均衡监听器的ID */ ListenerId: string; /** * 负载均衡监听器的名称 */ ListenerName: string; /** * 负载均衡实例的IP */ Vip: string; /** * 负载均衡实例的端口 */ Vport: number; /** * 负载均衡LD的地域 */ Region: string; /** * 监听器协议，http、https */ Protocol: string; /** * 负载均衡监听器所在的zone */ Zone: string; /** * 负载均衡的VPCID，公网为-1，内网按实际填写注意：此字段可能返回 null，表示取不到有效值。 */ NumericalVpcId?: number; /** * 负载均衡的网络类型注意：此字段可能返回 null，表示取不到有效值。 */ LoadBalancerType?: string; /** * 负载均衡的域名注意：此字段可能返回 null，表示取不到有效值。 */ LoadBalancerDomain?: string; } /** * CDC场景下负载均衡WAF的集群信息 */ export interface CdcCluster { /** * cdc的集群id */ Id: string; /** * cdc的集群名称注意：此字段可能返回 null，表示取不到有效值。 */ Name: string; } /** * DescribeCustomRules接口回包中的复杂类型 */ export interface DescribeCustomRulesRspRuleListItem { /** * 动作类型 */ ActionType?: string; /** * 跳过的策略 */ Bypass?: string; /** * 创建时间 */ CreateTime?: string; /** * 过期时间 */ ExpireTime?: string; /** * 策略名称 */ Name?: string; /** * 重定向地址 */ Redirect?: string; /** * 策略ID */ RuleId?: string; /** * 优先级 */ SortId?: string; /** * 状态 */ Status?: string; /** * 策略详情 */ Strategies?: Array<Strategy>; /** * 事件id 注意：此字段可能返回 null，表示取不到有效值。 */ EventId?: string; /** * 修改时间注意：此字段可能返回 null，表示取不到有效值。 */ ModifyTime?: string; /** * 生效状态注意：此字段可能返回 null，表示取不到有效值。 */ ValidStatus?: number; /** * 来源注意：此字段可能返回 null，表示取不到有效值。 */ Source?: string; } /** * ModifyAntiInfoLeakRules返回参数结构体 */ export interface ModifyAntiInfoLeakRulesResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 获取弹性qps的默认相关值 */ export interface QpsData { /** * 弹性qps默认值注意：此字段可能返回 null，表示取不到有效值。 */ ElasticBillingDefault?: number; /** * 弹性qps最小值注意：此字段可能返回 null，表示取不到有效值。 */ ElasticBillingMin?: number; /** * 弹性qps最大值注意：此字段可能返回 null，表示取不到有效值。 */ ElasticBillingMax?: number; /** * 业务扩展包最大qps 注意：此字段可能返回 null，表示取不到有效值。 */ QPSExtendMax?: number; /** * 海外业务扩展包最大qps 注意：此字段可能返回 null，表示取不到有效值。 */ QPSExtendIntlMax?: number; } /** * AddCustomWhiteRule返回参数结构体 */ export interface AddCustomWhiteRuleResponse { /** * 操作的状态码，如果所有的资源操作成功则返回的是成功的状态码，如果有资源操作失败则需要解析Message的内容来查看哪个资源失败 */ Success: ResponseCode; /** * 添加成功的规则ID 注意：此字段可能返回 null，表示取不到有效值。 */ RuleId: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SwitchElasticMode请求参数结构体 */ export interface SwitchElasticModeRequest { /** * 版本，只能是sparta-waf, clb-waf, cdn-waf */ Edition: string; /** * 0代表关闭，1代表打开 */ Mode: number; /** * 实例id */ InstanceID?: string; } /** * CLB-WAF删除域名参数 */ export interface HostDel { /** * 域名 */ Domain: string; /** * 域名ID */ DomainId: string; /** * 实例类型 */ InstanceID?: string; } /** * DescribeModuleStatus请求参数结构体 */ export interface DescribeModuleStatusRequest { /** * 要查询状态的域名 */ Domain: string; } /** * DescribeAntiFakeUrl请求参数结构体 */ export interface DescribeAntiFakeUrlRequest { /** * 域名 */ Domain: string; /** * 翻页参数 */ PageInfo: PageInfo; } /** * DeleteAttackWhiteRule请求参数结构体 */ export interface DeleteAttackWhiteRuleRequest { /** * 规则序号组 */ Ids: Array<number | bigint>; /** * 用户域名 */ Domain: string; } /** * DescribeHosts返回参数结构体 */ export interface DescribeHostsResponse { /** * 防护域名列表的长度 */ TotalCount: number; /** * 防护域名的列表注意：此字段可能返回 null，表示取不到有效值。 */ HostList: Array<HostRecord>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAccessIndex请求参数结构体 */ export declare type DescribeAccessIndexRequest = null; /** * domain列表 */ export interface DomainInfo { /** * 域名 */ Domain: string; /** * 域名ID */ DomainId: string; /** * 实例ID */ InstanceId: string; /** * cname地址 */ Cname: string; /** * 实例类型,sparta-waf表示saaswaf实例域名,clb-waf表示clbwaf实例域名,cdc-clb-waf表示CDC环境下clbwaf实例域名,cdn-waf表示cdnwaf实例域名 */ Edition: string; /** * 地域 */ Region: string; /** * 实例名 */ InstanceName: string; /** * 日志包 */ ClsStatus: number; /** * clbwaf使用模式,0镜像模式 1清洗模式 */ FlowMode: number; /** * waf开关,0关闭 1开启 */ Status: number; /** * 规则引擎防护模式,0观察模式 1拦截模式 */ Mode: number; /** * 规则引擎和AI引擎防护模式联合状态,10规则引擎观察&&AI引擎关闭模式 11规则引擎观察&&AI引擎观察模式 12规则引擎观察&&AI引擎拦截模式 20规则引擎拦截&&AI引擎关闭模式 21规则引擎拦截&&AI引擎观察模式 22规则引擎拦截&&AI引擎拦截模式 */ Engine: number; /** * CC列表 */ CCList: Array<string>; /** * 回源ip */ RsList: Array<string>; /** * 服务端口配置 */ Ports: Array<PortInfo>; /** * 负载均衡器 */ LoadBalancerSet: Array<LoadBalancerPackageNew>; /** * 用户id */ AppId: number; /** * clbwaf域名监听器状态,0操作成功 4正在绑定LB 6正在解绑LB 7解绑LB失败 8绑定LB失败 10内部错误 */ State: number; /** * 创建时间 */ CreateTime?: string; /** * Ipv6开关状态,0关闭 1开启 */ Ipv6Status?: number; /** * BOT开关状态,0关闭 1开启 */ BotStatus?: number; /** * 版本信息 */ Level?: number; /** * 是否开启投递CLS功能,0关闭 1开启 */ PostCLSStatus?: number; /** * 是否开启投递CKafka功能,0关闭 1开启 */ PostCKafkaStatus?: number; /** * cdc实例域名接入的集群信息,非cdc实例忽略注意：此字段可能返回 null，表示取不到有效值。 */ CdcClusters?: string; /** * api安全开关状态,0关闭 1开启注意：此字段可能返回 null，表示取不到有效值。 */ ApiStatus?: number; /** * 应用型负载均衡类型,clb或者apisix，默认clb 注意：此字段可能返回 null，表示取不到有效值。 */ AlbType?: string; /** * 安全组状态,0不展示 1非腾讯云源站 2安全组绑定失败 3安全组发生变更注意：此字段可能返回 null，表示取不到有效值。 */ SgState?: number; /** * 安全组状态的详细解释注意：此字段可能返回 null，表示取不到有效值。 */ SgDetail?: string; /** * 域名类型:hybrid表示混合云域名，public表示公有云域名注意：此字段可能返回 null，表示取不到有效值。 */ CloudType?: string; } /** * DescribeDomains返回参数结构体 */ export interface DescribeDomainsResponse { /** * 总数 */ Total?: number; /** * domain列表注意：此字段可能返回 null，表示取不到有效值。 */ Domains?: Array<DomainInfo>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AddAntiFakeUrl返回参数结构体 */ export interface AddAntiFakeUrlResponse { /** * 结果 */ Result?: string; /** * 规则ID */ Id?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifySpartaProtection返回参数结构体 */ export interface ModifySpartaProtectionResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeUserCdcClbWafRegions返回参数结构体 */ export interface DescribeUserCdcClbWafRegionsResponse { /** * CdcRegion的类型描述注意：此字段可能返回 null，表示取不到有效值。 */ Data?: Array<CdcRegion>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SwitchElasticMode返回参数结构体 */ export interface SwitchElasticModeResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAccessIndex接口的出参数 */ export interface AccessRuleInfo { /** * 全文索引配置注意：此字段可能返回 null，表示取不到有效值。注意：此字段可能返回 null，表示取不到有效值。 */ FullText: AccessFullTextInfo; /** * 键值索引配置注意：此字段可能返回 null，表示取不到有效值。注意：此字段可能返回 null，表示取不到有效值。 */ KeyValue: AccessRuleKeyValueInfo; /** * 元字段索引配置注意：此字段可能返回 null，表示取不到有效值。注意：此字段可能返回 null，表示取不到有效值。 */ Tag: AccessRuleTagInfo; } /** * CC规则总览 */ export interface CCRuleLists { /** * 总数 */ TotalCount: number; /** * 规则注意：此字段可能返回 null，表示取不到有效值。 */ Res: Array<CCRuleItems>; } /** * PostAttackDownloadTask请求参数结构体 */ export interface PostAttackDownloadTaskRequest { /** * 查询的域名，所有域名使用all */ Domain: string; /** * 查询起始时间 */ StartTime: string; /** * 查询结束时间 */ EndTime: string; /** * Lucene语法 */ QueryString: string; /** * 任务名称 */ TaskName: string; /** * 默认为desc，可以取值desc和asc */ Sort?: string; /** * 下载的日志条数 */ Count?: number; } /** * ModifyAntiFakeUrlStatus请求参数结构体 */ export interface ModifyAntiFakeUrlStatusRequest { /** * 域名 */ Domain: string; /** * 状态 */ Status: number; /** * Id列表 */ Ids: Array<number | bigint>; } /** * TLS 加密套件 */ export interface TLSCiphers { /** * TLS版本ID 注意：此字段可能返回 null，表示取不到有效值。 */ VersionId: number; /** * 加密套件ID 注意：此字段可能返回 null，表示取不到有效值。 */ CipherId: number; /** * 加密套件注意：此字段可能返回 null，表示取不到有效值。 */ CipherName: string; } /** * 响应体的返回码 */ export interface ResponseCode { /** * 如果成功则返回Success，失败则返回云api定义的错误码 */ Code: string; /** * 如果成功则返回Success，失败则返回WAF定义的二级错误码 */ Message: string; } /** * ModifyAccessPeriod返回参数结构体 */ export interface ModifyAccessPeriodResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyAttackWhiteRule返回参数结构体 */ export interface ModifyAttackWhiteRuleResponse { /** * 规则总数 */ RuleId: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SearchAccessLog返回参数结构体 */ export interface SearchAccessLogResponse { /** * 新接口此字段失效，默认返回空字符串 */ Context?: string; /** * 日志查询结果是否全部返回，其中，“true”表示结果返回，“false”表示结果为返回 */ ListOver?: boolean; /** * 返回的是否为分析结果，其中，“true”表示返回分析结果，“false”表示未返回分析结果 */ Analysis?: boolean; /** * 如果Analysis为True，则返回分析结果的列名，否则为空注意：此字段可能返回 null，表示取不到有效值。注意：此字段可能返回 null，表示取不到有效值。 */ ColNames?: Array<string>; /** * 日志查询结果；当Analysis为True时，可能返回为null 注意：此字段可能返回 null，表示取不到有效值注意：此字段可能返回 null，表示取不到有效值。 */ Results?: Array<AccessLogInfo>; /** * 日志分析结果；当Analysis为False时，可能返回为null 注意：此字段可能返回 null，表示取不到有效值注意：此字段可能返回 null，表示取不到有效值。 */ AnalysisResults?: Array<AccessLogItems>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAntiInfoLeakageRules请求参数结构体 */ export interface DescribeAntiInfoLeakageRulesRequest { /** * 域名 */ Domain: string; /** * 翻页支持，读取偏移 */ Offset?: number; /** * 翻页支持，读取长度限制 */ Limit?: number; /** * 排序方式，asc或者desc */ Order?: string; /** * 过滤器,可以允许如下的值： RuleId,Match_field,Name,Action,Status */ Filters?: Array<FiltersItemNew>; } /** * CreateHost返回参数结构体 */ export interface CreateHostResponse { /** * 新增防护域名ID */ DomainId?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyBotStatus请求参数结构体 */ export interface ModifyBotStatusRequest { /** * 域名 */ Domain: string; /** * 类别 */ Category: string; /** * 状态 */ Status: string; /** * 实例id */ InstanceID?: string; /** * 是否是bot4.0版本 */ IsVersionFour?: boolean; /** * 传入Bot版本号，场景化版本为"4.1.0" */ BotVersion?: string; } /** * ModifyHostFlowMode请求参数结构体 */ export interface ModifyHostFlowModeRequest { /** * 域名 */ Domain: string; /** * 域名ID */ DomainId: string; /** * WAF流量模式，1：清洗模式，0：镜像模式（默认） */ FlowMode: number; /** * 实例ID */ InstanceID?: string; } /** * CreateHost请求参数结构体 */ export interface CreateHostRequest { /** * 防护域名配置信息 */ Host: HostRecord; /** * 实例id */ InstanceID?: string; } /** * GetInstanceQpsLimit返回参数结构体 */ export interface GetInstanceQpsLimitResponse { /** * 弹性qps相关值集合 */ QpsData?: QpsData; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyCustomWhiteRule返回参数结构体 */ export interface ModifyCustomWhiteRuleResponse { /** * 操作的状态码，如果所有的资源操作成功则返回的是成功的状态码，如果有资源操作失败则需要解析Message的内容来查看哪个资源失败 */ Success?: ResponseCode; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 接入列表查询复杂条件 */ export interface SearchItem { /** * 日志开关 */ ClsStatus?: string; /** * waf开关 */ Status?: string; /** * 流量模式 */ FlowMode?: string; } /** * API安全资源信息 */ export interface ApiPkg { /** * 资源id 注意：此字段可能返回 null，表示取不到有效值。 */ ResourceIds?: string; /** * 状态注意：此字段可能返回 null，