tencentcloud-sdk-nodejs

/** * 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-格式）列表 */ Data?: Array<string>; /** * 包含详细属性的地域信息 */ RichDatas?: Array<ClbWafRegionItem>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AddAntiFakeUrl请求参数结构体 */ export interface AddAntiFakeUrlRequest { /** * 域名 */ Domain: string; /** * 名称 */ Name: string; /** * uri */ Uri: string; } /** * ModifyIpAccessControl请求参数结构体 */ export interface ModifyIpAccessControlRequest { /** * 具体域名如：test.qcloudwaf.com 全局域名为：global */ Domain: string; /** * ip参数列表 */ IpList: Array<string>; /** * 42为黑名单，40为白名单 */ ActionType: number; /** * 规则ID */ RuleId: number; /** * valid_ts为有效日期，值为秒级时间戳（（如1680570420代表2023-04-04 09:07:00）） * @deprecated */ ValidTS?: number; /** * 实例Id */ InstanceId?: string; /** * WAF实例类型，sparta-waf表示SAAS型WAF，clb-waf表示负载均衡型WAF */ Edition?: string; /** * 是否为批量防护IP黑白名单，当为批量防护IP黑白名单时，取值为batch，否则为空 */ SourceType?: string; /** * 备注 */ Note?: string; /** * 规则执行的方式，TimedJob为定时执行，CronJob为周期执行 */ JobType?: string; /** * 定时配置详情 */ JobDateTime?: JobDateTime; } /** * DescribeApiListVersionTwo返回参数结构体 */ export interface DescribeApiListVersionTwoResponse { /** * api资产列表 */ Data?: Array<ApiAsset>; /** * 总数 */ Total?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: 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; } /** * 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" */ Region: string; /** * 接入IP */ Vip: string; /** * 接入端口 */ Vport: number; /** * 地域 */ Zone: string; /** * VPCID */ NumericalVpcId: number; /** * CLB类型 */ LoadBalancerType: string; /** * 负载均衡器的域名 */ LoadBalancerDomain?: string; } /** * ModifyUserSignatureClass返回参数结构体 */ export interface ModifyUserSignatureClassResponse { /** * 规则类型ID */ TypeID?: string; /** * 规则类型状态，0：关闭，1：开启 */ Status?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UpdateProtectionModes返回参数结构体 */ export interface UpdateProtectionModesResponse { /** * 操作结果注意：此字段可能返回 null，表示取不到有效值。 */ CommonRsp?: CommonRspData; /** * 唯一请求 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; } /** * 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。 */ RequestId?: string; } /** * ModifyHostMode返回参数结构体 */ export interface ModifyHostModeResponse { /** * 操作的状态码，如果所有的资源操作成功则返回的是成功的状态码，如果有资源操作失败则需要解析Message的内容来查看哪个资源失败 */ Success?: ResponseCode; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * GetAttackDownloadRecords请求参数结构体 */ export declare type GetAttackDownloadRecordsRequest = null; /** * 重保防护资源信息 */ 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; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 用于 DescribeAccessIndex 的出参 */ export interface AccessKeyValueInfo { /** * 需要配置键值或者元字段索引的字段 */ Key?: string; /** * 字段的索引描述信息 */ 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 { /** * 删除失败的规则序号组 */ FailIds?: Array<number | bigint>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeWebshellStatus请求参数结构体 */ export interface DescribeWebshellStatusRequest { /** * 域名 */ Domain: string; } /** * GetAttackHistogram返回参数结构体 */ export interface GetAttackHistogramResponse { /** * 统计详情 */ Data?: Array<LogHistogramInfo>; /** * 时间段大小 */ Period?: number; /** * 统计的条目数 */ TotalCount?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 过滤数组 */ export interface FiltersItemNew { /** * 字段名；过滤子订单号过滤通过name 为：DealName； value为子订单号 */ Name: string; /** * 过滤值 */ Values: Array<string>; /** * 是否精确查找 */ ExactMatch: boolean; } /** * DeleteSpartaProtection返回参数结构体 */ export interface DeleteSpartaProtectionResponse { /** * 唯一请求 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; } /** * 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; } /** * 负载均衡型WAF域名信息 */ export interface HostRecord { /** * 域名 */ Domain: string; /** * 域名唯一ID */ DomainId: string; /** * 主域名，入参时为空 */ MainDomain: string; /** * 规则引擎防护模式。 0：观察模式 1：拦截模式 */ Mode: number; /** * waf和负载均衡器的绑定关系。 0：未绑定 1：已绑定 */ Status: number; /** * clbwaf域名监听器状态。 0：操作成功 4：正在绑定LB 6：正在解绑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: Array<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?: Array<string>; /** * 应用型负载均衡类型，默认clb。 clb：七层负载均衡器类型 apisix：apisix网关型 tsegw：云原生API网关 scf：云函数 */ AlbType?: string; /** * IsCdn=3时，需要填此参数，表示自定义header */ IpHeaders?: Array<string>; /** * 规则引擎类型。 1: menshen 2: tiga */ EngineType?: number; /** * 云类型。 public:公有云 private:私有云 hybrid:混合云 */ CloudType?: string; /** * 域名备注信息 */ Note?: string; } /** * ModifyCustomRule返回参数结构体 */ export interface ModifyCustomRuleResponse { /** * 操作的状态码，如果所有的资源操作成功则返回的是成功的状态码，如果有资源操作失败则需要解析Message的内容来查看哪个资源失败 */ Success?: ResponseCode; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 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 { /** * 分配的服务器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次数 */ StatusServerError?: number; /** * WAF返回给客户端状态码4xx次数 */ StatusClientError?: number; /** * WAF返回给客户端状态码302次数 */ StatusRedirect?: number; /** * WAF返回给客户端状态码202次数 */ StatusOk?: number; /** * 源站返回给WAF状态码5xx次数 */ UpstreamServerError?: number; /** * 源站返回给WAF状态码4xx次数 */ UpstreamClientError?: number; /** * 源站返回给WAF状态码302次数 */ UpstreamRedirect?: number; /** * 黑名单次数 */ BlackIP?: number; /** * 防篡改次数 */ Tamper?: number; /** * 信息防泄露次数 */ Leak?: number; /** * 访问控制 */ ACL?: number; /** * 小程序 qps */ WxAccess?: number; /** * 小程序请求数 */ WxCount?: number; /** * 小程序上行带宽峰值，单位B */ WxUp?: number; /** * 小程序下行带宽峰值，单位B */ WxDown?: 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; } /** * 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; } /** * 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; /** * IP黑白名单类型，40为IP白名单，42为IP黑名单 */ ActionType?: number; } /** * 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; } /** * 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。 */ RequestId?: string; } /** * DescribeUserDomainInfo请求参数结构体 */ export declare 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; } /** * DescribeHost返回参数结构体 */ export interface DescribeHostResponse { /** * 域名详情 */ Host?: HostRecord; /** * 唯一请求 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; } /** * 规则的匹配条件结构体 */ 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><tr><td>CONTENT_LENGTH（Content-length）</td><td>支持参数录入</td><td>numgt（数值大于） numlt（数值小于） numeq（数值等于） </td><td>请输入0-9999999999999之间的整数</td></tr><tr><td>IP_GEO（来源IP归属地）</td><td>支持参数录入</td><td>geo_in（属于） geo_not_in（不属于） </td><td>请输入内容,10240字符以内，格式为序列化的JSON，格式为：[{"Country":"中国","Region":"广东","City":"深圳"}]</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 （数值等于） 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; } /** * 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; } /** * DescribeAccessIndex */ export interface AccessFullTextInfo { /** * 是否大小写敏感 */ CaseSensitive?: boolean; /** * 全文索引的分词符，字符串中每个字符代表一个分词符 */ Tokenizer?: string; /** * 是否包含中文注意：此字段可能返回 null，表示取不到有效值。 */ ContainZH?: boolean; } /** * 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请求参数结构体 */ export interface DescribeUserSignatureRuleV2Request { /** * 需要查询的域名 */ Domain: string; /** * 分页 */ Offset: number; /** * 每页容量 */ Limit: number; /** * 排序字段，支持 signature_id, modify_time */ By?: string; /** * 排序方式 */ Order?: string; /** * 筛选条件，支持 MainClassName，SubClassID ,CveID, Status, ID; ID为规则id */ Filters?: Array<FiltersItemNew>; } /** * ModifyApiSecEventChange请求参数结构体 */ export interface ModifyApiSecEventChangeRequest { /** * 变更状态，1:新发现，2，确认中，3，已确认，4，已下线，5，已忽略 */ Mode?: string; /** * 处理人 */ UserName?: string; /** * 备注，有长度显示1k */ Remark?: string; /** * 批量操作的事件列表 */ EventIdList?: Array<string>; /** * 批量操作的api列表 */ ApiNameList?: Array<ApiSecKey>; /** * 判断是否删除，包括删除事件和删除资产 */ IsDelete?: boolean; /** * 判断是否是更新api的备注，更新api备注的时候，为true */ UpdateApiRemark?: boolean; } /** * DescribePostCLSFlows请求参数结构体 */ export interface DescribePostCLSFlowsRequest { /** * 1-访问日志，2-攻击日志，默认为访问日志。 */ LogType?: number; } /** * 规则执行的时间结构体 */ export interface JobDateTime { /** * 定时执行的时间参数 */ Timed?: Array<TimedJob>; /** * 周期执行的时间参数 */ Cron?: Array<CronJob>; /** * 时区 */ TimeTZone?: 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; } /** * ModifyAreaBanRule请求参数结构体 */ export interface ModifyAreaBanRuleRequest { /** * 需要修改的域名 */ Domain: string; /** * 需要新增的封禁地域 */ Areas: Array<Area>; /** * 规则执行的方式，TimedJob为定时执行，CronJob为周期执行 */ JobType: string; /** * 定时任务配置 */ JobDateTime: JobDateTime; /** * 地域信息的语言，支持cn、en，默认为中文cn */ Lang?: string; } /** * Clb-waf地域信息 */ export interface ClbWafRegionItem { /** * 地域ID */ Id?: string; /** * 地域中文说明 */ Text?: string; /** * 地域英文全拼 */ Value?: string; /** * 地域编码 */ Code?: string; } /** * DescribeFindDomainList请求参数结构体 */ export interface DescribeFindDomainListRequest { /** * 分页 */ Offset: number; /** * 每页容量 */ Limit: number; /** * 过滤条件 */ Key: string; /** * 是否接入waf；传"1"返回接入域名的详情，传"0"返回未接入域名的详情，传""返回接入和未接入域名的详情 */ IsWafDomain: string; /** * 排序参数 */ By?: string; /** * 排序方式 */ Order?: string; } /** * ModifyInstanceElasticMode返回参数结构体 */ export interface ModifyInstanceElasticModeResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribePostCLSFlows返回参数结构体 */ export interface DescribePostCLSFlowsResponse { /** * 客户的投递流列表 */ PostCLSFlows?: Array<PostCLSFlowInfo>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 需要开启/关闭API安全的实例+域名组合实体 */ export interface TargetEntity { /** * 实例ID */ InstanceId?: string; /** * 域名 */ Domain?: string; } /** * DeleteHost请求参数结构体 */ export interface DeleteHostRequest { /** * 删除的域名列表 */ HostsDel: Array<HostDel>; } /** * DescribeDomainCountInfo请求参数结构体 */ export declare type DescribeDomainCountInfoRequest = null; /** * DescribeCustomWhiteRule返回参数结构体 */ export interface DescribeCustomWhiteRuleResponse { /** * 规则详情 */ RuleList?: Array<DescribeCustomRulesRspRuleListItem>; /** * 规则条数 */ TotalCount?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifySpartaProtection请求参数结构体 */ export interface ModifySpartaProtectionRequest { /** * 域名 */ Domain: string; /** * 必填项。域名唯一ID */ DomainId: string; /** * 必填项。域名所属实例id */ InstanceID: string; /** * 证书类型。0：仅配置HTTP监听端口，没有证书1：证书来源为自有证书2：证书来源为托管证书 */ CertType?: number; /** * CertType为1时，需要填充此参数，表示自有证书的证书链 */ Cert?: string; /** * CertType为1时，需要填充此参数，表示自有证书的私钥 */ PrivateKey?: string; /** * CertType为2时，需要填充此参数，表示腾讯云SSL平台托管的证书id */ SSLId?: string; /** * waf前是否部署有七层代理服务。0：没有部署代理服务1：有部署代理服务，waf将使用XFF获取客户端IP2：有部署代理服务，waf将使用remote_addr获取客户端IP3：有部署代理服务，waf将使用ip_headers中的自定义header获取客户端IP */ IsCdn?: number; /** * 服务配置有HTTPS端口时，HTTPS的回源协议。 http：使用http协议回源，和HttpsUpstreamPort配合使用 https：使用https协议回源 */ UpstreamScheme?: string; /** * HTTPS回源端口,仅UpstreamScheme为http时需要填当前字段 */ HttpsUpstreamPort?: string; /** * 是否开启HTTP强制跳转到HTTPS。0：不强制跳转1：开启强制跳转 */ HttpsRewrite?: number; /** * 回源类型。0：通过IP回源1：通过域名回源 */ UpstreamType?: number; /** * 域名回源时的回源域名。UpstreamType为1时，需要填充此字段 */ UpstreamDomain?: string; /** * IP回源时的回源IP列表。UpstreamType为0时，需要填充此字段 */ SrcList?: Array<string>; /** * 是否开启HTTP2，需要开启HTTPS协议支持。0：关闭1：开启 */ IsHttp2?: number; /** * 是否开启WebSocket支持。0：关闭1：开启 */ IsWebsocket?: number; /** * 回源负载均衡策略。0：轮询1：IP hash2：加权轮询 */ LoadBalance?: number; /** * 待废弃，可不填。是否开启灰度，0表示不开启灰度。 */ IsGray?: number; /** * 域名所属实例类型 */ Edition?: string; /** * 端口信息，可通过DescribeDomains接口获取具体参数信息。 */ Ports?: Array<SpartaProtectionPort>; /** * 是否开启长连接。0：短连接1：长连接 */ IsKeepAlive?: string; /** * 待废弃。目前填0即可。anycast IP类型开关： 0 普通IP 1 Anycast IP */ Anycast?: number; /** * 回源IP列表各IP的权重，和SrcList一一对应。当且仅当UpstreamType为0，并且SrcList有多个IP，并且LoadBalance为2时需要填写，否则填 [] */ Weights?: Array<number | bigint>; /** * 是否开启主动健康检测。0：不开启1：开启 */ ActiveCheck?: number; /** * TLS版本信息 */ TLSVersion?: number; /** * 加密套件信息 */ Ciphers?: Array<number | bigint>; /** * 加密套件模板。0：不支持选择，使用默认模板 1：通用型模板 2：安全型模板3：自定义模板 */ CipherTemplate?: number; /** * WAF与源站的读超时时间，默认300s。 */ ProxyReadTimeout?: number; /** * WAF与源站的写超时时间，默认300s。 */ ProxySendTimeout?: number; /** * WAF回源时的SNI类型。 0：关闭SNI，不配置client_hello中的server_name 1：开启SNI，client_hello中的server_name为防护域名 2：开启SNI，SNI为域名回源时的源站域名 3：开启SNI，SNI为自定义域名 */ SniType?: number; /** * SniType为3时，需要填此参数，表示自定义的SNI； */ SniHost?: string; /** * IsCdn=3时，需要填此参数，表示自定义header */ IpHeaders?: Array<string>; /** * 是否开启XFF重置。0：关闭1：开启 */ XFFReset?: number; /** * 域名备注信息 */ Note?: string; /** * 自定义回源Host。默认为空字符串，表示使用防护域名作为回源Host。 */ UpstreamHost?: string; /** * 是否开启缓存。 0：关闭 1：开启 */ ProxyBuffer?: number; /** * 是否开启拨测。 0: 禁用拨测 1: 启用拨测。默认启用拨测 */ ProbeStatus?: 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; /** * 回源策略，支持负载均衡回源和分流回源两种方式。0：默认值，负载均衡回源；1：分流回源 */ UpstreamPolicy?: number; /** * 分流回源时生效，分流回源的规则。 */ UpstreamRules?: Array<UpstreamRule>; } /** * 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; /** * 目前支持根据create_time、modify_time、id排序 */ By?: string; } /** * DescribeVipInfo请求参数结构体 */ export interface DescribeVipInfoRequest { /** * waf实例id列表 */ InstanceIds: Array<string>; } /** * ImportIpAccessControl请求参数结构体 */ export interface ImportIpAccessControlRequest { /** * 导入的IP黑白名单列表 */ Data: Array<IpAccessControlParam>; /** * 具体域名如：test.qcloudwaf.com 全局域名为：global */ Domain: string; /** * 是否为批量防护IP黑白名单，当为批量防护IP黑白名单时，取值为batch，否则为空 */ SourceType: string; /** * 实例Id */ InstanceId?: string; } /** * DescribeFindDomainList返回参数结构体 */ export interface DescribeFindDomainListResponse { /** * 域名总数 */ Total?: number; /** * 域名信息列表 */ List?: Array<FindAllDomainDetail>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteSession返回参数结构体 */ export interface DeleteSessionResponse { /** * 结果 */ Data?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAccessIndex返回参数结构体 */ export interface DescribeAccessIndexResponse { /** * 是否生效，true表示生效，false表示未生效 */ Status?: boolean; /** * 索引配置信息注意：此字段可能返回 null，表示取不到有效值。 */ Rule?: AccessRuleInfo; /** * 索引修改时间，初始值为索引创建时间。 */ ModifyTime?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 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。 */ RequestId?: string; } /** * DescribeUserDomainInfo返回参数结构体 */ export interface DescribeUserDomainInfoResponse { /** * saas和clb域名信息 */ UsersInfo?: Array<UserDomainInfo>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * TLS信息 */ export interface TLSVersion { /** * TLSVERSION的ID */ VersionId?: number; /** * TLSVERSION的NAME */ 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，内网按实际填写 */ NumericalVpcId?: number; /** * 负载均衡的网络类型。OPEN：公网 INTERNAL ：内网 */ LoadBalancerType?: string; /** * 负载均衡的域名 */ LoadBalancerDomain?: string; } /** * CKafka投递流 */ export interface PostCLSFlowInfo { /** * 投递流唯一ID */ FlowId?: number; /** * 1-访问日志 2-攻击日志 */ LogType?: number; /** * 状态 0-为关闭 1-为启用 */ Status?: number; /** * CLS所在区域 */ CLSRegion?: string; /** * CLS日志集合名称 */ LogsetName?: string; /** * CLS日志集合ID */ LogsetID?: string; /** * CLS日志主题名称 */ LogTopicName?: string; /** * CLS日志集合ID */ LogTopicID?: string; } /** * CDC场景下负载均衡WAF的集群信息 */ export interface CdcCluster { /** * cdc的集群id */ Id: string; /** * cdc的集群名称 */ Name: string; } /** * DescribeCustomRules接口回包中的复杂类型 */ export 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?: Array<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; } /** * ModifyAntiInfoLeakRules返回参数结构体 */ export interface ModifyAntiInfoLeakRulesResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 获取弹性qps的默认相关值 */ export interface QpsData { /** * 弹性qps默认值 */ ElasticBillingDefault?: number; /** * 弹性qps最小值 */ ElasticBillingMin?: number; /** * 弹性qps最大值 */ ElasticBillingMax?: number; /** * 业务扩展包最大qps */ QPSExtendMax?: number; /** * 境外业务扩展包最大qps */ QPSExtendIntlMax?: number; } /** * AddCustomWhiteRule返回参数结构体 */ export interface AddCustomWhiteRuleResponse { /** * 操作的状态码，如果所有的资源操作成功则返回的是成功的状态码，如果有资源操作失败则需要解析Message的内容来查看哪个资源失败 */ Success?: ResponseCode; /** * 添加成功的规则ID */ RuleId?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyUserSignatureClass请求参数结构体 */ export interface ModifyUserSignatureClassRequest { /** * 域名 */ Domain?: string; /** * 规则类型ID */ TypeID?: string; /** * 规则类型状态，0:关闭，1:开启 */ Status?: number; } /** * CLB-WAF删除域名参数 */ export interface HostDel { /** * 域名 */ Domain: string; /** * 域名ID */ DomainId: string; /** * 实例类型 */ InstanceID?: string; } /** * DescribeModuleStatus请求参数结构体 */ export interface DescribeModuleStatusRequest { /** * 要查询状态的域名 */ Domain: string; } /** * DeleteAttackWhiteRule请求参数结构体 */ export interface DeleteAttackWhiteRuleRequest { /** * 规则序号组 */ Ids: Array<number | bigint>; /** * 用户域名 */ Domain: string; } /** * CreatePostCLSFlow返回参数结构体 */ export interface CreatePostCLSFlowResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeHosts返回参数结构体 */ export interface DescribeHostsResponse { /** * 防护域名列表的长度 */ TotalCount?: number; /** * 防护域名的列表 */ HostList?: Array<HostRecord>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 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：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: Array<string>; /** * 生产集群回源出口IP列表 */