边缘安全加速平台 EO
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 边缘安全加速平台 EO > API 文档 > 数据结构

数据结构

最近更新时间：2024-04-25 01:25:33

我的收藏

本页目录：

AccelerateMainland

中国大陆加速优化配置。

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

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

    AccelerateType

    加速类型

    被如下接口引用：DescribeHostsSetting。

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

    AccelerationDomain

    加速域名

    被如下接口引用：DescribeAccelerationDomains。

    名称 类型 描述
    ZoneId String 站点 ID。
    DomainName String 加速域名名称。
    DomainStatus String 加速域名状态，取值有：
  • online：已生效；
  • process：部署中；
  • offline：已停用；
  • forbidden：已封禁；
  • init：未生效，待激活站点；
    		•
    OriginDetail OriginDetail 源站信息。
    注意：此字段可能返回 null，表示取不到有效值。
    OriginProtocol String 回源协议，取值有：
  • FOLLOW: 协议跟随；
  • HTTP: HTTP协议回源；
  • HTTPS: HTTPS协议回源。

    • 注意：此字段可能返回 null，表示取不到有效值。
    Certificate AccelerationDomainCertificate 域名证书信息
    注意：此字段可能返回 null，表示取不到有效值。
    HttpOriginPort Integer HTTP回源端口。
    注意：此字段可能返回 null，表示取不到有效值。
    HttpsOriginPort Integer HTTPS回源端口。
    注意：此字段可能返回 null，表示取不到有效值。
    IPv6Status String IPv6状态，取值有：
  • follow：遵循站点IPv6配置；
  • on：开启状态；
  • off：关闭状态。

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

    • 注意：此字段可能返回 null，表示取不到有效值。
    CreatedOn Timestamp ISO8601 创建时间。
    ModifiedOn Timestamp ISO8601 修改时间。
    OwnershipVerification OwnershipVerification 当域名需要进行归属权验证才能继续提供服务时，该对象会携带对应验证方式所需要的信息。
    注意：此字段可能返回 null，表示取不到有效值。

    AccelerationDomainCertificate

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

    被如下接口引用：DescribeAccelerationDomains。

    名称 类型 必选 描述
    Mode String 否 配置证书的模式，取值有：
  • disable：不配置证书；
  • eofreecert：配置 EdgeOne 免费证书；
  • sslcert：配置 SSL 证书。
    		•
    List Array of CertificateInfo 否 证书列表。
    注意：此字段可能返回 null，表示取不到有效值。

    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 否 托管定制规则
    注意：此字段可能返回 null，表示取不到有效值。

    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）；
  • 缓存预刷新（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，表示取不到有效值。

    AdvancedFilter

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

    被如下接口引用：DescribeAccelerationDomains, DescribeAliasDomains, DescribeConfigGroupVersions, DescribeDeployHistory, 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校验和会话行为分析。
    注意：此字段可能返回 null，表示取不到有效值。
    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 别称域名修改时间。

    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时，该值才会生效。
    注意：此字段可能返回 null，表示取不到有效值。
    OriginPort String 否 源站端口，支持格式：
  • 单端口，如：80。
  • 端口段：81-82，表示81，82两个端口。
    		•
    RuleTag String 否 规则标签。
    注意：此字段可能返回 null，表示取不到有效值。

    AscriptionInfo

    站点归属信息

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

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

    BillingData

    计费数据项

    被如下接口引用：DescribeBillingData。

    名称 类型 描述
    Time Timestamp ISO8601 时间。
    Value Integer 数值。

    BillingDataFilter

    计费数据过滤条件。

    被如下接口引用：DescribeBillingData。

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

    BindSharedCNAMEMap

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

    被如下接口引用：BindSharedCNAME。

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

    BotConfig

    安全Bot配置

    被如下接口引用：ModifySecurityPolicy。

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

    BotExtendAction

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

    被如下接口引用：ModifySecurityPolicy。

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

    BotManagedRule

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

    被如下接口引用：ModifySecurityPolicy。

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

    BotPortraitRule

    bot 用户画像规则

    被如下接口引用：ModifySecurityPolicy。

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

    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 时必填，且不能为空。

    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 日志集所在的地域。

    Cache

    缓存时间设置

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

    名称 类型 必选 描述
    Switch String 是 缓存配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    CacheTime Integer 否 缓存过期时间设置。
    单位为秒，最大可设置为 365 天。
    注意：此字段可能返回 null，表示取不到有效值。

    CacheConfig

    缓存规则配置。

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

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

    CacheKey

    缓存键配置。

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

    名称 类型 必选 描述
    FullUrlCache String 否 是否开启全路径缓存，取值有：
  • on：开启全路径缓存（即关闭参数忽略）；
  • off：关闭全路径缓存（即开启参数忽略）。

    • 注意：此字段可能返回 null，表示取不到有效值。
    IgnoreCase String 否 是否忽略大小写缓存，取值有：
  • on：忽略；
  • off：不忽略。

    • 注意：此字段可能返回 null，表示取不到有效值。
    QueryString QueryString 否 CacheKey 中包含请求参数。
    注意：此字段可能返回 null，表示取不到有效值。

    CachePrefresh

    缓存预刷新

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

    名称 类型 必选 描述
    Switch String 是 缓存预刷新配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    Percent Integer 否 缓存预刷新百分比，取值范围：1-99。
    注意：此字段可能返回 null，表示取不到有效值。

    CertificateInfo

    https 服务端证书配置

    被如下接口引用：DescribeAccelerationDomains。

    名称 类型 描述
    CertId String 服务器证书 ID。
    Alias String 证书备注名。
    Type String 证书类型，取值有：
  • default：默认证书；
  • upload：用户上传；
  • managed：腾讯云托管。
    		•
    ExpireTime Timestamp ISO8601 证书过期时间。
    DeployTime Timestamp ISO8601 证书部署时间。
    SignAlgo String 签名算法。
    Status String 证书状态，取值有：
  • deployed：已部署；
  • processing：部署中；
  • applying：申请中；
  • failed：申请失败；
  • issued：绑定失败。
    		•

    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 的请求头名称。
    为空则使用默认值：X-Forwarded-IP。
    注意：此字段可能返回 null，表示取不到有效值。

    CnameStatus

    CNAME 状态

    被如下接口引用：CheckCnameStatus。

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

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

    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算法。

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

    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 标准的日期和时间格式。

    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 请求中包含的日志条数。

    CustomField

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

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

    名称 类型 必选 描述
    Name String 是 从 HTTP 请求和响应中的指定位置提取数据，取值有：
  • ReqHeader：从 HTTP 请求头中提取指定字段值；
  • RspHeader：从 HTTP 响应头中提取指定字段值；
  • Cookie: 从 Cookie 中提取指定字段值。

    • 注意：此字段可能返回 null，表示取不到有效值。
    Value String 是 需要提取值的参数名称，例如：Accept-Language。
    注意：此字段可能返回 null，表示取不到有效值。
    Enabled Boolean 否 是否投递该字段，不填表示不投递此字段。
    注意：此字段可能返回 null，表示取不到有效值。

    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 封禁受影响区域。

    DDosProtectionConfig

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

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

    名称 类型 必选 描述
    LevelMainland String 否 中国大陆地区独立 DDoS 防护的规格。详情请参考 独立 DDoS 防护相关费用
  • PLATFORM：平台默认防护，即不开启独立 DDoS 防护；
  • BASE30_MAX300：开启独立 DDoS 防护，提供 30 Gbps 保底防护带宽，可配置最高 300 Gpbs 弹性防护带宽；
  • BASE60_MAX600：开启独立 DDoS 防护，提供 60 Gbps 保底防护带宽，可配置最高 600 Gpbs 弹性防护带宽。
    • 不填写参数时，取默认值 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。

    DefaultServerCertInfo

    https 服务端证书配置

    被如下接口引用：DescribeDefaultCertificates。

    名称 类型 必选 描述
    CertId String 是 服务器证书 ID。
    注意：此字段可能返回 null，表示取不到有效值。
    Alias String 否 证书备注名。
    注意：此字段可能返回 null，表示取不到有效值。
    Type String 否 证书类型，取值有：
  • default: 默认证书;
  • upload:用户上传;
  • managed:腾讯云托管。

    • 注意：此字段可能返回 null，表示取不到有效值。
    ExpireTime Timestamp ISO8601 否 证书过期时间。
    注意：此字段可能返回 null，表示取不到有效值。
    EffectiveTime Timestamp ISO8601 否 证书生效时间。
    注意：此字段可能返回 null，表示取不到有效值。
    CommonName String 否 证书公用名。
    注意：此字段可能返回 null，表示取不到有效值。
    SubjectAltName Array of String 否 证书SAN域名。
    注意：此字段可能返回 null，表示取不到有效值。
    Status String 否 部署状态，取值有：
  • processing: 部署中；
  • deployed: 已部署；
  • failed: 部署失败。

    • 注意：此字段可能返回 null，表示取不到有效值。
    Message String 否 Status为失败时,此字段返回失败原因。
    注意：此字段可能返回 null，表示取不到有效值。
    SignAlgo String 否 证书算法。
    注意：此字段可能返回 null，表示取不到有效值。

    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：短时间等待后响应
    		•

    DeployRecord

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

    被如下接口引用：DescribeDeployHistory。

    名称 类型 描述
    ConfigGroupVersionInfos Array of ConfigGroupVersionInfo 发布版本的详细信息。
    DeployTime Timestamp ISO8601 发布时间。时间为世界标准时间（UTC）， 遵循 ISO 8601 标准的日期和时间格式。
    Status String 发布状态，取值有：
  • deploying ：发布中；
  • failure ：发布失败；
  • success： 发布成功。
    		•
    Message String 发布结果信息。
    RecordId String 发布记录 ID。
    注意：此字段可能返回 null，表示取不到有效值。
    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，表示取不到有效值。

    DiffIPWhitelist

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

    被如下接口引用：DescribeOriginProtection。

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

    DnsVerification

    CNAME 接入，使用 DNS 解析验证时所需的信息。

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

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

    DropPageConfig

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

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    Switch String 是 配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    WafDropPageDetail DropPageDetail 否 Waf(托管规则)模块的拦截页面配置。如果为null，默认使用历史配置。
    注意：此字段可能返回 null，表示取不到有效值。
    AclDropPageDetail DropPageDetail 否 自定义页面的拦截页面配置。如果为null，默认使用历史配置。
    注意：此字段可能返回 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 标准的日期和时间格式。

    ExceptConfig

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

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    Switch String 是 配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    ExceptUserRules Array of ExceptUserRule 否 例外规则详情。如果为null，默认使用历史配置。
    注意：此字段可能返回 null，表示取不到有效值。

    ExceptUserRule

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

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    RuleName String 是 规则名称，不可使用中文。
    Action String 是 规则的处置方式，当前仅支持skip：跳过全部托管规则。
    RuleStatus String 是 规则生效状态，取值有：
  • on：生效；
  • off：失效。
    		•
    RuleID Integer 否 规则ID。仅出参使用。默认由底层生成。
    UpdateTime Timestamp ISO8601 否 更新时间，如果为null，默认由底层按当前时间生成。
    注意：此字段可能返回 null，表示取不到有效值。
    ExceptUserRuleConditions Array of ExceptUserRuleCondition 否 匹配条件。
    注意：此字段可能返回 null，表示取不到有效值。
    ExceptUserRuleScope ExceptUserRuleScope 否 规则生效的范围。
    注意：此字段可能返回 null，表示取不到有效值。
    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防护。

    • 注意：此字段可能返回 null，表示取不到有效值。
    PartialModules Array of PartialModule 否 跳过部分规则ID的例外规则详情。如果为null，默认使用历史配置。
    注意：此字段可能返回 null，表示取不到有效值。
    SkipConditions Array of SkipCondition 否 跳过具体字段不去扫描的例外规则详情。如果为null，默认使用历史配置。
    注意：此字段可能返回 null，表示取不到有效值。

    FailReason

    失败原因

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

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

    FileAscriptionInfo

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

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

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

    FileVerification

    CNAME 接入，使用文件验证时所需的信息。

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

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

    Filter

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

    被如下接口引用：DescribeApplicationProxies, DescribeDefaultCertificates, DescribeHostsSetting, DescribeIdentifications, DescribeL4Proxy, DescribeL4ProxyRules, DescribeOriginProtection, DescribeRules。

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

    FirstPartConfig

    慢速攻击的首段包配置。

    被如下接口引用：ModifySecurityPolicy。

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

    • 注意：此字段可能返回 null，表示取不到有效值。
    StatTime Integer 否 首段包的统计时长，单位是秒，即期望首段包的统计时长是多少，默认5秒。
    注意：此字段可能返回 null，表示取不到有效值。

    FollowOrigin

    缓存遵循源站配置

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

    名称 类型 必选 描述
    Switch String 是 遵循源站配置开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    DefaultCacheTime Integer 否 源站未返回 Cache-Control 头时, 设置默认的缓存时间
    注意：此字段可能返回 null，表示取不到有效值。
    DefaultCache String 否 源站未返回 Cache-Control 头时, 设置缓存/不缓存
    注意：此字段可能返回 null，表示取不到有效值。
    DefaultCacheStrategy String 否 源站未返回 Cache-Control 头时, 使用/不使用默认缓存策略
    注意：此字段可能返回 null，表示取不到有效值。

    ForceRedirect

    访问协议强制https跳转配置

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

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

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

    Grpc

    Grpc配置项

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

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

    刷新预热附带的头部信息

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

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

    Hsts

    Hsts配置

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

    名称 类型 必选 描述
    Switch String 是 是否开启，取值有：
  • on：开启；
  • off：关闭。
    		•
    MaxAge Integer 否 MaxAge 数值。单位为秒，最大值为1天。
    注意：此字段可能返回 null，表示取不到有效值。
    IncludeSubDomains String 否 是否包含子域名，取值有：
  • on：开启；
  • off：关闭。

    • 注意：此字段可能返回 null，表示取不到有效值。
    Preload String 否 是否开启预加载，取值有：
  • on：开启；
  • off：关闭。

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

    Https

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

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

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

    • 注意：此字段可能返回 null，表示取不到有效值。
    OcspStapling String 否 OCSP 配置开关，取值有：
  • on：开启；
  • off：关闭。

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

    IPGroup

    IP 网段组

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

    名称 类型 必选 描述
    GroupId Integer 是 组 Id，创建时填 0 即可。
    Name String 是 组名称。
    Content Array of String 是 IP 组内容，仅支持 IP 及 IP 掩码。

    IPRegionInfo

    IP 归属信息查询

    被如下接口引用：DescribeIPRegion。

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

    IPWhitelist

    源站防护IP白名单

    被如下接口引用：DescribeOriginProtection。

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

    Identification

    站点验证信息

    被如下接口引用：DescribeIdentifications。

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

    ImageOptimize

    图片优化配置。

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

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

    IntelligenceRule

    智能分析规则

    被如下接口引用：ModifySecurityPolicy。

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

    • 注意：此字段可能返回 null，表示取不到有效值。
    IntelligenceRuleItems Array of IntelligenceRuleItem 否 规则详情。
    注意：此字段可能返回 null，表示取不到有效值。

    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：关闭；

    • 注意：此字段可能返回 null，表示取不到有效值。
    IpTableRules Array of IpTableRule 否 基础管控规则。如果为null，默认使用历史配置。
    注意：此字段可能返回 null，表示取不到有效值。

    IpTableRule

    IP黑白名单详细规则

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    Action String 是 动作，取值有：
  • drop：拦截；
  • trans：放行；
  • monitor：观察。
    		•
    MatchFrom String 是 根据类型匹配，取值有：
  • ip：对ip进行匹配；
  • area：对ip所属地区匹配。
    		•
    Operator String 否 规则的匹配方式，默认为空代表等于。
    取值有：
  • is_emty：配置为空；
  • not_exists：配置为不存在；
  • include：包含；
  • not_include：不包含；
  • equal：等于；
  • not_equal：不等于。

    • 注意：此字段可能返回 null，表示取不到有效值。
    RuleID Integer 否 规则id。仅出参使用。
    UpdateTime Timestamp ISO8601 否 更新时间。仅出参使用。
    Status String 否 规则启用状态，当返回为null时，为启用。取值有：
  • on：启用；
  • off：未启用。

    • 注意：此字段可能返回 null，表示取不到有效值。
    RuleName String 否 规则名。
    注意：此字段可能返回 null，表示取不到有效值。
    MatchContent String 否 匹配内容。当 Operator为is_emty 或not_exists时，此值允许为空。

    Ipv6

    Ipv6访问配置

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

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

    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 否 最新变更时间。

    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。

    L7OfflineLog

    七层离线日志详细信息。

    被如下接口引用：DownloadL7Logs。

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

    MaxAge

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

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

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

    NoCache

    不缓存配置

    被如下接口引用：DescribeHostsSetting, 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 切换至该地址。

    OfflineCache

    离线缓存是否开启

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

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

    Origin

    源站配置。

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

    名称 类型 必选 描述
    Origins Array of String 否 主源站列表。
    注意：此字段可能返回 null，表示取不到有效值。
    BackupOrigins Array of String 否 备源站列表。
    注意：此字段可能返回 null，表示取不到有效值。
    OriginPullProtocol String 否 回源协议配置，取值有：
  • http：强制 http 回源；
  • follow：协议跟随回源；
  • https：强制 https 回源。

    • 注意：此字段可能返回 null，表示取不到有效值。
    CosPrivateAccess String 否 源站为腾讯云 COS 时，是否为私有访问 bucket，取值有：
  • on：私有访问；
  • off：公共访问。

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

    OriginDetail

    加速域名源站信息。

    被如下接口引用：DescribeAccelerationDomains。

    名称 类型 描述
    OriginType String 源站类型，取值有：
  • IP_DOMAIN：IPV4、IPV6 或域名类型源站；
  • COS：腾讯云 COS 对象存储源站；
  • AWS_S3：AWS S3 对象存储源站；
  • ORIGIN_GROUP：源站组类型源站；
  • VODEO：云点播（混合云版）；
  • SPACE：源站卸载，当前仅白名单开放；
  • LB：负载均衡，当前仅白名单开放。
    		•
    Origin String 源站地址，根据 OriginType 的取值分为以下情况：
  • 当 OriginType = IP_DOMAIN 时，该参数为 IPv4、IPv6 地址或域名；
  • 当 OriginType = COS 时，该参数为 COS 桶的访问域名；
  • 当 OriginType = AWS_S3，该参数为 S3 桶的访问域名；
  • 当 OriginType = ORIGIN_GROUP 时，该参数为源站组 ID；
  • 当 OriginType = VODEO 时，如果 VodeoDistributionRange = ALL，则该参数为 "all-buckets-in-vodeo-application"；如果 VodeoDistributionRange = Bucket，则该参数为对应存储桶域名。
    		•
    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，表示取不到有效值。
    VodeoSubAppId Integer MO 子应用 ID
    VodeoDistributionRange String MO 分发范围，取值有：
  • All：全部
  • Bucket：存储桶
    		•
    VodeoBucketId String MO 存储桶 ID，分发范围(DistributionRange)为存储桶(Bucket)时必填

    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。
    注意：此字段可能返回 null，表示取不到有效值。

    OriginGroupReference

    源站组引用服务。

    被如下接口引用：DescribeOriginGroup。

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

    OriginInfo

    加速域名源站信息。

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

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

  • VODEO：云点播（混合云版）；
  • SPACE：源站卸载，当前仅白名单开放；
  • LB：负载均衡，当前仅白名单开放。
    		•
    Origin String 是 源站地址，根据 OriginType 的取值分为以下情况：
  • 当 OriginType = IP_DOMAIN 时，该参数请填写 IPv4、IPv6 地址或域名；
  • 当 OriginType = COS 时，该参数请填写 COS 桶的访问域名；
  • 当 OriginType = AWS_S3，该参数请填写 S3 桶的访问域名；
  • 当 OriginType = ORIGIN_GROUP 时，该参数请填写源站组 ID；
  • 当 OriginType = VODEO 时，如果 VodeoDistributionRange = ALL，则该参数填写 "all-buckets-in-vodeo-application"；如果 VodeoDistributionRange = Bucket，则该参数请填写对应存储桶域名；
  • 当 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 时会生效。
    VodeoSubAppId Integer 否 VODEO 子应用 ID。该参数当 OriginType = VODEO 时必填。
    VodeoDistributionRange String 否 VODEO 分发范围，该参数当 OriginType = VODEO 时必填。取值有：
  • All：当前应用下所有存储桶；

  • Bucket：指定的某一个存储桶。
    		•
    VodeoBucketId String 否 VODEO 存储桶 ID，该参数当 OriginType = VODEO 且 VodeoDistributionRange = Bucket 时必填。

    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，表示取不到有效值。

    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, 流量将不会调度到此源站。
    注意：此字段可能返回 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 否 模块名称，取值为：
  • waf：托管规则。
    		•
    Include Array of Integer 否 模块下的需要例外的具体规则ID列表。
    注意：此字段可能返回 null，表示取不到有效值。

    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 否 最大限制，取值在1MB和500MB之间。单位字节。
    注意：此字段可能返回 null，表示取不到有效值。

    PrivateParameter

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

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

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

    QueryCondition

    查询条件

    被如下接口引用：CreateRealtimeLogDeliveryTask, DescribeOverviewL7Data, DescribeTimingL4Data, DescribeTimingL7AnalysisData, DescribeTimingL7CacheData, 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参数。

    • 注意：此字段可能返回 null，表示取不到有效值。
    Value Array of String 否 使用/排除的url参数数组。
    注意：此字段可能返回 null，表示取不到有效值。

    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预热。
    		•

    RateLimitConfig

    速率限制规则

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    Switch String 是 开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    RateLimitUserRules Array of RateLimitUserRule 否 速率限制-用户规则列表。如果为null，默认使用历史配置。
    RateLimitTemplate RateLimitTemplate 否 速率限制模板功能。如果为null，默认使用历史配置。
    注意：此字段可能返回 null，表示取不到有效值。
    RateLimitIntelligence RateLimitIntelligence 否 智能客户端过滤。如果为null，默认使用历史配置。
    注意：此字段可能返回 null，表示取不到有效值。
    RateLimitCustomizes Array of RateLimitUserRule 否 速率限制-托管定制规则。如果为null，默认使用历史配置。
    注意：此字段可能返回 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：关闭，仅精准速率限制生效。

    • 注意：此字段可能返回 null，表示取不到有效值。
    ID Integer 是 唯一id。
    Action String 是 模板处置方式，取值有：
  • alg：JavaScript挑战；
  • monitor：观察。

    • 注意：此字段可能返回 null，表示取不到有效值。
    PunishTime Integer 是 惩罚时间，取值范围0-2天，单位秒。
    注意：此字段可能返回 null，表示取不到有效值。
    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 时必填，且不能为空。

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

    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资源。
    		•

    RewriteAction

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

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

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

    Rule

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

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

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

    RuleAndConditions

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

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

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

    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

    规则引擎条件参数

    被如下接口引用：CreateRule, DescribeRules, 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。
    • 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段。
    • 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。

    • 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压缩。
    • 不填表示不启用压缩。

    SecEntry

    安全数据Entry返回值

    被如下接口引用：DescribeDDoSAttackData。

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

    SecEntryValue

    安全数据维度值信息

    被如下接口引用：DescribeDDoSAttackData。

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

    SecurityConfig

    安全配置

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    WafConfig WafConfig 否 托管规则。如果入参为空或不填，默认使用历史配置。
    注意：此字段可能返回 null，表示取不到有效值。
    RateLimitConfig RateLimitConfig 否 速率限制。如果入参为空或不填，默认使用历史配置。
    注意：此字段可能返回 null，表示取不到有效值。
    AclConfig AclConfig 否 自定义规则。如果入参为空或不填，默认使用历史配置。
    注意：此字段可能返回 null，表示取不到有效值。
    BotConfig BotConfig 否 Bot配置。如果入参为空或不填，默认使用历史配置。
    注意：此字段可能返回 null，表示取不到有效值。
    SwitchConfig SwitchConfig 否 七层防护总开关。如果入参为空或不填，默认使用历史配置。
    注意：此字段可能返回 null，表示取不到有效值。
    IpTableConfig IpTableConfig 否 基础访问管控。如果入参为空或不填，默认使用历史配置。
    注意：此字段可能返回 null，表示取不到有效值。
    ExceptConfig ExceptConfig 否 例外规则配置。如果入参为空或不填，默认使用历史配置。
    注意：此字段可能返回 null，表示取不到有效值。
    DropPageConfig DropPageConfig 否 自定义拦截页面配置。如果入参为空或不填，默认使用历史配置。
    注意：此字段可能返回 null，表示取不到有效值。
    TemplateConfig TemplateConfig 否 模板配置。此处仅出参数使用。
    注意：此字段可能返回 null，表示取不到有效值。
    SlowPostConfig SlowPostConfig 否 慢速攻击配置。如果入参为空或不填，默认使用历史配置。
    注意：此字段可能返回 null，表示取不到有效值。

    SecurityTemplateBinding

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

    被如下接口引用：DescribeSecurityTemplateBindings。

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

    SecurityType

    安全类型配置项。

    被如下接口引用：DescribeHostsSetting。

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

    ServerCertInfo

    https 服务端证书配置

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

    名称 类型 必选 描述
    CertId String 是 服务器证书 ID。
    注意：此字段可能返回 null，表示取不到有效值。
    Alias String 否 证书备注名。
    注意：此字段可能返回 null，表示取不到有效值。
    Type String 否 证书类型，取值有：
  • default：默认证书；
  • upload：用户上传；
  • managed：腾讯云托管。

    • 注意：此字段可能返回 null，表示取不到有效值。
    ExpireTime Timestamp ISO8601 否 证书过期时间。
    注意：此字段可能返回 null，表示取不到有效值。
    DeployTime Timestamp ISO8601 否 证书部署时间。
    注意：此字段可能返回 null，表示取不到有效值。
    SignAlgo String 否 签名算法。
    注意：此字段可能返回 null，表示取不到有效值。
    CommonName String 否 证书归属域名名称。
    注意：此字段可能返回 null，表示取不到有效值。

    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的值。
    注意：此字段可能返回 null，表示取不到有效值。
    MatchContentType String 否 匹配Content所使用的匹配方式，取值为：
  • equal：精准匹配，等于；
  • wildcard：通配符匹配，支持 * 通配。
    		•
    MatchContent Array of String 否 匹配Value的值。
    注意：此字段可能返回 null，表示取不到有效值。

    SlowPostConfig

    慢速攻击配置。

    被如下接口引用：ModifySecurityPolicy。

    名称 类型 必选 描述
    Switch String 是 开关，取值有：
  • on：开启；
  • off：关闭。
    		•
    FirstPartConfig FirstPartConfig 否 首包配置。
    注意：此字段可能返回 null，表示取不到有效值。
    SlowRateConfig SlowRateConfig 否 基础配置。
    注意：此字段可能返回 null，表示取不到有效值。
    Action String 否 慢速攻击的处置动作，取值有：
  • monitor：观察；
  • drop：拦截。

    • 注意：此字段可能返回 null，表示取不到有效值。
    RuleId Integer 否 本规则的Id。
    注意：此字段可能返回 null，表示取不到有效值。

    SlowRateConfig

    慢速攻击的基础配置。

    被如下接口引用：ModifySecurityPolicy。

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

    SmartRouting

    智能加速配置

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

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

    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 功能到期时间。超出设置的时间，则功能失效。

    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的开关。

    Tag

    标签配置

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

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

    Task

    内容管理任务结果

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

    名称 类型 描述
    JobId String 任务 ID。
    Status String 状态。
    Target String 资源。
    Type String 任务类型。
    CreateTime Timestamp ISO8601 任务创建时间。
    UpdateTime Timestamp ISO8601 任务完成时间。

    TemplateConfig

    安全模板配置

    被如下接口引用：ModifySecurityPolicy。

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

    TemplateScope

    安全模板绑定域名状态

    被如下接口引用：DescribeSecurityTemplateBindings。

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

    TimingDataItem

    统计曲线数据项

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

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

    TimingDataRecord

    时序数据信息

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

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

    TimingTypeValue

    时序类型详细数据

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

    名称 类型 描述
    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 排序实体数量。

    UpstreamHttp2

    Http2回源配置

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

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

    VanityNameServers

    自定义 nameservers

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

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

    VanityNameServersIps

    自定义名字服务器 IP 信息

    被如下接口引用：DescribeZones。

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

    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秒。

    Zone

    站点信息

    被如下接口引用：DescribeZones。

    名称 类型 描述
    ZoneId String 站点 ID。
    ZoneName String 站点名称。
    OriginalNameServers Array of String 站点当前使用的 NS 列表。
    NameServers Array of String 腾讯云分配的 NS 列表。
    Status String 站点状态，取值有：
  • active：NS 已切换；
  • pending：NS 未切换；
  • moved：NS 已切走；
  • deactivated：被封禁。
  • initializing：待绑定套餐。
    • Type String 站点接入方式，取值有：
  • full：NS 接入；
  • partial：CNAME 接入；
  • noDomainAccess：无域名接入；
  • vodeo：开启 VODEO 后默认接入。
    		•
    Paused Boolean 站点是否关闭。
    CnameSpeedUp String 是否开启 CNAME 加速，取值有：
  • enabled：开启；
  • disabled：关闭。
    		•
    CnameStatus String CNAME 接入状态，取值有：
  • finished：站点已验证；
  • pending：站点验证中。
    		•
    Tags Array of Tag 资源标签列表。
    Resources Array of Resource 计费资源列表。
    CreatedOn Timestamp ISO8601 站点创建时间。
    ModifiedOn Timestamp ISO8601 站点修改时间。
    Area String 站点接入地域，取值有：
  • global：全球；
  • mainland：中国大陆；
  • overseas：境外区域。
    		•
    VanityNameServers VanityNameServers 用户自定义 NS 信息。
    注意：此字段可能返回 null，表示取不到有效值。
    VanityNameServersIps Array of VanityNameServersIps 用户自定义 NS IP 信息。
    注意：此字段可能返回 null，表示取不到有效值。
    ActiveStatus String 展示状态，取值有：
  • active：已启用；
  • inactive：未生效；
  • paused：已停用。
    		•
    AliasZoneName String 站点别名。数字、英文、-和_组合，限制20个字符。
    注意：此字段可能返回 null，表示取不到有效值。
    IsFake Integer 是否伪站点，取值有：
  • 0：非伪站点；
  • 1：伪站点。
    		•
    LockStatus String 锁定状态，取值有：
  • enable：正常，允许进行修改操作；
  • disable：锁定中，不允许进行修改操作；
  • plan_migrate：套餐迁移中，不允许进行修改操作。
    		•
    OwnershipVerification OwnershipVerification 归属权验证信息。
    注意：此字段可能返回 null，表示取不到有效值。

    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，表示取不到有效值。
    中国站