文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>边缘安全加速平台 EO>API 文档>数据结构

数据结构

最近更新时间：2025-10-30 02:50:15

我的收藏

本页目录：

APIResource

API 资源。

被如下接口引用：CreateSecurityAPIResource, DescribeSecurityAPIResource, ModifySecurityAPIResource。

名称 类型 必选 描述
Id String 否 资源 ID。
Name String 否 资源名称。
APIServiceIds Array of String 否 API 资源关联的 API 服务 ID 列表。
Path String 否 资源路径。
Methods Array of String 否 请求方法列表。支持以下取值：GET, POST, PUT, HEAD, PATCH, OPTIONS, DELETE。
RequestConstraint String 否 请求内容匹配规则的具体内容，需符合表达式语法，详细规范参见产品文档。

APIService

API 服务配置。

被如下接口引用：CreateSecurityAPIService, DescribeSecurityAPIService, ModifySecurityAPIService。

名称 类型 必选 描述
Id String 否 API 服务 ID。
Name String 否 API 服务名称。
BasePath String 否 基础路径。

AccelerateMainland

中国大陆加速优化配置。

被如下接口引用：CreateApplicationProxy, DescribeApplicationProxies, DescribeZoneSetting, ModifyApplicationProxy。

名称 类型 必选 描述
Switch String 是 是否开启中国大陆加速优化配置，取值有：
  • on：开启；
  • off：关闭。
    		•

    AccelerateMainlandParameters

    中国大陆加速优化配置。

    被如下接口引用：DescribeL7AccSetting, ModifyL7AccSetting。

    名称 类型 必选 描述
    Switch String 否 中国大陆加速优化配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•

    AccelerateType

    加速类型

    被如下接口引用：DescribeHostsSetting。

    名称 类型 必选 描述
    Switch String 是 加速开关。取值范围：
  • on：打开;
  • off：关闭。
    		•

    AccelerationDomain

    加速域名

    被如下接口引用：DescribeAccelerationDomains。

    名称 类型 描述
    ZoneId String 站点 ID。
    DomainName String 加速域名名称。
    DomainStatus String 加速域名状态，取值有：
  • online：已生效；
  • process：部署中；
  • offline：已停用；
  • forbidden：已封禁；
  • init：未生效，待激活站点。
    		•
    Cname String CNAME 地址。
    IPv6Status String IPv6 状态，取值有：
  • follow：遵循站点IPv6配置；
  • on：开启状态；
  • off：关闭状态。

    • 注意：此字段可能返回 null，表示取不到有效值。
    IdentificationStatus String 加速域名归属权验证状态，取值有：
  • pending：待验证；
  • finished：已完成验证。

    • 注意：此字段可能返回 null，表示取不到有效值。
    OwnershipVerification OwnershipVerification 加速域名需进行归属权验证才能继续提供服务时，该对象会携带对应验证方式所需要的信息。
    注意：此字段可能返回 null，表示取不到有效值。
    OriginDetail OriginDetail 源站信息。
    注意：此字段可能返回 null，表示取不到有效值。
    OriginProtocol String 回源协议，取值有：
  • FOLLOW：协议跟随；
  • HTTP：HTTP协议回源；
  • HTTPS：HTTPS协议回源。

    • 注意：此字段可能返回 null，表示取不到有效值。
    HttpOriginPort Integer HTTP 回源端口。
    注意：此字段可能返回 null，表示取不到有效值。
    HttpsOriginPort Integer HTTPS 回源端口。
    注意：此字段可能返回 null，表示取不到有效值。
    Certificate AccelerationDomainCertificate 加速域名证书信息。
    注意：此字段可能返回 null，表示取不到有效值。
    CreatedOn Timestamp ISO8601 创建时间。
    ModifiedOn Timestamp ISO8601 修改时间。

    AccelerationDomainCertificate

    加速域名所对应的证书信息。

    被如下接口引用：DescribeAccelerationDomains。

    名称 类型 必选 描述
    Mode String 否 配置服务端证书的模式，取值有：
    • disable：不配置服务端证书；
    • eofreecert：通过自动验证申请免费证书并部署。验证方式详见：申请免费证书支持的验证方式 - 在 NS 或者 DNSPod 托管接入模式下，仅支持自动验证的方式申请免费证书。 - 当免费证书申请失败时会导致证书部署失败，您可以通过检查免费证书申请结果接口获取申请失败原因。
    • eofreecert_manual：部署 DNS 委派验证或者文件验证申请的免费证书。在部署免费证书前，您需要触发申请免费证书接口申请免费证书。在免费证书申请成功后，你可以通过该枚举值对免费证书进行部署；
      • 注意：在对免费证书部署时，需要保证当前已存在申请成功的免费证书。您可以通过检查免费证书申请结果接口检查当前是否已存在申请成功的免费证书。
    • sslcert：配置 SSL 托管服务端证书。
    List Array of CertificateInfo 否 服务端证书列表，相关证书部署在 EO 的入口侧。
    注意：此字段可能返回 null，表示取不到有效值。
    ClientCertInfo MutualTLS 否 在边缘双向认证场景下，该字段为客户端的 CA 证书，部署在 EO 节点内，用于 EO 节点认证客户端证书。
    UpstreamCertInfo UpstreamCertInfo 否 用于 EO 节点回源时携带的证书，源站启用双向认证握手时使用，用于源站认证客户端证书是否有效，确保请求来源于受信任的 EO 节点。

    AccessURLRedirectParameters

    访问 URL 重定向 配置参数。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    StatusCode Integer 否 状态码，取值为 301、302、303、307、308 之一。
    Protocol String 否 目标请求协议，取值有：
  • http：目标请求协议 HTTP；
  • https：目标请求协议 HTTPS；
  • follow：跟随请求。
    		•
    HostName HostName 否 目标 HostName 。
    注意：此字段可能返回 null，表示取不到有效值。
    URLPath URLPath 否 目标路径。
    注意：此字段可能返回 null，表示取不到有效值。
    QueryString AccessURLRedirectQueryString 否 携带查询参数。
    注意：此字段可能返回 null，表示取不到有效值。

    AccessURLRedirectQueryString

    访问 URL 重定向 配置参数。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    Action String 否 执行动作，取值有：
  • full：全部保留；
  • ignore：全部忽略。
    		•

    AclCondition

    精准防护条件

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    MatchFrom String 是 匹配字段，取值有：
  • host：请求域名；
  • sip：客户端IP；
  • ua：User-Agent；
  • cookie：会话 Cookie；
  • cgi：CGI 脚本；
  • xff：XFF 扩展头部；
  • url：请求 URL；
  • accept：请求内容类型；
  • method：请求方式；
  • header：请求头部；
  • app_proto：应用层协议；
  • sip_proto：网络层协议；
  • uabot：UA 特征规则，仅bot自定义规则可用；
  • idcid：IDC 规则，仅bot自定义规则可用；
  • sipbot：搜索引擎规则，仅bot自定义规则可用；
  • portrait：画像分析，仅bot自定义规则可用；
  • header_seq：请求头顺序，仅bot自定义规则可用；
  • hdr：请求正文，仅Web防护自定义规则可用。
    		•
    MatchParam String 是 匹配字符串。当 MatchFrom 为 header 时，可以填入 header 的 key 作为参数。
    Operator String 是 匹配关系，取值有：
  • equal：字符串等于；
  • not_equal：数值不等于；
  • include：字符包含；
  • not_include：字符不包含；
  • match：ip匹配；
  • not_match：ip不匹配；
  • include_area：地域包含；
  • is_empty：存在字段但值为空；
  • not_exists：不存在关键字段；
  • regexp：正则匹配；
  • len_gt：数值大于；
  • len_lt：数值小于；
  • len_eq：数值等于；
  • match_prefix：前缀匹配；
  • match_suffix：后缀匹配；
  • wildcard：通配符。
    		•
    MatchContent String 是 匹配内容。

    AclConfig

    ACL配置

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    Switch String 是 开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    AclUserRules Array of AclUserRule 是 用户自定义规则。
    Customizes Array of AclUserRule 否 托管定制规则

    AclUserRule

    用户自定义规则

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    RuleName String 是 规则名。
    Action String 是 处罚动作，取值有：
  • trans：放行；
  • drop：拦截；
  • monitor：观察；
  • ban：IP 封禁；
  • redirect：重定向；
  • page：指定页面；
  • alg：JavaScript 挑战。
    		•
    RuleStatus String 是 规则状态，取值有：
  • on：生效；
  • off：失效。
    		•
    AclConditions Array of AclCondition 是 自定义规则。
    RulePriority Integer 是 规则优先级，取值范围0-100。
    RuleID Integer 否 规则 Id。仅出参使用。
    UpdateTime String 否 更新时间。仅出参使用。
    PunishTime Integer 否 ip 封禁的惩罚时间。Action 是 ban 时必填，且不能为空，取值范围0-2天。
    PunishTimeUnit String 否 ip 封禁的惩罚时间单位，取值有：
  • second：秒；
  • minutes：分；
  • hour：小时。
    • 默认为 second。
    Name String 否 自定义返回页面的名称。Action 是 page 时必填，且不能为空。
    PageId Integer 否 自定义返回页面的实例 Id。默认为0，代表使用系统默认拦截页面。该参数已废弃。
    CustomResponseId String 否 自定义响应 Id。该 Id 可通过查询自定义错误页列表接口获取。默认值为default，使用系统默认页面。Action 是 page 时必填，且不能为空。
    ResponseCode Integer 否 自定义返回页面的响应码。Action 是 page 时必填，且不能为空，取值: 100~600，不支持 3xx 响应码。默认值：567。
    RedirectUrl String 否 重定向时候的地址。Action 是 redirect 时必填，且不能为空。

    Action

    规则引擎功能项操作，对于一种功能只对应下面三种类型的其中一种，RuleAction 数组中的每一项只能是其中一个类型，更多功能项的填写规范可调用接口 查询规则引擎的设置参数 查看。

    被如下接口引用：CreateRule, DescribeRules, ModifyRule。

    名称 类型 必选 描述
    NormalAction NormalAction 否 常规功能操作，选择该类型的功能项有：
  • 访问URL 重写（AccessUrlRedirect）；
  • 回源 URL 重写 （UpstreamUrlRedirect）；
  • QUIC（QUIC）；
  • WebSocket （WebSocket）；
  • 视频拖拽（VideoSeek）；
  • Token 鉴权（Authentication）；
  • 自定义CacheKey（CacheKey）；
  • 节点缓存 TTL （Cache）；
  • 浏览器缓存 TTL（MaxAge）；
  • 离线缓存（OfflineCache）；
  • 智能加速（SmartRouting）；
  • 分片回源（RangeOriginPull）；
  • HTTP/2 回源（UpstreamHttp2）；
  • Host Header 重写（HostHeader）；
  • 强制 HTTPS（ForceRedirect）；
  • 回源 HTTPS（OriginPullProtocol）；
  • 单连接下载限速（ResponseSpeedLimit）；
  • 缓存预刷新（CachePrefresh）；
  • 智能压缩（Compression）；
  • Hsts；
  • ClientIpHeader；
  • SslTlsSecureConf；
  • OcspStapling；
  • HTTP/2 访问（Http2）；
  • 回源跟随重定向(UpstreamFollowRedirect)；
  • 修改源站(Origin)。
  • 七层回源超时(HTTPUpstreamTimeout)。
  • Http应答（HttpResponse）。

    • 注意：此字段可能返回 null，表示取不到有效值。
    RewriteAction RewriteAction 否 带有请求头/响应头的功能操作，选择该类型的功能项有：
  • 修改 HTTP 请求头（RequestHeader）；
  • 修改HTTP响应头（ResponseHeader）。

    • 注意：此字段可能返回 null，表示取不到有效值。
    CodeAction CodeAction 否 带有状态码的功能操作，选择该类型的功能项有：
  • 自定义错误页面（ErrorPage）；
  • 状态码缓存 TTL（StatusCodeCache）。

    • 注意：此字段可能返回 null，表示取不到有效值。

    AdaptiveFrequencyControl

    自适应频控

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    Enabled String 是 自适应频控是否开启。取值有：
  • on：开启；
  • off：关闭。
    		•
    Sensitivity String 否 自适应频控的限制等级，当 Enabled 为 on 时，此字段必填。取值有：
  • Loose：宽松；
  • Moderate：适中；
  • Strict：严格。
    		•
    Action SecurityAction 否 自适应频控的处置方式，当 Enabled 为 on 时，此字段必填。SecurityAction 的 Name 取值支持：
  • Monitor：观察；
  • Deny：拦截；
  • Challenge：挑战，其中ChallengeActionParameters.Name仅支持JSChallenge。
    		•

    Addresses

    IP 网段详情。

    被如下接口引用：DescribeMultiPathGatewayOriginACL, DescribeOriginACL。

    名称 类型 必选 描述
    IPv4 Array of String 否 IPv4 网段列表。
    IPv6 Array of String 否 IPv6 网段列表。

    AdvancedFilter

    描述键值对过滤器，用于条件过滤查询，支持模糊查询。例如过滤ID、名称、状态等。
    若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。
    若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。

    被如下接口引用：DescribeAccelerationDomains, DescribeAliasDomains, DescribeConfigGroupVersions, DescribeContentIdentifiers, DescribeCustomErrorPages, DescribeDeployHistory, DescribeDnsRecords, DescribeOriginGroup, DescribePrefetchTasks, DescribePurgeTasks, DescribeRealtimeLogDeliveryTasks, DescribeZones。

    名称 类型 必选 描述
    Name String 是 需要过滤的字段。
    Values Array of String 是 字段的过滤值。
    Fuzzy Boolean 否 是否启用模糊查询。

    AiRule

    AI规则引擎防护

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    Mode String 是 AI规则引擎状态，取值有：
  • smart_status_close：关闭；
  • smart_status_open：拦截处置；
  • smart_status_observe：观察处置。
    		•

    AlgDetectJS

    Bot主动特征识别客户端行为校验。

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    Name String 否 操作名称。
    WorkLevel String 否 工作量证明 (proof_Of-Work)校验强度，默认low，取值有：
  • low：低；
  • middle：中；
  • high：高。
    		•
    ExecuteMode Integer 否 执行方式，js延迟执行的时间。单位为ms，默认500，取值：0～1000。
    InvalidStatTime Integer 否 客户端末启用JS（末完成检测）统计周期。单位为秒，默认10，取值：5～3600。
    InvalidThreshold Integer 否 客户端末启用JS（末完成检测）触发阈值。单位为次，默认300，取值：1～100000000。
    AlgDetectResults Array of AlgDetectResult 否 Bot主动特征识别客户端行为校验结果。

    AlgDetectResult

    Bot主动特征识别校验结果。

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    Result String 否 校验结果，取值有：
  • invalid：不合法Cookie；
  • cookie_empty：末携带Cookie或Cookie己过期；
  • js_empty：客户端末启用JS（末完成检测）；
  • low：会话速率和周期特征校验低风险；
  • middle：会话速率和周期特征校验中风险；
  • high：会话速率和周期特征校验高风险；
  • timeout：检测超时时长；
  • not_browser：不合法浏览器；
  • is_bot：Bot客户端。
    		•
    Action String 否 处罚动作，取值有：
  • drop：拦截；
  • monitor：观察；
  • silence：静默；
  • shortdelay：（短时间）等待后响应；
  • longdelay：（长时间）等待后响应。
    		•

    AlgDetectRule

    Bot主动特征识别规则。

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    RuleID Integer 否 规则id。
    RuleName String 否 规则名。
    Switch String 否 规则开关。
    AlgConditions Array of AclCondition 否 自定义规则。
    AlgDetectSession AlgDetectSession 否 Cookie校验和会话行为分析。
    AlgDetectJS Array of AlgDetectJS 否 客户端行为校验。
    UpdateTime String 否 更新时间。仅出参使用。

    AlgDetectSession

    Cookie校验与会话跟踪。

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    Name String 否 操作名称。
    DetectMode String 否 校验方式，默认update_detect，取值有：
  • detect：仅校验；
  • update_detect：更新Cookie并校验。
    		•
    SessionAnalyzeSwitch String 否 会话速率和周期特征校验开关，默认off，取值有：
  • off：关闭；
  • on：打开。
    		•
    InvalidStatTime Integer 否 校验结果为未携带Cookie或Cookie已过期的统计周期。单位为秒，默认10，取值：5～3600。
    InvalidThreshold Integer 否 校验结果为未携带Cookie或Cookie已过期的触发阈值。单位为次，默认300，取值：1～100000000。
    AlgDetectResults Array of AlgDetectResult 否 Cookie校验校验结果。
    SessionBehaviors Array of AlgDetectResult 否 会话速率和周期特征校验结果。

    AliasDomain

    别称域名信息。

    被如下接口引用：DescribeAliasDomains。

    名称 类型 描述
    AliasName String 别称域名名称。
    ZoneId String 站点 ID。
    TargetName String 目标域名名称。
    Status String 别称域名状态，取值有：
  • active：已生效；
  • pending：部署中；
  • conflict：被找回。
  • stop：已停用；
    		•
    ForbidMode Integer 封禁模式，取值有：
  • 0：未封禁；
  • 11：合规封禁；
  • 14：未备案封禁。
    		•
    CreatedOn Timestamp ISO8601 别称域名创建时间。
    ModifiedOn Timestamp ISO8601 别称域名修改时间。

    AllowActionParameters

    Web 安全 Allow 的附加参数

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    MinDelayTime String 否 最小延迟响应时间，当配置为 0s 时，表示不延迟直接响应。支持的单位有：
  • s：秒，取值范围 0～5。
    		•
    MaxDelayTime String 否 最大延迟响应时间，支持的单位有：
  • s：秒，取值范围 5～10。
    		•

    ApplicationProxy

    应用代理实例

    被如下接口引用：DescribeApplicationProxies。

    名称 类型 描述
    ZoneId String 站点ID。
    ZoneName String 站点名称。
    ProxyId String 代理ID。
    ProxyName String 当ProxyType=hostname时，表示域名或子域名；
    当ProxyType=instance时，表示代理名称。
    ProxyType String 四层代理模式，取值有：
  • hostname：表示子域名模式；
  • instance：表示实例模式。
    		•
    PlatType String 调度模式，取值有：
  • ip：表示Anycast IP调度；
  • domain：表示CNAME调度。
    		•
    Area String 加速区域，取值有：
  • mainland：中国大陆境内;
  • overseas：全球（不含中国大陆）。

    • 默认值：overseas
    SecurityType Integer 是否开启安全，取值有：
  • 0：关闭安全；
  • 1：开启安全。
    		•
    AccelerateType Integer 是否开启加速，取值有：
  • 0：关闭加速；
  • 1：开启加速。
    		•
    SessionPersistTime Integer 会话保持时间。
    Status String 状态，取值有：
  • online：启用；
  • offline：停用；
  • progress：部署中；
  • stopping：停用中；
  • fail：部署失败/停用失败。
    		•
    BanStatus String 封禁状态，取值有：
  • banned：已封禁;
  • banning：封禁中；
  • recover：已解封；
  • recovering：解封禁中。
    		•
    ScheduleValue Array of String 调度信息。
    HostId String 当ProxyType=hostname时：
    表示代理加速唯一标识。
    Ipv6 Ipv6 Ipv6访问配置。
    UpdateTime Timestamp ISO8601 更新时间。
    ApplicationProxyRules Array of ApplicationProxyRule 规则列表。
    AccelerateMainland AccelerateMainland 中国大陆加速优化配置。

    ApplicationProxyRule

    应用代理规则

    被如下接口引用：CreateApplicationProxy, DescribeApplicationProxies。

    名称 类型 必选 描述
    Proto String 是 协议，取值有：
  • TCP：TCP协议；
  • UDP：UDP协议。
    		•
    Port Array of String 是 端口，支持格式：
  • 单个端口，如：80。
  • 端口段，如：81-82。表示81，82两个端口。

    • 注意：一条规则最多可填写20个端口。
    OriginType String 是 源站类型，取值有：
  • custom：手动添加；
  • loadbalancer：负载均衡；
  • origins：源站组。
    		•
    OriginValue Array of String 是 源站信息：
  • 当 OriginType 为 custom 时，表示一个或多个源站，如["8.8.8.8","9.9.9.9"] 或 OriginValue=["test.com"]；
  • 当 OriginType 为 loadbalancer 时，表示一个负载均衡，如["lb-xdffsfasdfs"]；
  • 当 OriginType 为 origins 时，要求有且仅有一个元素，表示源站组ID，如["origin-537f5b41-162a-11ed-abaa-525400c5da15"]。
    		•
    RuleId String 否 规则ID。
    Status String 否 状态，取值有：
  • online：启用；
  • offline：停用；
  • progress：部署中；
  • stopping：停用中；
  • fail：部署失败/停用失败。
    		•
    ForwardClientIp String 否 传递客户端IP，取值有：
  • TOA：TOA（仅Proto=TCP时可选）；
  • PPV1：Proxy Protocol传递，协议版本V1（仅Proto=TCP时可选）；
  • PPV2：Proxy Protocol传递，协议版本V2；
  • OFF：不传递。
    • 默认值：OFF。
    SessionPersist Boolean 否 是否开启会话保持，取值有：
  • true：开启；
  • false：关闭。
    • 默认值：false。
    SessionPersistTime Integer 否 会话保持的时间，只有当SessionPersist为true时，该值才会生效。
    OriginPort String 否 源站端口，支持格式：
  • 单端口，如：80。
  • 端口段：81-82，表示81，82两个端口。
    		•
    RuleTag String 否 规则标签。

    AscriptionInfo

    站点归属信息

    被如下接口引用：DescribeIdentifications, IdentifyZone。

    名称 类型 描述
    Subdomain String 主机记录。
    RecordType String 记录类型。
    RecordValue String 记录值。

    AudioTemplateInfo

    音频流配置参数。

    被如下接口引用：CreateJustInTimeTranscodeTemplate, DescribeJustInTimeTranscodeTemplates。

    名称 类型 必选 描述
    Codec String 是 音频流的编码格式。可选值为：
  • libfdk_aac。
    		•
    AudioChannel Integer 否 音频通道数，可选值：
  • 2：双通道。
    • 默认值：2。

    AuthenticationParameters

    Token 鉴权 配置参数。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    AuthType String 否 鉴权类型。取值有：

  • TypeA：鉴权方式 A 类型，具体含义请参考 鉴权方式 A；
  • TypeB：鉴权方式 B 类型，具体含义请参考 鉴权方式 B；
  • TypeC：鉴权方式 C 类型，具体含义请参考 鉴权方式 C；
  • TypeD：鉴权方式 D 类型，具体含义请参考 鉴权方式 D；
  • TypeVOD：鉴权方式 V 类型，具体含义请参考 鉴权方式 V。
    		•
    SecretKey String 否 主鉴权密钥，由 6～40 位大小写英文字母或数字组成，不能包含 " 和 $。
    Timeout Integer 否 鉴权 URL 的有效时长，单位为秒，取值：1～630720000。用于判断客户端访问请求是否过期：
  • 若当前时间超过 “timestamp + 有效时长” 时间，则为过期请求，直接返回 403。
  • 若当前时间未超过 “timestamp + 有效时长” 时间，则请求未过期，继续校验 md5 字符串。
    • 注意：当 AuthType 为 TypeA、TypeB、TypeC、TypeD 之一时，此字段必填。
    BackupSecretKey String 否 备鉴权密钥，由 6～40 位大小写英文字母或数字组成，不能包含 " 和 $。
    AuthParam String 否 鉴权参数名称，节点将校验此参数名对应的值。由 1～100 位大小写字母、数字或下划线组成。
    注意：当 AuthType 为 TypeA、TypeD 之一时，此字段必填。
    TimeParam String 否 鉴权时间戳，和 AuthParam 字段的值不能相同。
    注意：当 AuthType 为 TypeD 时，此字段必填。
    TimeFormat String 否 鉴权时间格式，取值有：
  • dec：十进制；
  • hex：十六进制。
    • 注意：当 AuthType 为 TypeD 时，此字段必填。默认为 hex。

    BandwidthAbuseDefense

    流量防盗刷（仅适用中国大陆地区）的具体配置。

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    Enabled String 是 流量防盗刷（仅适用中国大陆地区）是否开启。取值有：
  • on：开启；
  • off：关闭。
    		•
    Action SecurityAction 否 流量防盗刷（仅适用中国大陆地区）的处置方式，当 Enabled 为 on 时，此字段必填。SecurityAction 的 Name 取值支持：
  • Monitor：观察；
  • Deny：拦截；
  • Challenge：挑战，其中ChallengeActionParameters.Name仅支持JSChallenge。
    		•

    BasicBotSettings

    Bot 管理的基础配置，对策略关联的所有域名生效。可以通过 CustomRules 进行精细化定制。

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    SourceIDC SourceIDC 否 客户端 IP 的来源 IDC 配置，用于处置来自 IDC（数据中心） 的客户端 IP 的访问请求。此类来源请求不是由移动端或浏览器端直接访问。
    SearchEngineBots SearchEngineBots 否 搜索引擎爬虫配置，用于处置来自搜索引擎爬虫的请求。此类请求的 IP、User-Agent 或 rDNS 结果匹配已知搜索引擎爬虫。
    KnownBotCategories KnownBotCategories 否 商业或开源工具 UA 特征配置（原 UA 特征规则），用于处置来自已知商业工具或开源工具的访问请求。此类请求的 User-Agent 头部符合已知商业或开源工具特征。
    IPReputation IPReputation 否 IP 威胁情报库（原客户端画像分析）配置，用于处置近期访问行为具有特定风险特征的客户端 IP。
    BotIntelligence BotIntelligence 否 Bot 智能分析的具体配置。

    BillingData

    计费数据项。

    被如下接口引用：DescribeBillingData。

    名称 类型 描述
    Time Timestamp ISO8601 数据时间戳。
    Value Integer 数值。
    ZoneId String 数据点所属站点 ID。若使用内容标识符功能，则该项值为内容标识符。
    Host String 数据点所属域名。
    ProxyId String 数据点所属四层代理实例 ID。
    RegionId String 数据点所属计费大区 ID。计费大区以实际服务用户客户端的 EdgeOne 节点所在区域为准。取值有：
  • CH：中国大陆境内
  • AF：非洲
  • AS1：亚太一区
  • AS2：亚太二区
  • AS3：亚太三区
  • EU：欧洲
  • MidEast：中东
  • NA：北美
  • SA：南美
    		•

    BillingDataFilter

    计费数据过滤条件。

    被如下接口引用：DescribeBillingData。

    名称 类型 必选 描述
    Type String 是 参数名称。
    Value String 是 参数值。

    BindDomainInfo

    策略模板绑定的域名信息

    被如下接口引用：DescribeWebSecurityTemplates。

    名称 类型 描述
    Domain String 域名。
    ZoneId String 域名所属的站点 ID。
    Status String 绑定状态，取值有:
  • process：绑定中；
  • online：绑定成功；
  • fail：绑定失败。
    		•

    BindSharedCNAMEMap

    共享 CNAME 和接入域名的绑定关系

    被如下接口引用：BindSharedCNAME。

    名称 类型 必选 描述
    SharedCNAME String 是 需要绑定或解绑的共享 CNAME。
    DomainNames Array of String 是 加速域名，可传递多个，最多20个。

    BlockIPActionParameters

    Web安全IP封禁的附加参数

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    Duration String 是 封禁 IP 的惩罚时长。支持的单位有：
  • s：秒，取值范围1～120；
  • m：分，取值范围1～120；
  • h：小时，取值范围1～48。
    		•

    BotConfig

    安全Bot配置

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    Switch String 是 bot开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    BotManagedRule BotManagedRule 否 通用详细基础规则。如果为null，默认使用历史配置。
    BotPortraitRule BotPortraitRule 否 用户画像规则。如果为null，默认使用历史配置。
    IntelligenceRule IntelligenceRule 否 Bot智能分析。如果为null，默认使用历史配置。
    BotUserRules Array of BotUserRule 否 Bot自定义规则。如果为null，默认使用历史配置。
    AlgDetectRule Array of AlgDetectRule 否 Bot主动特征识别规则。
    Customizes Array of BotUserRule 否 Bot托管定制策略，入参可不填，仅出参使用。

    BotExtendAction

    Bot扩展处置方式，多处置动作组合。

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    Action String 是 处置动作，取值有：
  • monitor：观察；
  • alg：JavaScript挑战；
  • captcha：托管挑战；
  • random：随机，按照ExtendActions分配处置动作和比例；
  • silence：静默；
  • shortdelay：短时响应；
  • longdelay：长时响应。
    		•
    Percent Integer 否 处置方式的触发概率，范围0-100。

    BotIntelligence

    Bot 智能分析的具体配置。

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    BotRatings BotRatings 否 基于客户端和请求特征，将请求来源分为人类来源请求、合法 Bot 请求、疑似 Bot 请求和高风险 Bot 请求，并提供请求处置选项。
    Enabled String 否 Bot 智能分析的具体配置开关。取值有：

    on：开启；
    off：关闭。

    BotManagedRule

    Bot 规则，下列规则ID可参考接口 DescribeBotManagedRules返回的ID信息

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    Action String 是 触发规则后的处置方式，取值有：
  • drop：拦截；
  • trans：放行；
  • alg：Javascript挑战；
  • monitor：观察。
    		•
    RuleID Integer 否 本规则的ID。仅出参使用。
    TransManagedIds Array of Integer 否 放行的规则ID。默认所有规则不配置放行。
    AlgManagedIds Array of Integer 否 JS挑战的规则ID。默认所有规则不配置JS挑战。
    CapManagedIds Array of Integer 否 数字验证码的规则ID。默认所有规则不配置数字验证码。
    MonManagedIds Array of Integer 否 观察的规则ID。默认所有规则不配置观察。
    DropManagedIds Array of Integer 否 拦截的规则ID。默认所有规则不配置拦截。

    BotManagement

    Web 安全的 BOT 规则结构。

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    Enabled String 否 Bot 管理是否开启。取值有：
  • on：开启；
  • off：关闭。
    		•
    CustomRules BotManagementCustomRules 否 Bot 管理的自定义规则，组合各类爬虫和请求行为特征，精准定义 Bot 并配置定制化处置方式。
    BasicBotSettings BasicBotSettings 否 Bot 管理的基础配置，对策略关联的所有域名生效。可以通过 CustomRules 进行精细化定制。
    ClientAttestationRules ClientAttestationRules 否 客户端认证规则的定义列表。该功能内测中，如需使用，请提工单。
    BrowserImpersonationDetection BrowserImpersonationDetection 否 配置浏览器伪造识别规则（原主动特征识别规则）。设置注入 JavaScript 的响应页面范围，浏览器校验选项，以及对非浏览器客户端的处置方式。

    BotManagementActionOverrides

    Bot 规则项的具体配置，用于覆盖上层的默认配置。

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    Ids Array of String 否 Bot 规则组下的具体项，用于改写此单条规则项配置的内容，Ids 所对应的具体信息请参考 DescribeBotManagedRules 接口返回的信息。
    Action SecurityAction 否 Ids 中指定 Bot 规则项的处置动作。 SecurityAction 的 Name 取值支持：
  • Deny：拦截；
  • Monitor：观察；
  • Disabled：未启用，不启用指定规则；
  • Challenge：挑战，其中 ChallengeActionParameters 中的 ChallengeOption 支持 JSChallenge 和 ManagedChallenge；
  • Allow：放行（仅限Bot基础特征管理）。

    		•

    BotManagementCustomRule

    Web 安全的 Bot 自定义规则。

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    Id String 否 Bot 自定义规则的 ID。
    通过规则 ID 可支持不同的规则配置操作：
  • 增加新规则：ID 为空或不指定 ID 参数；
  • 修改已有规则：指定需要更新/修改的规则 ID；
  • 删除已有规则：BotManagementCustomRules 参数中，Rules 列表中未包含的已有规则将被删除。
    		•
    Name String 否 Bot 自定义规则的名称。
    Enabled String 否 Bot 自定义规则是否开启。取值有：
  • on：开启；
  • off：关闭。
    		•
    Priority Integer 否 Bot 自定义规则的优先级，范围是 1 ~ 100，默认为 50。
    Condition String 否 Bot 自定义规则的具体内容，需符合表达式语法，详细规范参见产品文档。
    Action Array of SecurityWeightedAction 否 Bot 自定义规则的处置方式。取值有：
  • Monitor：观察；
  • Deny：拦截，其中 DenyActionParameters.Name 支持 Deny 和 ReturnCustomPage；
  • Challenge：挑战，其中 ChallengeActionParameters.Name 支持 JSChallenge 和 ManagedChallenge；
  • Redirect：重定向至 URL。
    		•

    BotManagementCustomRules

    Bot 自定义规则的配置。

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    Rules Array of BotManagementCustomRule 否 Bot 自定义规则的列表。使用 ModifySecurityPolicy 修改 Web 防护配置时：
  • 若未指定 SecurityPolicy.BotManagement.CustomRules 中的 Rules 参数，或 Rules 参数长度为零：清空所有 Bot 自定义规则配置。
  • 若 SecurityPolicy.BotManagement 参数中，未指定 CustomRules 参数值：保持已有 Bot 自定义规则配置，不做修改。
    		•

    BotPortraitRule

    bot 用户画像规则

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    Switch String 是 本功能的开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    RuleID Integer 否 本规则的ID。仅出参使用。
    AlgManagedIds Array of Integer 否 JS挑战的规则ID。默认所有规则不配置JS挑战。
    CapManagedIds Array of Integer 否 数字验证码的规则ID。默认所有规则不配置数字验证码。
    MonManagedIds Array of Integer 否 观察的规则ID。默认所有规则不配置观察。
    DropManagedIds Array of Integer 否 拦截的规则ID。默认所有规则不配置拦截。

    BotRatings

    基于客户端和请求特征，将请求来源分为人类来源请求、合法 Bot 请求、疑似 Bot 请求和高风险 Bot 请求，并提供请求处置选项。

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    HighRiskBotRequestsAction SecurityAction 否 恶意 Bot 请求的执行动作。 SecurityAction 的 Name 取值支持：
  • Deny：拦截；
  • Monitor：观察；
  • Allow：放行；
  • Challenge：挑战，其中 ChallengeActionParameters 中的 ChallengeOption 支持 JSChallenge 和 ManagedChallenge。
    		•
    LikelyBotRequestsAction SecurityAction 否 疑似 Bot 请求的执行动作。 SecurityAction 的 Name 取值支持：
  • Deny：拦截；
  • Monitor：观察；
  • Allow：放行；
  • Challenge：挑战，其中 ChallengeActionParameters 中的 ChallengeOption 支持 JSChallenge 和 ManagedChallenge。
    		•
    VerifiedBotRequestsAction SecurityAction 否 友好 Bot 请求的执行动作。 SecurityAction 的 Name 取值支持：
  • Deny：拦截；
  • Monitor：观察；
  • Allow：放行；
  • Challenge：挑战，其中 ChallengeActionParameters 中的 ChallengeOption 支持 JSChallenge 和 ManagedChallenge。
    		•
    HumanRequestsAction SecurityAction 否 正常 Bot 请求的执行动作。 SecurityAction 的 Name 取值支持：
  • Allow：放行。
    		•

    BotSessionValidation

    Cookie 校验和会话跟踪行为具体配置。

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    IssueNewBotSessionCookie String 否 是否更新 Cookie 并校验。取值有：
  • on：更新 Cookie 并校验；
  • off：仅校验。
    		•
    MaxNewSessionTriggerConfig MaxNewSessionTriggerConfig 否 更新 Cookie 并校验时的触发阈值，仅当 IssueNewBotSessionCookie 为 on 时有效。
    SessionExpiredAction SecurityAction 否 未携带 Cookie 或 Cookie 已过期的执行动作。 SecurityAction 的 Name 取值支持：
  • Deny：拦截，其中 DenyActionParameters 中支持 Stall 配置；
  • Monitor：观察；
  • Allow：等待后响应，其中 AllowActionParameters 需要 MinDelayTime 和 MaxDelayTime 配置。
    		•
    SessionInvalidAction SecurityAction 否 不合法 Cookie 的执行动作。 SecurityAction 的 Name 取值支持：
  • Deny：拦截，其中 DenyActionParameters 中支持 Stall 配置；
  • Monitor：观察；
  • Allow：等待后响应，其中 AllowActionParameters 需要 MinDelayTime 和 MaxDelayTime 配置。
    		•
    SessionRateControl SessionRateControl 否 会话速率和周期特征校验的具体配置。

    BotUserRule

    Bot自定义规则

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    RuleName String 是 规则名，只能以英文字符，数字，下划线组合，且不能以下划线开头。
    Action String 是 处置动作，取值有：
  • drop：拦截；
  • monitor：观察；
  • trans：放行；
  • redirect：重定向；
  • page：指定页面；
  • alg：JavaScript 挑战；
  • captcha：托管挑战；
  • random：随机处置；
  • silence：静默；
  • shortdelay：短时响应；
  • longdelay：长时响应。
    		•
    RuleStatus String 是 规则状态，取值有：
  • on：生效；
  • off：不生效。
    • 默认 on 生效。
    AclConditions Array of AclCondition 是 规则详情。
    RulePriority Integer 是 规则权重，取值范围0-100。
    RuleID Integer 否 规则 Id。仅出参使用。
    ExtendActions Array of BotExtendAction 否 随机处置的处置方式及占比，非随机处置可不填暂不支持。
    FreqFields Array of String 否 过滤词，取值有：
  • sip：客户端 ip。

    • 默认为空字符串。
    UpdateTime String 否 更新时间。仅出参使用。
    FreqScope Array of String 否 统计范围。取值有：
  • source_to_eo：（响应）源站到 EdgeOne；
  • client_to_eo：（请求）客户端到 EdgeOne。

    • 默认为 source_to_eo。
    Name String 否 自定义返回页面的名称。Action 是 page 时必填，且不能为空。
    CustomResponseId String 否 自定义响应 Id。该 Id 可通过查询自定义错误页列表接口获取。默认值为default，使用系统默认页面。Action 是 page 时必填，且不能为空。
    ResponseCode Integer 否 自定义返回页面的响应码。Action 是 page 时必填，且不能为空，取值: 100~600，不支持 3xx 响应码。默认值：567。
    RedirectUrl String 否 重定向时候的地址。Action 是 redirect 时必填，且不能为空。

    BrowserImpersonationDetection

    浏览器伪造识别规则（原主动特征识别规则）的配置。

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    Rules Array of BrowserImpersonationDetectionRule 否 浏览器伪造识别规则的列表。使用 ModifySecurityPolicy 修改 Web 防护配置时：
  • 若未指定 SecurityPolicy.BotManagement.BrowserImpersonationDetection 中的 Rules 参数，或 Rules 参数长度为零： 清空所有浏览器伪造识别规则配置。
  • 若 SecurityPolicy.BotManagement 参数中，未指定 BrowserImpersonationDetection 参数值： 保持已有浏览器伪造识别规则配置，不做修改。
    		•

    BrowserImpersonationDetectionAction

    Bot 浏览器校验规则（原主动特征识别规则）的 Action。

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    BotSessionValidation BotSessionValidation 否 Cookie 校验和会话跟踪配置。
    ClientBehaviorDetection ClientBehaviorDetection 否 客户端行为校验配置。

    BrowserImpersonationDetectionRule

    浏览器伪造识别规则（原主动特征识别规则）。

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    Id String 否 浏览器伪造识别规则的 ID。
    通过规则 ID 可支持不同的规则配置操作：
  • 增加新规则：ID 为空或不指定 ID 参数；
  • 修改已有规则：指定需要更新/修改的规则 ID；
  • 删除已有规则：BrowserImpersonationDetection 参数中，Rules 列表中未包含的已有规则将被删除。
    		•
    Name String 否 浏览器伪造识别规则的名称。
    Enabled String 否 浏览器伪造识别规则是否开启。取值有：
  • on：开启；
  • off：关闭。
    		•
    Condition String 否 浏览器伪造识别规则的具体内容，其中仅支持请求方式（Method）、请求路径（Path）和请求 URL 的配置，需符合表达式语法，详细规范参见产品文档。
    Action BrowserImpersonationDetectionAction 否 浏览器伪造识别规则的处置方式，包括 Cookie 校验和会话跟踪配置以及客户端行为校验配置。

    CC

    cc配置项。

    被如下接口引用：DescribeHostsSetting。

    名称 类型 必选 描述
    Switch String 是 Waf开关，取值为：
  • on：开启；
  • off：关闭。
    		•
    PolicyId Integer 否 策略ID。

    CLSTopic

    实时日志投递到腾讯云 CLS 的配置信息。

    被如下接口引用：CreateRealtimeLogDeliveryTask, DescribeRealtimeLogDeliveryTasks。

    名称 类型 必选 描述
    LogSetId String 是 腾讯云 CLS 日志集 ID。
    TopicId String 是 腾讯云 CLS 日志主题 ID。
    LogSetRegion String 是 腾讯云 CLS 日志集所在的地域。

    CNAMEDetail

    CNAME 接入类型站点参数详情。

    被如下接口引用：DescribeZones。

    名称 类型 描述
    IsFake Integer 是否伪站点，取值有：
  • 0：非伪站点；
  • 1：伪站点。

    		•
    OwnershipVerification OwnershipVerification 归属权验证信息。详情请参考 站点/域名归属权验证 。

    Cache

    缓存时间设置

    被如下接口引用：DescribeHostsSetting, ModifyZoneSetting。

    名称 类型 必选 描述
    Switch String 是 缓存配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    CacheTime Integer 否 缓存过期时间设置。
    单位为秒，最大可设置为 365 天。

    CacheConfig

    缓存规则配置。

    被如下接口引用：DescribeHostsSetting, DescribeZoneSetting, ModifyZoneSetting。

    名称 类型 必选 描述
    Cache Cache 否 缓存配置。
    注意：此字段可能返回 null，表示取不到有效值。
    NoCache NoCache 否 不缓存配置。
    注意：此字段可能返回 null，表示取不到有效值。
    FollowOrigin FollowOrigin 否 遵循源站配置。
    注意：此字段可能返回 null，表示取不到有效值。

    CacheConfigCustomTime

    节点缓存 TTL 自定义缓存时间配置参数。

    被如下接口引用：DescribeL7AccSetting, ModifyL7AccSetting。

    名称 类型 必选 描述
    Switch String 否 自定义缓存时间开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    CacheTime Integer 否 自定义缓存时间数值，单位为秒，取值：0-315360000。
    注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。

    CacheConfigParameters

    节点缓存 TTL 配置参数。

    被如下接口引用：DescribeL7AccSetting, ModifyL7AccSetting。

    名称 类型 必选 描述
    FollowOrigin FollowOrigin 否 遵循源站缓存配置。FollowOrigin、NoCache、CustomTime 最多只能配置一个 Switch 为 on。
    注意：此字段可能返回 null，表示取不到有效值。
    NoCache NoCache 否 不缓存配置。FollowOrigin、NoCache、CustomTime 最多只能配置一个 Switch 为 on。
    注意：此字段可能返回 null，表示取不到有效值。
    CustomTime CacheConfigCustomTime 否 自定义缓存时间配置。FollowOrigin、NoCache、CustomTime 最多只能配置一个 Switch 为 on。
    注意：此字段可能返回 null，表示取不到有效值。

    CacheKey

    缓存键配置。

    被如下接口引用：DescribeHostsSetting, DescribeZoneSetting, ModifyZoneSetting。

    名称 类型 必选 描述
    FullUrlCache String 否 是否开启全路径缓存，取值有：
  • on：开启全路径缓存（即关闭参数忽略）；
  • off：关闭全路径缓存（即开启参数忽略）。
    		•
    IgnoreCase String 否 是否忽略大小写缓存，取值有：
  • on：忽略；
  • off：不忽略。
    		•
    QueryString QueryString 否 CacheKey 中包含请求参数。
    注意：此字段可能返回 null，表示取不到有效值。

    CacheKeyConfigParameters

    缓存键配置。

    被如下接口引用：DescribeL7AccSetting, ModifyL7AccSetting。

    名称 类型 必选 描述
    FullURLCache String 否 是否开启全路径缓存，取值有：
  • on：开启全路径缓存（即关闭参数忽略）；
  • off：关闭全路径缓存（即开启参数忽略）。
    		•
    IgnoreCase String 否 是否忽略大小写缓存，取值有：
  • on：忽略；
  • off：不忽略。
    		•
    QueryString CacheKeyQueryString 否 查询字符串保留配置参数。此字段和 FullURLCache 必须同时设置，但不能同为 on。

    CacheKeyCookie

    自定义 Cache Key Cookie 配置参数。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    Switch String 否 功能开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    Action String 否 缓存动作，取值有：
  • full：全部保留；
  • ignore：全部忽略；
  • includeCustom：保留指定参数；
  • excludeCustom：忽略指定参数。
    • 注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。
    Values Array of String 否 自定义 Cache Key Cookie 名称列表。
    注意：当 Action 为 includeCustom 或 excludeCustom 时，此字段必填；当 Action 为 full 或 ignore 时，无需填写此字段，若填写则不生效。

    CacheKeyHeader

    自定义 Cache Key HTTP 请求头配置参数。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    Switch String 否 功能开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    Values Array of String 否 自定义 Cache Key HTTP 请求头列表。
    注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。

    CacheKeyParameters

    自定义 Cache Key 配置参数。该配置参数的 FullURLCache 和 QueryString 采用组合表达，具体示例可以参考：

    • 查询字符串全部保留。开启忽略大小写。
      {
  "CacheKey": {
    "FullURLCache": "on",
    "QueryString": {
      "Switch": "off"
    },
    "IgnoreCase": "on"
  }
}
    • 查询字符串全部忽略。开启忽略大小写。
      {
  "CacheKey": {
    "FullURLCache": "off",
    "QueryString": {
      "Switch": "off"
    },
    "IgnoreCase": "on"
  }
}
    • 查询字符串保留指定参数。关闭忽略大小写。
      {
  "CacheKey": {
    "FullURLCache": "off",
    "QueryString": {
        "Switch": "on",
        "Action": "includeCustom",
        "Values": ["name1","name2","name3"]
    },
    "IgnoreCase": "off"
  }
}
    • 查询字符串忽略指定参数。关闭忽略大小写。
      {
  "CacheKey": {
    "FullURLCache": "off",
    "QueryString": {
        "Switch": "on",
        "Action": "excludeCustom",
        "Values": ["name1","name2","name3"]
    },
    "IgnoreCase": "off"
  }
}

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    FullURLCache String 否 查询字符串全部保留开关，取值有：
  • on：开启；
  • off：关闭。
    • 注意：FullURLCache、IgnoreCase、Header、Scheme、Cookie 至少设置一个配置。此字段和 QueryString.Switch 必须同时设置，但不能同为 on。
    QueryString CacheKeyQueryString 否 查询字符串保留配置参数。此字段和 FullURLCache 必须同时设置，但不能同为 on。
    注意：此字段可能返回 null，表示取不到有效值。
    IgnoreCase String 否 忽略大小写开关，取值有：
  • on：开启；
  • off：关闭。
    • 注意：FullURLCache、IgnoreCase、Header、Scheme、Cookie 至少设置一个配置。
    Header CacheKeyHeader 否 HTTP 请求头配置参数。FullURLCache、IgnoreCase、Header、Scheme、Cookie 至少设置一个配置。
    注意：此字段可能返回 null，表示取不到有效值。
    Scheme String 否 请求协议开关，取值有：
  • on：开启；
  • off：关闭。
    • 注意：FullURLCache、IgnoreCase、Header、Scheme、Cookie 至少设置一个配置。
    Cookie CacheKeyCookie 否 Cookie 配置参数。FullURLCache、IgnoreCase、Header、Scheme、Cookie 至少设置一个配置。
    注意：此字段可能返回 null，表示取不到有效值。

    CacheKeyQueryString

    自定义 Cache Key 查询字符串配置参数。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting。

    名称 类型 必选 描述
    Switch String 否 查询字符串保留/忽略指定参数开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    Action String 否 查询字符串保留/忽略指定参数动作。取值有：
  • includeCustom：表示保留部分参数；
  • excludeCustom：表示忽略部分参数。
    • 注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。
    Values Array of String 否 查询字符串中需保留/忽略的参数名列表。
    注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。

    CacheParameters

    节点缓存 TTL 配置参数。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    FollowOrigin FollowOrigin 否 缓存遵循源站。不填表示不设置该配置，FollowOrigin、NoCache、CustomTime 最多只能配置一个 Switch 为 on。
    注意：此字段可能返回 null，表示取不到有效值。
    NoCache NoCache 否 不缓存。不填表示不设置该配置，FollowOrigin、NoCache、CustomTime 最多只能配置一个 Switch 为 on。
    注意：此字段可能返回 null，表示取不到有效值。
    CustomTime CustomTime 否 自定义缓存时间。不填表示不设置该配置，FollowOrigin、NoCache、CustomTime 最多只能配置一个 Switch 为 on。
    注意：此字段可能返回 null，表示取不到有效值。

    CachePrefresh

    缓存预刷新

    被如下接口引用：DescribeZoneSetting, ModifyZoneSetting。

    名称 类型 必选 描述
    Switch String 是 缓存预刷新配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    Percent Integer 否 缓存预刷新百分比，取值范围：1-99。

    CachePrefreshParameters

    缓存预刷新 配置参数。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting。

    名称 类型 必选 描述
    Switch String 否 缓存预刷新开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    CacheTimePercent Integer 否 预刷新时间设置为节点缓存时间的百分比数值，取值：1～99。
    注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。

    CacheTag

    节点缓存清除类型取值为 purge_cache_tag 时附带的信息。

    被如下接口引用：CreatePurgeTask。

    名称 类型 必选 描述
    Domains Array of String 是 待清除缓存的域名列表。

    CertificateInfo

    https 证书配置。

    被如下接口引用：DescribeAccelerationDomains, ModifyHostsCertificate。

    名称 类型 必选 描述
    CertId String 是 证书 ID。来源于 SSL 侧，您可以前往 SSL 证书列表 查看 CertId。
    Alias String 否 证书备注名。
    Type String 否 证书类型，取值有：
  • default：默认证书；
  • upload：用户上传；
  • managed：腾讯云托管。
    		•
    ExpireTime Timestamp ISO8601 否 证书过期时间。
    DeployTime Timestamp ISO8601 否 证书部署时间。
    SignAlgo String 否 签名算法。
    Status String 否 证书状态，取值有：
  • deployed：已部署；
  • processing：部署中；
  • applying：申请中；
  • failed：申请失败；
  • issued：绑定失败。
    		•

    ChallengeActionParameters

    Web 安全 Challenge 挑战的附加参数

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    ChallengeOption String 是 安全执行的具体挑战动作。取值有：
  • InterstitialChallenge：插页式挑战；
  • InlineChallenge：内嵌式挑战；
  • JSChallenge：JavaScript 挑战；
  • ManagedChallenge：托管挑战。
    		•
    Interval String 否 重复挑战的时间间隔，当 Name 为 InterstitialChallenge/InlineChallenge 时，该字段必填。默认值为 300s。支持的单位有：
  • s：秒，取值范围1～60；
  • m：分，取值范围1～60；
  • h：小时，取值范围1～24。

    		•
    AttesterId String 否 客户端认证方式 ID 。当 Name 为 InterstitialChallenge/InlineChallenge 时，该字段必填。

    CheckRegionHealthStatus

    各个健康检查区域下源站的健康状态。

    被如下接口引用：DescribeOriginGroupHealthStatus。

    名称 类型 描述
    Region String 健康检查区域，ISO-3166-1 两位字母代码。
    Healthy String 单健康检查区域下探测源站的健康状态，取值有：
  • Healthy：健康；
  • Unhealthy：不健康；
  • Undetected：未探测到数据。
    • 说明：单健康检查区域下所有源站为健康，则状态为健康，否则为不健康。
    OriginHealthStatus Array of OriginHealthStatus 源站健康状态。

    ClientAttestationRule

    客户端认证规则

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    Id String 否 客户端认证规则的 ID。
    通过规则 ID 可支持不同的规则配置操作：
  • 增加新规则：ID 为空或不指定 ID 参数；
  • 修改已有规则：指定需要更新/修改的规则 ID；
  • 删除已有规则：BotManagement 参数中，ClientAttestationRule 列表中未包含的已有规则将被删除。
    		•
    Name String 否 客户端认证规则的名称。
    Enabled String 否 规则是否开启。取值有：
  • on：开启；
  • off：关闭。
    		•
    Priority Integer 否 规则的优先级，数值越小越优先执行，范围是 0 ~ 100，默认为 0。
    Condition String 否 规则的具体内容，需符合表达式语法，详细规范参见产品文档。
    AttesterId String 否 客户端认证选项 ID。
    DeviceProfiles Array of DeviceProfile 否 客户端设备配置。若 ClientAttestationRules 参数中，未指定 DeviceProfiles 参数值：保持已有客户端设备配置，不做修改。
    InvalidAttestationAction SecurityAction 否 客户端认证未通过的处置方式。SecurityAction 的 Name 取值支持：
  • Deny：拦截；
  • Monitor：观察；
  • Redirect：重定向；
  • Challenge：挑战。
    • 默认值为 Monitor。

    ClientAttestationRules

    客户端认证的配置。

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    Rules Array of ClientAttestationRule 否 客户端认证的列表。使用 ModifySecurityPolicy 修改 Web 防护配置时：
  • 若未指定 SecurityPolicy.BotManagement.ClientAttestationRules 中的 Rules 参数，或 Rules 参数长度为零：清空所有客户端认证规则配置。
  • 若 SecurityPolicy.BotManagement 参数中，未指定 ClientAttestationRules 参数值：保持已有客户端认证规则配置，不做修改。
    		•

    ClientAttester

    认证选项配置。

    被如下接口引用：CreateSecurityClientAttester, DescribeSecurityClientAttester, ModifySecurityClientAttester。

    名称 类型 必选 描述
    Id String 否 认证选项 ID。
    Name String 否 认证选项名称。
    Type String 否 认证规则类型。仅出参返回，取值有：
  • PRESET: 系统预置规则，仅允许修改 AttesterDuration；
  • CUSTOM: 用户自定义规则。
    		•
    AttesterSource String 否 认证方法。取值有：
  • TC-RCE: 使用风险识别 RCE 进行认证；
  • TC-CAPTCHA: 使用天御验证码进行认证。
    		•
    AttesterDuration String 否 认证有效时间。默认为 60s，支持的单位有：
  • s：秒，取值范围 60～43200；
  • m：分，取值范围 1～720；
  • h：小时，取值范围 1～12。
    		•
    TCRCEOption TCRCEOption 否 TC-RCE 认证的配置信息。
  • 当 AttesterSource 参数值为 TC-RCE 时，此字段必填。
    		•
    TCCaptchaOption TCCaptchaOption 否 TC-CAPTCHA 认证的配置信息。
  • 当 AttesterSource 参数值为 TC-CAPTCHA 时，此字段必填。
    		•

    ClientBehaviorDetection

    客户端行为校验

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    CryptoChallengeIntensity String 否 工作量证明校验强度。取值有：
  • low：低；
  • medium：中；
  • high：高。
    		•
    CryptoChallengeDelayBefore String 否 客户端行为校验的执行方式。取值有：
  • 0ms：立即执行；
  • 100ms：延迟 100ms 执行；
  • 200ms：延迟 200ms 执行；
  • 300ms：延迟 300ms 执行；
  • 400ms：延迟 400ms 执行；
  • 500ms：延迟 500ms 执行；
  • 600ms：延迟 600ms 执行；
  • 700ms：延迟 700ms 执行；
  • 800ms：延迟 800ms 执行；
  • 900ms：延迟 900ms 执行；
  • 1000ms：延迟 1000ms 执行。
    		•
    MaxChallengeCountInterval String 否 触发阈值统计的时间窗口，取值有：
  • 5s：5 秒内；
  • 10s：10 秒内；
  • 15s：15 秒内；
  • 30s：30 秒内；
  • 60s：60 秒内；
  • 5m：5 分钟内；
  • 10m：10 分钟内；
  • 30m：30 分钟内；
  • 60m：60 分钟内。
    		•
    MaxChallengeCountThreshold Integer 否 触发阈值统计的累计次数，取值范围 1 ~ 100000000。
    ChallengeNotFinishedAction SecurityAction 否 客户端未启用 JS（未完成检测）时的执行动作。 SecurityAction 的 Name 取值支持：
  • Deny：拦截，其中 DenyActionParameters 中支持 Stall 配置；
  • Monitor：观察；
  • Allow：等待后响应，其中 AllowActionParameters 需要 MinDelayTime 和 MaxDelayTime 配置。
    		•
    ChallengeTimeoutAction SecurityAction 否 客户端检测超时的执行动作。 SecurityAction 的 Name 取值支持：
  • Deny：拦截，其中 DenyActionParameters 中支持 Stall 配置；
  • Monitor：观察；
  • Allow：等待后响应，其中 AllowActionParameters 需要 MinDelayTime 和 MaxDelayTime 配置。
    		•
    BotClientAction SecurityAction 否 Bot 客户端的执行动作。 SecurityAction 的 Name 取值支持：
  • Deny：拦截，其中 DenyActionParameters 中支持 Stall 配置；
  • Monitor：观察；
  • Allow：等待后响应，其中 AllowActionParameters 需要 MinDelayTime 和 MaxDelayTime 配置。
    		•

    ClientFiltering

    智能客户端过滤

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    Enabled String 是 智能客户端过滤是否开启。取值有：
  • on：开启；
  • off：关闭。
    		•
    Action SecurityAction 否 智能客户端过滤的处置方式，当 Enabled 为 on 时，此字段必填。SecurityAction 的 Name 取值支持：
  • Monitor：观察；
  • Deny：拦截；
  • Challenge：挑战，其中ChallengeActionParameters.Name仅支持JSChallenge。
    		•

    ClientIPCountryParameters

    回源时携带客户端 IP 所属地域信息，值的格式为 ISO-3166-1 两位字母代码。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting。

    名称 类型 必选 描述
    Switch String 否 配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    HeaderName String 否 存放客户端 IP 所属地域信息的请求头名称，当 Switch=on 时有效。为空则使用默认值：EO-Client-IPCountry。

    ClientIPHeaderParameters

    存储客户端请求IP的头部信息配置。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting。

    名称 类型 必选 描述
    Switch String 否 配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    HeaderName String 否 回源时，存放客户端 IP 的请求头名称。当 Switch 为 on 时，该参数必填。该参数不允许填写 X-Forwarded-For。

    ClientIpCountry

    回源时携带客户端IP所属地域信息，值的格式为ISO-3166-1两位字母代码。

    被如下接口引用：DescribeHostsSetting, DescribeZoneSetting, ModifyZoneSetting。

    名称 类型 必选 描述
    Switch String 是 配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    HeaderName String 否 存放客户端 IP 所属地域信息的请求头名称，当 Switch=on 时有效。
    为空则使用默认值：EO-Client-IPCountry。

    ClientIpHeader

    存储客户端请求IP的头部信息配置

    被如下接口引用：DescribeZoneSetting, ModifyZoneSetting。

    名称 类型 必选 描述
    Switch String 是 配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    HeaderName String 否 回源时，存放客户端 IP 的请求头名称。当 Switch 为 on 时，该参数必填。该参数不允许填写 X-Forwarded-For。

    CnameStatus

    CNAME 状态

    被如下接口引用：CheckCnameStatus。

    名称 类型 描述
    RecordName String 记录名称。
    Cname String CNAME 地址。
    注意：此字段可能返回 null，表示取不到有效值。
    Status String CNAME 状态信息，取值有：
  • active：生效；
  • moved：不生效；
    		•

    CodeAction

    规则引擎带有状态码的动作

    被如下接口引用：CreateRule, DescribeRules, ModifyRule。

    名称 类型 必选 描述
    Action String 是 功能名称，功能名称填写规范可调用接口 查询规则引擎的设置参数 查看。
    Parameters Array of RuleCodeActionParams 是 操作参数。

    Compression

    智能压缩配置。

    被如下接口引用：DescribeHostsSetting, DescribeZoneSetting, ModifyZoneSetting。

    名称 类型 必选 描述
    Switch String 是 智能压缩配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    Algorithms Array of String 否 支持的压缩算法列表，取值有：
  • brotli：brotli算法；
  • gzip：gzip算法。
    		•

    CompressionParameters

    智能压缩配置。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting。

    名称 类型 必选 描述
    Switch String 否 智能压缩配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    Algorithms Array of String 否 支持的压缩算法列表。当 Switch 为 on 时，此字段必填，否则此字段不生效。取值有：
  • brotli：brotli 算法；
  • gzip：gzip 算法。
    		•

    ConfigGroupVersionInfo

    配置组版本信息。

    被如下接口引用：DeployConfigGroupVersion, DescribeConfigGroupVersionDetail, DescribeConfigGroupVersions, DescribeDeployHistory, DescribeEnvironments。

    名称 类型 必选 描述
    VersionId String 是 版本 ID。
    VersionNumber String 否 版本号。
    GroupId String 否 配置组 ID。
    GroupType String 否 配置组类型。取值有：
  • l7_acceleration ：七层加速配置组。
  • edge_functions ：边缘函数配置组。
    		•
    Description String 否 版本描述。
    Status String 否 版本状态，取值有：
  • creating：创建中；
  • inactive：未生效；
  • active：已生效。
    		•
    CreateTime Timestamp ISO8601 否 版本创建时间。时间为世界标准时间（UTC）， 遵循 ISO 8601 标准的日期和时间格式。

    ContentCompressionParameters

    内容压缩配置。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    Switch String 是 内容压缩配置开关，取值有：
  • on：开启；
  • off：关闭。

    • 当 Switch 为 on 时，将同时支持 brotli 和 gzip 压缩算法。

    ContentIdentifier

    内容标识符。该功能仅白名单开放。

    被如下接口引用：DescribeContentIdentifiers。

    名称 类型 描述
    ContentId String 内容标识符 ID。
    Description String 内容标识符描述。
    ReferenceCount Integer 被规则引擎引用的次数。
    PlanId String 绑定的套餐 ID。
    Tags Array of Tag 绑定的标签。
    Status String 内容标识符状态，取值有：
  • active：已生效；
  • deleted：已删除。
    		•
    CreatedOn Timestamp ISO8601 创建时间，时间为世界标准时间（UTC）， 遵循 ISO 8601 标准的日期和时间格式。
    ModifiedOn Timestamp ISO8601 最新一次更新时间，时间为世界标准时间（UTC）， 遵循 ISO 8601 标准的日期和时间格式。
    DeletedOn Timestamp ISO8601 删除时间，状态非 deleted 时候为空；时间为世界标准时间（UTC）， 遵循 ISO 8601 标准的日期和时间格式。
    注意：此字段可能返回 null，表示取不到有效值。

    CurrentOriginACL

    当前生效的回源 IP 网段。

    被如下接口引用：DescribeOriginACL。

    名称 类型 必选 描述
    EntireAddresses Addresses 否 回源 IP 网段详情。
    注意：此字段可能返回 null，表示取不到有效值。
    Version String 否 版本号。
    注意：此字段可能返回 null，表示取不到有效值。
    ActiveTime String 否 版本生效时间，时间是北京时间 UTC+8， 遵循 ISO 8601 标准的日期和时间格式。
    注意：此字段可能返回 null，表示取不到有效值。
    IsPlaned String 否 本参数用于记录当前版本生效前是否完成「我已更新至最新回源 IP 网段」的确认。取值有：
  • true：版本生效时，已完成更新至最新回源 IP 的确认；
  • false：版本生效时，仍未完成已更新至最新回源 IP 的确认，回源 IP 网段由后台强制更新至最新版本。
    • 注意：本参数返回 false 时，请及时确认您的源站防火墙配置是否已更新至最新的回源 IP 网段，以避免出现回源失败。
    注意：此字段可能返回 null，表示取不到有效值。

    CustomEndpoint

    实时日志投递到自定义 HTTP(S) 接口的配置信息。

    被如下接口引用：CreateRealtimeLogDeliveryTask, DescribeRealtimeLogDeliveryTasks, ModifyRealtimeLogDeliveryTask。

    名称 类型 必选 描述
    Url String 是 实时日志投递的自定义 HTTP 接口地址，暂仅支持 HTTP/HTTPS 协议。
    AccessId String 否 填写自定义的 SecretId 用于生成加密签名，如果源站需要鉴权此参数必填。
    AccessKey String 否 填写自定义的 SecretKey 用于生成加密签名，如果源站需要鉴权此参数必填。
    CompressType String 否 数据压缩类型，取值有:
  • gzip：使用 gzip 方式压缩。
    • 不填表示不启用压缩。
    Protocol String 否 POST 请求投递日志时，使用的应用层协议类型，取值有：
  • http：HTTP 协议；
  • https：HTTPS 协议。
    • 如果不填默认根据填写的 URL 地址解析出协议类型。
    Headers Array of Header 否 投递日志时携带的自定义请求头。若您填写的头部名称为 Content-Type 等 EdgeOne 日志推送默认携带的头部，那么您填写的头部值将覆盖默认值。头部值引用单个变量${batchSize}，以获取每次 POST 请求中包含的日志条数。

    CustomErrorPage

    自定义错误码页面结构体。

    被如下接口引用：DescribeCustomErrorPages。

    名称 类型 描述
    PageId String 自定义错误页面 ID。
    ZoneId String 站点 ID。
    Name String 自定义错误页面名称。
    ContentType String 自定义错误页面类型。
    Description String 自定义错误页面描述。
    Content String 自定义错误页面内容。
    References Array of ErrorPageReference 自定义错误页面引用。

    CustomField

    实时日志投递任务中的自定义日志字段。

    被如下接口引用：CreateRealtimeLogDeliveryTask, DescribeRealtimeLogDeliveryTasks, ModifyRealtimeLogDeliveryTask。

    名称 类型 必选 描述
    Name String 是 自定义日志字段类型。从 HTTP 请求和响应中的指定位置提取数据，取值有：
  • ReqHeader：从 HTTP 请求头中提取指定字段值；
  • RspHeader：从 HTTP 响应头中提取指定字段值；
  • Cookie: 从 Cookie 中提取指定字段值；
  • ReqBody: 从 HTTP 请求正文中通过 Google RE2 正则表达式提取指定内容。
    		•
    Value String 是 根据字段类型（Name）填入字段值的定义。需要区分大小写。
  • 当字段类型为 ReqHeader、RspHeader、Cookie 时，填入需要提取值的参数名称，例如：Accept-Language。可输入 1-100 个字符，允许的字符开头为字母，中间为字母、数字、-，结尾为字母、数字；
  • 当字段类型为 ReqBody 时，填入 Google RE2 正则表达式，正则表达式长度上限为 4KB。
    		•
    Enabled Boolean 否 是否投递该字段，不填表示不投递此字段。

    CustomRule

    Web安全的自定义规则

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    Name String 是 自定义规则的名称。
    Condition String 是 自定义规则的具体内容，需符合表达式语法，详细规范参见产品文档。
    Action SecurityAction 是 自定义规则的执行动作。 SecurityAction 的 Name 取值支持：
  • Deny：拦截；
  • Monitor：观察；
  • ReturnCustomPage：使用指定页面拦截；
  • Redirect：重定向至 URL；
  • BlockIP：IP 封禁；
  • JSChallenge：JavaScript 挑战；
  • ManagedChallenge：托管挑战；
  • Allow：放行。
    		•
    Enabled String 是 自定义规则是否开启。取值有：
  • on：开启
  • off：关闭
    		•
    Id String 否 自定义规则的 ID。
    通过规则 ID 可支持不同的规则配置操作：
    - 增加新规则：ID 为空或不指定 ID 参数；
    - 修改已有规则：指定需要更新/修改的规则 ID；
    - 删除已有规则：CustomRules 参数中，Rules 列表中未包含的已有规则将被删除。
    RuleType String 否 自定义规则的类型。取值有：
  • BasicAccessRule：基础访问管控；
  • PreciseMatchRule：精准匹配规则，默认；
  • ManagedAccessRule：专家定制规则，仅出参。

    • 默认为PreciseMatchRule。
    Priority Integer 否 自定义规则的优先级，范围是 0 ~ 100，默认为 0，仅支持精准匹配规则（PreciseMatchRule）。

    CustomRules

    Web安全的自定义规则结构

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    Rules Array of CustomRule 否 自定义规则的定义列表。
    使用 ModifySecurityPolicy 修改 Web 防护配置时:
    - 若未指定 Rules 参数，或 Rules 参数长度为零：清空所有自定义规则配置。
    - 若 SecurityPolicy 参数中，未指定 CustomRules 参数值：保持已有自定义规则配置，不做修改。

    CustomTime

    节点缓存 TTL 自定义缓存时间参数配置。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    Switch String 否 自定义缓存时间开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    IgnoreCacheControl String 否 忽略源站 CacheControl 开关，取值有：
  • on：开启；
  • off：关闭。
    • 注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。
    CacheTime Integer 否 自定义缓存时间数值，单位为秒，取值：0～315360000。
    注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。

    CustomizedHeader

    负载均衡实例 HTTP/HTTPS 健康检查策略下可配置的自定义头部。

    被如下接口引用：CreateLoadBalancer, ModifyLoadBalancer。

    名称 类型 必选 描述
    Key String 是 自定义头部 Key。
    Value String 是 自定义头部 Value。

    DDoS

    DDoS配置

    被如下接口引用：DescribeHostsSetting。

    名称 类型 必选 描述
    Switch String 是 开关，取值有：
  • on：开启；
  • off：关闭。
    		•

    DDoSAttackEvent

    DDoS攻击事件对象

    被如下接口引用：DescribeDDoSAttackEvent。

    名称 类型 描述
    EventId String 事件ID。
    AttackType String 攻击类型(对应交互事件名称)。
    AttackStatus Integer 攻击状态。
    AttackMaxBandWidth Integer 攻击最大带宽。
    AttackPacketMaxRate Integer 攻击包速率峰值。
    AttackStartTime Integer 攻击开始时间，单位为s。
    AttackEndTime Integer 攻击结束时间，单位为s。
    PolicyId Integer DDoS策略组ID。
    注意：此字段可能返回 null，表示取不到有效值。
    ZoneId String 站点ID。
    注意：此字段可能返回 null，表示取不到有效值。
    Area String 攻击事件所属地区，取值有：
  • overseas：全球（除中国大陆地区）数据；
  • mainland：中国大陆地区数据。

    • 注意：此字段可能返回 null，表示取不到有效值。
    DDoSBlockData Array of DDoSBlockData 封禁解封信息。
    注意：此字段可能返回 null，表示取不到有效值。

    DDoSBlockData

    DDoS封禁解封信息

    被如下接口引用：DescribeDDoSAttackEvent。

    名称 类型 描述
    StartTime Integer 开始时间，采用unix时间戳。
    EndTime Integer 结束时间，采用unix时间戳, 为0表示还处于封禁中。
    BlockArea String 封禁受影响区域。

    DDoSProtection

    独立 DDoS 防护配置。

    被如下接口引用：DescribeDDoSProtection, ModifyDDoSProtection。

    名称 类型 必选 描述
    ProtectionOption String 是 指定独立 DDoS 的防护范围。取值为：
  • protect_all_domains：独立 DDoS 防护对站点内全部域名生效，新接入域名自动开启独立 DDoS 防护，入参为 protect_all_domains 时，入参 DomainDDoSProtections 不作处理；
  • protect_specified_domains：仅对指定域名生效，具体范围可通过 DomainDDoSProtection 参数指定。
    		•
    DomainDDoSProtections Array of DomainDDoSProtection 否 域名的独立 DDoS 防护配置。在入参场景中：
  • 当 ProtectionOption 保持为 protect_specified_domains 时：未填写的域名维持原有独立 DDoS 防护配置不变，显式指定的域名​按传入参数更新；
  • 当 ProtectionOption 由 protect_all_domains 切换为 protect_specified_domains 时：若 DomainDDoSProtections 传空，停用站点下全部域名的独立 DDoS 防护；若 DomainDDoSProtections 不为空，参数中指定的域名停用或保持独立 DDoS 防护，其余未列出的域名统一停用独立 DDoS 防护。
    		•
    SharedCNAMEDDoSProtections Array of DomainDDoSProtection 否 共享 CNAME 的独立 DDoS 防护配置。仅作为出参使用。

    DDosProtectionConfig

    适用于四层代理或 Web 站点服务的独立 DDoS 防护规格配置。

    被如下接口引用：CreateL4Proxy, DescribeL4Proxy。

    名称 类型 必选 描述
    LevelMainland String 否 中国大陆地区独立 DDoS 防护的规格。详情请参考 独立 DDoS 防护相关费用
  • PLATFORM：平台默认防护，即不开启独立 DDoS 防护；
  • BASE30_MAX300：开启独立 DDoS 防护，提供 30 Gbps 保底防护带宽以及 300 Gbps 弹性防护带宽；
  • BASE60_MAX600：开启独立 DDoS 防护，提供 60 Gbps 保底防护带宽以及 600 Gbps 弹性防护带宽。
    • 不填写参数时，取默认值 PLATFORM。
    MaxBandwidthMainland Integer 否 中国大陆地区独立 DDoS 防护的弹性防护带宽配置。
    仅当开启中国大陆区域独立 DDos 防护时有效（详见 LevelMainland 参数配置），且取值范围有如下限制：
  • 开启中国大陆地区独立 DDoS 防护，使用 30 Gbps 保底防护带宽规格时（ LevelMainland 参数值为 BASE30_MAX300 ）：有效取值范围为 30 至 300，单位为 Gbps；
  • 开启中国大陆地区独立 DDoS 防护，使用 60 Gbps 保底防护带宽规格时（ LevelMainland 参数值为 BASE60_MAX600 ）：有效取值范围为 60 至 600，单位为 Gbps；
  • 使用平台默认防护（ LevelMainland 参数值为 PLATFORM ）：不支持配置，本参数值无效。
    		•
    LevelOverseas String 否 全球（除中国大陆以外）地区独立 DDoS 防护的规格。
  • PLATFORM：平台默认防护，即不开启独立 DDoS 防护；
  • ANYCAST300：开启独立 DDoS 防护，提供 300 Gbps 防护带宽；
  • ANYCAST_ALLIN：开启独立 DDoS 防护，使用全部可用防护资源进行防护。
    • 不填写参数时，取默认值 PLATFORM。

    DNSPodDetail

    DNSPod 托管类型站点参数详情。

    被如下接口引用：DescribeZones。

    名称 类型 描述
    IsFake Integer 是否伪站点，取值有：
  • 0：非伪站点；
  • 1：伪站点。

    		•

    DefaultServerCertInfo

    https 服务端证书配置

    被如下接口引用：DescribeDefaultCertificates。

    名称 类型 必选 描述
    CertId String 是 服务器证书 ID。
    Alias String 否 证书备注名。
    Type String 否 证书类型，取值有：
  • default: 默认证书;
  • upload:用户上传;
  • managed:腾讯云托管。
    		•
    ExpireTime Timestamp ISO8601 否 证书过期时间。
    EffectiveTime Timestamp ISO8601 否 证书生效时间。
    CommonName String 否 证书公用名。
    SubjectAltName Array of String 否 证书SAN域名。
    Status String 否 部署状态，取值有：
  • processing: 部署中；
  • deployed: 已部署；
  • failed: 部署失败。
    		•
    Message String 否 Status为失败时,此字段返回失败原因。
    SignAlgo String 否 证书算法。

    DeliveryCondition

    实时日志投递条件，用于定义投递日志范围。DeliveryCondition 数组内多个项的关系为“或”，内层 Conditions 数组内多个项的关系为“且”。

    被如下接口引用：CreateRealtimeLogDeliveryTask, DescribeRealtimeLogDeliveryTasks, ModifyRealtimeLogDeliveryTask。

    名称 类型 必选 描述
    Conditions Array of QueryCondition 否 日志过滤条件，详细的过滤条件如下：
  • EdgeResponseStatusCode：按照 EdgeOne 节点响应返回给客户端的状态码进行过滤。
       支持运算符：equal、great、less、great_equal、less_equal
       取值范围：任意大于等于 0 的整数
  • OriginResponseStatusCode：按照源站响应状态码进行过滤。
       支持运算符：equal、great、less、great_equal、less_equal
       取值范围：任意大于等于 -1 的整数
  • SecurityAction：按照请求命中安全规则后的最终处置动作进行过滤。
       支持运算符：equal
       可选项如下：
       -：未知/未命中
       Monitor：观察
       JSChallenge：JavaScript 挑战
       Deny：拦截
       Allow：放行
       BlockIP：IP 封禁
       Redirect：重定向
       ReturnCustomPage：返回自定义页面
       ManagedChallenge：托管挑战
       Silence：静默
       LongDelay：长时间等待后响应
       ShortDelay：短时间等待后响应
  • SecurityModule：按照最终处置请求的安全模块名称进行过滤。
       支持运算符：equal
       可选项如下：
       -：未知/未命中
       CustomRule：Web防护 - 自定义规则
       RateLimitingCustomRule：Web防护 - 速率限制规则
       ManagedRule：Web防护 - 托管规则
       L7DDoS：Web防护 - CC攻击防护
       BotManagement：Bot管理 - Bot基础管理
       BotClientReputation：Bot管理 - 客户端画像分析
       BotBehaviorAnalysis：Bot管理 - Bot智能分析
       BotCustomRule：Bot管理 - 自定义Bot规则
       BotActiveDetection：Bot管理 - 主动特征识别
    		•

    DenyActionParameters

    安全执行动作为封禁的附加参数。

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    BlockIp String 否 是否对来源 IP 延长封禁。取值有：
  • on：开启；
  • off：关闭。

    • 启用后，对触发规则的客户端 IP 持续拦截。当启用该选项时，必须同时指定 BlockIpDuration 参数。
    注意：该选项不可与 ReturnCustomPage 或 Stall 选项同时启用。
    BlockIpDuration String 否 当 BlockIP 为 on 时IP 的封禁时长。
    ReturnCustomPage String 否 是否使用自定义页面。取值有：
  • on：开启；
  • off：关闭。

    • 启用后，使用自定义页面内容拦截（响应）请求，当启用该选项时，必须同时指定 ResponseCode 和 ErrorPageId 参数。
    注意：该选项不可与 BlockIp 或 Stall 选项同时启用。
    ResponseCode String 否 自定义页面的状态码。
    ErrorPageId String 否 自定义页面的PageId。
    Stall String 否 是否对请求来源挂起不予处理。取值有：
  • on：开启；
  • off：关闭。

    • 启用后，不再响应当前连接会话内请求，且不会主动断开连接。用于爬虫对抗时，消耗客户端连接资源。
    注意：该选项不可与 BlockIp 或 ReturnCustomPage 选项同时启用。

    DeployRecord

    配置组版本发布记录详情。

    被如下接口引用：DescribeDeployHistory。

    名称 类型 描述
    ConfigGroupVersionInfos Array of ConfigGroupVersionInfo 发布版本的详细信息。
    DeployTime Timestamp ISO8601 发布时间。时间为世界标准时间（UTC）， 遵循 ISO 8601 标准的日期和时间格式。
    Status String 发布状态，取值有：
  • deploying ：发布中；
  • failure ：发布失败；
  • success： 发布成功。
    		•
    Message String 发布结果信息。
    RecordId String 发布记录 ID。
    Description String 变更说明。

    DetailHost

    域名配置信息

    被如下接口引用：DescribeHostsSetting。

    名称 类型 描述
    ZoneId String 站点ID。
    Status String 加速服务状态，取值为：
  • process：部署中；
  • online：已启动；
  • offline：已关闭。
    		•
    Host String 域名。
    ZoneName String 站点名称。
    Cname String 分配的Cname域名
    Id String 资源ID。
    InstanceId String 实例ID。
    Lock Integer 锁状态。
    Mode Integer 域名状态类型。
    Area String 域名加速地域，取值有：
  • global：全球；
  • mainland：中国大陆；
  • overseas：境外区域。
    		•
    AccelerateType AccelerateType 加速类型配置项。
    注意：此字段可能返回 null，表示取不到有效值。
    Https Https Https配置项。
    注意：此字段可能返回 null，表示取不到有效值。
    CacheConfig CacheConfig 缓存配置项。
    注意：此字段可能返回 null，表示取不到有效值。
    Origin Origin 源站配置项。
    注意：此字段可能返回 null，表示取不到有效值。
    SecurityType SecurityType 安全类型。
    注意：此字段可能返回 null，表示取不到有效值。
    CacheKey CacheKey 缓存键配置项。
    注意：此字段可能返回 null，表示取不到有效值。
    Compression Compression 智能压缩配置项。
    注意：此字段可能返回 null，表示取不到有效值。
    Waf Waf Waf防护配置项。
    注意：此字段可能返回 null，表示取不到有效值。
    CC CC CC防护配置项。
    注意：此字段可能返回 null，表示取不到有效值。
    DDoS DDoS DDoS防护配置。
    注意：此字段可能返回 null，表示取不到有效值。
    SmartRouting SmartRouting 智能路由配置项。
    注意：此字段可能返回 null，表示取不到有效值。
    Ipv6 Ipv6 Ipv6访问配置项。
    注意：此字段可能返回 null，表示取不到有效值。
    ClientIpCountry ClientIpCountry 回源时是否携带客户端IP所属地域信息的配置。
    注意：此字段可能返回 null，表示取不到有效值。

    DetectLengthLimitCondition

    检测长度限制配置条件。

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    Name String 是 匹配条件的参数名称，取值有：
  • body_depth：请求正文包部分的检测深度。
    		•
    Values Array of String 是 匹配条件的参数值，取值与 Name 成对使用。
    当 Name 值为 body_depth 时， Values 只支持传入单个值，取值有：
  • 10KB；
  • 64KB；
  • 128KB。
    		•

    DetectLengthLimitConfig

    检测长度限制

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    DetectLengthLimitRules Array of DetectLengthLimitRule 是 检测长度限制的规则列表。

    DetectLengthLimitRule

    检测长度限制规则详情

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    RuleId Integer 是 规则Id。仅出参使用。
    RuleName String 是 规则名称。仅出参使用。
    Description String 是 规则描述，仅出参使用。
    Conditions Array of DetectLengthLimitCondition 是 规则配置条件。仅出参使用。
    Action String 是 处置方式，取值有：
  • skip：当请求正文数据超过 Conditions 出参中 body_depth 设置的检测深度时，跳过所有请求正文内容的检测；
  • scan：仅检测 Conditions 出参中 body_depth 设置的检测深度，对超出部分的请求正文内容直接截断处理，超出部分的请求正文不会经过安全检测。
    • 仅出参使用。

    DeviceProfile

    客户端设备配置

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    ClientType String 是 客户端设备类型。取值有：
  • iOS；
  • Android；
  • WebView。
    		•
    HighRiskMinScore Integer 否 判定请求为高风险的最低值，取值范围为 1～99。数值越大请求风险越高越接近 Bot 客户端发起的请求。默认值为 50，对应含义 51～100 为高风险。
    HighRiskRequestAction SecurityAction 否 高风险请求的处置方式。SecurityAction 的 Name 取值支持：
  • Deny：拦截；
  • Monitor：观察；
  • Redirect：重定向；
  • Challenge：挑战。
    • 默认值为 Monitor。
    MediumRiskMinScore Integer 否 判定请求为中风险的最低值，取值范围为 1～99。数值越大请求风险越高越接近 Bot 客户端发起的请求。默认值为 15，对应含义 16～50 为中风险。
    MediumRiskRequestAction SecurityAction 否 中风险请求的处置方式。SecurityAction 的 Name 取值支持：
  • Deny：拦截；
  • Monitor：观察；
  • Redirect：重定向；
  • Challenge：挑战。
    • 默认值为 Monitor。

    DiffIPWhitelist

    最新IP白名单列表相比于当前IP白名单列表的区别

    被如下接口引用：DescribeOriginProtection。

    名称 类型 描述
    LatestIPWhitelist IPWhitelist 最新IP白名单列表。
    AddedIPWhitelist IPWhitelist 最新IP白名单列表相比于当前IP白名单列表，新增部分。
    RemovedIPWhitelist IPWhitelist 最新IP白名单列表相比于当前IP白名单列表，删减部分。
    NoChangeIPWhitelist IPWhitelist 最新IP白名单列表相比于当前IP白名单列表，不变部分。

    DnsRecord

    DNS 记录

    被如下接口引用：DescribeDnsRecords, ModifyDnsRecords。

    名称 类型 必选 描述
    ZoneId String 否 站点 ID。
    注意：ZoneId 仅做出参使用，在 ModifyDnsRecords 不可作为入参使用，如有传此参数，会忽略。
    RecordId String 否 DNS 记录 ID。
    Name String 否 DNS 记录名。
    Type String 否 DNS 记录类型，取值有：
  • A：将域名指向一个外网 IPv4 地址，如 8.8.8.8；
  • AAAA：将域名指向一个外网 IPv6 地址；
  • MX：用于邮箱服务器。存在多条 MX 记录时，优先级越低越优先；
  • CNAME：将域名指向另一个域名，再由该域名解析出最终 IP 地址；
  • TXT：对域名进行标识和说明，常用于域名验证和 SPF 记录（反垃圾邮件）；
  • NS：如果需要将子域名交给其他 DNS 服务商解析，则需要添加 NS 记录。根域名无法添加 NS 记录；
  • CAA：指定可为本站点颁发证书的 CA；
  • SRV：标识某台服务器使用了某个服务，常见于微软系统的目录管理。
    		•
    Location String 否 DNS 记录解析线路，不指定默认为 Default，表示默认解析线路，代表全部地域生效。
    解析线路配置仅适用于当 Type（DNS 记录类型）为 A、AAAA、CNAME 时。
    取值请参考：解析线路及对应代码枚举。
    Content String 否 DNS 记录内容。根据 Type 值填入与之相对应的内容。
    TTL Integer 否 缓存时间，取值范围 60~86400，数值越小，修改记录各地生效时间越快，单位：秒。
    Weight Integer 否 DNS 记录权重，取值范围 -1~100，为 -1 时表示不分配权重，为 0 时表示不解析。权重配置仅适用于当 Type（DNS 记录类型）为 A、AAAA、CNAME 时。
    Priority Integer 否 MX 记录优先级，取值范围 0~50，数值越小越优先。
    Status String 否 DNS 记录解析状态，取值有：
  • enable：已生效；
  • disable：已停用。
    • 注意：Status 仅做出参使用，在 ModifyDnsRecords 不可作为入参使用，如有传此参数，会忽略。
    CreatedOn Timestamp ISO8601 否 创建时间。
    注意：CreatedOn 仅做出参使用，在 ModifyDnsRecords 不可作为入参使用，如有传此参数，会忽略。
    ModifiedOn Timestamp ISO8601 否 修改时间。
    注意：ModifiedOn 仅做出参使用，在 ModifyDnsRecords 不可作为入参使用，如有传此参数，会忽略。

    DnsVerification

    站点 CNAME 模式接入验证归属权或域名申请免费证书时，使用 DNS 解析验证时所需的信息。

    被如下接口引用：CreateAccelerationDomain, CreateZone, DescribeAccelerationDomains, DescribeZones。

    名称 类型 描述
    Subdomain String 主机记录。
    RecordType String 记录类型。
    RecordValue String 记录值。

    DomainDDoSProtection

    域名的独立 DDoS 防护信息。

    被如下接口引用：DescribeDDoSProtection, ModifyDDoSProtection。

    名称 类型 必选 描述
    Domain String 是 域名。
    Switch String 是 域名的独立 DDoS 开关，取值为：
  • on：已开启；
  • off：已关闭。
    		•

    DropPageConfig

    拦截页面的总体配置，用于配置各个模块的拦截后行为。

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    Switch String 是 配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    WafDropPageDetail DropPageDetail 否 Waf(托管规则)模块的拦截页面配置。如果为null，默认使用历史配置。
    AclDropPageDetail DropPageDetail 否 自定义页面的拦截页面配置。如果为null，默认使用历史配置。

    DropPageDetail

    拦截页面的配置信息

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    PageId Integer 是 拦截页面的唯一 Id。系统默认包含一个自带拦截页面，Id 值为0。
    该 Id 可通过创建拦截页面接口进行上传获取。如传入0，代表使用系统默认拦截页面。该参数已废弃。
    StatusCode Integer 是 拦截页面的 HTTP 状态码。状态码取值：100～600，不支持 3xx 状态码。托管规则拦截页面默认：566，安全防护（除托管规则外）拦截页面默认：567.
    Name String 是 页面文件名或 url。
    Type String 是 页面的类型，取值有：
  • page：指定页面。

    		•
    CustomResponseId String 否 自定义响应 Id。该 Id 可通过查询自定义错误页列表接口获取。默认值为default，使用系统默认页面。Type 类型是 page 时必填，且不能为空。

    EntityStatus

    安全实例状态。

    被如下接口引用：DescribeSecurityTemplateBindings。

    名称 类型 描述
    Entity String 实例名，现在只有子域名。
    Status String 实例配置下发状态，取值有：
  • online：配置已生效；
  • fail：配置失败；
  • process：配置下发中。
    		•
    Message String 实例配置下发信息提示。

    EnvInfo

    环境信息。

    被如下接口引用：DescribeEnvironments。

    名称 类型 描述
    EnvId String 环境 ID。
    EnvType String 环境类型，取值有：
  • production: 生产环境；
  • staging: 测试环境。
    		•
    Status String 环境状态，取值有：
  • creating：创建中；
  • running：稳定运行中，可进行版本变更；
  • version_deploying：版本部署中，不能进行新的变更。
    		•
    Scope Array of String 当前环境的配置生效范围：
  • 当 EnvType 取值为 production 时，该参数值为 ["ALL"]，代表全网生效；
  • 当 EnvType 取值为 staging 时，会返回测试节点 IP，可用于绑定 host 测试。
    		•
    CurrentConfigGroupVersionInfos Array of ConfigGroupVersionInfo 当前环境中各配置组实际生效的版本，根据 Status 的取值有以下两种情况：
  • 当 Status 取值为 version_deploying 时，本字段返回的值为执行变更动作之前生效的版本，即新版本部署期间，实际生效的版本为执行变更动作之前的版本；
  • 当 Status 取值为 running 时，本字段返回的值即为当前实际生效的版本。
    		•
    CreateTime Timestamp ISO8601 创建时间。时间为世界标准时间（UTC）， 遵循 ISO 8601 标准的日期和时间格式。
    UpdateTime Timestamp ISO8601 更新时间。时间为世界标准时间（UTC）， 遵循 ISO 8601 标准的日期和时间格式。

    ErrorPage

    自定义错误页面。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    StatusCode Integer 是 状态码。支持范围为 400、403、404、405、414、416、451、500、501、502、503、504。
    RedirectURL String 是 重定向 URL，需要为完整跳转路径，如 https://www.test.com/error.html。

    ErrorPageParameters

    自定义错误页面配置参数。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    ErrorPageParams Array of ErrorPage 否 自定义错误页面配置列表。
    注意：此字段可能返回 null，表示取不到有效值。

    ErrorPageReference

    自定义错误页面被引用的来源

    被如下接口引用：DescribeCustomErrorPages。

    名称 类型 描述
    BusinessId String 引用的业务 ID，如自定义拦截规则 ID。

    ExceptConfig

    例外规则，用于配置需要跳过特定场景的规则

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    Switch String 是 配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    ExceptUserRules Array of ExceptUserRule 否 例外规则详情。如果为null，默认使用历史配置。

    ExceptUserRule

    例外规则的配置，包含生效的条件，生效的范围。

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    RuleName String 是 规则名称，不可使用中文。
    Action String 是 规则的处置方式，当前仅支持skip：跳过全部托管规则。
    RuleStatus String 是 规则生效状态，取值有：
  • on：生效；
  • off：失效。
    		•
    RuleID Integer 否 规则ID。仅出参使用。默认由底层生成。
    UpdateTime Timestamp ISO8601 否 更新时间，如果为null，默认由底层按当前时间生成。
    ExceptUserRuleConditions Array of ExceptUserRuleCondition 否 匹配条件。
    ExceptUserRuleScope ExceptUserRuleScope 否 规则生效的范围。
    RulePriority Integer 否 优先级，取值范围0-100。如果为null，默认由底层设置为0。

    ExceptUserRuleCondition

    例外规则生效的具体条件。

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    MatchFrom String 否 匹配项，取值有：
  • host：请求域名；
  • sip：客户端IP；
  • ua：User-Agent；
  • cookie：会话 Cookie；
  • cgi：CGI 脚本；
  • xff：XFF 扩展头部；
  • url：请求 URL；
  • accept：请求内容类型；
  • method：请求方式；
  • header：请求头部；
  • sip_proto：网络层协议。
    		•
    MatchParam String 否 匹配项的参数。仅当 MatchFrom 为 header 时，可以使用本参数，值可填入 header 的 key 作为参数。
    Operator String 否 匹配操作符，取值有：
  • equal：字符串等于；
  • not_equal：数值不等于；
  • include：字符包含；
  • not_include：字符不包含；
  • match：ip匹配；
  • not_match：ip不匹配；
  • include_area：地域包含；
  • is_empty：存在字段但值为空；
  • not_exists：不存在关键字段；
  • regexp：正则匹配；
  • len_gt：数值大于；
  • len_lt：数值小于；
  • len_eq：数值等于；
  • match_prefix：前缀匹配；
  • match_suffix：后缀匹配；
  • wildcard：通配符。
    		•
    MatchContent String 否 匹配值。

    ExceptUserRuleScope

    例外规则的生效范围。

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    Type String 否 例外规则类型。其中complete模式代表全量数据进行例外，partial模式代表可选择指定模块指定字段进行例外，该字段取值有：
  • complete：完全跳过模式；
  • partial：部分跳过模式。
    		•
    Modules Array of String 否 生效的模块，该字段取值有：
  • waf：托管规则；
  • rate：速率限制；
  • acl：自定义规则；
  • cc：cc攻击防护；
  • bot：Bot防护。
    		•
    PartialModules Array of PartialModule 否 跳过部分规则ID的例外规则详情。如果为null，默认使用历史配置。
    SkipConditions Array of SkipCondition 否 跳过具体字段不去扫描的例外规则详情。如果为null，默认使用历史配置。

    ExceptionRule

    Web安全的例外规则

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    Id String 否 例外规则的 ID。
    通过规则 ID 可支持不同的规则配置操作：
  • 增加新规则：ID 为空或不指定 ID 参数；
  • 修改已有规则：指定需要更新/修改的规则 ID；
  • 删除已有规则：ExceptionRules 参数中，Rules 列表中未包含的已有规则将被删除。
    		•
    Name String 否 例外规则的名称。
    Condition String 否 例外规则的具体内容，需符合表达式语法，详细规范参见产品文档。
    SkipScope String 否 例外规则执行选项，取值有：
  • WebSecurityModules: 指定例外规则的安全防护模块。
  • ManagedRules：指定托管规则。
    		•
    SkipOption String 否 跳过请求的具体类型，取值有：
  • SkipOnAllRequestFields: 跳过所有请求；
  • SkipOnSpecifiedRequestFields: 跳过指定请求字段。
    • 仅当 SkipScope 为 ManagedRules 时有效。
    WebSecurityModulesForException Array of String 否 指定例外规则的安全防护模块，仅当 SkipScope 为 WebSecurityModules 时有效。取值有：
  • websec-mod-managed-rules：托管规则；
  • websec-mod-rate-limiting：速率限制；
  • websec-mod-custom-rules：自定义规则；
  • websec-mod-adaptive-control：自适应频控、智能客户端过滤、慢速攻击防护、流量盗刷防护；
  • websec-mod-bot：Bot管理。
    		•
    ManagedRulesForException Array of String 否 指定例外规则的具体托管规则，仅当 SkipScope 为 ManagedRules 时有效，且此时不能指定 ManagedRuleGroupsForException 。
    ManagedRuleGroupsForException Array of String 否 指定例外规则的托管规则组，仅当 SkipScope 为 ManagedRules 时有效，且此时不能指定 ManagedRulesForException 。
    RequestFieldsForException Array of RequestFieldsForException 否 指定例外规则跳过指定请求字段的具体配置，仅当 SkipScope 为 ManagedRules 并且 SkipOption 为 SkipOnSpecifiedRequestFields 时有效。
    Enabled String 否 例外规则是否开启。取值有：
  • on：开启
  • off：关闭
    		•

    ExceptionRules

    Web安全的例外规则

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    Rules Array of ExceptionRule 否 例外规则的定义列表。使用 ModifySecurityPolicy 修改 Web 防护配置时:
  • 若未指定 Rules 参数，或 Rules 参数长度为零：清空所有例外规则配置。
  • 若 SecurityPolicy 参数中，未指定 ExceptionRules 参数值：保持已有例外规则配置，不做修改。
    		•

    FailReason

    失败原因

    被如下接口引用：CreatePrefetchTask, CreatePurgeTask。

    名称 类型 描述
    Reason String 失败原因。
    Targets Array of String 处理失败的资源列表。

    FileAscriptionInfo

    站点归属权校验——文件校验信息。

    被如下接口引用：DescribeIdentifications, IdentifyZone。

    名称 类型 描述
    IdentifyPath String 文件校验目录。
    IdentifyContent String 文件校验内容。

    FileVerification

    站点 CNAME 模式接入验证归属权或域名申请免费证书时，使用 HTTP 访问验证文件时所需的信息。

    被如下接口引用：CreateAccelerationDomain, CreateZone, DescribeAccelerationDomains, DescribeZones。

    名称 类型 描述
    Path String EdgeOne 后台服务器将通过 http://{Host}{URL Path} 的格式（例如 http://www.example.com/.well-known/teo-verification/z12h416twn.txt）获取文件验证信息。其中，本字段为您需要创建的 URL Path 部分，Host 为当前加速域名。
    Content String 验证文件的内容。该字段的内容需要您填写至 Path 字段返回的 txt 文件中。

    Filter

    描述键值对过滤器，用于条件过滤查询。例如过滤ID、名称、状态等。
    若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。
    若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。

    被如下接口引用：DescribeApplicationProxies, DescribeDefaultCertificates, DescribeFunctionRules, DescribeFunctions, DescribeHostsSetting, DescribeIdentifications, DescribeJustInTimeTranscodeTemplates, DescribeL4Proxy, DescribeL4ProxyRules, DescribeL7AccRules, DescribeLoadBalancerList, DescribeMultiPathGateways, DescribeOriginProtection, DescribePlans, DescribeRules。

    名称 类型 必选 描述
    Name String 是 需要过滤的字段。
    Values Array of String 是 字段的过滤值。

    FirstPartConfig

    慢速攻击的首段包配置。

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    Switch String 是 开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    StatTime Integer 否 首段包的统计时长，单位是秒，即期望首段包的统计时长是多少，默认5秒。

    FollowOrigin

    缓存遵循源站配置。

    被如下接口引用：CreateL7AccRules, DescribeHostsSetting, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting, ModifyZoneSetting。

    名称 类型 必选 描述
    Switch String 是 遵循源站配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    DefaultCache String 否 源站未返回 Cache-Control 头时，缓存/不缓存开关。当 Switch 为 on 时，此字段必填，当 Switch 为 off 时，无需填写此字段，若填写则不生效。取值有：
  • on：缓存；
  • off：不缓存。
    		•
    DefaultCacheStrategy String 否 源站未返回 Cache-Control 头时，使用/不使用默认缓存策略开关。当 DefaultCache 为 on 时，此字段必填，否则此字段不生效；当 DefaultCacheTime 不为 0 时，此字段必须为 off。取值有：
  • on：使用默认缓存策略；
  • off：不使用默认缓存策略。
    		•
    DefaultCacheTime Integer 否 源站未返回 Cache-Control 头时，表示默认的缓存时间，单位为秒，取值：0-315360000。当 DefaultCache 为 on 时，此字段必填，否则此字段不生效；当 DefaultCacheStrategy 为 on 时， 此字段必须为 0。

    ForceRedirect

    访问协议强制 HTTPS 跳转配置。

    被如下接口引用：DescribeZoneSetting, ModifyZoneSetting。

    名称 类型 必选 描述
    Switch String 是 访问强制跳转配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    RedirectStatusCode Integer 否 重定向状态码，取值有：
  • 301：301跳转；
  • 302：302跳转。
    		•

    ForceRedirectHTTPSParameters

    访问协议强制 HTTPS 跳转配置。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting。

    名称 类型 必选 描述
    Switch String 否 访问强制跳转配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    RedirectStatusCode Integer 否 重定向状态码。当 Switch 为 on 时，此字段必填，否则此字段不生效。取值有：
  • 301：301跳转；
  • 302：302跳转。
    		•

    FrequentScanningProtection

    高频扫描防护配置选项，当某一访客的请求频繁命中「配置为拦截」的托管规则时，在一段时间内封禁该访客所有请求。

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    Enabled String 否 高频扫描防护规则是否开启。取值有：
  • on：开启，高频扫描防护规则生效；
  • off：关闭，高频扫描防护规则不生效。
    		•
    Action SecurityAction 否 高频扫描防护的处置动作。 当 Enabled 为 on 时，此字段必填。SecurityAction 的 Name 取值支持：
  • Deny：拦截，响应拦截页面；
  • Monitor：观察，不处理请求记录安全事件到日志中；
  • JSChallenge：JavaScript 挑战，响应 JavaScript 挑战页面。
    		•
    CountBy String 否 请求统计的匹配方式，当 Enabled 为 on 时，此字段必填。取值有：
  • http.request.xff_header_ip：客户端 IP（优先匹配 XFF 头部）；
  • http.request.ip：客户端 IP。
    		•
    BlockThreshold Integer 否 此参数指定高频扫描防护的阈值，即在 CountingPeriod 所设置时间范围内命中「配置为拦截」的托管规则时的累计拦截次数，取值范围 1 ~ 4294967294，例如 100，当超过此统计值时，后续请求将触发 Action 所设置的处置动作。当 Enabled 为 on 时，此字段必填。
    CountingPeriod String 否 此参数指定高频扫描防护所统计的时间窗口，即命中「配置为拦截」的托管规则的请求的统计时间窗口，取值 5 ~ 1800，单位仅支持秒（s），例如 5s。 当 Enabled 为 on 时，此字段必填。
    ActionDuration String 否 此参数指定高频扫描防护 Action 参数所设置处置动作的持续时长，取值范围 60 ~ 86400，单位仅支持秒（s），例如 60s。当 Enabled 为 on 时，此字段必填。

    Function

    边缘函数详情

    被如下接口引用：DescribeFunctions。

    名称 类型 描述
    FunctionId String 函数 ID。
    ZoneId String 站点 ID。
    Name String 函数名字。
    Remark String 函数描述。
    Content String 函数内容。
    Domain String 函数默认域名。
    CreateTime String 创建时间。时间为世界标准时间（UTC）， 遵循 ISO 8601 标准的日期和时间格式。
    UpdateTime String 修改时间。时间为世界标准时间（UTC）， 遵循 ISO 8601 标准的日期和时间格式。

    FunctionEnvironmentVariable

    边缘函数环境变量

    被如下接口引用：DescribeFunctionRuntimeEnvironment, HandleFunctionRuntimeEnvironment。

    名称 类型 必选 描述
    Key String 是 变量的名称，限制只能包含大小写字母、数字，特殊字符仅支持 @ . - _ ，最大 64 个字节，不支持重复。
    Value String 否 变量的值，限制最大 5000 字节，默认值为空。
    Type String 否 变量的类型，取值有：
  • string：字符串类型；
  • json：json 对象类型。
    • 默认值为：string。

    FunctionRegionSelection

    地区策略配置。

    被如下接口引用：CreateFunctionRule, DescribeFunctionRules, ModifyFunctionRule。

    名称 类型 必选 描述
    FunctionId String 是 函数 ID 。
    Regions Array of String 是 国家/地区列表。示例值：CN：中国，CN.GD：中国广东。取值请参考：国家/地区及对应代码枚举。

    FunctionRule

    边缘函数触发规则。

    被如下接口引用：DescribeFunctionRules。

    名称 类型 描述
    RuleId String 规则ID。
    FunctionRuleConditions Array of FunctionRuleCondition 规则条件列表，列表项之间为或关系。
    TriggerType String 函数选择配置类型：
  • direct：直接指定执行函数；
  • weight：基于权重比选择函数；
  • region：基于客户端 IP 的国家/地区选择函数。

    		•
    FunctionId String 指定执行的函数 ID。当 TriggerType 为 direct 时有效。
    FunctionName String 指定执行的函数名称。
    RegionMappingSelections Array of FunctionRegionSelection 基于客户端 IP 国家/地区的函数选择配置。
    WeightedSelections Array of FunctionWeightedSelection 基于权重的函数选择配置。
    Priority Integer 函数触发规则优先级，数值越大，优先级越高。
    Remark String 规则描述。
    CreateTime Timestamp ISO8601 创建时间。时间为世界标准时间（UTC）， 遵循 ISO 8601 标准的日期和时间格式。
    UpdateTime Timestamp ISO8601 更新时间。时间为世界标准时间（UTC）， 遵循 ISO 8601 标准的日期和时间格式。

    FunctionRuleCondition

    边缘函数触发规则条件。

    被如下接口引用：CreateFunctionRule, DescribeFunctionRules, ModifyFunctionRule。

    名称 类型 必选 描述
    RuleConditions Array of RuleCondition 是 边缘函数触发规则条件，该列表内所有项全部满足即判断该条件满足。

    FunctionWeightedSelection

    权重策略配置。

    被如下接口引用：CreateFunctionRule, DescribeFunctionRules, ModifyFunctionRule。

    名称 类型 必选 描述
    FunctionId String 是 函数 ID 。
    Weight Integer 是 选中权重。取值范围0-100，所有的权重之和需要为100。
    选中概率计算方式为：
    weight/100。例如设置了两个函数 A 和 B ，其中 A 的权重为30，那么 B 的权重必须为70，最终选中 A 的概率为30%，选中 B 的概率为70%。

    GatewayRegion

    多通道安全网关可用地域

    被如下接口引用：DescribeMultiPathGatewayRegions。

    名称 类型 描述
    RegionId String 地域 ID 。
    CNName String 中文地域名称。
    ENName String 英文地域名称。

    Grpc

    Grpc配置项

    被如下接口引用：DescribeZoneSetting, ModifyZoneSetting。

    名称 类型 必选 描述
    Switch String 是 是否开启 Grpc 配置，取值有：
  • on：开启；
  • off：关闭。
    		•

    GrpcParameters

    gRPC 配置项。

    被如下接口引用：DescribeL7AccSetting, ModifyL7AccSetting。

    名称 类型 必选 描述
    Switch String 否 gRPC 配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•

    HSTSParameters

    HSTS 配置参数。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting。

    名称 类型 必选 描述
    Switch String 否 HSTS 配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    Timeout Integer 否 缓存 HSTS 头部时间，单位为秒，取值：1-31536000。
    注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。
    IncludeSubDomains String 否 是否允许其他子域名继承相同的 HSTS 头部，取值有：
  • on：允许其他子域名继承相同的 HSTS 头部；
  • off：不允许其他子域名继承相同的 HSTS 头部。
    • 注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。
    Preload String 否 是否允许浏览器预加载 HSTS 头部，取值有：
  • on：允许浏览器预加载 HSTS 头部；
  • off：不允许浏览器预加载 HSTS 头部。
    • 注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。

    HTTP2Parameters

    HTTP2 接入配置参数。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting。

    名称 类型 必选 描述
    Switch String 否 HTTP2 接入配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•

    HTTPResponseParameters

    HTTP 应答配置参数。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    StatusCode Integer 否 响应状态码。支持 2XX、4XX、5XX，不包括 499、514、101、301、302、303、509、520-599。
    ResponsePage String 否 响应页面 ID。

    HTTPUpstreamTimeoutParameters

    七层回源超时配置。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    ResponseTimeout Integer 否 HTTP 应答超时时间，单位为秒，取值：5～600。

    刷新预热附带的头部信息

    被如下接口引用：CreatePrefetchTask, CreateRealtimeLogDeliveryTask, ModifyRealtimeLogDeliveryTask。

    名称 类型 必选 描述
    Name String 是 HTTP头部名称。
    Value String 是 HTTP头部值。

    HeaderAction

    HTTP 头部设置规则。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    Action String 是 HTTP 头部设置方式。取值有：
  • set：设置。变更指定头部参数的取值为设置后的值；
  • del：删除。删除指定的头部参数；
  • add：增加。增加指定的头部参数。
    		•
    Name String 是 HTTP 头部名称。
    Value String 否 HTTP 头部值。当 Action 取值为 set 或者 add 时，该参数必填；当 Action 取值为 del 时，该参数无需填写。

    HealthChecker

    负载均衡实例健康检查策略。

    被如下接口引用：CreateLoadBalancer, DescribeLoadBalancerList, ModifyLoadBalancer。

    名称 类型 必选 描述
    Type String 是 健康检查策略，取值有：
  • HTTP；
  • HTTPS；
  • TCP；
  • UDP；
  • ICMP Ping；
  • NoCheck。

    • 注意：NoCheck 表示不启用健康检查策略。
    Port Integer 否 检查端口。当 Type=HTTP 或 Type=HTTPS 或 Type=TCP 或 Type=UDP 时为必填。
    Interval Integer 否 检查频率，表示多久发起一次健康检查任务，单位为秒。可取值有：30，60，180，300 或 600。
    Timeout Integer 否 每一次健康检查的超时时间，若健康检查消耗时间大于此值，则检查结果判定为”不健康“， 单位为秒，默认值为 5s，取值必须小于 Interval。
    HealthThreshold Integer 否 健康阈值，表示连续几次健康检查结果为"健康"，则判断源站为"健康"，单位为次，默认 3 次，最小取值 1 次。
    CriticalThreshold Integer 否 不健康阈值，表示连续几次健康检查结果为"不健康"，则判断源站为"不健康"，单位为次，默认 2 次。
    Path String 否 该参数仅当 Type=HTTP 或 Type=HTTPS 时有效，表示探测路径，需要填写完整的 host/path，不包含协议部分，例如：www.example.com/test。
    Method String 否 该参数仅当 Type=HTTP 或 Type=HTTPS 时有效，表示请求方法，取值有：
  • GET；
  • HEAD。
    		•
    ExpectedCodes Array of String 否 该参数仅当 Type=HTTP 或 Type=HTTPS 时有效，表示探测节点向源站发起健康检查时，响应哪些状态码可用于认定探测结果为健康。
    Headers Array of CustomizedHeader 否 该参数仅当 Type=HTTP 或 Type=HTTPS 时有效，表示探测请求携带的自定义 HTTP 请求头，至多可配置 10 个。
    FollowRedirect String 否 该参数仅当 Type=HTTP 或 Type=HTTPS 时有效，表示是否启用遵循 301/302 重定向。启用后，301/302 默认为"健康"的状态码，默认跳转 3 次。
    SendContext String 否 该参数仅当 Type=UDP 时有效，表示健康检查发送的内容。只允许 ASCII 可见字符，最大长度限制 500 个字符。
    RecvContext String 否 该参数仅当 Type=UDP 时有效，表示健康检查期望源站返回结果。只允许 ASCII 可见字符，最大长度限制 500 个字符。

    HostHeaderParameters

    Host Header 重写配置参数。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    Action String 否 执行动作，取值有：
  • followOrigin：跟随源站域名；
  • custom：自定义。
    		•
    ServerName String 否 Host Header 重写，需要填写完整域名。
    注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。

    HostName

    访问 URL 重定向 HostName 配置参数。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    Action String 否 目标 HostName 配置，取值有：
  • follow：跟随请求；
  • custom：自定义。
    		•
    Value String 否 目标 HostName 自定义取值，最大长度 1024。
    注意：当 Action 为 custom 时，此字段必填；当 Action 为 follow 时，此字段不生效。

    Hsts

    Hsts配置

    被如下接口引用：DescribeHostsSetting, ModifyZoneSetting。

    名称 类型 必选 描述
    Switch String 是 是否开启，取值有：
  • on：开启；
  • off：关闭。
    		•
    MaxAge Integer 否 MaxAge 数值。单位为秒，最大值为1天。
    IncludeSubDomains String 否 是否包含子域名，取值有：
  • on：开启；
  • off：关闭。
    		•
    Preload String 否 是否开启预加载，取值有：
  • on：开启；
  • off：关闭。
    		•

    HttpDDoSProtection

    HTTP DDOS防护配置。

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    AdaptiveFrequencyControl AdaptiveFrequencyControl 否 自适应频控的具体配置。
    ClientFiltering ClientFiltering 否 智能客户端过滤的具体配置。
    BandwidthAbuseDefense BandwidthAbuseDefense 否 流量防盗刷的具体配置。
    SlowAttackDefense SlowAttackDefense 否 慢速攻击防护的具体配置。

    Https

    域名 https 加速配置，默认为关闭状态

    被如下接口引用：DescribeHostsSetting, DescribeZoneSetting, ModifyZoneSetting。

    名称 类型 必选 描述
    Http2 String 否 http2 配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    OcspStapling String 否 OCSP 配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    TlsVersion Array of String 否 Tls 版本设置，取值有：
  • TLSv1：TLSv1版本；
  • TLSv1.1：TLSv1.1版本；
  • TLSv1.2：TLSv1.2版本；
  • TLSv1.3：TLSv1.3版本。
    • 修改时必须开启连续的版本。
    Hsts Hsts 否 HSTS 配置。
    注意：此字段可能返回 null，表示取不到有效值。
    CertInfo Array of ServerCertInfo 否 证书配置。
    注意：此字段可能返回 null，表示取不到有效值。
    ApplyType String 否 申请类型，取值有：
  • apply：托管EdgeOne；
  • none：不托管EdgeOne。
    • 不填，默认取值为none。
    CipherSuite String 否 密码套件，取值有：
  • loose-v2023：提供高兼容性，安全性一般，支持 TLS 1.0-1.3 密码套件；
  • general-v2023：提供较高兼容性，安全性中等，支持 TLS 1.2-1.3 密码套件；
  • strict-v2023：提供高安全性能，禁用所有含不安全隐患的加密套件，支持 TLS 1.2-1.3 密码套件。
    		•

    IPExpireInfo

    存储定时过期时间和对应 IP。

    被如下接口引用：CreateSecurityIPGroup, DescribeSecurityIPGroup, DescribeSecurityIPGroupInfo, ModifySecurityIPGroup。

    名称 类型 必选 描述
    ExpireTime Timestamp ISO8601 否 定时过期时间，遵循 ISO 8601 标准的日期和时间格式。例如 "2022-01-01T00:00:00+08:00"。
    IPList Array of String 否 IP 列表。仅支持 IP 及 IP 网段。

    IPGroup

    IP 网段组

    被如下接口引用：CreateSecurityIPGroup, DescribeSecurityIPGroup, DescribeSecurityIPGroupInfo, ModifySecurityIPGroup。

    名称 类型 必选 描述
    GroupId Integer 是 组 Id，创建时填 0 即可。
    Name String 是 组名称。
    Content Array of String 是 IP 组内容，仅支持 IP 及 IP 网段。
    IPTotalCount Integer 否 IP 组中正在生效的 IP 或网段个数。作为出参时有效，作为入参时无需填写该字段。
    IPExpireInfo Array of IPExpireInfo 否 IP 定时过期信息。
    作为入参，用于为指定的 IP 地址或网段配置定时过期时间。
    作为出参，包含以下两类信息：
  • 当前未到期的定时过期信息：尚未触发的过期配置。
  • 一周内已到期的定时过期信息：已触发的过期配置。
    		•

    IPRegionInfo

    IP 归属信息查询

    被如下接口引用：DescribeIPRegion。

    名称 类型 描述
    IP String IP 地址，IPV4 或 IPV6。
    IsEdgeOneIP String IP 是否属于 EdgeOne 节点，取值有：
  • yes：该 IP 属于 EdgeOne 节点；
  • no：该 IP 不属于 EdgeOne 节点。
    		•

    IPReputation

    IP 情报库（原客户端画像分析）配置。

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    Enabled String 否 IP 情报库（原客户端画像分析）。取值有：
  • on：开启；
  • off：关闭。
    		•
    IPReputationGroup IPReputationGroup 否 IP 情报库（原客户端画像分析）的具体配置内容。

    IPReputationGroup

    IP 情报库（原客户端画像分析）的具体配置。

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    BaseAction SecurityAction 否 IP 情报库（原客户端画像分析）的执行动作。SecurityAction 的 Name 取值支持：
  • Deny：拦截；
  • Monitor：观察；
  • Disabled：未启用，不启用指定规则；
  • Challenge：挑战，其中 ChallengeActionParameters 中的 ChallengeOption 支持 JSChallenge 和 ManagedChallenge。
    		•
    BotManagementActionOverrides Array of BotManagementActionOverrides 否 IP 情报库（原客户端画像分析）的具体配置，用于覆盖 BaseAction 中的默认配置。其中 BotManagementActionOverrides 的 Ids 中可以填写：
  • IPREP_WEB_AND_DDOS_ATTACKERS_LOW：网络攻击 - 一般置信度；
  • IPREP_WEB_AND_DDOS_ATTACKERS_MID：网络攻击 - 中等置信度；
  • IPREP_WEB_AND_DDOS_ATTACKERS_HIGH：网络攻击 - 高置信度；
  • IPREP_PROXIES_AND_ANONYMIZERS_LOW：网络代理 - 一般置信度；
  • IPREP_PROXIES_AND_ANONYMIZERS_MID：网络代理 - 中等置信度；
  • IPREP_PROXIES_AND_ANONYMIZERS_HIGH：网络代理 - 高置信度；
  • IPREP_SCANNING_TOOLS_LOW：扫描器 - 一般置信度；
  • IPREP_SCANNING_TOOLS_MID：扫描器 - 中等置信度；
  • IPREP_SCANNING_TOOLS_HIGH：扫描器 - 高置信度；
  • IPREP_ATO_ATTACKERS_LOW：账号接管攻击 - 一般置信度；
  • IPREP_ATO_ATTACKERS_MID：账号接管攻击 - 中等置信度；
  • IPREP_ATO_ATTACKERS_HIGH：账号接管攻击 - 高置信度；
  • IPREP_WEB_SCRAPERS_AND_TRAFFIC_BOTS_LOW：恶意 BOT - 一般置信度；
  • IPREP_WEB_SCRAPERS_AND_TRAFFIC_BOTS_MID：恶意 BOT - 中等置信度；
  • IPREP_WEB_SCRAPERS_AND_TRAFFIC_BOTS_HIGH：恶意 BOT - 高置信度。
    		•

    IPWhitelist

    源站防护IP白名单

    被如下接口引用：DescribeOriginProtection。

    名称 类型 描述
    IPv4 Array of String IPv4列表。
    IPv6 Array of String IPv6列表。

    IPv6Parameters

    IPv6 访问配置。

    被如下接口引用：DescribeL7AccSetting, ModifyL7AccSetting。

    名称 类型 必选 描述
    Switch String 否 IPv6 访问功能配置，取值有：
  • on：开启 IPv6 访问功能；
  • off：关闭 IPv6 访问功能。
    		•

    Identification

    站点验证信息

    被如下接口引用：DescribeIdentifications。

    名称 类型 描述
    ZoneName String 站点名称。
    Domain String 验证子域名。验证站点时，该值为空。验证子域名是为具体子域名。
    Status String 验证状态，取值有：
  • pending：验证中；
  • finished：验证完成。
    		•
    Ascription AscriptionInfo 站点归属权校验：Dns校验信息。
    OriginalNameServers Array of String 域名当前的 NS 记录。
    FileAscription FileAscriptionInfo 站点归属权校验：文件校验信息。

    ImageOptimize

    图片优化配置。

    被如下接口引用：DescribeZoneSetting, ModifyZoneSetting。

    名称 类型 必选 描述
    Switch String 是 开关，取值有：
  • on：开启；
  • off：关闭。
    		•

    IntelligenceRule

    智能分析规则

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    Switch String 否 开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    IntelligenceRuleItems Array of IntelligenceRuleItem 否 规则详情。

    IntelligenceRuleItem

    Bot智能分析规则详情

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    Label String 是 智能分析标签，取值有：
  • evil_bot：恶意bot；
  • suspect_bot：疑似bot；
  • good_bot：良好bot；
  • normal：正常请求。
    		•
    Action String 是 触发智能分析标签对应的处置方式，取值有：
  • drop：拦截；
  • trans：放行；
  • alg：Javascript挑战；
  • captcha：数字验证码；
  • monitor：观察。
    		•

    IpTableConfig

    IP黑白名单及IP区域控制配置

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    Switch String 是 开关，取值有：
  • on：开启；
  • off：关闭；
    		•
    IpTableRules Array of IpTableRule 否 基础管控规则。如果为null，默认使用历史配置。

    IpTableRule

    自定义规则-基础访问管控配置。

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    Action String 是 动作，取值有：
  • drop：拦截；
  • trans：放行；
  • monitor：观察。
    		•
    MatchFrom String 是 根据类型匹配，取值有：
  • ip：客户端 IP 进行匹配；
  • area：客户端 IP 所属地区匹配；
  • asn：客户端所属的自治系统进行匹配；
  • referer：请求头 Referer 进行匹配；
  • ua：请求头 User-Agent 进行匹配；
  • url：请求 URL 进行匹配。
    		•
    Operator String 否 规则的匹配方式。取值有：
  • match：匹配，适用于 MatchFrom 为 ip；
  • not_match：不匹配，适用于 MatchFrom 为 ip；
  • include_area：地域包含，适用于 MatchFrom 为 area；
  • not_include_area：地域不包含，适用于 MatchFrom 为 area；
  • asn_match：ASN 包含，适用于 MatchFrom 为 asn；
  • asn_not_match：ASN 不包含，适用于 MatchFrom 为 asn；
  • equal：等于，适用于 MatchFrom 为 ua , referer；
  • not_equal：不等于，适用于 MatchFrom 为 ua , referer；
  • include：通配符匹配，适用于 MatchFrom 为 ua , referer , url；
  • not_include：通配符不匹配，适用于 MatchFrom 为 ua , referer；
  • is_emty：配置内容为空，适用于 MatchFrom 为 ua , referer；
  • not_exists：配置内容不存在，适用于 MatchFrom 为 ua , referer。
    		•
    RuleID Integer 否 规则id。仅出参使用。
    UpdateTime Timestamp ISO8601 否 更新时间。仅出参使用。
    Status String 否 规则启用状态。取值有：
  • on：启用；
  • off：未启用。

    • 当入参缺省时，按 on 取值。
    RuleName String 否 规则名。
    MatchContent String 否 匹配内容。支持多值输入。
  • 当输入多个匹配值时，请使用英文逗号分隔；
  • 当 MatchFrom 为 ua 时，不支持多值输入；
  • 当 Operator 为 is_empty 或 not_exists 时，本字段入参值无效。
    		•

    Ipv6

    Ipv6访问配置

    被如下接口引用：CreateApplicationProxy, DescribeApplicationProxies, DescribeHostsSetting, DescribeZoneSetting, ModifyApplicationProxy, ModifyZoneSetting。

    名称 类型 必选 描述
    Switch String 是 Ipv6 访问功能配置，取值有：
  • on：开启Ipv6访问功能；
  • off：关闭Ipv6访问功能。
    		•

    JITVideoProcess

    视频即时处理配置

    被如下接口引用：DescribeZoneSetting, ModifyZoneSetting。

    名称 类型 必选 描述
    Switch String 是 视频即时处理配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•

    JSInjectionRule

    JavaScript 注入规则。

    被如下接口引用：CreateSecurityJSInjectionRule, DescribeSecurityJSInjectionRule, ModifySecurityJSInjectionRule。

    名称 类型 必选 描述
    RuleId String 否 规则 ID。
    Name String 否 规则名称。
    Priority Integer 否 规则优先级，数值越小越优先执行，范围是 0 ~ 100，默认为 0。
    Condition String 否 匹配条件内容。需符合表达式语法，详细规范参见产品文档。
    InjectJS String 否 JavaScript 注入选项。默认值为 run-attestations，取值有：
  • no-injection: 不注入 JavaScript;
  • inject-sdk-only: 注入当前支持的所有认证方式的 SDK，当前支持：TC-RCE 和 TC-CAPTCHA。注意：若需执行认证检测，请配置挑战规则。

    		•

    JustInTimeTranscodeTemplate

    即时转码模板详情。

    被如下接口引用：DescribeJustInTimeTranscodeTemplates。

    名称 类型 描述
    TemplateId String 即时转码模板唯一标识。
    TemplateName String 转码模板名称。
    Comment String 模板描述信息。
    Type String 模板类型，取值：
  • preset：系统预置模板；
  • custom：用户自定义模板。
    		•
    VideoStreamSwitch String 启用视频流开关，取值：
  • on：开启；
  • off：关闭。
    		•
    AudioStreamSwitch String 启用音频流开关，取值：
  • on：开启；
  • off：关闭。
    		•
    VideoTemplate VideoTemplateInfo 视频流配置参数，仅当 VideoStreamSwitch 为 on，该字段有效。
    AudioTemplate AudioTemplateInfo 音频流配置参数，仅当 AudioStreamSwitch 为 on，该字段有效。
    CreateTime String 模板创建时间，使用 ISO 日期格式。
    UpdateTime String 模板最后修改时间，使用 ISO 日期格式。

    KnownBotCategories

    商业或开源工具 UA 特征配置（原 UA 特征规则）。

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    BaseAction SecurityAction 否 来自已知商业工具或开源工具的访问请求的处置方式。 SecurityAction 的 Name 取值支持：
  • Deny：拦截；
  • Monitor：观察；
  • Disabled：未启用，不启用指定规则；
  • Challenge：挑战，其中 ChallengeActionParameters 中的 ChallengeOption 支持 JSChallenge 和 ManagedChallenge；
  • Allow：放行（待废弃）。
    		•
    BotManagementActionOverrides Array of BotManagementActionOverrides 否 指定已知商业工具或开源工具的访问请求的处置方式。

    L4OfflineLog

    离线日志详细信息

    被如下接口引用：DownloadL4Logs。

    名称 类型 描述
    ProxyId String 四层代理实例 ID。
    Area String 日志所属区域，取值有：
  • mainland：中国大陆境内;
  • overseas：全球（不含中国大陆）。
    		•
    LogPacketName String 离线日志数据包名。
    Url String 离线日志下载地址。
    LogTime Integer 日志打包时间，此参数已经废弃。
    LogStartTime Timestamp ISO8601 日志打包开始时间。
    LogEndTime Timestamp ISO8601 日志打包结束时间。
    Size Integer 日志大小，单位为 Byte。

    L4Proxy

    四层代理实例。

    被如下接口引用：DescribeL4Proxy。

    名称 类型 必选 描述
    ZoneId String 否 站点 ID。
    ProxyId String 否 四层代理实例 ID。
    ProxyName String 否 四层代理实例名称。
    Area String 否 四层代理实例的加速区域。
  • mainland：中国大陆可用区；
  • overseas： 全球可用区（不含中国大陆）；

  • global：全球可用区。
    		•
    Cname String 否 接入 CNAME。
    Ips Array of String 否 开启固定 IP 后，该值会返回对应的接入 IP；未开启时，该值为空。
    Status String 否 四层代理实例状态。
  • online：已启用；
  • offline：已停用；
  • progress：部署中；

  • stopping：停用中；
  • banned：已封禁；
  • fail：部署失败/停用失败。
    		•
    Ipv6 String 否 是否开启 IPv6 访问。
  • on：开启；

  • off：关闭。
    		•
    StaticIp String 否 是否开启固定 IP。
  • on：开启；
  • off：关闭。
    		•
    AccelerateMainland String 否 是否开启中国大陆网络优化。
  • on：开启
  • off：关闭
    		•
    DDosProtectionConfig DDosProtectionConfig 否 安全防护配置。
    注意：此字段可能返回 null，表示取不到有效值。
    L4ProxyRuleCount Integer 否 四层代理实例下的转发规则数量。
    UpdateTime Timestamp ISO8601 否 最新变更时间。

    L4ProxyRemoteAuth

    四层远程鉴权信息

    被如下接口引用：CreateL4ProxyRules, DescribeL4ProxyRules, ModifyL4ProxyRules。

    名称 类型 必选 描述
    Switch String 是 四层远程鉴权开关，取值有：
  • on：表示开启;
  • off：表示关闭。
    		•
    Address String 是 远程鉴权服务地址，格式为: domain/ip:port。例：example.auth.com:8888
    ServerFaultyBehavior String 是 远程鉴权服务不可访问后，经过四层转发规则默认回源行为，取值有：
  • reject：表示进行拦截，拒绝访问;
  • allow：表示允许通过。
    		•

    L4ProxyRule

    四层代理转发规则详情。

    被如下接口引用：CreateL4ProxyRules, DescribeL4ProxyRules, ModifyL4ProxyRules。

    名称 类型 必选 描述
    RuleId String 否 转发规则 ID。
    注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数请勿填写；在 ModifyL4ProxyRules 作为入参使用时，该参数必填。
    Protocol String 否 转发协议。取值有：
  • TCP：TCP 协议；
  • UDP：UDP 协议。

    • 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。
    PortRange Array of String 否 转发端口，支持按照以下形式填写：
  • 单端口，如：80；
  • 端口段，如：81-85。表示 81、82、83、84、85 五个端口。

    • 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。
    OriginType String 否 源站类型，取值有：
  • IP_DOMAIN：IP/域名源站；
  • ORIGIN_GROUP：源站组；
  • LB：负载均衡，当前仅白名单开放。

    • 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。
    OriginValue Array of String 否 源站地址：
  • 当 OriginType 为 IP_DOMAIN 时，填写 IP 或域名，如 8.8.8.8 或 test.com ；
  • 当 OriginType 为 ORIGIN_GROUP 时，填写源站组 ID，如 og-537y24vf5b41；
  • 当 OriginType 为 LB 时，填写负载均衡实例 ID，如 lb-2qwk30xf7s9g。

    • 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。
    OriginPortRange String 否 源站端口，支持按照以下形式填写：
  • 单端口，如：80；
  • 端口段，如：81-85，表示 81、82、83、84、85 五个端口。填写端口段时，则需要与转发端口段长度保持一致，例如转发端口：80-90，则转发端口：90-100。

    • 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。
    ClientIPPassThroughMode String 否 传递客户端 IP 的形式，取值有：
  • TOA：TOA（仅 Protocol = TCP 时可选）；

  • PPV1：Proxy Protocol 传递，协议版本 V1（仅 Protocol = TCP 时可选）；
  • PPV2：Proxy Protocol 传递，协议版本 V2；

  • SPP：Simple Proxy Protocol 传递，（仅 Protocol = UDP 时可选）；

  • OFF：不传递。

    • 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 OFF；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。
    SessionPersist String 否 是否开启会话保持，取值有：
  • on：开启；
  • off：关闭。

    • 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 off；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。
    SessionPersistTime Integer 否 会话保持时间，取值范围为 30-3600，单位为秒。
    注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，仅当 SessionPersist = on 时，该值才会生效，且当 SessionPersist = on ，该值不填写默认为 3600；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。
    RuleTag String 否 规则标签。可输入1-50 个任意字符。
    注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。
    Status String 否 规则状态，取值有：
  • online：已启用；
  • offline：已停用；
  • progress：部署中；
  • stopping：停用中；
  • fail：部署失败/停用失败。

    • 注意：L4ProxyRule 在 CreateL4ProxyRules、ModifyL4ProxyRules 作为入参使用时，该参数请勿填写。
    BuId String 否 BuID。
    RemoteAuth L4ProxyRemoteAuth 否 远程鉴权信息。
    注意：RemoteAuth 在 CreateL4ProxyRules 或 ModifyL4ProxyRules 不可作为入参使用，如有传此参数，会忽略。在 DescribeL4ProxyRules 返回为空时，表示没有开启远程鉴权。
    注意：此字段可能返回 null，表示取不到有效值。

    L7OfflineLog

    七层离线日志详细信息。

    被如下接口引用：DownloadL7Logs。

    名称 类型 描述
    Domain String 离线日志域名。
    Area String 日志所属区域，取值有：
  • mainland：中国大陆境内;
  • overseas：全球（不含中国大陆）。
    		•
    LogPacketName String 离线日志数据包名。
    Url String 离线日志下载地址。
    LogTime Integer 日志打包时间，此参数已经废弃。
    LogStartTime Timestamp ISO8601 日志打包开始时间。
    LogEndTime Timestamp ISO8601 日志打包结束时间。
    Size Integer 日志原始大小，单位 Byte。

    LoadBalancer

    负载均衡实例信息。

    被如下接口引用：DescribeLoadBalancerList。

    名称 类型 描述
    InstanceId String 实例 ID。
    Name String 实例名称，可输入 1-200 个字符，允许字符为 a-z，A-Z，0-9，_，-。
    Type String 实例类型，取值有：
  • HTTP：HTTP 专用型，支持添加 HTTP 专用型和通用型源站组，仅支持被站点加速相关服务引用（如域名服务和规则引擎）；
  • GENERAL：通用型，仅支持添加通用型源站组，能被站点加速服务（如域名服务和规则引擎）和四层代理引用。
    		•
    HealthChecker HealthChecker 健康检查策略。详情请参考 健康检查策略介绍。
    SteeringPolicy String 源站组间的流量调度策略，取值有：
  • Pritory：按优先级顺序进行故障转移 。
    		•
    FailoverPolicy String 实际访问某源站失败时的请求重试策略，详情请参考 请求重试策略介绍，取值有：
  • OtherOriginGroup：单次请求失败后，请求优先重试下一优先级源站组；
  • OtherRecordInOriginGroup：单次请求失败后，请求优先重试同源站组内的其他源站。
    		•
    OriginGroupHealthStatus Array of OriginGroupHealthStatus 源站组健康状态。
    Status String 负载均衡状态，取值有：
  • Pending：部署中；
  • Deleting：删除中；
  • Running：已生效。
    		•
    L4UsedList Array of String 该负载均衡实例绑的四层代理实例的列表。
    L7UsedList Array of String 该负载均衡实例绑定的七层域名列表。

    LogFormat

    实时日志投递的输出格式。您可以直接通过 FormatType 参数使用指定预设日志输出格式（JSON Lines / csv），也可以在预设日志输出格式基础上，通过其他参数来自定义变体输出格式。

    被如下接口引用：CreateRealtimeLogDeliveryTask, DescribeRealtimeLogDeliveryTasks, ModifyRealtimeLogDeliveryTask。

    名称 类型 必选 描述
    FormatType String 是 日志投递的预设输出格式类型，取值有：
  • json：使用预设日志输出格式 JSON Lines，单条日志中的字段以键值对方式呈现；
  • csv：使用预设日志输出格式 csv，单条日志中仅呈现字段值，不呈现字段名称。
    		•
    BatchPrefix String 否 在每个日志投递批次之前添加的字符串。每个日志投递批次可能包含多条日志记录。
    BatchSuffix String 否 在每个日志投递批次后附加的字符串。
    RecordPrefix String 否 在每条日志记录之前添加的字符串。
    RecordSuffix String 否 在每条日志记录后附加的字符串。
    RecordDelimiter String 否 插入日志记录之间作为分隔符的字符串，取值有：
  • \n：换行符；
  • \t：制表符；
  • ，：半角逗号。
    		•
    FieldDelimiter String 否 单条日志记录内，插入字段之间作为分隔符的字符串，取值有：
  • \t：制表符；
  • ，：半角逗号；
  • ;：半角分号。
    		•

    ManagedRuleAction

    托管规则的项配置

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    RuleId String 是 托管规则组下的具体项，用于改写此单条规则项配置的内容，具体参考产品文档。
    Action SecurityAction 是 RuleId 中指定托管规则项的处置动作。 SecurityAction 的 Name 取值支持：
  • Deny：拦截，响应拦截页面；
  • Monitor：观察，不处理请求记录安全事件到日志中；
  • Disabled：未启用，不扫描请求跳过该规则。
    		•

    ManagedRuleAutoUpdate

    托管规则自动更新选项

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    AutoUpdateToLatestVersion String 是 是否开启自动更新至最新版本。取值有：
  • on：开启
  • off：关闭
    		•
    RulesetVersion String 否 当前使用的版本，格式符合ISO 8601标准，如2023-12-21T12:00:32Z，默认为空，仅出参。

    ManagedRuleDetail

    托管规则详情

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    RuleId String 否 托管规则Id。
    RiskLevel String 否 托管规则的防护级别。取值有：
  • low：低风险，此规则风险较低，适用于非常严格控制环境下的访问场景，该等级规则可能造成较多的误报；
  • medium：中风险，表示此条规则风险正常，适用较为严格的防护场景；
  • high：高风险，表示此条规则风险较高，大多数场景不会产生误报；
  • extreme：超高风险，表示此条规则风险极高，基本不会产生误报；
    		•
    Description String 否 规则描述。
    Tags Array of String 否 规则标签。部分类型的规则不存在标签。
    RuleVersion String 否 规则所属版本。

    ManagedRuleGroup

    托管规则组配置。

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    GroupId String 是 托管规则的组名称，未指定配置的规则分组将按照默认配置处理，GroupId 的具体取值参考产品文档。
    SensitivityLevel String 是 托管规则组的防护级别。取值有：
  • loose：宽松，只包含超高风险规则，此时需配置Action，且RuleActions配置无效；
  • normal：正常，包含超高风险和高风险规则，此时需配置Action，且RuleActions配置无效；
  • strict：严格，包含超高风险、高风险和中风险规则，此时需配置Action，且RuleActions配置无效；
  • extreme：超严格，包含超高风险、高风险、中风险和低风险规则，此时需配置Action，且RuleActions配置无效；
  • custom：自定义，精细化策略，按单条规则配置处置方式，此时Action字段无效，使用RuleActions配置单条规则的精细化策略。
    		•
    Action SecurityAction 是 托管规则组的处置动作。SecurityAction 的 Name 取值支持：
  • Deny：拦截，响应拦截页面；
  • Monitor：观察，不处理请求记录安全事件到日志中；
  • Disabled：未启用，不扫描请求跳过该规则。
    		•
    RuleActions Array of ManagedRuleAction 否 托管规则组下规则项的具体配置，仅在 SensitivityLevel 为 custom 时配置生效。
    MetaData ManagedRuleGroupMeta 否 托管规则组信息，仅出参。

    ManagedRuleGroupMeta

    托管规则组信息

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    GroupDetail String 否 托管规则组描述，仅出参。
    GroupName String 否 托管规则组名称，仅出参。
    RuleDetails Array of ManagedRuleDetail 否 当前托管规则组下的所有子规则信息，仅出参。

    ManagedRules

    Web安全的托管规则

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    Enabled String 是 托管规则是否开启。取值有：
  • on：开启，所有托管规则按配置生效；
  • off：关闭，所有托管规则不生效。
    		•
    DetectionOnly String 是 评估模式是否开启，仅在 Enabled 参数为 on 时有效。取值有：
  • on：开启，表示所有托管规则以观察模式生效；
  • off：关闭，表示所有托管规则以实际配置生效。
    		•
    SemanticAnalysis String 否 托管规则语义分析选项是否开启，仅在 Enabled 参数为 on 时有效。取值有：
  • on：开启，对请求进行语义分析后进行处理；
  • off：关闭，对请求不进行语义分析，直接进行处理。

    • 默认为 off。
    AutoUpdate ManagedRuleAutoUpdate 否 托管规则自动更新选项。
    ManagedRuleGroups Array of ManagedRuleGroup 否 托管规则组的配置。如果此结构传空数组或 GroupId 未包含在列表内将按照默认方式处理。
    FrequentScanningProtection FrequentScanningProtection 否 高频扫描防护配置选项，当某一访客的请求频繁命中「配置为拦截」的托管规则时，在一段时间内封禁该访客所有请求。

    MaxAge

    浏览器缓存规则配置，用于设置 MaxAge 默认值，默认为关闭状态

    被如下接口引用：DescribeZoneSetting, ModifyZoneSetting。

    名称 类型 必选 描述
    FollowOrigin String 否 是否遵循源站，取值有：
  • on：遵循源站，忽略MaxAge 时间设置；
  • off：不遵循源站，使用MaxAge 时间设置。
    		•
    MaxAgeTime Integer 否 MaxAge 时间设置，单位为秒，取值：0～315360000。
    注意：时间为0，即不缓存。

    MaxAgeParameters

    浏览器缓存 TTL 配置参数。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting。

    名称 类型 必选 描述
    FollowOrigin String 否 遵循源站 Cache-Control 开关，取值有：
  • on：遵循源站，忽略 CacheTime 时间设置；
  • off：不遵循源站，使用 CacheTime 时间设置。
    		•
    CacheTime Integer 否 自定义缓存时间数值，单位为秒，取值：0～315360000。
    注意：当 FollowOrigin 为 off 时，表示不遵循源站，使用 CacheTime 设置缓存时间，否则此字段不生效。

    MaxNewSessionTriggerConfig

    Bot 管理中校验的触发阈值。

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    MaxNewSessionCountInterval String 否 触发阈值统计的时间窗口，取值有：
  • 5s：5 秒内；
  • 10s：10 秒内；
  • 15s：15 秒内；
  • 30s：30 秒内；
  • 60s：60 秒内；
  • 5m：5 分钟内；
  • 10m：10 分钟内；
  • 30m：30 分钟内；
  • 60m：60 分钟内。
    		•
    MaxNewSessionCountThreshold Integer 否 触发阈值统计的累计次数，取值范围 1 ~ 100000000。

    MinimalRequestBodyTransferRate

    正文传输最小速率阈值的具体配置。

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    MinimalAvgTransferRateThreshold String 是 正文传输最小速率阈值，单位仅支持bps。
    CountingPeriod String 是 正文传输最小速率统计时间范围，取值有：
  • 10s：10秒；
  • 30s：30秒；
  • 60s：60秒；
  • 120s：120秒。
    		•
    Enabled String 是 正文传输最小速率阈值是否开启。取值有：
  • on：开启；
  • off：关闭。
    		•

    ModifyOriginParameters

    修改源站配置参数。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    OriginType String 否 源站类型。取值有：
  • IPDomain：IPV4、IPV6 或域名类型源站；
  • OriginGroup：源站组类型源站；
  • LoadBalance：负载均衡，该功能内测中，如需使用，请提工单或联系智能客服；
  • COS：腾讯云 COS 对象存储源站；
  • AWSS3：支持 AWS S3 协议的所有对象存储源站。
    		•
    Origin String 否 源站地址，根据 OriginType 的取值分为以下情况：
  • 当 OriginType = IPDomain 时，该参数请填写 IPV4、IPV6 地址或域名；
  • 当 OriginType = COS 时，该参数请填写 COS 桶的访问域名；
  • 当 OriginType = AWSS3，该参数请填写 S3 桶的访问域名；
  • 当 OriginType = OriginGroup 时，该参数请填写源站组 ID；
  • 当 OriginType = LoadBalance 时，该参数请填写负载均衡实例 ID，该功能当前仅白名单开放。
    		•
    OriginProtocol String 否 回源协议配置。当 OriginType 取值为 IPDomain、OriginGroup、LoadBalance 时该参数必填。取值有：
  • http：使用 HTTP 协议；
  • https：使用 HTTPS 协议；
  • follow：协议跟随。
    		•
    HTTPOriginPort Integer 否 HTTP 回源端口，取值范围 1～65535。当回源协议 OriginProtocol 为 http 或者 follow 时该参数必填。
    HTTPSOriginPort Integer 否 HTTPS 回源端口，取值范围 1～65535。当回源协议 OriginProtocol 为 https 或者 follow 时该参数必填。
    PrivateAccess String 否 指定是否允许访问私有对象存储源站，当源站类型 OriginType = COS 或 AWSS3 时该参数必填，取值有：
  • on：使用私有鉴权；
  • off：不使用私有鉴权。
    		•
    PrivateParameters OriginPrivateParameters 否 私有鉴权使用参数，该参数仅当 OriginType = AWSS3 且 PrivateAccess = on 时会生效。
    注意：此字段可能返回 null，表示取不到有效值。

    ModifyRequestHeaderParameters

    修改 HTTP 回源请求头配置参数。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    HeaderActions Array of HeaderAction 否 HTTP 头部设置规则列表。
    注意：此字段可能返回 null，表示取不到有效值。

    ModifyResponseHeaderParameters

    修改 HTTP 节点响应头配置参数。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    HeaderActions Array of HeaderAction 否 HTTP 回源头部规则列表。
    注意：此字段可能返回 null，表示取不到有效值。

    MultiPathGateway

    多通道安全网关详情

    被如下接口引用：DescribeMultiPathGateway, DescribeMultiPathGateways。

    名称 类型 描述
    GatewayId String 网关 ID。
    GatewayName String 网关名。
    GatewayType String 网关类型，取值有：
  • cloud：云上网关，腾讯云创建和管理的网关。
  • private：自有网关，用户部署的私有网关。
    		•
    GatewayPort Integer 网关端口，范围 1～65535（除去 8888 ）。
    Status String 网关状态，取值有：
  • creating : 创建中；
  • online : 在线；
  • offline : 离线；
  • disable : 已停用。
    		•
    GatewayIP String 网关 IP， 格式为 IPv4。
    RegionId String 网关地域 Id，可以从接口 DescribeMultiPathGatewayRegions 获取 RegionId 列表。
    Lines Array of MultiPathGatewayLine 线路信息，当查询网关信息详情 DescribeMultiPathGateway 的时候会返回，当查询网关列表 DescribeMultiPathGateways 的时候不会返回。
    NeedConfirm String 网关回源 IP 列表发生了变化是否需要重新确认，取值有：
  • true：回源 IP 列表发生了变化，需要确认；
  • false：回源 IP 列表未发生变化，无需确认。
    		•

    MultiPathGatewayCurrentOriginACL

    当前生效的回源 IP 网段。

    被如下接口引用：DescribeMultiPathGatewayOriginACL。

    名称 类型 必选 描述
    EntireAddresses Addresses 否 回源 IP 网段详情。
    Version Integer 否 版本号。
    IsPlaned String 否 本参数用于记录当前版本生效前是否完成「我已更新至最新回源 IP 网段」的确认。取值有：
  • true：已完成更新至最新回源 IP 的确认；
  • false：未完成更新至最新回源 IP 的确认；

    • 注意：本参数返回 false 时，请及时确认您的源站防火墙配置是否已更新至最新的回源 IP 网段，以避免出现回源失败。

    MultiPathGatewayLine

    多通道安全网关线路信息

    被如下接口引用：DescribeMultiPathGateway, DescribeMultiPathGatewayLine, DescribeMultiPathGateways。

    名称 类型 描述
    LineId String 线路 ID ， 其中 line-0 和 line-1 为系统内置线路 ID，取值有:
  • line-0：直连线路，不支持添加、编辑和删除；
  • line-1： EdgeOne 四层代理线路，支持修改实例和规则，不支持删除；
  • line-2 及以上：EdgeOne 四层代理线路或者自定义线路，支持修改、删除实例和规则。
    		•
    LineType String 线路类型，取值有：
  • direct ：直连线路，不支持编辑、不支持删除；
  • proxy ：EdgeOne 四层代理线路，支持编辑修改实例和规则，不支持删除；
  • custom ：自定义线路，支持编辑、支持删除。
    		•
    LineAddress String 线路地址，格式为 host:port 。
    ProxyId String 四层代理实例 ID ，当线路类型 LineType 取值为 proxy（EdgeOne 四层代理）返回。
    RuleId String 转发规则 ID ，当线路类型 LineType 取值为 proxy（EdgeOne 四层代理）返回。

    MultiPathGatewayNextOriginACL

    当回源 IP 网段发生更新时，该字段会返回下一个版本将要生效的回源 IP 网段，包含与当前生效的回源 IP 网段的对比。

    被如下接口引用：DescribeMultiPathGatewayOriginACL。

    名称 类型 必选 描述
    Version Integer 否 版本号。
    EntireAddresses Addresses 否 回源 IP 网段详情。
    AddedAddresses Addresses 否 最新回源 IP 网段相较于 MultiPathGatewayCurrentOrginACL 中回源 IP 网段新增的部分。
    RemovedAddresses Addresses 否 最新回源 IP 网段相较于 MultiPathGatewayCurrentOrginACL 中回源 IP 网段删减的部分。
    NoChangeAddresses Addresses 否 最新回源 IP 网段相较于 MultiPathGatewayCurrentOrginACL 中回源 IP 网段无变化的部分。

    MultiPathGatewayOriginACLInfo

    多通道网关示例实例与回源 IP 网段的绑定关系，以及回源 IP 网段详情。

    被如下接口引用：DescribeMultiPathGatewayOriginACL。

    名称 类型 必选 描述
    MultiPathGatewayCurrentOriginACL MultiPathGatewayCurrentOriginACL 否 当前生效的回源 IP 网段。
    MultiPathGatewayNextOriginACL MultiPathGatewayNextOriginACL 否 当回源 IP 网段发生更新时，该字段会返回下一个版本将要生效的回源 IP 网段，包含与当前回源 IP 网段的对比。无更新时该字段为空。

    MutualTLS

    HTTPS 双向认证。

    被如下接口引用：DescribeAccelerationDomains, ModifyHostsCertificate。

    名称 类型 必选 描述
    Switch String 是 双向认证配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    CertInfos Array of CertificateInfo 否 双向认证证书列表。
    注意：MutualTLS 在 ModifyHostsCertificate 作为入参使用时，该参数传入对应证书的 CertId 即可。您可以前往 SSL 证书列表 查看 CertId。

    NSDetail

    NS 接入类型站点参数详情。

    被如下接口引用：DescribeZones。

    名称 类型 描述
    CnameSpeedUp String 是否开启 CNAME 加速，取值有：
  • enabled：开启；
  • disabled：关闭。
    		•
    IsFake Integer 是否存在同名站点，取值有：
  • 0：不存在同名站点；
  • 1：已存在同名站点。
    		•
    OwnershipVerification OwnershipVerification 归属权验证信息。针对 NS 接入类型的站点，将当前的 NS 服务器切换至腾讯云 EdgeOne 指定的 NS 服务器，即视为通过归属权验证。详情请参考 站点/域名归属权验证 。
    OriginalNameServers Array of String 由 EdgeOne 检测到的站点当前正在使用的 NS 服务器列表。
    NameServers Array of String 腾讯云 EdgeOne 分配的 NS 服务器列表。需要将当前站点 NS 服务器指向该地址，站点才能生效。
    VanityNameServers VanityNameServers 用户自定义 NS 服务器域名信息。如果启用了自定义 NS 服务，需要在域名注册厂商内将 NS 指向该地址。
    VanityNameServersIps Array of VanityNameServersIps 用户自定义 NS 服务器对应的 IP 地址信息。

    NextOriginACL

    当回源 IP 网段发生更新时，该字段会返回下一个版本将要生效的回源 IP 网段，包含与当前生效的回源 IP 网段的对比。

    被如下接口引用：DescribeOriginACL。

    名称 类型 必选 描述
    Version String 否 版本号。
    PlannedActiveTime String 否 版本生效时间，时间是北京时间 UTC+8， 遵循 ISO 8601 标准的日期和时间格式。
    EntireAddresses Addresses 否 回源 IP 网段详情。
    AddedAddresses Addresses 否 最新回源 IP 网段相较于 CurrentOrginACL 中回源 IP 网段新增的部分。
    RemovedAddresses Addresses 否 最新回源 IP 网段相较于 CurrentOrginACL 中回源 IP 网段删减的部分。
    NoChangeAddresses Addresses 否 最新回源 IP 网段相较于 CurrentOrginACL 中回源 IP 网段无变化的部分。

    NoCache

    不缓存配置

    被如下接口引用：CreateL7AccRules, DescribeHostsSetting, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting, ModifyZoneSetting。

    名称 类型 必选 描述
    Switch String 是 不缓存配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•

    NormalAction

    规则引擎常规类型的动作

    被如下接口引用：CreateRule, DescribeRules, ModifyRule。

    名称 类型 必选 描述
    Action String 是 功能名称，功能名称填写规范可调用接口 查询规则引擎的设置参数 查看。
    Parameters Array of RuleNormalActionParams 是 参数。

    NsVerification

    NS 接入，切换 DNS 服务器所需的信息。

    被如下接口引用：CreateAccelerationDomain, CreateZone, DescribeAccelerationDomains, DescribeZones。

    名称 类型 描述
    NameServers Array of String NS 接入时，分配给用户的 DNS 服务器地址，需要将域名的 NameServer 切换至该地址。

    OCSPStaplingParameters

    OCSP 装订配置参数。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting。

    名称 类型 必选 描述
    Switch String 否 OCSP 装订配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•

    OfflineCache

    离线缓存是否开启

    被如下接口引用：DescribeZoneSetting, ModifyZoneSetting。

    名称 类型 必选 描述
    Switch String 是 离线缓存是否开启，取值有：
  • on：开启；
  • off：关闭。
    		•

    OfflineCacheParameters

    离线缓存是否开启。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting。

    名称 类型 必选 描述
    Switch String 否 离线缓存开关，取值有：
  • on：开启；
  • off：关闭。
    		•

    Origin

    源站配置。

    被如下接口引用：DescribeHostsSetting, DescribeZoneSetting, ModifyZoneSetting。

    名称 类型 必选 描述
    Origins Array of String 否 主源站列表。
    BackupOrigins Array of String 否 备源站列表。
    OriginPullProtocol String 否 回源协议配置，取值有：
  • http：强制 http 回源；
  • follow：协议跟随回源；
  • https：强制 https 回源。
    		•
    CosPrivateAccess String 否 源站为腾讯云 COS 时，是否为私有访问 bucket，取值有：
  • on：私有访问；
  • off：公共访问。
    		•

    OriginACLEntity

    需要配置特定回源 IP 网段回源的实例。

    被如下接口引用：ModifyOriginACL。

    名称 类型 必选 描述
    Type String 是 实例类型，取值有：
    - l7：七层加速域名；
    - l4：四层代理实例。
    Instances Array of String 是 实例详情，取值有：
    - 当 Type = l7 时，请填写七层加速域名；
    - 当 Type = l4 时，请填写四层代理实例 ID。
    OperationMode String 是 操作模式，取值有：
  • enable：启用；
  • disable：停用。
    		•

    OriginACLInfo

    七层加速域名/四层代理实例与回源 IP 网段的绑定关系，以及回源 IP 网段详情。

    被如下接口引用：DescribeOriginACL。

    名称 类型 必选 描述
    L7Hosts Array of String 否 启用了特定回源 IP 网段回源的七层加速域名列表。源站防护未开启时为空。
    L4ProxyIds Array of String 否 启用了特定回源 IP 网段回源的四层代理实例列表。源站防护未开启时为空。
    CurrentOriginACL CurrentOriginACL 否 当前生效的回源 IP 网段。源站防护未开启时为空。
    注意：此字段可能返回 null，表示取不到有效值。
    NextOriginACL NextOriginACL 否 当回源 IP 网段发生更新时，该字段会返回下一个版本将要生效的回源 IP 网段，包含与当前回源 IP 网段的对比。无更新或者源站防护未开启时该字段为空。
    注意：此字段可能返回 null，表示取不到有效值。
    Status String 否 源站防护状态，取值有：
  • online：已生效；
  • offline：已停用；
  • updating: 配置部署中。
    		•

    OriginDetail

    加速域名源站信息。

    被如下接口引用：DescribeAccelerationDomains。

    名称 类型 描述
    OriginType String 源站类型，取值有：
  • IP_DOMAIN：IPV4、IPV6 或域名类型源站；
  • COS：腾讯云 COS 对象存储源站；
  • AWS_S3：AWS S3 对象存储源站；
  • ORIGIN_GROUP：源站组类型源站；
  • VOD：云点播；
  • SPACE：源站卸载，当前仅白名单开放；
  • LB：负载均衡，当前仅白名单开放。
    		•
    Origin String 源站地址，根据 OriginType 的取值分为以下情况：
  • 当 OriginType = IP_DOMAIN 时，该参数为 IPv4、IPv6 地址或域名；
  • 当 OriginType = COS 时，该参数为 COS 桶的访问域名；
  • 当 OriginType = AWS_S3，该参数为 S3 桶的访问域名；
  • 当 OriginType = ORIGIN_GROUP 时，该参数为源站组 ID；
  • 当 OriginType = VOD 时，该参数请填写云点播应用 ID ；
    		•
    BackupOrigin String 备用源站组 ID，该参数仅在 OriginType = ORIGIN_GROUP 且配置了备源站组时会生效。
    OriginGroupName String 主源源站组名称，当 OriginType = ORIGIN_GROUP 时该参数会返回值。
    BackOriginGroupName String 备用源站组名称，该参数仅当 OriginType = ORIGIN_GROUP 且配置了备用源站组时会生效。
    PrivateAccess String 指定是否允许访问私有对象存储源站，该参数仅当源站类型OriginType = COS 或 AWS_S3 时会生效，取值有：
  • on：使用私有鉴权；
  • off：不使用私有鉴权。

    • 不填写，默认值为 off。
    PrivateParameters Array of PrivateParameter 私有鉴权使用参数，该参数仅当源站类型 PrivateAccess = on 时会生效。
    注意：此字段可能返回 null，表示取不到有效值。
    HostHeader String 当前配置的回源 HOST 头。
    VodOriginScope String 云点播回源范围，当 OriginType = VOD 时该参数会返回值。取值有:
  • all：当前源站对应的云点播应用内所有文件，默认值为 all；
  • bucket：当前源站对应的云点播应用下指定某一个存储桶内的文件。通过参数 VodBucketId 来指定存储桶。
    		•
    VodBucketId String 云点播存储桶 ID，该参数当 OriginType = VOD 且 VodOriginScope = bucket 时必填。数据来源：云点播专业版应用下存储桶的存储 ID 。

    OriginGroup

    源站组信息

    被如下接口引用：DescribeOriginGroup。

    名称 类型 描述
    GroupId String 源站组ID。
    Name String 源站组名称。
    Type String 源站组类型，取值有：
  • GENERAL：通用型源站组；
  • HTTP： HTTP专用型源站组。
    		•
    Records Array of OriginRecord 源站记录信息。
    References Array of OriginGroupReference 源站组被引用实例列表。
    CreateTime Timestamp ISO8601 源站组创建时间。
    UpdateTime Timestamp ISO8601 源站组更新时间。
    HostHeader String 回源Host Header。

    OriginGroupHealthStatus

    源站组健康状态。

    被如下接口引用：DescribeLoadBalancerList。

    名称 类型 描述
    OriginGroupID String 源站组 ID。
    OriginGroupName String 源站组名。
    OriginType String 源站组类型，取值有：
  • HTTP：HTTP 专用型；
  • GENERAL：通用型。
    		•
    Priority String 优先级。
    OriginHealthStatus Array of OriginHealthStatus 源站组里各源站的健康状态。

    OriginGroupHealthStatusDetail

    源站组健康状态详情。

    被如下接口引用：DescribeOriginGroupHealthStatus。

    名称 类型 描述
    OriginGroupId String 源站组 ID。
    OriginHealthStatus Array of OriginHealthStatus 根据所有探测区域的结果综合决策出来的源站组下各个源站的健康状态。超过一半的地域判定该源站不健康，则对应状态为不健康，否则为健康。
    CheckRegionHealthStatus Array of CheckRegionHealthStatus 各个健康检查区域下源站的健康状态。

    OriginGroupInLoadBalancer

    负载均衡实例中需要绑定的源站组和优先级关系。

    被如下接口引用：CreateLoadBalancer, ModifyLoadBalancer。

    名称 类型 必选 描述
    Priority String 是 优先级，填写格式为 "priority_" + "数字"，最高优先级为 "priority_1"。参考取值有：
  • priority_1：第一优先级；
  • priority_2：第二优先级；
  • priority_3：第三优先级。
    • 其他优先级可以将数字递增，最多可以递增至 "priority_10"。
    OriginGroupId String 是 源站组 ID。

    OriginGroupReference

    源站组引用服务。

    被如下接口引用：DescribeOriginGroup。

    名称 类型 描述
    InstanceType String 引用服务类型，取值有：
  • AccelerationDomain: 加速域名；
  • RuleEngine: 规则引擎；
  • Loadbalance: 负载均衡；
  • ApplicationProxy: 四层代理。
    		•
    InstanceId String 引用类型的实例ID。
    InstanceName String 应用类型的实例名称。

    OriginHealthStatus

    源站组里的源站健康状态。

    被如下接口引用：DescribeLoadBalancerList, DescribeOriginGroupHealthStatus。

    名称 类型 描述
    Origin String 源站。
    Healthy String 源站健康状态，取值有：
  • Healthy：健康；
  • Unhealthy：不健康；
  • Undetected：未探测到数据。

    		•

    OriginInfo

    加速域名源站信息。

    被如下接口引用：CreateAccelerationDomain, ModifyAccelerationDomain。

    名称 类型 必选 描述
    OriginType String 是 源站类型，取值有：
  • IP_DOMAIN：IPV4、IPV6 或域名类型源站；
  • COS：腾讯云 COS 对象存储源站；
  • AWS_S3：AWS S3 对象存储源站；
  • ORIGIN_GROUP：源站组类型源站；

  • VOD：云点播；
  • SPACE：源站卸载，当前仅白名单开放；
  • LB：负载均衡，当前仅白名单开放。
    		•
    Origin String 是 源站地址，根据 OriginType 的取值分为以下情况：
  • 当 OriginType = IP_DOMAIN 时，该参数请填写 IPv4、IPv6 地址或域名；
  • 当 OriginType = COS 时，该参数请填写 COS 桶的访问域名；
  • 当 OriginType = AWS_S3，该参数请填写 S3 桶的访问域名；
  • 当 OriginType = ORIGIN_GROUP 时，该参数请填写源站组 ID；
  • 当 OriginType = VOD 时，该参数请填写云点播应用 ID ；
  • 当 OriginType = LB 时，该参数请填写负载均衡实例 ID，该功能当前仅白名单开放；
  • 当 OriginType = SPACE 时，该参数请填写源站卸载空间 ID，该功能当前仅白名单开放。
    		•
    BackupOrigin String 否 备用源站组 ID，该参数仅在 OriginType = ORIGIN_GROUP 时生效，该字段为旧版能力，调用后控制台无法进行配置修改，如需使用请提交工单咨询。
    PrivateAccess String 否 指定是否允许访问私有对象存储源站，该参数仅当源站类型 OriginType = COS 或 AWS_S3 时会生效，取值有：
  • on：使用私有鉴权；
  • off：不使用私有鉴权。

    • 不填写时，默认值为off。
    PrivateParameters Array of PrivateParameter 否 私有鉴权使用参数，该参数仅当源站类型 PrivateAccess = on 时会生效。
    HostHeader String 否 自定义回源 HOST 头，该参数仅当 OriginType=IP_DOMAIN 时生效。
    如果 OriginType=COS 或 AWS_S3 时，回源 HOST 头将与源站域名保持一致。
    如果OriginType=ORIGIN_GROUP 时，回源 HOST 头遵循源站组内配置，如果没有配置则默认为加速域名。
    如果 OriginType=VOD 或 SPACE 时，无需配置该头部，按对应的回源域名生效。
    VodOriginScope String 否 云点播回源范围，该参数当 OriginType = VOD 时生效。取值有：
  • all：当前源站对应的云点播应用内所有文件，默认值为 all；
  • bucket：当前源站对应的云点播应用下指定某一个存储桶内的文件。通过参数 VodBucketId 来指定存储桶。
    		•
    VodBucketId String 否 VOD 存储桶 ID，该参数当 OriginType = VOD 且 VodOriginScope = bucket 时必填。数据来源：云点播专业版应用下存储桶的存储 ID 。

    OriginPrivateParameters

    对象存储源站私有鉴权参数。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    AccessKeyId String 是 鉴权参数 Access Key ID。
    SecretAccessKey String 是 鉴权参数 Secret Access Key。
    SignatureVersion String 是 鉴权版本。取值有：
  • v2：v2版本；
  • v4：v4版本。
    		•
    Region String 否 存储桶地域。

    OriginProtectionInfo

    源站防护信息

    被如下接口引用：DescribeOriginProtection。

    名称 类型 描述
    ZoneId String 站点ID。
    Hosts Array of String 域名列表。
    ProxyIds Array of String 代理ID列表。
    CurrentIPWhitelist IPWhitelist 当前版本的IP白名单。
    注意：此字段可能返回 null，表示取不到有效值。
    NeedUpdate Boolean 该站点是否需要更新源站白名单，取值有：
  • true ：需要更新IP白名单 ；
  • false ：无需更新IP白名单。
    		•
    Status String 源站防护状态，取值有：
  • online ：源站防护启用中 ；
  • offline ：源站防护已停用 ；
  • nonactivate ：源站防护未激活，仅在从未使用过源站防护功能的站点调用中返回。
    		•
    PlanSupport Boolean 站点套餐是否支持源站防护，取值有：
  • true ：支持 ；
  • false ：不支持。
    		•
    DiffIPWhitelist DiffIPWhitelist 最新IP白名单与当前IP白名单的对比。
    注意：此字段可能返回 null，表示取不到有效值。

    OriginPullProtocolParameters

    回源 HTTPS 配置参数。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    Protocol String 否 回源协议配置，取值有：
  • http：使用 HTTP 协议回源；
  • https：使用 HTTPS 协议回源；
  • follow：协议跟随。
    		•

    OriginRecord

    源站组记录

    被如下接口引用：CreateOriginGroup, DescribeOriginGroup, ModifyOriginGroup。

    名称 类型 必选 描述
    Record String 是 源站记录值，不包含端口信息，可以为：IPv4，IPv6，域名格式。
    Type String 否 源站类型，取值有：
  • IP_DOMAIN：IPV4、IPV6、域名类型源站；
  • COS：COS源。
  • AWS_S3：AWS S3对象存储源站。
    		•
    RecordId String 否 源站记录ID。
    Weight Integer 否 【源站权重】：用于控制流量分配优先级的参数，取值范围：0-100（整数）：
  • 空值：不设置权重，系统按默认策略调度；
  • 0 值：明确设置权重为0，流量将不会分配到该源站，注意事项：必须确保至少有一个源站的权重值大于0；
  • 正常值：数值越大分配流量越多 ；

    • 注意：此字段可能返回 null，表示取不到有效值。
    Private Boolean 否 是否私有鉴权，当源站类型 RecordType=COS/AWS_S3 时生效，取值有：
  • true：使用私有鉴权；
  • false：不使用私有鉴权。
    • 不填写，默认值为：false。
    PrivateParameters Array of PrivateParameter 否 私有鉴权参数，当源站类型Private=true时有效。

    OwnershipVerification

    该结构体表示各种场景、模式下，用于验证用户对站点域名的归属权内容。

    被如下接口引用：CreateAccelerationDomain, CreateZone, DescribeAccelerationDomains, DescribeZones。

    名称 类型 描述
    DnsVerification DnsVerification CNAME 、无域名接入时，使用 DNS 解析验证时所需的信息。详情参考 站点/域名归属权验证
    。
    注意：此字段可能返回 null，表示取不到有效值。
    FileVerification FileVerification CNAME 、无域名接入时，使用文件验证时所需的信息。详情参考 站点/域名归属权验证
    。
    注意：此字段可能返回 null，表示取不到有效值。
    NsVerification NsVerification NS 接入，切换 DNS 服务器所需的信息。详情参考 修改 DNS 服务器。
    注意：此字段可能返回 null，表示取不到有效值。

    PartialModule

    例外规则的详细模块配置。

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    Module String 否 模块名称，取值为：
  • managed-rule：托管规则 Id；
  • managed-group：托管规则组；
  • waf：待废弃，托管规则。
    		•
    Include Array of Integer 否 模块下的需要例外的具体规则ID列表。

    Plan

    套餐信息

    被如下接口引用：DescribePlans。

    名称 类型 描述
    PlanType String 套餐类型。取值有：
  • plan-trial: 试用版套餐；
  • plan-personal: 个人版套餐；
  • plan-basic: 基础版套餐；
  • plan-standard: 标准版套餐；
  • plan-enterprise-v2: 企业版套餐；
  • plan-enterprise-model-a: 企业版 Model A 套餐。
  • plan-enterprise: 旧企业版套餐。
    		•
    PlanId String 套餐 ID。形如 edgeone-2y041pblwaxe。
    Area String 服务区域，取值有：
  • mainland: 中国大陆；
  • overseas: 全球（不包括中国大陆）；
  • global: 全球（包括中国大陆）。
    		•
    AutoRenewal Boolean 自动续费开关。取值有：
  • true: 已开启自动续费；
  • false: 未开启自动续费。
    		•
    Status String 套餐状态，取值有：
  • normal：正常状态；
  • expiring-soon：即将到期状态；
  • expired：到期状态；
  • isolated：隔离状态；
  • overdue-isolated：欠费隔离状态。
    		•
    PayMode Integer 付费类型，取值有：
  • 0: 后付费；
  • 1: 预付费。
    		•
    ZonesInfo Array of ZoneInfo 套餐绑定的站点信息，包括站点id和站点名称，站点状态。
    SmartRequestCapacity Integer 套餐内智能加速请求数规格，单位：次。
    VAUCapacity Integer 套餐内VAU规格，单位：个。
    AccTrafficCapacity Integer 套餐内内容加速流量规格，单位：字节。
    SmartTrafficCapacity Integer 套餐内智能加速流量规格，单位：字节。
    DDoSTrafficCapacity Integer 套餐内DDoS防护流量规格，单位：字节。
    SecTrafficCapacity Integer 套餐内安全流量规格，单位：字节。
    SecRequestCapacity Integer 套餐内安全请求数规格，单位：次。
    L4TrafficCapacity Integer 套餐内四层加速流量规格，单位：字节。
    CrossMLCTrafficCapacity Integer 套餐内中国大陆网络优化流量规格，单位：字节。
    Bindable String 套餐是否允许绑定新站点，取值有：
  • true: 允许绑定新站点；
  • false: 不允许绑定新站点。
    		•
    EnabledTime Timestamp ISO8601 套餐生效时间。
    ExpiredTime Timestamp ISO8601 套餐过期时间。
    Features Array of String 套餐所支持的功能，取值有：
  • ContentAcceleration：内容加速功能；
  • SmartAcceleration：智能加速功能；
  • L4：四层加速功能；
  • Waf：高级 Web 防护；
  • QUIC：QUIC功能；
  • CrossMLC：中国大陆网络优化功能；
  • ProcessMedia：媒体处理功能；
  • L4DDoS：四层DDoS防护功能；
    • L7DDoS功能只会出现以下所有规格中的一项
  • L7DDoS.CM30G；七层DDoS防护功能-中国大陆30G保底带宽规格；
  • L7DDoS.CM60G；七层DDoS防护功能-中国大陆60G保底带宽规格；
  • L7DDoS.CM100G；七层DDoS防护功能-中国大陆100G保底带宽规格；
  • L7DDoS.Anycast300G；七层DDoS防护功能-中国大陆以外Anycast300G保底带宽规格；
  • L7DDoS.AnycastUnlimited；七层DDoS防护功能-中国大陆以外Anycast无上限全力防护规格；
  • L7DDoS.CM30G_Anycast300G；七层DDoS防护功能-中国大陆30G保底带宽规格，中国大陆以外Anycast300G保底带宽规格；
  • L7DDoS.CM60G_Anycast300G；七层DDoS防护功能-中国大陆60G保底带宽规格，中国大陆以外Anycast300G保底带宽规格；
  • L7DDoS.CM100G_Anycast300G；七层DDoS防护功能-中国大陆100G保底带宽规格，中国大陆以外Anycast300G保底带宽规格；
  • L7DDoS.CM30G_AnycastUnlimited；七层DDoS防护功能-中国大陆30G保底带宽规格，中国大陆以外Anycast无上限全力防护规格；
  • L7DDoS.CM60G_AnycastUnlimited；七层DDoS防护功能-中国大陆60G保底带宽规格，中国大陆以外Anycast无上限全力防护规格；
  • L7DDoS.CM100G_AnycastUnlimited；七层DDoS防护功能-中国大陆100G保底带宽规格，中国大陆以外Anycast无上限全力防护规格；
    		•

    PlanInfo

    edgeone套餐信息

    被如下接口引用：DescribeAvailablePlans。

    名称 类型 描述
    Currency String 结算货币类型，取值有：
  • CNY ：人民币结算；
  • USD ：美元结算。
    		•
    Flux Integer 套餐所含流量，该流量数值为安全加速流量，内容加速流量和智能加速流量的总和（单位：字节）。
    Frequency String 结算周期，取值有：
  • y ：按年结算；
  • m ：按月结算；
  • h ：按小时结算；
  • M ：按分钟结算；
  • s ：按秒结算。
    • PlanType String 套餐类型，取值有：
  • sta ：全球内容分发网络（不包括中国大陆）标准版套餐；
  • sta_with_bot ：全球内容分发网络（不包括中国大陆）标准版套餐附带bot管理；
  • sta_cm ：中国大陆内容分发网络标准版套餐；
  • sta_cm_with_bot ：中国大陆内容分发网络标准版套餐附带bot管理；
  • sta_global ：全球内容分发网络（包括中国大陆）标准版套餐；
  • sta_global_with_bot ：全球内容分发网络（包括中国大陆）标准版套餐附带bot管理；
  • ent ：全球内容分发网络（不包括中国大陆）企业版套餐；
  • ent_with_bot ： 全球内容分发网络（不包括中国大陆）企业版套餐附带bot管理；
  • ent_cm ：中国大陆内容分发网络企业版套餐；
  • ent_cm_with_bot ：中国大陆内容分发网络企业版套餐附带bot管理；
  • ent_global ：全球内容分发网络（包括中国大陆）企业版套餐；
  • ent_global_with_bot ：全球内容分发网络（包括中国大陆）企业版套餐附带bot管理。
    		•
    Price Float 套餐价格（单位：分）。
    Request Integer 套餐所含请求次数，该请求次数为安全加速请求次数。（单位：次）。
    SiteNumber Integer 套餐所能绑定的站点个数。
    Area String 套餐加速区域类型，取值有：
  • mainland ：中国大陆；
  • overseas ：全球（不包括中国大陆）；
  • global ：全球（包括中国大陆）。

    • PostMaxSize

    POST请求上传文件流式传输最大限制

    被如下接口引用：DescribeZoneSetting, ModifyZoneSetting。

    名称 类型 必选 描述
    Switch String 是 是否开启 POST 请求上传文件限制，平台默认为限制为32MB，取值有：
  • on：开启限制；
  • off：关闭限制。
    		•
    MaxSize Integer 否 最大限制，该字段仅在 Switch 为 on 时生效，取值在 1MB 和 800MB 之间，单位字节。

    PostMaxSizeParameters

    POST 请求上传文件流式传输最大限制。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting。

    名称 类型 必选 描述
    Switch String 否 是否开启 POST 请求上传文件限制，单位为 Byte，平台默认为限制为 32 * 220 Byte，取值有：
  • on：开启限制；
  • off：关闭限制。
    		•
    MaxSize Integer 否 POST 请求上传文件流式传输最大限制，该字段仅在 Switch 为 on 时生效，取值在 1MB 和 800MB 之间，单位字节。

    PrepaidPlanParam

    预付费套餐计费参数

    被如下接口引用：CreatePlan。

    名称 类型 必选 描述
    Period Integer 否 订阅预付费套餐的周期，单位：月，取值有：1，2，3，4，5，6，7，8，9，10，11，12，24，36。

    不填写使用默认值 1。
    RenewFlag String 否 预付费套餐的自动续费标志，取值有：
  • on：开启自动续费；
  • off：不开启自动续费。

    • 不填写使用默认值 off，自动续费时，默认续费1个月。

    PrivateParameter

    对象存储源站私有鉴权参数

    被如下接口引用：CreateAccelerationDomain, CreateOriginGroup, DescribeAccelerationDomains, DescribeOriginGroup, ModifyAccelerationDomain, ModifyOriginGroup。

    名称 类型 必选 描述
    Name String 是 私有鉴权参数名称，取值有：
  • AccessKeyId：鉴权参数 Access Key ID；
  • SecretAccessKey：鉴权参数 Secret Access Key；
  • SignatureVersion：鉴权版本，v2 或者 v4；
  • Region：存储桶地域。
    		•
    Value String 是 私有鉴权参数值。

    QUICParameters

    QUIC 配置项。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting。

    名称 类型 必选 描述
    Switch String 否 QUIC 配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•

    QueryCondition

    查询条件

    被如下接口引用：CreateRealtimeLogDeliveryTask, DescribeOverviewL7Data, DescribeTimingL4Data, DescribeTimingL7AnalysisData, DescribeTimingL7CacheData, DescribeTimingL7OriginPullData, DescribeTopL7AnalysisData, DescribeTopL7CacheData, ModifyRealtimeLogDeliveryTask。

    名称 类型 必选 描述
    Key String 是 筛选条件的key。
    Operator String 是 查询条件操作符，操作类型有：
  • equals: 等于；
  • notEquals: 不等于；
  • include: 包含；
  • notInclude: 不包含;
  • startWith: 开始的值是value；
  • notStartWith: 不以value的值开始；
  • endWith: 结尾是value值；
  • notEndWith: 不以value的值结尾。
    		•
    Value Array of String 是 筛选条件的值。

    QueryString

    CacheKey中包含请求参数

    被如下接口引用：DescribeHostsSetting, ModifyZoneSetting。

    名称 类型 必选 描述
    Switch String 是 CacheKey是否由QueryString组成，取值有：
  • on：是；
  • off：否。
    		•
    Action String 否 CacheKey使用QueryString的方式，取值有：
  • includeCustom：使用部分url参数；
  • excludeCustom：排除部分url参数。
    		•
    Value Array of String 否 使用/排除的url参数数组。

    Quic

    Quic配置项

    被如下接口引用：DescribeZoneSetting, ModifyZoneSetting。

    名称 类型 必选 描述
    Switch String 是 是否开启 Quic 配置，取值有：
  • on：开启；
  • off：关闭。
    		•

    Quota

    刷新/预热 可用量及配额

    被如下接口引用：DescribeContentQuota。

    名称 类型 描述
    Batch Integer 单次批量提交配额上限。
    Daily Integer 每日提交配额上限。
    DailyAvailable Integer 每日剩余的可提交配额。
    Type String 刷新预热缓存类型，取值有：
  • purge_prefix：按前缀刷新；
  • purge_url：按URL刷新；
  • purge_host：按Hostname刷新；
  • purge_all：刷新全部缓存内容；
  • purge_cache_tag：按CacheTag刷新；
  • prefetch_url：按URL预热。
    		•

    RangeOriginPullParameters

    分片回源配置参数。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    Switch String 否 分片回源开关，取值有：
  • on：开启；
  • off：关闭。
    		•

    RateLimitConfig

    速率限制规则

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    Switch String 是 开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    RateLimitUserRules Array of RateLimitUserRule 否 速率限制-用户规则列表。如果为null，默认使用历史配置。
    RateLimitTemplate RateLimitTemplate 否 速率限制模板功能。如果为null，默认使用历史配置。
    RateLimitIntelligence RateLimitIntelligence 否 智能客户端过滤。如果为null，默认使用历史配置。
    RateLimitCustomizes Array of RateLimitUserRule 否 速率限制-托管定制规则。如果为null，默认使用历史配置。

    RateLimitIntelligence

    智能客户端过滤

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    Switch String 是 功能开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    Action String 是 执行动作，取值有：
  • monitor：观察；
  • alg：挑战。
    		•
    RuleId Integer 否 规则id，仅出参使用。

    RateLimitTemplate

    速率限制模板

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    Mode String 是 模板等级名称，取值有：
  • sup_loose：超级宽松；
  • loose：宽松；
  • emergency：紧急；
  • normal：适中；
  • strict：严格；
  • close：关闭，仅精准速率限制生效。
    		•
    Action String 否 模板处置方式，取值有：
  • alg：JavaScript挑战；
  • monitor：观察。
    • 不填写默认取alg。
    RateLimitTemplateDetail RateLimitTemplateDetail 否 模板值详情。仅出参返回。

    RateLimitTemplateDetail

    模板当前详细配置

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    Mode String 是 模板等级名称，取值有：
  • sup_loose：超级宽松；
  • loose：宽松；
  • emergency：紧急；
  • normal：适中；
  • strict：严格；
  • close：关闭，仅精准速率限制生效。
    		•
    ID Integer 是 唯一id。
    Action String 是 模板处置方式，取值有：
  • alg：JavaScript挑战；
  • monitor：观察。
    		•
    PunishTime Integer 是 惩罚时间，取值范围0-2天，单位秒。
    Threshold Integer 是 统计阈值，单位是次，取值范围0-4294967294。
    Period Integer 是 统计周期，取值范围0-120秒。

    RateLimitUserRule

    RateLimit规则

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    Threshold Integer 是 速率限制统计阈值，单位是次，取值范围0-4294967294。
    Period Integer 是 速率限制统计时间，取值范围 10/20/30/40/50/60 单位是秒。
    RuleName String 是 规则名，只能以英文字符，数字，下划线组合，且不能以下划线开头。
    Action String 是 处置动作，取值有：
  • monitor：观察；
  • drop：拦截；
  • redirect：重定向；
  • page：指定页面；
  • alg：JavaScript 挑战。
    		•
    PunishTime Integer 是 惩罚时长，0-2天。
    PunishTimeUnit String 是 处罚时长单位，取值有：
  • second：秒；
  • minutes：分钟；
  • hour：小时。
    		•
    RuleStatus String 是 规则状态，取值有：
  • on：生效；
  • off：不生效。
    • 默认 on 生效。
    AclConditions Array of AclCondition 是 规则详情。
    RulePriority Integer 是 规则权重，取值范围0-100。
    RuleID Integer 否 规则 Id。仅出参使用。
    FreqFields Array of String 否 过滤词，取值有：
  • sip：客户端 ip。

    • 默认为空字符串。
    UpdateTime String 否 更新时间。仅出参使用。修改时默认为当前时间。
    FreqScope Array of String 否 统计范围。取值有：
  • source_to_eo：（响应）源站到 EdgeOne；
  • client_to_eo：（请求）客户端到 EdgeOne。

    • 默认为 source_to_eo。
    Name String 否 自定义返回页面的名称。Action 是 page 时必填，且不能为空。
    CustomResponseId String 否 自定义响应 Id。该 Id 可通过查询自定义错误页列表接口获取。默认值为default，使用系统默认页面。Action 是 page 时必填，且不能为空。
    ResponseCode Integer 否 自定义返回页面的响应码。Action 是 page 时必填，且不能为空，取值: 100~600，不支持 3xx 响应码。默认值：567。
    RedirectUrl String 否 重定向时候的地址。Action 是 redirect 时必填，且不能为空。

    RateLimitingRule

    速率限制的具体配置。

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    Id String 否 精准速率限制的 ID。
    通过规则 ID 可支持不同的规则配置操作：
  • 增加新规则：ID 为空或不指定 ID 参数；
  • 修改已有规则：指定需要更新/修改的规则 ID；
  • 删除已有规则：RateLimitingRules 参数中，Rules 列表中未包含的已有规则将被删除。
    		•
    Name String 否 精准速率限制的名称。
    Condition String 否 精准速率限制的具体内容，需符合表达式语法，详细规范参见产品文档。
    CountBy Array of String 否 速率阈值请求特征的匹配方式， 当 Enabled 为 on 时，此字段必填。

    当条件有多个时，将组合多个条件共同进行统计计算，条件最多不可超过5条。取值有：
  • http.request.ip：客户端 IP；
  • http.request.xff_header_ip：客户端 IP（优先匹配 XFF 头部）；
  • http.request.uri.path：请求的访问路径；
  • http.request.cookies['session']：名称为session的Cookie，其中session可替换为自己指定的参数；
  • http.request.headers['user-agent']：名称为user-agent的HTTP头部，其中user-agent可替换为自己指定的参数；
  • http.request.ja3：请求的JA3指纹；
  • http.request.uri.query['test']：名称为test的URL查询参数，其中test可替换为自己指定的参数。
    		•
    MaxRequestThreshold Integer 否 精准速率限制在时间范围内的累计拦截次数，取值范围 1 ~ 100000。
    CountingPeriod String 否 统计的时间窗口，取值有：
  • 1s：1秒；
  • 5s：5秒；
  • 10s：10秒；
  • 20s：20秒；
  • 30s：30秒；
  • 40s：40秒；
  • 50s：50秒；
  • 1m：1分钟；
  • 2m：2分钟；
  • 5m：5分钟；
  • 10m：10分钟；
  • 1h：1小时。
    		•
    ActionDuration String 否 Action 动作的持续时长，单位仅支持：
  • s：秒，取值 1 ~ 120；
  • m：分钟，取值 1 ~ 120；
  • h：小时，取值 1 ~ 48；
  • d：天，取值 1 ~ 30。
    		•
    Action SecurityAction 否 精准速率限制的处置方式。取值有：
  • Monitor：观察；
  • Deny：拦截，其中DenyActionParameters.Name支持Deny和ReturnCustomPage；
  • Challenge：挑战，其中ChallengeActionParameters.Name支持JSChallenge和ManagedChallenge；
  • Redirect：重定向至URL；
    		•
    Priority Integer 否 精准速率限制的优先级，范围是 0 ~ 100，默认为 0。
    Enabled String 否 精准速率限制规则是否开启。取值有：
  • on：开启；
  • off：关闭。
    		•

    RateLimitingRules

    精准速率限制的配置

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    Rules Array of RateLimitingRule 否 精准速率限制的定义列表。使用 ModifySecurityPolicy 修改 Web 防护配置时:
  • 若未指定 Rules 参数，或 Rules 参数长度为零：清空所有精准速率限制配置。
  • 若 SecurityPolicy 参数中，未指定 RateLimitingRules 参数值：保持已有自定义规则配置，不做修改。
    		•

    RealtimeLogDeliveryTask

    实时日志投递任务。

    被如下接口引用：DescribeRealtimeLogDeliveryTasks。

    名称 类型 描述
    TaskId String 实时日志投递任务 ID。
    TaskName String 实时日志投递任务的名称。
    DeliveryStatus String 实时日志投递任务的状态，取值有：
  • enabled: 已启用；
  • disabled: 已停用；
  • deleted: 异常删除状态，请检查目的地腾讯云 CLS 日志集/日志主题是否已被删除。
    		•
    TaskType String 实时日志投递任务类型，取值有：
  • cls: 推送到腾讯云 CLS；
  • custom_endpoint：推送到自定义 HTTP(S) 地址；
  • s3：推送到 AWS S3 兼容存储桶地址。
    		•
    EntityList Array of String 实时日志投递任务对应的实体（七层域名或者四层代理实例）列表。取值示例如下：
  • 七层域名：domain.example.com；
  • 四层代理实例：sid-2s69eb5wcms7。
    		•
    LogType String 数据投递类型，取值有：
  • domain：站点加速日志；
  • application：四层代理日志；
  • web-rateLiming：速率限制和 CC 攻击防护日志；
  • web-attack：托管规则日志；
  • web-rule：自定义规则日志；
  • web-bot：Bot管理日志。
    		•
    Area String 数据投递区域，取值有：
  • mainland：中国大陆境内；
  • overseas：全球（不含中国大陆）。
    		•
    Fields Array of String 投递的预设字段列表。
    CustomFields Array of CustomField 投递的自定义字段列表。
    DeliveryConditions Array of DeliveryCondition 日志投递的过滤条件。
    Sample Integer 采样比例，采用千分制，取值范围为1-1000，例如：605 表示采样比例为 60.5%。
    LogFormat LogFormat 日志投递的输出格式。出参为 null 时表示为默认格式，默认格式逻辑如下：
  • 当 TaskType 取值为 custom_endpoint 时，默认格式为多个 JSON 对象组成的数组，每个 JSON 对象为一条日志；
  • 当 TaskType 取值为 s3 时，默认格式为 JSON Lines。

    • 注意：此字段可能返回 null，表示取不到有效值。
    CLS CLSTopic CLS 的配置信息。
    注意：此字段可能返回 null，表示取不到有效值。
    CustomEndpoint CustomEndpoint 自定义 HTTP 服务的配置信息。
    注意：此字段可能返回 null，表示取不到有效值。
    S3 S3 AWS S3 兼容存储桶的配置信息。
    注意：此字段可能返回 null，表示取不到有效值。
    CreateTime Timestamp ISO8601 创建时间。
    UpdateTime Timestamp ISO8601 更新时间。

    RedirectActionParameters

    Web安全重定向的附加参数

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    URL String 是 重定向的URL。

    RenewFlag

    预付费套餐自动续费配置项。

    被如下接口引用：ModifyPlan。

    名称 类型 必选 描述
    Switch String 是 预付费套餐的自动续费标志，取值有：
  • on：开启自动续费；
  • off：不开启自动续费。
    		•

    RequestBodyTransferTimeout

    正文传输超时时长的具体配置。

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    IdleTimeout String 是 正文传输超时时长，取值 5 ~ 120，单位仅支持秒（s）。
    Enabled String 是 正文传输超时时长是否开启。取值有：
  • on：开启；
  • off：关闭。
    		•

    RequestFieldsForException

    例外规则中的跳过字段配置

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    Scope String 是 跳过的具体字段。取值支持：

  • body.json：JSON 请求内容；此时 Condition 支持 key、value, TargetField 支持 key、value，例如 { "Scope": "body.json", "Condition": "", "TargetField": "key" }，表示 JSON 请求内容所有参数跳过 WAF 扫描；

  • cookie：Cookie；此时 Condition 支持 key、value, TargetField 支持 key、value，例如 { "Scope": "cookie", "Condition": "${key} in ['account-id'] and ${value} like ['prefix-']", "TargetField": "value" }，表示 Cookie 参数名称等于account-id 并且参数值通配符匹配 prefix- 跳过 WAF 扫描；

  • header：HTTP 头部参数；此时 Condition 支持 key、value, TargetField 支持 key、value，例如 { "Scope": "header", "Condition": "${key} like ['x-auth-']", "TargetField": "value" }，表示 header 参数名称通配符匹配 x-auth- 跳过 WAF 扫描；

  • uri.query：URL 编码内容/查询参数；此时 Condition 支持 key、value, TargetField 支持 key、value，例如 { "Scope": "uri.query", "Condition": "${key} in ['action'] and ${value} in ['upload', 'delete']", "TargetField": "value" }，表示 URL 编码内容/查询参数的参数名称等于 action 并且参数值等于 upload 或 delete 跳过 WAF 扫描；

  • uri：请求路径URI；此时 Condition 必须为空， TargetField 支持 query、path、fullpath，例如 { "Scope": "uri", "Condition": "", "TargetField": "query" }，表示请求路径 URI 仅查询参数跳过 WAF 扫描；

  • body：请求正文内容。此时 Condition 必须为空， TargetField 支持 fullbody、multipart，例如 { "Scope": "body", "Condition": "", "TargetField": "fullbody" }，表示请求正文内容为完整请求正文跳过 WAF 扫描；
    		•
    Condition String 是 跳过的具体字段的表达式，需要符合表达式语法。

    Condition 支持表达式配置语法：
  • 按规则的匹配条件表达式语法编写，支持引用 key、value。
  • 支持 in、like 操作符，以及 and 逻辑组合。

    • 例如：
  • ${key} in ['x-trace-id']：参数名称等于x-trace-id。
  • ${key} in ['x-trace-id'] and ${value} like ['Bearer *']：参数名称等于x-trace-id并且参数值通配符匹配Bearer *。
    		•
    TargetField String 是 Scope 参数使用不同取值时，TargetField 表达式中支持的值如下：
  • body.json：支持 key、value
  • cookie：支持 key、value
  • header：支持 key、value
  • uri.query：支持 key、value
  • uri：支持 path、query、fullpath
  • body：支持 fullbody、multipart
    		•

    Resource

    计费资源

    被如下接口引用：DescribeZones。

    名称 类型 描述
    Id String 资源 ID。
    PayMode Integer 付费模式，取值有：
  • 0：后付费。
    		•
    CreateTime Timestamp ISO8601 创建时间。
    EnableTime Timestamp ISO8601 生效时间。
    ExpireTime Timestamp ISO8601 失效时间。
    Status String 套餐状态，取值有：
  • normal：正常；
  • isolated：隔离；
  • destroyed：销毁。
    		•
    Sv Array of Sv 询价参数。
    AutoRenewFlag Integer 是否自动续费，取值有：
  • 0：默认状态；
  • 1：自动续费；
  • 2：不自动续费。
    		•
    PlanId String 套餐关联资源 ID。
    Area String 地域，取值有：
  • mainland：中国大陆境内；
  • overseas：中国大陆境外。
  • global：全球。
    		•
    Group String 资源类型，取值有：
  • plan：套餐类型；
  • pay-as-you-go：后付费类型。
  • value-added：增值服务类型。

    • 注意：此字段可能返回 null，表示取不到有效值。
    ZoneNumber Integer 当前资源绑定的站点数量。
    注意：此字段可能返回 null，表示取不到有效值。
    Type String 资源标记类型，取值有：
  • vodeo：vodeo资源。
    		•

    ResponseSpeedLimitParameters

    单连接下载限速配置参数。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    Mode String 是 下载限速模式，取值有：
  • LimitUponDownload：全过程下载限速；
  • LimitAfterSpecificBytesDownloaded：全速下载特定字节后开始限速；
  • LimitAfterSpecificSecondsDownloaded：全速下载特定时间后开始限速。
    		•
    MaxSpeed String 是 限速值，指定限速大小，填写含单位的数值或变量。当前支持单位有：KB/s。
    StartAt String 否 限速开始值，可以为下载大小或指定时长，填写含单位的数值或变量，指定下载大小或指定时长。

    - 当Mode 取值为 LimitAfterSpecificBytesDownloaded 时，单位取值有： KB；

    - 当Mode 取值为 LimitAfterSpecificSecondsDownloaded 时，单位取值有： s。

    ReturnCustomPageActionParameters

    Web安全自定义页面的附加参数

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    ResponseCode String 是 响应状态码。
    ErrorPageId String 是 响应的自定义页面ID。

    RewriteAction

    规则引擎HTTP请求头/响应头类型的动作

    被如下接口引用：CreateRule, DescribeRules, ModifyRule。

    名称 类型 必选 描述
    Action String 是 功能名称，功能名称填写规范可调用接口 查询规则引擎的设置参数 查看。
    Parameters Array of RuleRewriteActionParams 是 参数。

    Rule

    规则引擎规则项，Conditions 数组内多个项的关系为 或，内层 Conditions 列表内多个项的关系为 且。

    被如下接口引用：CreateRule, DescribeRules, ModifyRule。

    名称 类型 必选 描述
    Conditions Array of RuleAndConditions 是 执行功能判断条件。
    注意：满足该数组内任意一项条件，功能即可执行。
    Actions Array of Action 否 执行的功能。注意：Actions 和 SubRules 不可都为空
    SubRules Array of SubRuleItem 否 嵌套规则。注意：SubRules 和 Actions 不可都为空

    RuleAndConditions

    规则引擎条件且关系条件列表

    被如下接口引用：CreateRule, DescribeRules, ModifyRule。

    名称 类型 必选 描述
    Conditions Array of RuleCondition 是 规则引擎条件，该数组内所有项全部满足即判断该条件满足。

    RuleBranch

    子规则分支。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    Condition String 否 匹配条件。
    Actions Array of RuleEngineAction 否 操作。
    注意：Actions 和 SubRules 不可同时为空。
    注意：此字段可能返回 null，表示取不到有效值。
    SubRules Array of RuleEngineSubRule 否 子规则列表。此列表中时存在多条规则，按照从上往下的顺序依次执行。
    注意：SubRules 和 Actions 不可同时为空。且当前只支持填写一层 SubRules。
    注意：此字段可能返回 null，表示取不到有效值。

    RuleChoicePropertiesItem

    规则引擎可应用于匹配请求的设置详细信息，可选参数配置项

    被如下接口引用：DescribeRulesSetting。

    名称 类型 描述
    Name String 参数名称。
    Type String 参数值类型。
  • CHOICE：参数值只能在 ChoicesValue 中选择；
  • TOGGLE：参数值为开关类型，可在 ChoicesValue 中选择；
  • CUSTOM_NUM：参数值用户自定义，整型类型；
  • CUSTOM_STRING：参数值用户自定义，字符串类型。
    		•
    ChoicesValue Array of String 参数值的可选值。
    注意：若参数值为用户自定义则该数组为空数组。
    Min Integer 数值参数的最小值，非数值参数或 Min 和 Max 值都为 0 则此项无意义。
    Max Integer 数值参数的最大值，非数值参数或 Min 和 Max 值都为 0 则此项无意义。
    IsMultiple Boolean 参数值是否支持多选或者填写多个。
    IsAllowEmpty Boolean 是否允许为空。
    ExtraParameter RuleExtraParameter 特殊参数。
  • 为 NULL：RuleAction 选择 NormalAction；
  • 成员参数 Id 为 Action：RuleAction 选择 RewirteAction；
  • 成员参数 Id 为 StatusCode：RuleAction 选择 CodeAction。
    		•

    RuleCodeActionParams

    规则引擎条件使用StatusCode字段动作参数

    被如下接口引用：CreateRule, DescribeRules, ModifyRule。

    名称 类型 必选 描述
    StatusCode Integer 是 状态 Code。
    Name String 是 参数名称，参数填写规范可调用接口 查询规则引擎的设置参数 查看。
    Values Array of String 是 参数值。

    RuleCondition

    规则引擎条件参数

    被如下接口引用：CreateFunctionRule, CreateRule, DescribeRules, ModifyFunctionRule, ModifyRule。

    名称 类型 必选 描述
    Operator String 是 运算符，取值有：
  • equal: 等于；
  • notequal: 不等于；
  • exist: 存在；
  • notexist: 不存在。
    		•
    Target String 是 匹配类型，取值有：
  • filename：文件名；
  • extension：文件后缀；
  • host：HOST；
  • full_url：URL Full，当前站点下完整 URL 路径，必须包含 HTTP 协议，Host 和 路径；
  • url：URL Path，当前站点下 URL 路径的请求；
  • client_country：客户端国家/地区；
  • query_string：查询字符串，当前站点下请求 URL 的查询字符串；
  • request_header：HTTP 请求头部。
  • client_ip：客户端 IP。
  • request_protocol：请求协议。
  • request_method：HTTP 请求方法。
    • Values Array of String 否 对应匹配类型的参数值，仅在匹配类型为查询字符串或HTTP请求头并且运算符取值为存在或不存在时允许传空数组，对应匹配类型有：
  • 文件后缀：jpg、txt 等文件后缀；
  • 文件名称：例如 foo.jpg 中的 foo；
  • 全部（站点任意请求）：all；
  • HOST：当前站点下的 host ，例如www.maxx55.com；
  • URL Path：当前站点下 URL 路径的请求，例如：/example；
  • URL Full：当前站点下完整 URL 请求，必须包含 HTTP 协议，Host 和 路径，例如：https://www.maxx55.cn/example；
  • 客户端国家/地区：符合 ISO3166 标准的国家/地区标识；
  • 查询字符串: 当前站点下 URL 请求中查询字符串的参数值，例如 lang=cn&version=1 中的 cn 和 1；
  • HTTP 请求头: HTTP 请求头部字段值，例如 Accept-Language:zh-CN,zh;q=0.9中的zh-CN,zh;q=0.9 ；
  • 客户端 IP: 当前请求携带的客户端请求 IP，支持 IPv4/IPv6, 支持 IP 段；
  • 请求协议: 当前请求的协议，取值范围为：HTTP、HTTPS；
  • HTTP 请求方法: 当前请求的方法，取值范围为：GET、HEAD、POST、PUT、DELETE、TRACE、CONNECT、OPTIONS、PATCH、COPY、LOCK、MKCOL、MOVE、PROPFIND、PROPPATCH、UNLOCK。
    • IgnoreCase Boolean 否 是否忽略参数值的大小写，默认值为 false。
    Name String 否 对应匹配类型的参数名称，在 Target 值为以下取值时有效，有效时值不能为空：
  • query_string（查询字符串）: 当前站点下URL请求中查询字符串的参数名称，例如lang=cn&version=1中的lang和version；
  • request_header（HTTP 请求头）: HTTP请求头部字段名，例如Accept-Language:zh-CN,zh;q=0.9中的Accept-Language。

    • RuleEngineAction

    规则引擎操作。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    Name String 是 操作名称。名称需要与参数结构体对应，例如 Name=Cache，则 CacheParameters 必填。
  • Cache：节点缓存 TTL；
  • CacheKey：自定义 Cache Key；
  • CachePrefresh：缓存预刷新；
  • AccessURLRedirect：访问 URL 重定向；
  • UpstreamURLRewrite：回源 URL 重写；
  • QUIC：QUIC；
  • WebSocket：WebSocket；
  • Authentication：Token 鉴权；
  • MaxAge：浏览器缓存 TTL；
  • StatusCodeCache：状态码缓存 TTL；
  • OfflineCache：离线缓存；
  • SmartRouting：智能加速；
  • RangeOriginPull：分片回源 ；
  • UpstreamHTTP2：HTTP2 回源；
  • HostHeader：Host Header 重写；
  • ForceRedirectHTTPS：访问协议强制 HTTPS 跳转配置；
  • OriginPullProtocol：回源 HTTPS；
  • Compression：智能压缩配置；
  • HSTS：HSTS；
  • ClientIPHeader：存储客户端请求 IP 的头部信息配置；
  • OCSPStapling：OCSP 装订；
  • HTTP2：HTTP2 接入；
  • PostMaxSize：POST 请求上传文件流式传输最大限制配置；
  • ClientIPCountry：回源时携带客户端 IP 所属地域信息；
  • UpstreamFollowRedirect：回源跟随重定向参数配置；
  • UpstreamRequest：回源请求参数；
  • TLSConfig：SSL/TLS 安全；
  • ModifyOrigin：修改源站；
  • HTTPUpstreamTimeout：七层回源超时配置；
  • HttpResponse：HTTP 应答；
  • ErrorPage：自定义错误页面；
  • ModifyResponseHeader：修改 HTTP 节点响应头；
  • ModifyRequestHeader：修改 HTTP 节点请求头；
  • ResponseSpeedLimit：单连接下载限速；
  • SetContentIdentifier：设置内容标识符；
  • Vary：Vary 特性配置。
    		•
    CacheParameters CacheParameters 否 节点缓存 TTL 配置参数，当 Name 取值为 Cache 时，该参数必填。
    注意：此字段可能返回 null，表示取不到有效值。
    CacheKeyParameters CacheKeyParameters 否 自定义 Cache Key 配置参数，当 Name 取值为 CacheKey 时，该参数必填。
    注意：此字段可能返回 null，表示取不到有效值。
    CachePrefreshParameters CachePrefreshParameters 否 缓存预刷新配置参数，当 Name 取值为 CachePrefresh 时，该参数必填。
    注意：此字段可能返回 null，表示取不到有效值。
    AccessURLRedirectParameters AccessURLRedirectParameters 否 访问 URL 重定向配置参数，当 Name 取值为 AccessURLRedirect 时，该参数必填。
    注意：此字段可能返回 null，表示取不到有效值。
    UpstreamURLRewriteParameters UpstreamURLRewriteParameters 否 回源 URL 重写配置参数，当 Name 取值为 UpstreamURLRewrite 时，该参数必填。
    注意：此字段可能返回 null，表示取不到有效值。
    QUICParameters QUICParameters 否 QUIC 配置参数，当 Name 取值为 QUIC 时，该参数必填。
    注意：此字段可能返回 null，表示取不到有效值。
    WebSocketParameters WebSocketParameters 否 WebSocket 配置参数，当 Name 取值为 WebSocket 时，该参数必填。
    注意：此字段可能返回 null，表示取不到有效值。
    AuthenticationParameters AuthenticationParameters 否 Token 鉴权配置参数，当 Name 取值为 Authentication 时，该参数必填。
    注意：此字段可能返回 null，表示取不到有效值。
    MaxAgeParameters MaxAgeParameters 否 浏览器缓存 TTL 配置参数，当 Name 取值为 MaxAge 时，该参数必填。
    注意：此字段可能返回 null，表示取不到有效值。
    StatusCodeCacheParameters StatusCodeCacheParameters 否 状态码缓存 TTL 配置参数，当 Name 取值为 StatusCodeCache 时，该参数必填。
    注意：此字段可能返回 null，表示取不到有效值。
    OfflineCacheParameters OfflineCacheParameters 否 离线缓存配置参数，当 Name 取值为 OfflineCache 时，该参数必填。
    注意：此字段可能返回 null，表示取不到有效值。
    SmartRoutingParameters SmartRoutingParameters 否 智能加速配置参数，当 Name 取值为 SmartRouting 时，该参数必填。
    注意：此字段可能返回 null，表示取不到有效值。
    RangeOriginPullParameters RangeOriginPullParameters 否 分片回源配置参数，当 Name 取值为 RangeOriginPull 时，该参数必填。
    注意：此字段可能返回 null，表示取不到有效值。
    UpstreamHTTP2Parameters UpstreamHTTP2Parameters 否 HTTP2 回源配置参数，当 Name 取值为 UpstreamHTTP2 时，该参数必填。
    注意：此字段可能返回 null，表示取不到有效值。
    HostHeaderParameters HostHeaderParameters 否 Host Header 重写配置参数，当 Name 取值为 HostHeader 时，该参数必填。
    注意：此字段可能返回 null，表示取不到有效值。
    ForceRedirectHTTPSParameters ForceRedirectHTTPSParameters 否 访问协议强制 HTTPS 跳转配置，当 Name 取值为 ForceRedirectHTTPS 时，该参数必填。
    注意：此字段可能返回 null，表示取不到有效值。
    OriginPullProtocolParameters OriginPullProtocolParameters 否 回源 HTTPS 配置参数，当 Name 取值为 OriginPullProtocol 时，该参数必填。
    注意：此字段可能返回 null，表示取不到有效值。
    CompressionParameters CompressionParameters 否 智能压缩配置，当 Name 取值为 Compression 时，该参数必填。
    注意：此字段可能返回 null，表示取不到有效值。
    HSTSParameters HSTSParameters 否 HSTS 配置参数，当 Name 取值为 HSTS 时，该参数必填。
    注意：此字段可能返回 null，表示取不到有效值。
    ClientIPHeaderParameters ClientIPHeaderParameters 否 存储客户端请求 IP 的头部信息配置，当 Name 取值为 ClientIPHeader 时，该参数必填。
    注意：此字段可能返回 null，表示取不到有效值。
    OCSPStaplingParameters OCSPStaplingParameters 否 OCSP 装订配置参数，当 Name 取值为 OCSPStapling 时，该参数必填。
    注意：此字段可能返回 null，表示取不到有效值。
    HTTP2Parameters HTTP2Parameters 否 HTTP2 接入配置参数，当 Name 取值为 HTTP2 时，该参数必填。
    注意：此字段可能返回 null，表示取不到有效值。
    PostMaxSizeParameters PostMaxSizeParameters 否 POST 请求上传文件流式传输最大限制配置，当 Name 取值为 PostMaxSize 时，该参数必填。
    注意：此字段可能返回 null，表示取不到有效值。
    ClientIPCountryParameters ClientIPCountryParameters 否 回源时携带客户端 IP 所属地域信息配置参数，当 Name 取值为 ClientIPCountry 时，该参数必填。
    注意：此字段可能返回 null，表示取不到有效值。
    UpstreamFollowRedirectParameters UpstreamFollowRedirectParameters 否 回源跟随重定向参数配置，当 Name 取值为 UpstreamFollowRedirect 时，该参数必填。
    注意：此字段可能返回 null，表示取不到有效值。
    UpstreamRequestParameters UpstreamRequestParameters 否 回源请求参数配置参数，当 Name 取值为 UpstreamRequest 时，该参数必填。
    注意：此字段可能返回 null，表示取不到有效值。
    TLSConfigParameters TLSConfigParameters 否 SSL/TLS 安全配置参数，当 Name 取值为 TLSConfig 时，该参数必填。
    注意：此字段可能返回 null，表示取不到有效值。
    ModifyOriginParameters ModifyOriginParameters 否 修改源站配置参数，当 Name 取值为 ModifyOrigin 时，该参数必填。
    注意：此字段可能返回 null，表示取不到有效值。
    HTTPUpstreamTimeoutParameters HTTPUpstreamTimeoutParameters 否 七层回源超时配置，当 Name 取值为 HTTPUpstreamTimeout 时，该参数必填。
    注意：此字段可能返回 null，表示取不到有效值。
    HttpResponseParameters HTTPResponseParameters 否 HTTP 应答配置参数，当 Name 取值为 HttpResponse 时，该参数必填。
    注意：此字段可能返回 null，表示取不到有效值。
    ErrorPageParameters ErrorPageParameters 否 自定义错误页面配置参数，当 Name 取值为 ErrorPage 时，该参数必填。
    注意：此字段可能返回 null，表示取不到有效值。
    ModifyResponseHeaderParameters ModifyResponseHeaderParameters 否 修改 HTTP 节点响应头配置参数，当 Name 取值为 ModifyResponseHeader 时，该参数必填。
    注意：此字段可能返回 null，表示取不到有效值。
    ModifyRequestHeaderParameters ModifyRequestHeaderParameters 否 修改 HTTP 节点请求头配置参数，当 Name 取值为 ModifyRequestHeader 时，该参数必填。
    注意：此字段可能返回 null，表示取不到有效值。
    ResponseSpeedLimitParameters ResponseSpeedLimitParameters 否 单连接下载限速配置参数，当 Name 取值为 ResponseSpeedLimit 时，该参数必填。
    注意：此字段可能返回 null，表示取不到有效值。
    SetContentIdentifierParameters SetContentIdentifierParameters 否 内容标识配置参数，当 Name 取值为 SetContentIdentifier 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。
    VaryParameters VaryParameters 否 Vary 特性配置参数，当 Name 取值为 Vary 时，该参数必填。
    ContentCompressionParameters ContentCompressionParameters 否 内容压缩配置参数，当 Name 取值为 ContentCompression 时，该参数必填。该参数为白名单功能，如有需要，请联系腾讯云工程师处理。

    RuleEngineItem

    规则引擎规则详情。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    Status String 否 规则状态。取值有：
  • enable: 启用；
  • disable: 未启用。
    		•
    RuleId String 否 规则 ID。规则的唯一性标识，当调用 ModifyL7AccRules 时，该参数必填。
    RuleName String 否 规则名称。名称长度限制不超过 255 个字符。
    Description Array of String 否 规则注释。可以填写多个注释。
    Branches Array of RuleBranch 否 子规则分支。此列表当前只支持填写一项规则，多填无效。
    注意：此字段可能返回 null，表示取不到有效值。
    RulePriority Integer 否 规则优先级。仅作为出参使用。

    RuleEngineSubRule

    子规则。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    Branches Array of RuleBranch 否 子规则分支
    注意：此字段可能返回 null，表示取不到有效值。
    Description Array of String 否 规则注释。

    RuleExtraParameter

    规则引擎参数详情信息，特殊参数类型。

    被如下接口引用：DescribeRulesSetting。

    名称 类型 描述
    Id String 参数名，取值有：
  • Action：修改 HTTP 头部所需参数，RuleAction 选择 RewirteAction；
  • StatusCode：状态码相关功能所需参数，RuleAction 选择 CodeAction。
    		•
    Type String 参数值类型。
  • CHOICE：参数值只能在 Values 中选择；
  • CUSTOM_NUM：参数值用户自定义，整型类型；
  • CUSTOM_STRING：参数值用户自定义，字符串类型。
    		•
    Choices Array of String 可选参数值。
    注意：当 Id 的值为 StatusCode 时数组中的值为整型，填写参数值时请填写字符串的整型数值。

    RuleItem

    规则引擎规则详情

    被如下接口引用：DescribeRules。

    名称 类型 描述
    RuleId String 规则ID。
    RuleName String 规则名称，名称字符串长度 1~255。
    Status String 规则状态，取值有:
  • enable: 启用；
  • disable: 未启用。
    • Rules Array of Rule 规则内容。
    RulePriority Integer 规则优先级, 值越大优先级越高，最小为 1。
    Tags Array of String 规则标签。

    RuleNormalActionParams

    规则引擎条件常规动作参数

    被如下接口引用：CreateRule, DescribeRules, ModifyRule。

    名称 类型 必选 描述
    Name String 是 参数名称，参数填写规范可调用接口 查询规则引擎的设置参数 查看。
    Values Array of String 是 参数值。

    RuleRewriteActionParams

    规则引擎条件 HTTP 请求/响应头操作动作参数。

    被如下接口引用：CreateRule, DescribeRules, ModifyRule。

    名称 类型 必选 描述
    Action String 是 功能参数名称，参数填写规范可调用接口 查询规则引擎的设置参数 查看。现在只有三种取值：
  • add：添加 HTTP 头部；
  • set：重写 HTTP 头部；
  • del：删除 HTTP 头部。
    		•
    Name String 是 参数名称。
    Values Array of String 是 参数值。

    RulesProperties

    规则引擎可应用于匹配请求的设置详细信息。

    被如下接口引用：DescribeRulesSetting。

    名称 类型 描述
    Name String 值为参数名称。
    Min Integer 数值参数的最小值，非数值参数或 Min 和 Max 值都为 0 则此项无意义。
    ChoicesValue Array of String 参数值的可选值。
    注意：若参数值为用户自定义则该数组为空数组。
    Type String 参数值类型。
  • CHOICE：参数值只能在 ChoicesValue 中选择；
  • TOGGLE：参数值为开关类型，可在 ChoicesValue 中选择；
  • OBJECT：参数值为对象类型，ChoiceProperties 为改对象类型关联的属性；
  • CUSTOM_NUM：参数值用户自定义，整型类型；
  • CUSTOM_STRING：参数值用户自定义，字符串类型。
    • 注意：当参数类型为 OBJECT 类型时，请注意参考 示例2 参数为 OBJECT 类型的创建
    Max Integer 数值参数的最大值，非数值参数或 Min 和 Max 值都为 0 则此项无意义。
    IsMultiple Boolean 参数值是否支持多选或者填写多个。
    IsAllowEmpty Boolean 是否允许为空。
    ChoiceProperties Array of RuleChoicePropertiesItem 该参数对应的关联配置参数，属于调用接口的必填参数。
    注意：如果可选参数无特殊新增参数则该数组为空数组。
    ExtraParameter RuleExtraParameter
  • 为 NULL：无特殊参数，RuleAction 选择 NormalAction；

    • 注意：此字段可能返回 null，表示取不到有效值。

    RulesSettingAction

    规则引擎可应用于匹配请求的设置列表及其详细信息

    被如下接口引用：DescribeRulesSetting。

    名称 类型 描述
    Action String 功能名称，取值有：
  • 访问URL 重写（AccessUrlRedirect）；
  • 回源 URL 重写 （UpstreamUrlRedirect）；
  • 自定义错误页面
    (ErrorPage)；
  • QUIC（QUIC）；
  • WebSocket （WebSocket）；
  • 视频拖拽（VideoSeek）；
  • Token 鉴权（Authentication）；
  • 自定义CacheKey（CacheKey）；
  • 节点缓存 TTL （Cache）；
  • 浏览器缓存 TTL（MaxAge）；
  • 离线缓存（OfflineCache）；
  • 智能加速（SmartRouting）；
  • 分片回源（RangeOriginPull）；
  • HTTP/2 回源（UpstreamHttp2）；
  • Host Header 重写（HostHeader）；
  • 强制 HTTPS（ForceRedirect）；
  • 回源 HTTPS（OriginPullProtocol）；
  • 缓存预刷新（CachePrefresh）；
  • 智能压缩（Compression）；
  • 修改 HTTP 请求头（RequestHeader）；
  • 修改HTTP响应头（ResponseHeader）;
  • 状态码缓存 TTL（StatusCodeCache）;
  • Hsts；
  • ClientIpHeader；
  • TlsVersion；
  • OcspStapling。
    		•
    Properties Array of RulesProperties 参数信息。

    S3

    实时日志投递到 AWS S3 兼容存储桶的配置信息。

    被如下接口引用：CreateRealtimeLogDeliveryTask, DescribeRealtimeLogDeliveryTasks, ModifyRealtimeLogDeliveryTask。

    名称 类型 必选 描述
    Endpoint String 是 不包含存储桶名称或路径的 URL，例如：https://storage.googleapis.com、https://s3.ap-northeast-2.amazonaws.com、https://cos.ap-nanjing.myqcloud.com。
    Region String 是 存储桶所在的地域，例如：ap-northeast-2。
    Bucket String 是 存储桶名称和日志存储目录，例如：your_bucket_name/EO-logs/。如果存储桶中无此目录则会自动创建。
    AccessId String 是 访问存储桶使用的 Access Key ID。
    AccessKey String 是 访问存储桶使用的 secret key。
    CompressType String 否 数据压缩类型，取值有:
  • gzip：gzip压缩。
    • 不填表示不启用压缩。

    SearchEngineBots

    搜索引擎规则配置。

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    BaseAction SecurityAction 否 来自搜索引擎爬虫的请求的执行动作。 SecurityAction 的 Name 取值支持：
  • Deny：拦截；
  • Monitor：观察；
  • Disabled：未启用，不启用指定规则；
  • Challenge：挑战，其中 ChallengeActionParameters 中的 ChallengeOption 支持 JSChallenge 和 ManagedChallenge；
  • Allow：放行（待废弃）。
    		•
    BotManagementActionOverrides Array of BotManagementActionOverrides 否 指定搜索引擎爬虫请求的处置方式。

    SecEntry

    安全数据Entry返回值

    被如下接口引用：DescribeDDoSAttackData。

    名称 类型 描述
    Key String 查询维度值。
    Value Array of SecEntryValue 查询维度下详细数据。

    SecEntryValue

    安全数据维度值信息

    被如下接口引用：DescribeDDoSAttackData。

    名称 类型 描述
    Metric String 指标名称。
    Detail Array of TimingDataItem 时序数据详情。
    Max Integer 最大值。
    Avg Float 平均值。
    Sum Float 数据总和。

    SecurityAction

    安全的执行动作

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    Name String 是 安全执行的具体动作。取值有：
  • Deny：拦截，阻止请求访问站点资源；
  • Monitor：观察，仅记录日志；
  • Redirect：重定向至 URL；
  • Disabled：未启用，不启用指定规则；
  • Allow：允许访问，但延迟处理请求；
  • Challenge：挑战，响应挑战内容；
  • Trans：放行，允许请求直接访问站点资源；
  • BlockIP：待废弃，IP 封禁；
  • ReturnCustomPage：待废弃，使用指定页面拦截；
  • JSChallenge：待废弃，JavaScript 挑战；
  • ManagedChallenge：待废弃，托管挑战。
    		•
    DenyActionParameters DenyActionParameters 否 当 Name 为 Deny 时的附加参数。
    RedirectActionParameters RedirectActionParameters 否 当 Name 为 Redirect 时的附加参数。
    AllowActionParameters AllowActionParameters 否 当 Name 为 Allow 时的附加参数。
    ChallengeActionParameters ChallengeActionParameters 否 当 Name 为 Challenge 时的附加参数。
    BlockIPActionParameters BlockIPActionParameters 否 待废弃，当 Name 为 BlockIP 时的附加参数。
    ReturnCustomPageActionParameters ReturnCustomPageActionParameters 否 待废弃，当 Name 为 ReturnCustomPage 时的附加参数。

    SecurityConfig

    Web安全配置

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    WafConfig WafConfig 否 托管规则。如果入参为空或不填，默认使用历史配置。
    RateLimitConfig RateLimitConfig 否 速率限制。如果入参为空或不填，默认使用历史配置。
    AclConfig AclConfig 否 自定义规则。如果入参为空或不填，默认使用历史配置。
    BotConfig BotConfig 否 Bot配置。如果入参为空或不填，默认使用历史配置。
    SwitchConfig SwitchConfig 否 七层防护总开关。如果入参为空或不填，默认使用历史配置。
    IpTableConfig IpTableConfig 否 基础访问管控。如果入参为空或不填，默认使用历史配置。
    ExceptConfig ExceptConfig 否 例外规则配置。如果入参为空或不填，默认使用历史配置。
    DropPageConfig DropPageConfig 否 自定义拦截页面配置。如果入参为空或不填，默认使用历史配置。
    TemplateConfig TemplateConfig 否 模板配置。此处仅出参数使用。
    SlowPostConfig SlowPostConfig 否 慢速攻击配置。如果入参为空或不填，默认使用历史配置。
    DetectLengthLimitConfig DetectLengthLimitConfig 否 检测长度限制配置。仅出参使用。

    SecurityPolicy

    安全策略配置

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    CustomRules CustomRules 否 自定义规则配置。
    ManagedRules ManagedRules 否 托管规则配置。
    HttpDDoSProtection HttpDDoSProtection 否 HTTP DDOS 防护配置。
    RateLimitingRules RateLimitingRules 否 速率限制规则配置。
    ExceptionRules ExceptionRules 否 例外规则配置。
    BotManagement BotManagement 否 Bot 管理配置。

    SecurityPolicyTemplateInfo

    策略模板信息

    被如下接口引用：DescribeWebSecurityTemplates。

    名称 类型 描述
    ZoneId String 策略模板所属的站点 ID。
    TemplateId String 策略模板 ID。
    TemplateName String 策略模板名称。
    BindDomains Array of BindDomainInfo 策略模板绑定的域名信息。

    SecurityTemplateBinding

    安全策略模板的绑定关系。

    被如下接口引用：DescribeSecurityTemplateBindings。

    名称 类型 描述
    TemplateId String 模板ID
    TemplateScope Array of TemplateScope 模板绑定状态。

    SecurityType

    安全类型配置项。

    被如下接口引用：DescribeHostsSetting。

    名称 类型 必选 描述
    Switch String 是 安全类型开关，取值为：
  • on：开启；
  • off：关闭。
    		•

    SecurityWeightedAction

    按权重分配的 SecurityAction。

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    SecurityAction SecurityAction 否 Bot 自定义规则的处置方式。取值有：
  • Allow：放行，其中 AllowActionParameters 支持 MinDelayTime 和 MaxDelayTime 配置；
  • Deny：拦截，其中 DenyActionParameters 中支持 BlockIp、ReturnCustomPage 和 Stall 配置；
  • Monitor：观察；
  • Challenge：挑战，其中 ChallengeActionParameters.ChallengeOption 支持 JSChallenge 和 ManagedChallenge；
  • Redirect：重定向至URL。
    		•
    Weight Integer 否 当前 SecurityAction 的权重，仅支持 10 ~ 100 且必须为 10 的倍数，其中 Weight 参数全部相加须等于 100。

    ServerCertInfo

    https 服务端证书配置

    被如下接口引用：DescribeHostsSetting, ModifyHostsCertificate, ModifyZoneSetting。

    名称 类型 必选 描述
    CertId String 是 服务器证书 ID。来源于 SSL 侧，您可以前往 SSL 证书列表 查看 CertId。
    Alias String 否 证书备注名。
    Type String 否 证书类型，取值有：
  • default：默认证书；
  • upload：用户上传；
  • managed：腾讯云托管。
    		•
    ExpireTime Timestamp ISO8601 否 证书过期时间。
    DeployTime Timestamp ISO8601 否 证书部署时间。
    SignAlgo String 否 签名算法。
    CommonName String 否 证书归属域名名称。

    SessionRateControl

    会话速率和周期特征校验配置。

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    Enabled String 否 会话速率和周期特征校验配置是否开启。取值有：
  • on：启用
  • off：关闭
    		•
    HighRateSessionAction SecurityAction 否 会话速率和周期特征校验高风险的执行动作。 SecurityAction 的 Name 取值支持：
  • Deny：拦截，其中 DenyActionParameters 中支持 Stall 配置；
  • Monitor：观察；
  • Allow：等待后响应，其中 AllowActionParameters 需要 MinDelayTime 和 MaxDelayTime 配置。
    		•
    MidRateSessionAction SecurityAction 否 会话速率和周期特征校验中风险的执行动作。 SecurityAction 的 Name 取值支持：
  • Deny：拦截，其中 DenyActionParameters 中支持 Stall 配置；
  • Monitor：观察；
  • Allow：等待后响应，其中 AllowActionParameters 需要 MinDelayTime 和 MaxDelayTime 配置。
    		•
    LowRateSessionAction SecurityAction 否 会话速率和周期特征校验低风险的执行动作。 SecurityAction 的 Name 取值支持：
  • Deny：拦截，其中 DenyActionParameters 中支持 Stall 配置；
  • Monitor：观察；
  • Allow：等待后响应，其中 AllowActionParameters 需要 MinDelayTime 和 MaxDelayTime 配置。
    		•

    SetContentIdentifierParameters

    内容标识配置参数。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    ContentIdentifier String 否 内容标识id

    SkipCondition

    例外规则的跳过匹配条件，即在例外时根据本匹配条件，略过指定字段及内容。

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    Type String 是 例外跳过类型，取值为：
  • header_fields：HTTP请求Header；
  • cookie：HTTP请求Cookie；
  • query_string：HTTP请求URL中的Query参数；
  • uri：HTTP请求URI；
  • body_raw：HTTP请求Body；
  • body_json： JSON格式的HTTP Body。
    		•
    Selector String 是 选择跳过的字段，取值为：
  • args：uri 下选择 query 参数: ?name1=jack&age=12；
  • path：uri 下选择部分路径：/path/to/resource.jpg；
  • full：uri 下选择完整路径：example.com/path/to/resource.jpg?name1=jack&age=12；
  • upload_filename：分段文件名，即分段传输文件时；
  • keys：所有的Key；
  • values：匹配Key对应的值；
  • key_value：匹配Key及匹配Value。
    		•
    MatchFromType String 否 匹配Key所使用的匹配方式，取值为：
  • equal：精准匹配，等于；
  • wildcard：通配符匹配，支持 * 通配。
    		•
    MatchFrom Array of String 否 匹配Key的值。
    MatchContentType String 否 匹配Content所使用的匹配方式，取值为：
  • equal：精准匹配，等于；
  • wildcard：通配符匹配，支持 * 通配。
    		•
    MatchContent Array of String 否 匹配Value的值。

    SlowAttackDefense

    慢速攻击防护的具体配置。

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    Enabled String 是 慢速攻击防护是否开启。取值有：
  • on：开启；
  • off：关闭。
    		•
    Action SecurityAction 否 慢速攻击防护的处置方式，当 Enabled 为 on 时，此字段必填。SecurityAction 的 Name 取值支持：
  • Monitor：观察；
  • Deny：拦截；
    		•
    MinimalRequestBodyTransferRate MinimalRequestBodyTransferRate 否 正文传输最小速率阈值的具体配置，当 Enabled 为 on 时，此字段必填。
    RequestBodyTransferTimeout RequestBodyTransferTimeout 否 正文传输超时时长的具体配置，当 Enabled 为 on 时，此字段必填。

    SlowPostConfig

    慢速攻击配置。

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    Switch String 是 开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    FirstPartConfig FirstPartConfig 否 首包配置。
    SlowRateConfig SlowRateConfig 否 基础配置。
    Action String 否 慢速攻击的处置动作，取值有：
  • monitor：观察；
  • drop：拦截。
    		•
    RuleId Integer 否 本规则的Id。

    SlowRateConfig

    慢速攻击的基础配置。

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    Switch String 是 开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    Interval Integer 否 统计的间隔，单位是秒，即在首段包传输结束后，将数据传输轴按照本参数切分，每个分片独立计算慢速攻击。
    Threshold Integer 否 统计时应用的速率阈值，单位是bps，即如果本分片中的传输速率没达到本参数的值，则判定为慢速攻击，应用慢速攻击的处置方式。

    SmartRouting

    智能加速配置

    被如下接口引用：DescribeHostsSetting, DescribeZoneSetting, ModifyZoneSetting。

    名称 类型 必选 描述
    Switch String 是 智能加速配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•

    SmartRoutingParameters

    智能加速配置。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting。

    名称 类型 必选 描述
    Switch String 否 智能加速配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•

    SourceIDC

    IDC 规则配置的具体内容。

    被如下接口引用：CreateWebSecurityTemplate, DescribeSecurityPolicy, DescribeWebSecurityTemplate, ModifySecurityPolicy, ModifyWebSecurityTemplate。

    名称 类型 必选 描述
    BaseAction SecurityAction 否 来自指定 IDC 请求的处置方式。 SecurityAction 的 Name 取值支持：
  • Deny：拦截；
  • Monitor：观察；
  • Disabled：未启用，不启用指定规则；
  • Challenge：挑战，其中 ChallengeActionParameters 中的 ChallengeOption 支持 JSChallenge 和 ManagedChallenge；
  • Allow：放行（待废弃）。
    		•
    BotManagementActionOverrides Array of BotManagementActionOverrides 否 指定 IDC 请求的处置方式。

    StandardDebug

    支持标准debug结构体

    被如下接口引用：DescribeZoneSetting, ModifyZoneSetting。

    名称 类型 必选 描述
    Switch String 是 Debug 功能开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    AllowClientIPList Array of String 是 允许的客户端来源。支持填写 IPv4 以及 IPv6 的 IP/IP 段。0.0.0.0/0 表示允许所有 IPv4 客户端进行调试，::/0 表示允许所有 IPv6 客户端进行调试。
    ExpireTime Timestamp ISO8601 是 Debug 功能到期时间。超出设置的时间，则功能失效。

    StandardDebugParameters

    Debug 调试结构体。

    被如下接口引用：DescribeL7AccSetting, ModifyL7AccSetting。

    名称 类型 必选 描述
    Switch String 否 Debug 功能开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    AllowClientIPList Array of String 否 允许的客户端来源。支持填写 IPv4 以及 IPv6 的 IP 网段。0.0.0.0/0 表示允许所有 IPv4 客户端进行调试；::/0 表示允许所有 IPv6 客户端进行调试；不能填写 127.0.0.1。
    注意：当 Switch 字段为 on 时，此字段必填，且填写个数为 1～100；当 Switch 为 off 时，无需填写此字段，若填写则不生效。
    Expires Timestamp ISO8601 否 Debug 功能到期时间。超出设置的时间，则功能失效。
    注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。

    StatusCodeCacheParam

    状态码缓存 TTL 配置参数内部结构。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    StatusCode Integer 否 状态码，取值为 400、 401、403、 404、 405、 407、 414、 500、 501、 502、 503、 504、 509、 514 之一。
    CacheTime Integer 否 缓存时间数值，单位为秒，取值：0～31536000。

    StatusCodeCacheParameters

    状态码缓存 TTL 配置参数。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    StatusCodeCacheParams Array of StatusCodeCacheParam 否 状态码缓存 TTL 。
    注意：此字段可能返回 null，表示取不到有效值。

    SubRule

    嵌套规则信息。

    被如下接口引用：CreateRule, DescribeRules, ModifyRule。

    名称 类型 必选 描述
    Conditions Array of RuleAndConditions 是 执行功能判断条件。
    注意：满足该数组内任意一项条件，功能即可执行。
    Actions Array of Action 是 执行的功能。

    SubRuleItem

    规则引擎嵌套规则

    被如下接口引用：CreateRule, DescribeRules, ModifyRule。

    名称 类型 必选 描述
    Rules Array of SubRule 是 嵌套规则信息。
    Tags Array of String 否 规则标签。

    Sv

    询价参数

    被如下接口引用：DescribeZones。

    名称 类型 必选 描述
    Key String 是 询价参数键。
    Value String 是 询价参数值。
    Pack String 否 询价参数映射的配额，取值有：
  • zone：站点数；
  • custom-rule：自定义规则数；
  • rate-limiting-rule：速率限制规则数；
  • l4-proxy-instance：四层代理实例数。

    • 注意：此字段可能返回 null，表示取不到有效值。
    InstanceId String 否 询价参数映射的四层代理实例Id。
    注意：此字段可能返回 null，表示取不到有效值。
    ProtectionSpecs String 否 询价参数对应的防护等级。
    取值有：
  • cm_30G：中国大陆加速区域保底防护30Gbps；
  • cm_60G：中国大陆加速区域保底防护60Gbps；
  • cm_100G：中国大陆加速区域保底防护100Gbps；
  • anycast_300G：全球加速区域（除中国大陆）Anycast联防300Gbps；
  • anycast_unlimited：全球加速区域（除中国大陆）Anycast无上限全力防护；
  • cm_30G_anycast_300G：中国大陆加速区域保底防护30Gbps，全球加速区域（除中国大陆）Anycast联防300Gbps；
  • cm_30G_anycast_unlimited：中国大陆加速区域保底防护30Gbps，全球加速区域（除中国大陆）Anycast无上限全力防护；
  • cm_60G_anycast_300G：中国大陆加速区域保底防护60Gbps，全球加速区域（除中国大陆）Anycast联防300Gbps；
  • cm_60G_anycast_unlimited：中国大陆加速区域保底防护60Gbps，全球加速区域（除中国大陆）Anycast无上限全力防护；
  • cm_100G_anycast_300G：中国大陆加速区域保底防护100Gbps，全球加速区域（除中国大陆）Anycast联防300Gbps；
  • cm_100G_anycast_unlimited：中国大陆加速区域保底防护100Gbps，全球加速区域（除中国大陆）Anycast无上限全力防护。

    • 注意：此字段可能返回 null，表示取不到有效值。

    SwitchConfig

    功能总开关

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    WebSwitch String 是 Web类型的安全总开关，取值有：
  • on：开启；
  • off：关闭。
    • 不影响DDoS与Bot的开关。

    TCCaptchaOption

    验证码认证实例信息。

    被如下接口引用：CreateSecurityClientAttester, DescribeSecurityClientAttester, ModifySecurityClientAttester。

    名称 类型 必选 描述
    CaptchaAppId String 是 CaptchaAppId 信息。
    AppSecretKey String 是 AppSecretKey 信息。

    TCRCEOption

    RCE 认证选项实例信息。

    被如下接口引用：CreateSecurityClientAttester, DescribeSecurityClientAttester, ModifySecurityClientAttester。

    名称 类型 必选 描述
    Channel String 是 Channel 信息。

    TLSConfigParameters

    SSL/TLS 安全配置参数。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting。

    名称 类型 必选 描述
    Version Array of String 否 TLS 版本。至少填写一个，如果是多个时，需要为连续版本号，例如：开启 TLS1、1.1、1.2 和 1.3，不可仅开启 1 和 1.2 而关闭 1.1。取值有：
  • TLSv1：TLSv1 版本；
  • TLSv1.1：TLSv1.1 版本；
  • TLSv1.2：TLSv1.2 版本；
  • TLSv1.3：TLSv1.3 版本。
    		•
    CipherSuite String 否 密码套件。详细介绍请参考 TLS 版本及密码套件说明。取值有：
  • loose-v2023：loose-v2023 密码套件；
  • general-v2023：general-v2023 密码套件；
  • strict-v2023：strict-v2023 密码套件。
    		•

    Tag

    标签配置

    被如下接口引用：CreateContentIdentifier, CreateZone, DescribeContentIdentifiers, DescribeZones。

    名称 类型 必选 描述
    TagKey String 是 标签键。
    注意：此字段可能返回 null，表示取不到有效值。
    TagValue String 是 标签值。
    注意：此字段可能返回 null，表示取不到有效值。

    Task

    内容管理任务结果

    被如下接口引用：DescribePrefetchTasks, DescribePurgeTasks。

    名称 类型 描述
    JobId String 任务 ID。
    Target String 资源。
    Type String 任务类型。
    Method String 节点缓存清除方法，取值有：
  • invalidate：标记过期，用户请求时触发回源校验，即发送带有 If-None-Match 和 If-Modified-Since 头部的 HTTP 条件请求。若源站响应 200，则节点会回源拉取新的资源并更新缓存；若源站响应 304，则节点不会更新缓存；
  • delete：直接删除节点缓存，用户请求时触发回源拉取资源。
    		•
    Status String 状态。取值有：
  • processing：处理中；
  • success：成功；
  • failed：失败；
  • timeout：超时；
  • canceled：已取消。
    		•
    CreateTime Timestamp ISO8601 任务创建时间。
    UpdateTime Timestamp ISO8601 任务完成时间。
    FailType String 刷新、预热失败类型。取值有：
  • taskFailed：任务失败；
  • quotaExceeded：配额超限；
  • downloadManifestFailed：下载描述文件失败；
  • accessDenied：访问被拒绝。
  • originPullFailed：回源失败。
    		•
    FailMessage String 清除缓存、预热缓存的失败原因描述。

    TemplateConfig

    安全模板配置

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    TemplateId String 是 模板ID。
    TemplateName String 是 模板名称。

    TemplateScope

    安全模板绑定域名状态

    被如下接口引用：DescribeSecurityTemplateBindings。

    名称 类型 必选 描述
    ZoneId String 否 站点ID。
    注意：此字段可能返回 null，表示取不到有效值。
    EntityStatus Array of EntityStatus 否 实例状态列表。
    注意：此字段可能返回 null，表示取不到有效值。

    TimingDataItem

    统计曲线数据项

    被如下接口引用：DescribeDDoSAttackData, DescribeOverviewL7Data, DescribeTimingL4Data, DescribeTimingL7AnalysisData, DescribeTimingL7CacheData, DescribeTimingL7OriginPullData。

    名称 类型 描述
    Timestamp Integer 返回数据对应时间点，采用 unix 秒级时间戳。
    Value Integer 具体数值。

    TimingDataRecord

    时序数据信息

    被如下接口引用：DescribeOverviewL7Data, DescribeTimingL4Data, DescribeTimingL7AnalysisData, DescribeTimingL7CacheData, DescribeTimingL7OriginPullData。

    名称 类型 描述
    TypeKey String 查询维度值。
    TypeValue Array of TimingTypeValue 详细时序数据。

    TimingTypeValue

    时序类型详细数据

    被如下接口引用：DescribeOverviewL7Data, DescribeTimingL4Data, DescribeTimingL7AnalysisData, DescribeTimingL7CacheData, DescribeTimingL7OriginPullData。

    名称 类型 描述
    Sum Integer 数据和。
    Max Integer 最大值。
    Avg Integer 平均值。
    MetricName String 指标名。
    Detail Array of TimingDataItem 详细数据。
    注意：此字段可能返回 null，表示取不到有效值。

    TopDataRecord

    Top类数据记录

    被如下接口引用：DescribeTopL7AnalysisData, DescribeTopL7CacheData。

    名称 类型 描述
    TypeKey String 查询维度值。
    DetailData Array of TopDetailData top数据排行。

    TopDetailData

    Top数据的详细信息

    被如下接口引用：DescribeTopL7AnalysisData, DescribeTopL7CacheData。

    名称 类型 描述
    Key String 字段名。
    Value Integer 字段值。

    TopEntry

    TopN的Entry数据

    被如下接口引用：DescribeDDoSAttackTopData。

    名称 类型 描述
    Key String top查询维度值。
    Value Array of TopEntryValue 查询具体数据。

    TopEntryValue

    TopN数据Entry

    被如下接口引用：DescribeDDoSAttackTopData。

    名称 类型 描述
    Name String 排序实体名。
    Count Integer 排序实体数量。

    URLPath

    访问 URL 重定向路径配置参数。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    Action String 否 执行动作，取值有：
  • follow：跟随请求；
  • custom：自定义；
  • regex：正则匹配。
    		•
    Regex String 否 正则匹配的表达式，长度范围为 1～1024。
    注意：当 Action 为 regex 时，此字段必填；当 Action 为 follow 或 custom 时，无需填写此字段，若填写则不生效。
    Value String 否 重定向的目标URL，长度范围为 1～1024。
    注意：当 Action 为 regex 或 custom 时，此字段必填；当 Action 为 follow 时，无需填写此字段，若填写则不生效。

    UpstreamCertInfo

    用于 EO 节点回源时携带的证书，源站启用双向认证握手时使用，用于源站认证客户端证书是否有效，确保请求来源于受信任的 EO 节点。

    被如下接口引用：DescribeAccelerationDomains, ModifyHostsCertificate。

    名称 类型 必选 描述
    UpstreamMutualTLS MutualTLS 否 在回源双向认证场景下，该字段为 EO 节点回源时携带的证书（包含公钥、私钥即可），部署在 EO 节点，用于源站对 EO 节点进行认证。在作为入参使用时，不填写表示保持原有配置。

    UpstreamFollowRedirectParameters

    回源跟随重定向参数配置。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    Switch String 否 回源跟随重定向配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    MaxTimes Integer 否 最大重定向次数。取值为 1-5。
    注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。

    UpstreamHTTP2Parameters

    HTTP2 回源配置。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting。

    名称 类型 必选 描述
    Switch String 否 HTTP2 回源配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•

    UpstreamHttp2

    Http2回源配置

    被如下接口引用：DescribeZoneSetting, ModifyZoneSetting。

    名称 类型 必选 描述
    Switch String 是 http2 回源配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•

    UpstreamRequestCookie

    回源请求参数 Cookie 配置。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    Switch String 否 回源请求参数 Cookie 配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    Action String 否 回源请求参数 Cookie 模式。当 Switch 为 on 时，该参数必填。取值有：
  • full：表示全部保留；
  • ignore：表示全部忽略；
  • includeCustom：表示保留部分参数；
  • excludeCustom：表示忽略部分参数。
    		•
    Values Array of String 否 指定参数值。仅当查询字符串模式 Action 为 includeCustom 或者 excludeCustom 时该参数生效，用于指定需要保留或者忽略的参数。最大支持 10 个参数。

    UpstreamRequestParameters

    回源请求参数配置参数。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    QueryString UpstreamRequestQueryString 否 查询字符串配置。可选配置项，不填表示不配置。
    注意：此字段可能返回 null，表示取不到有效值。
    Cookie UpstreamRequestCookie 否 Cookie 配置。可选配置项，不填表示不配置。
    注意：此字段可能返回 null，表示取不到有效值。

    UpstreamRequestQueryString

    回源请求参数查询字符串配置。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    Switch String 否 回源请求参数查询字符串配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    Action String 否 查询字符串模式。当 Switch 为 on 时，该参数必填。取值有：
  • full：全部保留；
  • ignore：全部忽略；
  • includeCustom：保留部分参数；
  • excludeCustom：忽略部分参数。
    		•
    Values Array of String 否 指定参数值。仅当查询字符串模式 Action 为 includeCustom 或者 excludeCustom 时该参数生效，用于指定需要保留或者忽略的参数。最大支持 10 个参数。

    UpstreamURLRewriteParameters

    回源 URL 重写 配置参数。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    Type String 否 回源 URL 重写类型。仅支持填写 Path。
    Action String 否 回源 URL 重写动作。取值有：
  • replace：指替换完整路径。用于将完整的请求 URL Path 替换为指定路径。
  • addPrefix：指增加路径前缀。用于增加指定路径前缀至请求 URL Path。
  • rmvPrefix：指移除路径前缀。用于移除请求 URL Path 的指定路径前缀。
  • regexReplace：指正则替换完整路径。用于通过 Google RE2 正则表达式匹配和替换完整路径。
    		•
    Value String 否 回源 URL 重写值。需要满足 URL Path 规范，且保证重写后的 Path 以 / 开头，以防止回源 URL 的 Host 被修改，长度范围为 1～1024。当 Action 为 addPrefix 时，不能以 / 结尾；当 Action 为 rmvPrefix 时，不能存在 *；当 Action 为 regexReplace 时，支持用 $NUM 引用正则捕获组，其中 NUM 代表组编号，如 $1，最多支持 $9。
    Regex String 否 回源 URL 重写用于正则替换匹配完整路径的正则表达式。需要满足 Google RE2 规范，长度范围为 1～1024。当 Action 为 regexReplace 时，此字段必填，否则无需填写此字段。

    VanityNameServers

    自定义 nameservers

    被如下接口引用：DescribeZones, ModifyZone。

    名称 类型 必选 描述
    Switch String 是 自定义 ns 开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    Servers Array of String 否 自定义 ns 列表。

    VanityNameServersIps

    自定义名字服务器 IP 信息

    被如下接口引用：DescribeZones。

    名称 类型 描述
    Name String 自定义名字服务器名称。
    IPv4 String 自定义名字服务器 IPv4 地址。

    VaryParameters

    Vary 特性 配置参数。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。

    名称 类型 必选 描述
    Switch String 是 Vary 特性配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•

    VideoTemplateInfo

    视频流配置参数。

    被如下接口引用：CreateJustInTimeTranscodeTemplate, DescribeJustInTimeTranscodeTemplates。

    名称 类型 必选 描述
    Codec String 是 视频流的编码格式，可选值：
  • H.264: 使用 H.264 编码；
  • H.265: 使用 H.265 编码。
    		•
    Fps Float 否 视频帧率，取值范围：[0, 30]，单位：Hz。
    取值为 0，表示帧率和原始视频保持一致，但最大不超过 30。
    默认值：0。
    Bitrate Integer 否 视频流的码率，取值范围：0 和 [128, 10000]，单位：kbps。
    取值为 0，表示自动根据视频画面和质量选择视频码率。
    默认值：0。
    ResolutionAdaptive String 否 分辨率自适应，可选值：
  • open：开启，此时，Width 代表视频的长边，Height 表示视频的短边；
  • close：关闭，此时，Width 代表视频的宽度，Height 表示视频的高度。
    • 默认值：open。
    Width Integer 否 视频流宽度（或长边）的最大值，取值范围：0 和 [128, 1920]，单位：px。
  • 当 Width、Height 均为 0，则分辨率同源；
  • 当 Width 为 0，Height 非 0，则 Width 按比例缩放；
  • 当 Width 非 0，Height 为 0，则 Height 按比例缩放；
  • 当 Width、Height 均非 0，则分辨率按用户指定。
    • 默认值：0。
    Height Integer 否 视频流高度（或短边）的最大值，取值范围：0 和 [128, 1080]，单位：px。
  • 当 Width、Height 均为 0，则分辨率同源；
  • 当 Width 为 0，Height 非 0，则 Width 按比例缩放；
  • 当 Width 非 0，Height 为 0，则 Height 按比例缩放；
  • 当 Width、Height 均非 0，则分辨率按用户指定。
    • 默认值：0。
    FillType String 否 填充方式，当视频流配置宽高参数与原始视频的宽高比不一致时，对转码的处理方式，即为“填充”。可选填充方式：
  • stretch：拉伸，对每一帧进行拉伸，填满整个画面，可能导致转码后的视频被“压扁”或者“拉长”。
  • black：留黑，保持视频宽高比不变，边缘剩余部分使用黑色填充。
  • white：留白，保持视频宽高比不变，边缘剩余部分使用白色填充。
  • gauss：高斯模糊，保持视频宽高比不变，边缘剩余部分使用高斯模糊填充。
    • 默认值：black 。

    Waf

    无

    被如下接口引用：DescribeHostsSetting。

    名称 类型 必选 描述
    Switch String 是 Waf开关，取值为：
  • on：开启；
  • off：关闭。
    		•
    PolicyId Integer 否 策略ID。

    WafConfig

    Waf配置。

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    Switch String 是 WafConfig开关，取值有：
  • on：开启；
  • off：关闭。
    • 开关仅与配置是否生效有关，即使为off（关闭），也可以正常修改配置的内容。
    Level String 是 上一次设置的防护级别，取值有：
  • loose：宽松；
  • normal：正常；
  • strict：严格；
  • stricter：超严格；
  • custom：自定义。
    		•
    Mode String 是 全局WAF模式，取值有：
  • block：阻断（全局阻断，但可对详细规则配置观察）；
  • observe：观察（无论详细规则配置什么，都为观察）。
    		•
    WafRule WafRule 否 托管规则详细配置。如果为null，默认使用历史配置。
    AiRule AiRule 否 AI规则引擎防护配置。如果为null，默认使用历史配置。

    WafRule

    Waf规则

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    Switch String 是 托管规则开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    BlockRuleIDs Array of Integer 是 黑名单ID列表，将规则ID加入本参数列表中代表该ID关闭，即该规则ID不再生效。
    ObserveRuleIDs Array of Integer 是 观察模式ID列表，将规则ID加入本参数列表中代表该ID使用观察模式生效，即该规则ID进入观察模式。

    WebSocket

    WebSocket配置

    被如下接口引用：DescribeZoneSetting, ModifyZoneSetting。

    名称 类型 必选 描述
    Switch String 是 WebSocket 超时时间配置开关，取值有：
  • on：使用Timeout作为WebSocket超时时间；
  • off：平台仍支持WebSocket连接，此时使用系统默认的15秒为超时时间。
    		•
    Timeout Integer 否 超时时间，单位为秒，最大超时时间120秒。

    WebSocketParameters

    WebSocket 配置。

    被如下接口引用：CreateL7AccRules, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting。

    名称 类型 必选 描述
    Switch String 否 WebSocket 超时时间配置开关，取值有：
  • on：使用 Timeout 作为 WebSocket 超时时间；
  • off：平台仍支持 WebSocket 连接，此时使用系统默认的 15 秒为超时时间。
    		•
    Timeout Integer 否 超时时间，单位为秒，最大超时时间 120 秒。
    注意：当 Switch 为 on 时，此字段必填，否则此字段不生效。

    Zone

    站点详情。

    被如下接口引用：DescribeZones。

    名称 类型 描述
    ZoneId String 站点 ID。
    ZoneName String 站点名称。
    AliasZoneName String 同名站点标识。允许输入数字、英文、"." 、"-" 和 "_" 组合，长度 200 个字符以内。
    Area String 站点加速区域，取值有：
  • global：全球可用区；
  • mainland：中国大陆可用区；
  • overseas：全球可用区（不含中国大陆）。
    		•
    Type String 站点接入类型，取值有：
  • full：NS 接入类型；
  • partial：CNAME 接入类型；
  • noDomainAccess：无域名接入类型；
  • dnsPodAccess：DNSPod 托管类型，该类型要求您的域名已托管在腾讯云 DNSPod；
  • pages：Pages 类型。
    		•
    Tags Array of Tag 站点关联的标签。
    Resources Array of Resource 计费资源列表。
    NSDetail NSDetail NS 类型站点详情。仅当 Type = full 时返回值。
    CNAMEDetail CNAMEDetail CNAME 类型站点详情。仅当 Type = partial 时返回值。
    DNSPodDetail DNSPodDetail DNSPod 托管类型站点详情。仅当 Type = dnsPodAccess 时返回值。
    CreatedOn Timestamp ISO8601 站点创建时间。
    ModifiedOn Timestamp ISO8601 站点修改时间。
    Status String 站点状态，取值有：
  • active：NS 已切换；
  • pending：NS 未切换；
  • moved：NS 已切走；
  • deactivated：被封禁。
  • initializing：待绑定套餐。
    • CnameStatus String CNAME 接入状态，取值有：
  • finished：站点已验证；
  • pending：站点验证中。
    		•
    ActiveStatus String 展示状态，取值有：
  • active：已启用；
  • inactive：未生效；
  • paused：已停用。
    		•
    LockStatus String 锁定状态，取值有：
  • enable：正常，允许进行修改操作；
  • disable：锁定中，不允许进行修改操作；
  • plan_migrate：套餐迁移中，不允许进行修改操作。
    		•
    Paused Boolean 站点是否关闭。
    IsFake Integer 是否伪站点（该字段为历史保留字段，已不再维护，请根据站点类型参考对应字段），取值有：
  • 0：非伪站点；
  • 1：伪站点。

    		•
    CnameSpeedUp String 是否开启 CNAME 加速（该字段为历史保留字段，已不再维护，请根据站点类型参考对应字段），取值有：
  • enabled：开启；
  • disabled：关闭。
    		•
    OwnershipVerification OwnershipVerification 归属权验证信息。（该字段为历史保留字段，已不再维护，请根据站点类型参考对应字段）
    注意：此字段可能返回 null，表示取不到有效值。
    OriginalNameServers Array of String 站点当前使用的 NS 列表。（该字段为历史保留字段，已不再维护，请根据站点类型参考对应字段）
    NameServers Array of String 腾讯云分配的 NS 列表。（该字段为历史保留字段，已不再维护，请根据站点类型参考对应字段）
    VanityNameServers VanityNameServers 用户自定义 NS 信息。（该字段为历史保留字段，已不再维护，请根据站点类型参考对应字段）
    注意：此字段可能返回 null，表示取不到有效值。
    VanityNameServersIps Array of VanityNameServersIps 用户自定义 NS IP 信息。（该字段为历史保留字段，已不再维护，请根据站点类型参考对应字段）
    注意：此字段可能返回 null，表示取不到有效值。

    ZoneConfig

    站点加速配置。

    被如下接口引用：DescribeL7AccSetting, ModifyL7AccSetting。

    名称 类型 必选 描述
    SmartRouting SmartRoutingParameters 否 智能加速配置。
    注意：此字段可能返回 null，表示取不到有效值。
    Cache CacheConfigParameters 否 缓存过期时间配置。
    注意：此字段可能返回 null，表示取不到有效值。
    MaxAge MaxAgeParameters 否 浏览器缓存配置。
    注意：此字段可能返回 null，表示取不到有效值。
    CacheKey CacheKeyConfigParameters 否 节点缓存键配置。
    注意：此字段可能返回 null，表示取不到有效值。
    CachePrefresh CachePrefreshParameters 否 缓存预刷新配置。
    注意：此字段可能返回 null，表示取不到有效值。
    OfflineCache OfflineCacheParameters 否 离线缓存配置。
    注意：此字段可能返回 null，表示取不到有效值。
    Compression CompressionParameters 否 智能压缩配置。
    注意：此字段可能返回 null，表示取不到有效值。
    ForceRedirectHTTPS ForceRedirectHTTPSParameters 否 访问协议强制 HTTPS 跳转配置。
    注意：此字段可能返回 null，表示取不到有效值。
    HSTS HSTSParameters 否 HSTS 相关配置。
    注意：此字段可能返回 null，表示取不到有效值。
    TLSConfig TLSConfigParameters 否 TLS 相关配置。
    注意：此字段可能返回 null，表示取不到有效值。
    OCSPStapling OCSPStaplingParameters 否 OCSP 装订配置。
    注意：此字段可能返回 null，表示取不到有效值。
    HTTP2 HTTP2Parameters 否 HTTP2 相关配置。
    注意：此字段可能返回 null，表示取不到有效值。
    QUIC QUICParameters 否 QUIC 访问配置。
    注意：此字段可能返回 null，表示取不到有效值。
    UpstreamHTTP2 UpstreamHTTP2Parameters 否 HTTP2 回源配置。
    注意：此字段可能返回 null，表示取不到有效值。
    IPv6 IPv6Parameters 否 IPv6 访问配置。
    注意：此字段可能返回 null，表示取不到有效值。
    WebSocket WebSocketParameters 否 WebSocket 配置。
    注意：此字段可能返回 null，表示取不到有效值。
    PostMaxSize PostMaxSizeParameters 否 POST 请求传输配置。
    注意：此字段可能返回 null，表示取不到有效值。
    ClientIPHeader ClientIPHeaderParameters 否 客户端 IP 回源请求头配置。
    注意：此字段可能返回 null，表示取不到有效值。
    ClientIPCountry ClientIPCountryParameters 否 回源时是否携带客户端 IP 所属地域信息的配置。
    注意：此字段可能返回 null，表示取不到有效值。
    Grpc GrpcParameters 否 gRPC 协议支持配置。
    注意：此字段可能返回 null，表示取不到有效值。
    AccelerateMainland AccelerateMainlandParameters 否 中国大陆加速优化配置。
    注意：此字段可能返回 null，表示取不到有效值。
    StandardDebug StandardDebugParameters 否 标准 Debug 配置。
    注意：此字段可能返回 null，表示取不到有效值。

    ZoneConfigParameters

    站点配置相关信息。

    被如下接口引用：DescribeL7AccSetting。

    名称 类型 描述
    ZoneName String 站点名称。
    ZoneConfig ZoneConfig 站点配置信息。
    注意：此字段可能返回 null，表示取不到有效值。

    ZoneInfo

    返回站点信息

    被如下接口引用：DescribePlans。

    名称 类型 必选 描述
    ZoneId String 否 站点id。
    ZoneName String 否 站点名称。
    Paused Boolean 否 站点是否停用。取值有：
  • false：非停用；
  • true：停用。
    		•

    ZoneSetting

    站点配置。

    被如下接口引用：DescribeZoneSetting。

    名称 类型 描述
    ZoneName String 站点名称。
    Area String 站点加速区域信息，取值有：
  • mainland：中国境内加速；
  • overseas：中国境外加速。
    		•
    CacheKey CacheKey 节点缓存键配置。
    注意：此字段可能返回 null，表示取不到有效值。
    Quic Quic Quic访问配置。
    注意：此字段可能返回 null，表示取不到有效值。
    PostMaxSize PostMaxSize POST请求传输配置。
    注意：此字段可能返回 null，表示取不到有效值。
    Compression Compression 智能压缩配置。
    注意：此字段可能返回 null，表示取不到有效值。
    UpstreamHttp2 UpstreamHttp2 Http2回源配置。
    注意：此字段可能返回 null，表示取不到有效值。
    ForceRedirect ForceRedirect 访问协议强制Https跳转配置。
    注意：此字段可能返回 null，表示取不到有效值。
    CacheConfig CacheConfig 缓存过期时间配置。
    注意：此字段可能返回 null，表示取不到有效值。
    Origin Origin 源站配置。
    注意：此字段可能返回 null，表示取不到有效值。
    SmartRouting SmartRouting 智能加速配置。
    注意：此字段可能返回 null，表示取不到有效值。
    MaxAge MaxAge 浏览器缓存配置。
    注意：此字段可能返回 null，表示取不到有效值。
    OfflineCache OfflineCache 离线缓存配置。
    注意：此字段可能返回 null，表示取不到有效值。
    WebSocket WebSocket WebSocket配置。
    注意：此字段可能返回 null，表示取不到有效值。
    ClientIpHeader ClientIpHeader 客户端IP回源请求头配置。
    注意：此字段可能返回 null，表示取不到有效值。
    CachePrefresh CachePrefresh 缓存预刷新配置。
    注意：此字段可能返回 null，表示取不到有效值。
    Ipv6 Ipv6 Ipv6访问配置。
    注意：此字段可能返回 null，表示取不到有效值。
    Https Https Https 加速配置。
    注意：此字段可能返回 null，表示取不到有效值。
    ClientIpCountry ClientIpCountry 回源时是否携带客户端IP所属地域信息的配置。
    注意：此字段可能返回 null，表示取不到有效值。
    Grpc Grpc Grpc协议支持配置。
    注意：此字段可能返回 null，表示取不到有效值。
    ImageOptimize ImageOptimize 图片优化相关配置。
    注意：此字段可能返回 null，表示取不到有效值。
    AccelerateMainland AccelerateMainland 中国大陆加速优化配置。
    注意：此字段可能返回 null，表示取不到有效值。
    StandardDebug StandardDebug 标准 Debug 配置。
    注意：此字段可能返回 null，表示取不到有效值。
    JITVideoProcess JITVideoProcess 视频即时处理配置。
    注意：此字段可能返回 null，表示取不到有效值。
    中国站
    目录