AccelerateMainland
中国大陆加速优化配置。
被如下接口引用:CreateApplicationProxy, DescribeApplicationProxies, DescribeZoneSetting, ModifyApplicationProxy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | 是否开启中国大陆加速优化配置,取值有: |
AccelerateMainlandParameters
中国大陆加速优化配置。
被如下接口引用:DescribeL7AccSetting, ModifyL7AccSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 否 | 中国大陆加速优化配置开关,取值有: |
AccelerateType
加速类型
被如下接口引用:DescribeHostsSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | 加速开关。取值范围: |
AccelerationDomain
加速域名
被如下接口引用:DescribeAccelerationDomains。
名称 | 类型 | 描述 |
---|---|---|
ZoneId | String | 站点 ID。 |
DomainName | String | 加速域名名称。 |
DomainStatus | String | 加速域名状态,取值有: |
OriginDetail | OriginDetail | 源站信息。 注意:此字段可能返回 null,表示取不到有效值。 |
OriginProtocol | String | 回源协议,取值有: 注意:此字段可能返回 null,表示取不到有效值。 |
Certificate | AccelerationDomainCertificate | 域名证书信息 注意:此字段可能返回 null,表示取不到有效值。 |
HttpOriginPort | Integer | HTTP回源端口。 注意:此字段可能返回 null,表示取不到有效值。 |
HttpsOriginPort | Integer | HTTPS回源端口。 注意:此字段可能返回 null,表示取不到有效值。 |
IPv6Status | String | IPv6状态,取值有: 注意:此字段可能返回 null,表示取不到有效值。 |
Cname | String | CNAME 地址。 |
IdentificationStatus | String | 加速域名归属权验证状态,取值有: 注意:此字段可能返回 null,表示取不到有效值。 |
CreatedOn | Timestamp ISO8601 | 创建时间。 |
ModifiedOn | Timestamp ISO8601 | 修改时间。 |
OwnershipVerification | OwnershipVerification | 当域名需要进行归属权验证才能继续提供服务时,该对象会携带对应验证方式所需要的信息。 注意:此字段可能返回 null,表示取不到有效值。 |
AccelerationDomainCertificate
加速域名所对应的证书信息。
被如下接口引用:DescribeAccelerationDomains。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Mode | String | 否 | 配置证书的模式,取值有: |
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 | 否 | 目标请求协议,取值有: |
HostName | HostName | 否 | 目标 HostName 。 注意:此字段可能返回 null,表示取不到有效值。 |
URLPath | URLPath | 否 | 目标路径。 注意:此字段可能返回 null,表示取不到有效值。 |
QueryString | AccessURLRedirectQueryString | 否 | 携带查询参数。 注意:此字段可能返回 null,表示取不到有效值。 |
AccessURLRedirectQueryString
访问 URL 重定向 配置参数。
被如下接口引用:CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Action | String | 否 | 执行动作,取值有: |
AclCondition
精准防护条件
被如下接口引用:ModifySecurityPolicy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
MatchFrom | String | 是 | 匹配字段,取值有: |
MatchParam | String | 是 | 匹配字符串。当 MatchFrom 为 header 时,可以填入 header 的 key 作为参数。 |
Operator | String | 是 | 匹配关系,取值有: |
MatchContent | String | 是 | 匹配内容。 |
AclConfig
ACL配置
被如下接口引用:ModifySecurityPolicy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | 开关,取值有: |
AclUserRules | Array of AclUserRule | 是 | 用户自定义规则。 |
Customizes | Array of AclUserRule | 否 | 托管定制规则 注意:此字段可能返回 null,表示取不到有效值。 |
AclUserRule
用户自定义规则
被如下接口引用:ModifySecurityPolicy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
RuleName | String | 是 | 规则名。 |
Action | String | 是 | 处罚动作,取值有: |
RuleStatus | String | 是 | 规则状态,取值有: |
AclConditions | Array of AclCondition | 是 | 自定义规则。 |
RulePriority | Integer | 是 | 规则优先级,取值范围0-100。 |
RuleID | Integer | 否 | 规则 Id。仅出参使用。 |
UpdateTime | String | 否 | 更新时间。仅出参使用。 |
PunishTime | Integer | 否 | ip 封禁的惩罚时间。Action 是 ban 时必填,且不能为空,取值范围0-2天。 |
PunishTimeUnit | String | 否 | ip 封禁的惩罚时间单位,取值有: |
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 | 否 | 常规功能操作,选择该类型的功能项有: 注意:此字段可能返回 null,表示取不到有效值。 |
RewriteAction | RewriteAction | 否 | 带有请求头/响应头的功能操作,选择该类型的功能项有: 注意:此字段可能返回 null,表示取不到有效值。 |
CodeAction | CodeAction | 否 | 带有状态码的功能操作,选择该类型的功能项有: 注意:此字段可能返回 null,表示取不到有效值。 |
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规则引擎状态,取值有: |
AlgDetectJS
Bot主动特征识别客户端行为校验。
被如下接口引用:ModifySecurityPolicy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Name | String | 否 | 操作名称。 |
WorkLevel | String | 否 | 工作量证明 (proof_Of-Work)校验强度,默认low,取值有: |
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 | 否 | 校验结果,取值有: |
Action | String | 否 | 处罚动作,取值有: |
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,取值有: |
SessionAnalyzeSwitch | String | 否 | 会话速率和周期特征校验开关,默认off,取值有: |
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 | 别称域名状态,取值有: |
ForbidMode | Integer | 封禁模式,取值有: |
CreatedOn | Timestamp ISO8601 | 别称域名创建时间。 |
ModifiedOn | Timestamp ISO8601 | 别称域名修改时间。 |
ApplicationProxy
应用代理实例
被如下接口引用:DescribeApplicationProxies。
名称 | 类型 | 描述 |
---|---|---|
ZoneId | String | 站点ID。 |
ZoneName | String | 站点名称。 |
ProxyId | String | 代理ID。 |
ProxyName | String | 当ProxyType=hostname时,表示域名或子域名; 当ProxyType=instance时,表示代理名称。 |
ProxyType | String | 四层代理模式,取值有: |
PlatType | String | 调度模式,取值有: |
Area | String | 加速区域,取值有: 默认值:overseas |
SecurityType | Integer | 是否开启安全,取值有: |
AccelerateType | Integer | 是否开启加速,取值有: |
SessionPersistTime | Integer | 会话保持时间。 |
Status | String | 状态,取值有: |
BanStatus | String | 封禁状态,取值有: |
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 | 是 | 协议,取值有: |
Port | Array of String | 是 | 端口,支持格式: 注意:一条规则最多可填写20个端口。 |
OriginType | String | 是 | 源站类型,取值有: |
OriginValue | Array of String | 是 | 源站信息:["8.8.8.8","9.9.9.9"] 或 OriginValue=["test.com"] ;["lb-xdffsfasdfs"] ;["origin-537f5b41-162a-11ed-abaa-525400c5da15"] 。 |
RuleId | String | 否 | 规则ID。 |
Status | String | 否 | 状态,取值有: |
ForwardClientIp | String | 否 | 传递客户端IP,取值有: |
SessionPersist | Boolean | 否 | 是否开启会话保持,取值有: |
SessionPersistTime | Integer | 否 | 会话保持的时间,只有当SessionPersist为true时,该值才会生效。 注意:此字段可能返回 null,表示取不到有效值。 |
OriginPort | String | 否 | 源站端口,支持格式: |
RuleTag | String | 否 | 规则标签。 注意:此字段可能返回 null,表示取不到有效值。 |
AscriptionInfo
站点归属信息
被如下接口引用:DescribeIdentifications, IdentifyZone。
名称 | 类型 | 描述 |
---|---|---|
Subdomain | String | 主机记录。 |
RecordType | String | 记录类型。 |
RecordValue | String | 记录值。 |
AuthenticationParameters
Token 鉴权 配置参数。
被如下接口引用:CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
AuthType | String | 否 | 鉴权类型。取值有: |
SecretKey | String | 否 | 主鉴权密钥,由 6~40 位大小写英文字母或数字组成,不能包含 " 和 $。 |
Timeout | Integer | 否 | 鉴权 URL 的有效时长,单位为秒,取值:1~630720000。用于判断客户端访问请求是否过期: |
BackupSecretKey | String | 否 | 备鉴权密钥,由 6~40 位大小写英文字母或数字组成,不能包含 " 和 $。 |
AuthParam | String | 否 | 鉴权参数名称,节点将校验此参数名对应的值。由 1~100 位大小写字母、数字或下划线组成。 注意:当 AuthType 为 TypeA、TypeD 之一时,此字段必填。 |
TimeParam | String | 否 | 鉴权时间戳,和 AuthParam 字段的值不能相同。 注意:当 AuthType 为 TypeD 时,此字段必填。 |
TimeFormat | 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开关,取值有: |
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 | 是 | 处置动作,取值有: |
Percent | Integer | 否 | 处置方式的触发概率,范围0-100。 注意:此字段可能返回 null,表示取不到有效值。 |
BotManagedRule
Bot 规则,下列规则ID可参考接口 DescribeBotManagedRules返回的ID信息
被如下接口引用:ModifySecurityPolicy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Action | String | 是 | 触发规则后的处置方式,取值有: |
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 | 是 | 本功能的开关,取值有: |
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 | 是 | 处置动作,取值有: |
RuleStatus | String | 是 | 规则状态,取值有: |
AclConditions | Array of AclCondition | 是 | 规则详情。 |
RulePriority | Integer | 是 | 规则权重,取值范围0-100。 |
RuleID | Integer | 否 | 规则 Id。仅出参使用。 |
ExtendActions | Array of BotExtendAction | 否 | 随机处置的处置方式及占比,非随机处置可不填暂不支持。 |
FreqFields | Array of String | 否 | 过滤词,取值有: 默认为空字符串。 |
UpdateTime | String | 否 | 更新时间。仅出参使用。 |
FreqScope | Array of String | 否 | 统计范围。取值有: 默认为 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开关,取值为: |
PolicyId | Integer | 否 | 策略ID。 |
CLSTopic
实时日志投递到腾讯云 CLS 的配置信息。
被如下接口引用:CreateRealtimeLogDeliveryTask, DescribeRealtimeLogDeliveryTasks。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
LogSetId | String | 是 | 腾讯云 CLS 日志集 ID。 |
TopicId | String | 是 | 腾讯云 CLS 日志主题 ID。 |
LogSetRegion | String | 是 | 腾讯云 CLS 日志集所在的地域。 |
Cache
缓存时间设置
被如下接口引用:DescribeHostsSetting, ModifyZoneSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | 缓存配置开关,取值有: |
CacheTime | Integer | 否 | 缓存过期时间设置。 单位为秒,最大可设置为 365 天。 注意:此字段可能返回 null,表示取不到有效值。 |
CacheConfig
缓存规则配置。
被如下接口引用:DescribeHostsSetting, DescribeZoneSetting, ModifyZoneSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Cache | Cache | 否 | 缓存配置。 注意:此字段可能返回 null,表示取不到有效值。 |
NoCache | NoCache | 否 | 不缓存配置。 注意:此字段可能返回 null,表示取不到有效值。 |
FollowOrigin | FollowOrigin | 否 | 遵循源站配置。 注意:此字段可能返回 null,表示取不到有效值。 |
CacheConfigCustomTime
节点缓存 TTL 自定义缓存时间配置参数。
被如下接口引用:DescribeL7AccSetting, ModifyL7AccSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 否 | 自定义缓存时间开关,取值有: |
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 | 否 | 是否开启全路径缓存,取值有: 注意:此字段可能返回 null,表示取不到有效值。 |
IgnoreCase | String | 否 | 是否忽略大小写缓存,取值有: 注意:此字段可能返回 null,表示取不到有效值。 |
QueryString | QueryString | 否 | CacheKey 中包含请求参数。 注意:此字段可能返回 null,表示取不到有效值。 |
CacheKeyConfigParameters
缓存键配置。
被如下接口引用:DescribeL7AccSetting, ModifyL7AccSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
FullURLCache | String | 否 | 是否开启全路径缓存,取值有: |
IgnoreCase | String | 否 | 是否忽略大小写缓存,取值有: |
QueryString | CacheKeyQueryString | 否 | 查询字符串保留配置参数。此字段和 FullURLCache 必须同时设置,但不能同为 on。 |
CacheKeyCookie
自定义 Cache Key Cookie 配置参数。
被如下接口引用:CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 否 | 功能开关,取值有: |
Action | String | 否 | 缓存动作,取值有: |
Values | Array of String | 否 | 自定义 Cache Key Cookie 名称列表。 注意:当 Action 为 includeCustom 或 excludeCustom 时,此字段必填;当 Action 为 full 或 ignore 时,无需填写此字段,若填写则不生效。 |
CacheKeyHeader
自定义 Cache Key HTTP 请求头配置参数。
被如下接口引用:CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 否 | 功能开关,取值有: |
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 | 否 | 查询字符串全部保留开关,取值有: |
QueryString | CacheKeyQueryString | 否 | 查询字符串保留配置参数。此字段和 FullURLCache 必须同时设置,但不能同为 on。 注意:此字段可能返回 null,表示取不到有效值。 |
IgnoreCase | String | 否 | 忽略大小写开关,取值有: |
Header | CacheKeyHeader | 否 | HTTP 请求头配置参数。FullURLCache、IgnoreCase、Header、Scheme、Cookie 至少设置一个配置。 注意:此字段可能返回 null,表示取不到有效值。 |
Scheme | String | 否 | 请求协议开关,取值有: |
Cookie | CacheKeyCookie | 否 | Cookie 配置参数。FullURLCache、IgnoreCase、Header、Scheme、Cookie 至少设置一个配置。 注意:此字段可能返回 null,表示取不到有效值。 |
CacheKeyQueryString
自定义 Cache Key 查询字符串配置参数。
被如下接口引用:CreateL7AccRules, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 否 | 查询字符串保留/忽略指定参数开关,取值有: |
Action | String | 否 | 查询字符串保留/忽略指定参数动作。取值有: |
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 | 是 | 缓存预刷新配置开关,取值有: |
Percent | Integer | 否 | 缓存预刷新百分比,取值范围:1-99。 注意:此字段可能返回 null,表示取不到有效值。 |
CachePrefreshParameters
缓存预刷新 配置参数。
被如下接口引用:CreateL7AccRules, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 否 | 缓存预刷新开关,取值有: |
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 | 否 | 证书类型,取值有: |
ExpireTime | Timestamp ISO8601 | 否 | 证书过期时间。 |
DeployTime | Timestamp ISO8601 | 否 | 证书部署时间。 |
SignAlgo | String | 否 | 签名算法。 |
Status | String | 否 | 证书状态,取值有: |
CheckRegionHealthStatus
各个健康检查区域下源站的健康状态。
被如下接口引用:DescribeOriginGroupHealthStatus。
名称 | 类型 | 描述 |
---|---|---|
Region | String | 健康检查区域,ISO-3166-1 两位字母代码。 |
Healthy | String | 单健康检查区域下探测源站的健康状态,取值有: |
OriginHealthStatus | Array of OriginHealthStatus | 源站健康状态。 |
ClientIPCountryParameters
回源时携带客户端 IP 所属地域信息,值的格式为 ISO-3166-1 两位字母代码。
被如下接口引用:CreateL7AccRules, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 否 | 配置开关,取值有: |
HeaderName | String | 否 | 存放客户端 IP 所属地域信息的请求头名称,当 Switch=on 时有效。为空则使用默认值:EO-Client-IPCountry。 |
ClientIPHeaderParameters
存储客户端请求IP的头部信息配置。
被如下接口引用:CreateL7AccRules, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 否 | 配置开关,取值有: |
HeaderName | String | 否 | 回源时,存放客户端 IP 的请求头名称。当 Switch 为 on 时,该参数必填。该参数不允许填写 X-Forwarded-For。 |
ClientIpCountry
回源时携带客户端IP所属地域信息,值的格式为ISO-3166-1两位字母代码。
被如下接口引用:DescribeHostsSetting, DescribeZoneSetting, ModifyZoneSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | 配置开关,取值有: |
HeaderName | String | 否 | 存放客户端 IP 所属地域信息的请求头名称,当 Switch=on 时有效。 为空则使用默认值:EO-Client-IPCountry。 |
ClientIpHeader
存储客户端请求IP的头部信息配置
被如下接口引用:DescribeZoneSetting, ModifyZoneSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | 配置开关,取值有: |
HeaderName | String | 否 | 回源时,存放客户端 IP 的请求头名称。当 Switch 为 on 时,该参数必填。该参数不允许填写 X-Forwarded-For。 注意:此字段可能返回 null,表示取不到有效值。 |
CnameStatus
CNAME 状态
被如下接口引用:CheckCnameStatus。
名称 | 类型 | 描述 |
---|---|---|
RecordName | String | 记录名称。 |
Cname | String | CNAME 地址。 注意:此字段可能返回 null,表示取不到有效值。 |
Status | String | Cname状态信息,取值有: 注意:此字段可能返回 null,表示取不到有效值。 |
CodeAction
规则引擎带有状态码的动作
被如下接口引用:CreateRule, DescribeRules, ModifyRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Action | String | 是 | 功能名称,功能名称填写规范可调用接口 查询规则引擎的设置参数 查看。 |
Parameters | Array of RuleCodeActionParams | 是 | 操作参数。 |
Compression
智能压缩配置。
被如下接口引用:DescribeHostsSetting, DescribeZoneSetting, ModifyZoneSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | 智能压缩配置开关,取值有: |
Algorithms | Array of String | 否 | 支持的压缩算法列表,取值有: 注意:此字段可能返回 null,表示取不到有效值。 |
CompressionParameters
智能压缩配置。
被如下接口引用:CreateL7AccRules, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 否 | 智能压缩配置开关,取值有: |
Algorithms | Array of String | 否 | 支持的压缩算法列表。当 Switch 为 on 时,此字段必填,否则此字段不生效。取值有: |
ConfigGroupVersionInfo
配置组版本信息。
被如下接口引用:DeployConfigGroupVersion, DescribeConfigGroupVersionDetail, DescribeConfigGroupVersions, DescribeDeployHistory, DescribeEnvironments。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
VersionId | String | 是 | 版本 ID。 |
VersionNumber | String | 否 | 版本号。 |
GroupId | String | 否 | 配置组 ID。 |
GroupType | String | 否 | 配置组类型。取值有: |
Description | String | 否 | 版本描述。 |
Status | String | 否 | 版本状态,取值有: |
CreateTime | Timestamp ISO8601 | 否 | 版本创建时间。时间为世界标准时间(UTC), 遵循 ISO 8601 标准的日期和时间格式。 |
ContentIdentifier
内容标识符。该功能仅白名单开放。
被如下接口引用:DescribeContentIdentifiers。
名称 | 类型 | 描述 |
---|---|---|
ContentId | String | 内容标识符 ID。 |
Description | String | 内容标识符描述。 |
ReferenceCount | Integer | 被规则引擎引用的次数。 |
PlanId | String | 绑定的套餐 ID。 |
Tags | Array of Tag | 绑定的标签。 |
Status | String | 内容标识符状态,取值有: |
CreatedOn | Timestamp ISO8601 | 创建时间,时间为世界标准时间(UTC), 遵循 ISO 8601 标准的日期和时间格式。 |
ModifiedOn | Timestamp ISO8601 | 最新一次更新时间,时间为世界标准时间(UTC), 遵循 ISO 8601 标准的日期和时间格式。 |
DeletedOn | Timestamp ISO8601 | 删除时间,状态非 deleted 时候为空;时间为世界标准时间(UTC), 遵循 ISO 8601 标准的日期和时间格式。 注意:此字段可能返回 null,表示取不到有效值。 |
CustomEndpoint
实时日志投递到自定义 HTTP(S) 接口的配置信息。
被如下接口引用:CreateRealtimeLogDeliveryTask, DescribeRealtimeLogDeliveryTasks, ModifyRealtimeLogDeliveryTask。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Url | String | 是 | 实时日志投递的自定义 HTTP 接口地址,暂仅支持 HTTP/HTTPS 协议。 |
AccessId | String | 否 | 填写自定义的 SecretId 用于生成加密签名,如果源站需要鉴权此参数必填。 |
AccessKey | String | 否 | 填写自定义的 SecretKey 用于生成加密签名,如果源站需要鉴权此参数必填。 |
CompressType | String | 否 | 数据压缩类型,取值有: |
Protocol | String | 否 | POST 请求投递日志时,使用的应用层协议类型,取值有: |
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 请求和响应中的指定位置提取数据,取值有: 注意:此字段可能返回 null,表示取不到有效值。 |
Value | String | 是 | 根据字段类型(Name)填入字段值的定义。需要区分大小写。 注意:此字段可能返回 null,表示取不到有效值。 |
Enabled | Boolean | 否 | 是否投递该字段,不填表示不投递此字段。 注意:此字段可能返回 null,表示取不到有效值。 |
CustomTime
节点缓存 TTL 自定义缓存时间参数配置。
被如下接口引用:CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 否 | 自定义缓存时间开关,取值有: |
IgnoreCacheControl | String | 否 | 忽略源站 CacheControl 开关,取值有: |
CacheTime | Integer | 否 | 自定义缓存时间数值,单位为秒,取值:0~315360000。 注意:当 Switch 为 on 时,此字段必填;当 Switch 为 off 时,无需填写此字段,若填写则不生效。 |
CustomizedHeader
负载均衡实例 HTTP/HTTPS 健康检查策略下可配置的自定义头部。
被如下接口引用:CreateLoadBalancer, ModifyLoadBalancer。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Key | String | 是 | 自定义头部 Key。 注意:此字段可能返回 null,表示取不到有效值。 |
Value | String | 是 | 自定义头部 Value。 注意:此字段可能返回 null,表示取不到有效值。 |
DDoS
DDoS配置
被如下接口引用:DescribeHostsSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | 开关,取值有: |
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 | 攻击事件所属地区,取值有: 注意:此字段可能返回 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 防护相关费用 |
MaxBandwidthMainland | Integer | 否 | 中国大陆地区独立 DDoS 防护的弹性防护带宽配置。 仅当开启中国大陆区域独立 DDos 防护时有效(详见 LevelMainland 参数配置),且取值范围有如下限制: |
LevelOverseas | String | 否 | 全球(除中国大陆以外)地区独立 DDoS 防护的规格。 |
DefaultServerCertInfo
https 服务端证书配置
被如下接口引用:DescribeDefaultCertificates。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
CertId | String | 是 | 服务器证书 ID。 注意:此字段可能返回 null,表示取不到有效值。 |
Alias | String | 否 | 证书备注名。 注意:此字段可能返回 null,表示取不到有效值。 |
Type | String | 否 | 证书类型,取值有: 注意:此字段可能返回 null,表示取不到有效值。 |
ExpireTime | Timestamp ISO8601 | 否 | 证书过期时间。 注意:此字段可能返回 null,表示取不到有效值。 |
EffectiveTime | Timestamp ISO8601 | 否 | 证书生效时间。 注意:此字段可能返回 null,表示取不到有效值。 |
CommonName | String | 否 | 证书公用名。 注意:此字段可能返回 null,表示取不到有效值。 |
SubjectAltName | Array of String | 否 | 证书SAN域名。 注意:此字段可能返回 null,表示取不到有效值。 |
Status | String | 否 | 部署状态,取值有: 注意:此字段可能返回 null,表示取不到有效值。 |
Message | String | 否 | Status为失败时,此字段返回失败原因。 注意:此字段可能返回 null,表示取不到有效值。 |
SignAlgo | String | 否 | 证书算法。 注意:此字段可能返回 null,表示取不到有效值。 |
DeliveryCondition
实时日志投递条件,用于定义投递日志范围。DeliveryCondition 数组内多个项的关系为“或”,内层 Conditions 数组内多个项的关系为“且”。
被如下接口引用:CreateRealtimeLogDeliveryTask, DescribeRealtimeLogDeliveryTasks, ModifyRealtimeLogDeliveryTask。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Conditions | Array of QueryCondition | 否 | 日志过滤条件,详细的过滤条件如下: 支持运算符:equal、great、less、great_equal、less_equal 取值范围:任意大于等于 0 的整数 支持运算符:equal、great、less、great_equal、less_equal 取值范围:任意大于等于 -1 的整数 支持运算符:equal 可选项如下: -:未知/未命中 Monitor:观察 JSChallenge:JavaScript 挑战 Deny:拦截 Allow:放行 BlockIP:IP 封禁 Redirect:重定向 ReturnCustomPage:返回自定义页面 ManagedChallenge:托管挑战 Silence:静默 LongDelay:长时间等待后响应 ShortDelay:短时间等待后响应 支持运算符:equal 可选项如下: -:未知/未命中 CustomRule:Web防护 - 自定义规则 RateLimitingCustomRule:Web防护 - 速率限制规则 ManagedRule:Web防护 - 托管规则 L7DDoS:Web防护 - CC攻击防护 BotManagement:Bot管理 - Bot基础管理 BotClientReputation:Bot管理 - 客户端画像分析 BotBehaviorAnalysis:Bot管理 - Bot智能分析 BotCustomRule:Bot管理 - 自定义Bot规则 BotActiveDetection:Bot管理 - 主动特征识别 |
DeployRecord
配置组版本发布记录详情。
被如下接口引用:DescribeDeployHistory。
名称 | 类型 | 描述 |
---|---|---|
ConfigGroupVersionInfos | Array of ConfigGroupVersionInfo | 发布版本的详细信息。 |
DeployTime | Timestamp ISO8601 | 发布时间。时间为世界标准时间(UTC), 遵循 ISO 8601 标准的日期和时间格式。 |
Status | String | 发布状态,取值有: |
Message | String | 发布结果信息。 |
RecordId | String | 发布记录 ID。 注意:此字段可能返回 null,表示取不到有效值。 |
Description | String | 变更说明。 |
DetailHost
域名配置信息
被如下接口引用:DescribeHostsSetting。
名称 | 类型 | 描述 |
---|---|---|
ZoneId | String | 站点ID。 |
Status | String | 加速服务状态,取值为: |
Host | String | 域名。 |
ZoneName | String | 站点名称。 |
Cname | String | 分配的Cname域名 |
Id | String | 资源ID。 |
InstanceId | String | 实例ID。 |
Lock | Integer | 锁状态。 |
Mode | Integer | 域名状态类型。 |
Area | String | 域名加速地域,取值有: |
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白名单列表,不变部分。 |
DnsRecord
DNS 记录
被如下接口引用:DescribeDnsRecords, ModifyDnsRecords。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ZoneId | String | 否 | 站点 ID。 注意:ZoneId 仅做出参使用,在 ModifyDnsRecords 不可作为入参使用,如有传此参数,会忽略。 |
RecordId | String | 否 | DNS 记录 ID。 |
Name | String | 否 | DNS 记录名。 |
Type | String | 否 | DNS 记录类型,取值有: |
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 记录解析状态,取值有: |
CreatedOn | Timestamp ISO8601 | 否 | 创建时间。 注意:CreatedOn 仅做出参使用,在 ModifyDnsRecords 不可作为入参使用,如有传此参数,会忽略。 |
ModifiedOn | Timestamp ISO8601 | 否 | 修改时间。 注意:ModifiedOn 仅做出参使用,在 ModifyDnsRecords 不可作为入参使用,如有传此参数,会忽略。 |
DnsVerification
CNAME 接入,使用 DNS 解析验证时所需的信息。
被如下接口引用:CreateAccelerationDomain, CreateZone, DescribeAccelerationDomains, DescribeZones。
名称 | 类型 | 描述 |
---|---|---|
Subdomain | String | 主机记录。 |
RecordType | String | 记录类型。 |
RecordValue | String | 记录值。 |
DropPageConfig
拦截页面的总体配置,用于配置各个模块的拦截后行为。
被如下接口引用:ModifySecurityPolicy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | 配置开关,取值有: |
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 | 是 | 页面的类型,取值有: |
CustomResponseId | String | 否 | 自定义响应 Id。该 Id 可通过查询自定义错误页列表接口获取。默认值为default,使用系统默认页面。Type 类型是 page 时必填,且不能为空。 |
EntityStatus
安全实例状态。
被如下接口引用:DescribeSecurityTemplateBindings。
名称 | 类型 | 描述 |
---|---|---|
Entity | String | 实例名,现在只有子域名。 |
Status | String | 实例配置下发状态,取值有: |
Message | String | 实例配置下发信息提示。 |
EnvInfo
环境信息。
被如下接口引用:DescribeEnvironments。
名称 | 类型 | 描述 |
---|---|---|
EnvId | String | 环境 ID。 |
EnvType | String | 环境类型,取值有: |
Status | String | 环境状态,取值有: |
Scope | Array of String | 当前环境的配置生效范围: |
CurrentConfigGroupVersionInfos | Array of ConfigGroupVersionInfo | 当前环境中各配置组实际生效的版本,根据 Status 的取值有以下两种情况: |
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 | 是 | 配置开关,取值有: |
ExceptUserRules | Array of ExceptUserRule | 否 | 例外规则详情。如果为null,默认使用历史配置。 注意:此字段可能返回 null,表示取不到有效值。 |
ExceptUserRule
例外规则的配置,包含生效的条件,生效的范围。
被如下接口引用:ModifySecurityPolicy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
RuleName | String | 是 | 规则名称,不可使用中文。 |
Action | String | 是 | 规则的处置方式,当前仅支持skip:跳过全部托管规则。 |
RuleStatus | String | 是 | 规则生效状态,取值有: |
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 | 否 | 匹配项,取值有: |
MatchParam | String | 否 | 匹配项的参数。仅当 MatchFrom 为 header 时,可以使用本参数,值可填入 header 的 key 作为参数。 |
Operator | String | 否 | 匹配操作符,取值有: |
MatchContent | String | 否 | 匹配值。 |
ExceptUserRuleScope
例外规则的生效范围。
被如下接口引用:ModifySecurityPolicy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Type | String | 否 | 例外规则类型。其中complete模式代表全量数据进行例外,partial模式代表可选择指定模块指定字段进行例外,该字段取值有: |
Modules | Array of String | 否 | 生效的模块,该字段取值有: 注意:此字段可能返回 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, DescribeFunctionRules, DescribeFunctions, DescribeHostsSetting, DescribeIdentifications, DescribeL4Proxy, DescribeL4ProxyRules, DescribeL7AccRules, DescribeLoadBalancerList, DescribeOriginProtection, DescribeRules。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Name | String | 是 | 需要过滤的字段。 |
Values | Array of String | 是 | 字段的过滤值。 |
FirstPartConfig
慢速攻击的首段包配置。
被如下接口引用:ModifySecurityPolicy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | 开关,取值有: 注意:此字段可能返回 null,表示取不到有效值。 |
StatTime | Integer | 否 | 首段包的统计时长,单位是秒,即期望首段包的统计时长是多少,默认5秒。 注意:此字段可能返回 null,表示取不到有效值。 |
FollowOrigin
缓存遵循源站配置。
被如下接口引用:CreateL7AccRules, DescribeHostsSetting, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting, ModifyZoneSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | 遵循源站配置开关,取值有: |
DefaultCache | String | 否 | 源站未返回 Cache-Control 头时,缓存/不缓存开关。当 Switch 为 on 时,此字段必填,当 Switch 为 off 时,无需填写此字段,若填写则不生效。取值有: |
DefaultCacheStrategy | String | 否 | 源站未返回 Cache-Control 头时,使用/不使用默认缓存策略开关。当 DefaultCache 为 on 时,此字段必填,否则此字段不生效;当 DefaultCacheTime 不为 0 时,此字段必须为 off。取值有: |
DefaultCacheTime | Integer | 否 | 源站未返回 Cache-Control 头时,表示默认的缓存时间,单位为秒,取值:0-315360000。当 DefaultCache 为 on 时,此字段必填,否则此字段不生效;当 DefaultCacheStrategy 为 on 时, 此字段必须为 0。 |
ForceRedirect
访问协议强制 HTTPS 跳转配置。
被如下接口引用:DescribeZoneSetting, ModifyZoneSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | 访问强制跳转配置开关,取值有: |
RedirectStatusCode | Integer | 否 | 重定向状态码,取值有: 注意:此字段可能返回 null,表示取不到有效值。 |
ForceRedirectHTTPSParameters
访问协议强制 HTTPS 跳转配置。
被如下接口引用:CreateL7AccRules, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 否 | 访问强制跳转配置开关,取值有: |
RedirectStatusCode | Integer | 否 | 重定向状态码。当 Switch 为 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 | 否 | 变量的类型,取值有: |
FunctionRule
边缘函数触发规则。
被如下接口引用:DescribeFunctionRules。
名称 | 类型 | 描述 |
---|---|---|
RuleId | String | 规则ID。 |
FunctionRuleConditions | Array of FunctionRuleCondition | 规则条件列表,列表项之间为或关系。 |
FunctionId | String | 函数 ID,命中触发规则条件后执行的函数。 |
Remark | String | 规则描述。 |
FunctionName | String | 函数名称。 |
Priority | Integer | 函数触发规则优先级,数值越大,优先级越高。 |
CreateTime | Timestamp ISO8601 | 创建时间。时间为世界标准时间(UTC), 遵循 ISO 8601 标准的日期和时间格式。 |
UpdateTime | Timestamp ISO8601 | 更新时间。时间为世界标准时间(UTC), 遵循 ISO 8601 标准的日期和时间格式。 |
FunctionRuleCondition
边缘函数触发规则条件。
被如下接口引用:CreateFunctionRule, DescribeFunctionRules, ModifyFunctionRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
RuleConditions | Array of RuleCondition | 是 | 边缘函数触发规则条件,该列表内所有项全部满足即判断该条件满足。 |
Grpc
Grpc配置项
被如下接口引用:DescribeZoneSetting, ModifyZoneSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | 是否开启 Grpc 配置,取值有: |
GrpcParameters
gRPC 配置项。
被如下接口引用:DescribeL7AccSetting, ModifyL7AccSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 否 | gRPC 配置开关,取值有: |
HSTSParameters
HSTS 配置参数。
被如下接口引用:CreateL7AccRules, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 否 | HSTS 配置开关,取值有: |
Timeout | Integer | 否 | 缓存 HSTS 头部时间,单位为秒,取值:1-31536000。 注意:当 Switch 为 on 时,此字段必填;当 Switch 为 off 时,无需填写此字段,若填写则不生效。 |
IncludeSubDomains | String | 否 | 是否允许其他子域名继承相同的 HSTS 头部,取值有: |
Preload | String | 否 | 是否允许浏览器预加载 HSTS 头部,取值有: |
HTTP2Parameters
HTTP2 接入配置参数。
被如下接口引用:CreateL7AccRules, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 否 | HTTP2 接入配置开关,取值有: |
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。 |
Header
刷新预热附带的头部信息
被如下接口引用:CreatePrefetchTask, CreateRealtimeLogDeliveryTask, ModifyRealtimeLogDeliveryTask。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Name | String | 是 | HTTP头部名称。 |
Value | String | 是 | HTTP头部值。 |
HeaderAction
HTTP 头部设置规则。
被如下接口引用:CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Action | String | 是 | HTTP 头部设置方式。取值有: |
Name | String | 是 | HTTP 头部名称。 |
Value | String | 否 | HTTP 头部值。当 Action 取值为 set 或者 add 时,该参数必填;当 Action 取值为 del 时,该参数无需填写。 |
HealthChecker
负载均衡实例健康检查策略。
被如下接口引用:CreateLoadBalancer, DescribeLoadBalancerList, ModifyLoadBalancer。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Type | String | 是 | 健康检查策略,取值有: 注意: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 时有效,表示请求方法,取值有: |
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 | 否 | 执行动作,取值有: |
ServerName | String | 否 | Host Header 重写,需要填写完整域名。 注意:当 Switch 为 on 时,此字段必填;当 Switch 为 off 时,无需填写此字段,若填写则不生效。 |
HostName
访问 URL 重定向 HostName 配置参数。
被如下接口引用:CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Action | String | 否 | 目标 HostName 配置,取值有: |
Value | String | 否 | 目标 HostName 自定义取值,最大长度 1024。 注意:当 Action 为 custom 时,此字段必填;当 Action 为 follow 时,此字段不生效。 |
Hsts
Hsts配置
被如下接口引用:DescribeHostsSetting, ModifyZoneSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | 是否开启,取值有: |
MaxAge | Integer | 否 | MaxAge 数值。单位为秒,最大值为1天。 注意:此字段可能返回 null,表示取不到有效值。 |
IncludeSubDomains | String | 否 | 是否包含子域名,取值有: 注意:此字段可能返回 null,表示取不到有效值。 |
Preload | String | 否 | 是否开启预加载,取值有: 注意:此字段可能返回 null,表示取不到有效值。 |
Https
域名 https 加速配置,默认为关闭状态
被如下接口引用:DescribeHostsSetting, DescribeZoneSetting, ModifyZoneSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Http2 | String | 否 | http2 配置开关,取值有: 注意:此字段可能返回 null,表示取不到有效值。 |
OcspStapling | String | 否 | OCSP 配置开关,取值有: 注意:此字段可能返回 null,表示取不到有效值。 |
TlsVersion | Array of String | 否 | Tls 版本设置,取值有: 注意:此字段可能返回 null,表示取不到有效值。 |
Hsts | Hsts | 否 | HSTS 配置。 注意:此字段可能返回 null,表示取不到有效值。 |
CertInfo | Array of ServerCertInfo | 否 | 证书配置。 注意:此字段可能返回 null,表示取不到有效值。 |
ApplyType | String | 否 | 申请类型,取值有: 注意:此字段可能返回 null,表示取不到有效值。 |
CipherSuite | String | 否 | 密码套件,取值有: 注意:此字段可能返回 null,表示取不到有效值。 |
IPGroup
IP 网段组
被如下接口引用:CreateSecurityIPGroup, DescribeSecurityIPGroup, 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 节点,取值有: |
IPWhitelist
源站防护IP白名单
被如下接口引用:DescribeOriginProtection。
名称 | 类型 | 描述 |
---|---|---|
IPv4 | Array of String | IPv4列表。 |
IPv6 | Array of String | IPv6列表。 |
IPv6Parameters
IPv6 访问配置。
被如下接口引用:DescribeL7AccSetting, ModifyL7AccSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 否 | IPv6 访问功能配置,取值有: |
Identification
站点验证信息
被如下接口引用:DescribeIdentifications。
名称 | 类型 | 描述 |
---|---|---|
ZoneName | String | 站点名称。 |
Domain | String | 验证子域名。验证站点时,该值为空。验证子域名是为具体子域名。 注意:此字段可能返回 null,表示取不到有效值。 |
Status | String | 验证状态,取值有: |
Ascription | AscriptionInfo | 站点归属权校验:Dns校验信息。 |
OriginalNameServers | Array of String | 域名当前的 NS 记录。 注意:此字段可能返回 null,表示取不到有效值。 |
FileAscription | FileAscriptionInfo | 站点归属权校验:文件校验信息。 |
ImageOptimize
图片优化配置。
被如下接口引用:DescribeZoneSetting, ModifyZoneSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | 开关,取值有: |
IntelligenceRule
智能分析规则
被如下接口引用:ModifySecurityPolicy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 否 | 开关,取值有: 注意:此字段可能返回 null,表示取不到有效值。 |
IntelligenceRuleItems | Array of IntelligenceRuleItem | 否 | 规则详情。 注意:此字段可能返回 null,表示取不到有效值。 |
IntelligenceRuleItem
Bot智能分析规则详情
被如下接口引用:ModifySecurityPolicy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Label | String | 是 | 智能分析标签,取值有: |
Action | String | 是 | 触发智能分析标签对应的处置方式,取值有: |
IpTableConfig
IP黑白名单及IP区域控制配置
被如下接口引用:ModifySecurityPolicy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | 开关,取值有: 注意:此字段可能返回 null,表示取不到有效值。 |
IpTableRules | Array of IpTableRule | 否 | 基础管控规则。如果为null,默认使用历史配置。 注意:此字段可能返回 null,表示取不到有效值。 |
IpTableRule
自定义规则-基础访问管控配置。
被如下接口引用:ModifySecurityPolicy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Action | String | 是 | 动作,取值有: |
MatchFrom | String | 是 | 根据类型匹配,取值有: |
Operator | String | 否 | 规则的匹配方式。取值有: |
RuleID | Integer | 否 | 规则id。仅出参使用。 |
UpdateTime | Timestamp ISO8601 | 否 | 更新时间。仅出参使用。 |
Status | String | 否 | 规则启用状态。取值有: 当入参缺省时,按 on 取值。 |
RuleName | String | 否 | 规则名。 注意:此字段可能返回 null,表示取不到有效值。 |
MatchContent | String | 否 | 匹配内容。支持多值输入。 |
Ipv6
Ipv6访问配置
被如下接口引用:CreateApplicationProxy, DescribeApplicationProxies, DescribeHostsSetting, DescribeZoneSetting, ModifyApplicationProxy, ModifyZoneSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | Ipv6 访问功能配置,取值有: |
JITVideoProcess
视频即时处理配置
被如下接口引用:DescribeZoneSetting, ModifyZoneSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | 视频即时处理配置开关,取值有: |
L4OfflineLog
离线日志详细信息
被如下接口引用:DownloadL4Logs。
名称 | 类型 | 描述 |
---|---|---|
ProxyId | String | 四层代理实例 ID。 |
Area | String | 日志所属区域,取值有: |
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 | 否 | 四层代理实例的加速区域。 |
Cname | String | 否 | 接入 CNAME。 |
Ips | Array of String | 否 | 开启固定 IP 后,该值会返回对应的接入 IP;未开启时,该值为空。 |
Status | String | 否 | 四层代理实例状态。 |
Ipv6 | String | 否 | 是否开启 IPv6 访问。 |
StaticIp | String | 否 | 是否开启固定 IP。 |
AccelerateMainland | String | 否 | 是否开启中国大陆网络优化。 |
DDosProtectionConfig | DDosProtectionConfig | 否 | 安全防护配置。 注意:此字段可能返回 null,表示取不到有效值。 |
L4ProxyRuleCount | Integer | 否 | 四层代理实例下的转发规则数量。 |
UpdateTime | Timestamp ISO8601 | 否 | 最新变更时间。 |
L4ProxyRemoteAuth
四层远程鉴权信息
被如下接口引用:CreateL4ProxyRules, DescribeL4ProxyRules, ModifyL4ProxyRules。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | 四层远程鉴权开关,取值有: |
Address | String | 是 | 远程鉴权服务地址,格式为: domain/ip:port。例:example.auth.com:8888 |
ServerFaultyBehavior | String | 是 | 远程鉴权服务不可访问后,经过四层转发规则默认回源行为,取值有: |
L4ProxyRule
四层代理转发规则详情。
被如下接口引用:CreateL4ProxyRules, DescribeL4ProxyRules, ModifyL4ProxyRules。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
RuleId | String | 否 | 转发规则 ID。 注意:L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时,该参数请勿填写;在 ModifyL4ProxyRules 作为入参使用时,该参数必填。 |
Protocol | String | 否 | 转发协议。取值有: 注意:L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时,该参数必填;在 ModifyL4ProxyRules 作为入参使用时,该参数选填,不填写时表示不修改。 |
PortRange | Array of String | 否 | 转发端口,支持按照以下形式填写: 注意:L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时,该参数必填;在 ModifyL4ProxyRules 作为入参使用时,该参数选填,不填写时表示不修改。 |
OriginType | String | 否 | 源站类型,取值有: 注意:L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时,该参数必填;在 ModifyL4ProxyRules 作为入参使用时,该参数选填,不填写时表示不修改。 |
OriginValue | Array of String | 否 | 源站地址: 注意:L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时,该参数必填;在 ModifyL4ProxyRules 作为入参使用时,该参数选填,不填写时表示不修改。 |
OriginPortRange | String | 否 | 源站端口,支持按照以下形式填写: 注意:L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时,该参数必填;在 ModifyL4ProxyRules 作为入参使用时,该参数选填,不填写时表示不修改。 |
ClientIPPassThroughMode | String | 否 | 传递客户端 IP 的形式,取值有: 注意:L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时,该参数选填,不填写时默认为 OFF;在 ModifyL4ProxyRules 作为入参使用时,该参数选填,不填写表示不修改。 |
SessionPersist | String | 否 | 是否开启会话保持,取值有: 注意: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 | 否 | 规则状态,取值有: 注意:L4ProxyRule 在 CreateL4ProxyRules、ModifyL4ProxyRules 作为入参使用时,该参数请勿填写。 |
BuId | String | 否 | BuID。 |
RemoteAuth | L4ProxyRemoteAuth | 否 | 远程鉴权信息。 注意:RemoteAuth 在 CreateL4ProxyRules 或 ModifyL4ProxyRules 不可作为入参使用,如有传此参数,会忽略。在 DescribeL4ProxyRules 返回为空时,表示没有开启远程鉴权。 注意:此字段可能返回 null,表示取不到有效值。 |
L7OfflineLog
七层离线日志详细信息。
被如下接口引用:DownloadL7Logs。
名称 | 类型 | 描述 |
---|---|---|
Domain | String | 离线日志域名。 |
Area | String | 日志所属区域,取值有: |
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 | 实例类型,取值有: |
HealthChecker | HealthChecker | 健康检查策略。详情请参考 健康检查策略介绍。 |
SteeringPolicy | String | 源站组间的流量调度策略,取值有: |
FailoverPolicy | String | 实际访问某源站失败时的请求重试策略,详情请参考 请求重试策略介绍,取值有: |
OriginGroupHealthStatus | Array of OriginGroupHealthStatus | 源站组健康状态。 |
Status | String | 负载均衡状态,取值有: |
L4UsedList | Array of String | 该负载均衡实例绑的定四层层代理实例的列表。 |
L7UsedList | Array of String | 该负载均衡实例绑定的七层域名列表。 |
LogFormat
实时日志投递的输出格式。您可以直接通过 FormatType 参数使用指定预设日志输出格式(JSON Lines / csv),也可以在预设日志输出格式基础上,通过其他参数来自定义变体输出格式。
被如下接口引用:CreateRealtimeLogDeliveryTask, DescribeRealtimeLogDeliveryTasks, ModifyRealtimeLogDeliveryTask。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
FormatType | String | 是 | 日志投递的预设输出格式类型,取值有: |
BatchPrefix | String | 否 | 在每个日志投递批次之前添加的字符串。每个日志投递批次可能包含多条日志记录。 |
BatchSuffix | String | 否 | 在每个日志投递批次后附加的字符串。 |
RecordPrefix | String | 否 | 在每条日志记录之前添加的字符串。 |
RecordSuffix | String | 否 | 在每条日志记录后附加的字符串。 |
RecordDelimiter | String | 否 | 插入日志记录之间作为分隔符的字符串,取值有: |
FieldDelimiter | String | 否 | 单条日志记录内,插入字段之间作为分隔符的字符串,取值有: |
MaxAge
浏览器缓存规则配置,用于设置 MaxAge 默认值,默认为关闭状态
被如下接口引用:DescribeZoneSetting, ModifyZoneSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
FollowOrigin | String | 否 | 是否遵循源站,取值有: |
MaxAgeTime | Integer | 否 | MaxAge 时间设置,单位秒,最大365天。 注意:时间为0,即不缓存。 |
MaxAgeParameters
浏览器缓存 TTL 配置参数。
被如下接口引用:CreateL7AccRules, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
FollowOrigin | String | 否 | 遵循源站 Cache-Control 开关,取值有: |
CacheTime | Integer | 否 | 自定义缓存时间数值,单位为秒,取值:0~315360000。 注意:当 FollowOrigin 为 off 时,表示不遵循源站,使用 CacheTime 设置缓存时间,否则此字段不生效。 |
ModifyOriginParameters
修改源站配置参数。
被如下接口引用:CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
OriginType | String | 否 | 源站类型。取值有: |
Origin | String | 否 | 源站地址,根据 OriginType 的取值分为以下情况: |
OriginProtocol | String | 否 | 回源协议配置。当 OriginType 取值为 IPDomain、OriginGroup、LoadBalance 时该参数必填。取值有: |
HTTPOriginPort | Integer | 否 | HTTP 回源端口,取值范围 1~65535。该参数仅当回源协议 OriginProtocol 为 http 或者 follow 时生效。 |
HTTPSOriginPort | Integer | 否 | HTTPS 回源端口,取值范围 1~65535。该参数仅当回源协议 OriginProtocol 为 https 或者 follow 时生效。 |
PrivateAccess | String | 否 | 指定是否允许访问私有对象存储源站,该参数仅当源站类型 OriginType = COS 或 AWSS3 时会生效,取值有: |
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,表示取不到有效值。 |
MutualTLS
HTTPS 双向认证。
被如下接口引用:DescribeAccelerationDomains, ModifyHostsCertificate。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | 双向认证配置开关,取值有: |
CertInfos | Array of CertificateInfo | 否 | 双向认证证书列表。 注意:MutualTLS 在 ModifyHostsCertificate 作为入参使用时,该参数传入对应证书的 CertId 即可。您可以前往 SSL 证书列表 查看 CertId。 |
NoCache
不缓存配置
被如下接口引用:CreateL7AccRules, DescribeHostsSetting, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting, ModifyZoneSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | 不缓存配置开关,取值有: |
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 装订配置开关,取值有: |
OfflineCache
离线缓存是否开启
被如下接口引用:DescribeZoneSetting, ModifyZoneSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | 离线缓存是否开启,取值有: |
OfflineCacheParameters
离线缓存是否开启。
被如下接口引用:CreateL7AccRules, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 否 | 离线缓存开关,取值有: |
Origin
源站配置。
被如下接口引用:DescribeHostsSetting, DescribeZoneSetting, ModifyZoneSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Origins | Array of String | 否 | 主源站列表。 注意:此字段可能返回 null,表示取不到有效值。 |
BackupOrigins | Array of String | 否 | 备源站列表。 注意:此字段可能返回 null,表示取不到有效值。 |
OriginPullProtocol | String | 否 | 回源协议配置,取值有: 注意:此字段可能返回 null,表示取不到有效值。 |
CosPrivateAccess | String | 否 | 源站为腾讯云 COS 时,是否为私有访问 bucket,取值有: 注意:此字段可能返回 null,表示取不到有效值。 |
OriginDetail
加速域名源站信息。
被如下接口引用:DescribeAccelerationDomains。
名称 | 类型 | 描述 |
---|---|---|
OriginType | String | 源站类型,取值有: |
Origin | String | 源站地址,根据 OriginType 的取值分为以下情况: |
BackupOrigin | String | 备用源站组 ID,该参数仅在 OriginType = ORIGIN_GROUP 且配置了备源站组时会生效。 |
OriginGroupName | String | 主源源站组名称,当 OriginType = ORIGIN_GROUP 时该参数会返回值。 |
BackOriginGroupName | String | 备用源站组名称,该参数仅当 OriginType = ORIGIN_GROUP 且配置了备用源站组时会生效。 |
PrivateAccess | String | 指定是否允许访问私有对象存储源站,该参数仅当源站类型OriginType = COS 或 AWS_S3 时会生效,取值有: 不填写,默认值为 off。 |
PrivateParameters | Array of PrivateParameter | 私有鉴权使用参数,该参数仅当源站类型 PrivateAccess = on 时会生效。 注意:此字段可能返回 null,表示取不到有效值。 |
VodOriginScope | String | 云点播回源范围,当 OriginType = VOD 时该参数会返回值。取值有: |
VodBucketId | String | 云点播存储桶 ID,该参数当 OriginType = VOD 且 VodOriginScope = bucket 时必填。数据来源:云点播专业版应用下存储桶的存储 ID 。 |
OriginGroup
源站组信息
被如下接口引用:DescribeOriginGroup。
名称 | 类型 | 描述 |
---|---|---|
GroupId | String | 源站组ID。 |
Name | String | 源站组名称。 |
Type | String | 源站组类型,取值有: |
Records | Array of OriginRecord | 源站记录信息。 |
References | Array of OriginGroupReference | 源站组被引用实例列表。 |
CreateTime | Timestamp ISO8601 | 源站组创建时间。 |
UpdateTime | Timestamp ISO8601 | 源站组更新时间。 |
HostHeader | String | 回源Host Header。 注意:此字段可能返回 null,表示取不到有效值。 |
OriginGroupHealthStatus
源站组健康状态。
被如下接口引用:DescribeLoadBalancerList。
名称 | 类型 | 描述 |
---|---|---|
OriginGroupID | String | 源站组 ID。 |
OriginGroupName | String | 源站组名。 |
OriginType | String | 源站组类型,取值有: |
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"。参考取值有: |
OriginGroupId | String | 是 | 源站组 ID。 |
OriginGroupReference
源站组引用服务。
被如下接口引用:DescribeOriginGroup。
名称 | 类型 | 描述 |
---|---|---|
InstanceType | String | 引用服务类型,取值有: |
InstanceId | String | 引用类型的实例ID。 |
InstanceName | String | 应用类型的实例名称。 |
OriginHealthStatus
源站组里的源站健康状态。
被如下接口引用:DescribeLoadBalancerList, DescribeOriginGroupHealthStatus。
名称 | 类型 | 描述 |
---|---|---|
Origin | String | 源站。 |
Healthy | String | 源站健康状态,取值有: |
OriginInfo
加速域名源站信息。
被如下接口引用:CreateAccelerationDomain, ModifyAccelerationDomain。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
OriginType | String | 是 | 源站类型,取值有: |
Origin | String | 是 | 源站地址,根据 OriginType 的取值分为以下情况: |
BackupOrigin | String | 否 | 备用源站组 ID,该参数仅在 OriginType = ORIGIN_GROUP 时生效,该字段为旧版能力,调用后控制台无法进行配置修改,如需使用请提交工单咨询。 |
PrivateAccess | String | 否 | 指定是否允许访问私有对象存储源站,该参数仅当源站类型 OriginType = COS 或 AWS_S3 时会生效,取值有: 不填写时,默认值为off。 |
PrivateParameters | Array of PrivateParameter | 否 | 私有鉴权使用参数,该参数仅当源站类型 PrivateAccess = on 时会生效。 |
VodOriginScope | String | 否 | 云点播回源范围,该参数当 OriginType = VOD 时生效。取值有: |
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 | 是 | 鉴权版本。取值有: |
Region | String | 否 | 存储桶地域。 |
OriginProtectionInfo
源站防护信息
被如下接口引用:DescribeOriginProtection。
名称 | 类型 | 描述 |
---|---|---|
ZoneId | String | 站点ID。 |
Hosts | Array of String | 域名列表。 |
ProxyIds | Array of String | 代理ID列表。 |
CurrentIPWhitelist | IPWhitelist | 当前版本的IP白名单。 注意:此字段可能返回 null,表示取不到有效值。 |
NeedUpdate | Boolean | 该站点是否需要更新源站白名单,取值有: |
Status | String | 源站防护状态,取值有: |
PlanSupport | Boolean | 站点套餐是否支持源站防护,取值有: |
DiffIPWhitelist | DiffIPWhitelist | 最新IP白名单与当前IP白名单的对比。 注意:此字段可能返回 null,表示取不到有效值。 |
OriginRecord
源站组记录
被如下接口引用:CreateOriginGroup, DescribeOriginGroup, ModifyOriginGroup。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Record | String | 是 | 源站记录值,不包含端口信息,可以为:IPv4,IPv6,域名格式。 |
Type | String | 否 | 源站类型,取值有: |
RecordId | String | 否 | 源站记录ID。 |
Weight | Integer | 否 | 源站权重,取值为0-100, 不填表示不设置权重,由系统自由调度,填0表示权重为0, 流量将不会调度到此源站。 注意:此字段可能返回 null,表示取不到有效值。 |
Private | Boolean | 否 | 是否私有鉴权,当源站类型 RecordType=COS/AWS_S3 时生效,取值有: |
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 | 否 | 模块名称,取值为: |
Include | Array of Integer | 否 | 模块下的需要例外的具体规则ID列表。 注意:此字段可能返回 null,表示取不到有效值。 |
PlanInfo
edgeone套餐信息
被如下接口引用:DescribeAvailablePlans。
名称 | 类型 | 描述 |
---|---|---|
Currency | String | 结算货币类型,取值有: |
Flux | Integer | 套餐所含流量,该流量数值为安全加速流量,内容加速流量和智能加速流量的总和(单位:字节)。 |
Frequency | String | 结算周期,取值有: |
PlanType | String | 套餐类型,取值有: |
Price | Float | 套餐价格(单位:分)。 |
Request | Integer | 套餐所含请求次数,该请求次数为安全加速请求次数。(单位:次)。 |
SiteNumber | Integer | 套餐所能绑定的站点个数。 |
Area | String | 套餐加速区域类型,取值有: |
PostMaxSize
POST请求上传文件流式传输最大限制
被如下接口引用:DescribeZoneSetting, ModifyZoneSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | 是否开启 POST 请求上传文件限制,平台默认为限制为32MB,取值有: |
MaxSize | Integer | 否 | 最大限制,取值在1MB和500MB之间。单位字节。 注意:此字段可能返回 null,表示取不到有效值。 |
PostMaxSizeParameters
POST 请求上传文件流式传输最大限制。
被如下接口引用:CreateL7AccRules, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 否 | 是否开启 POST 请求上传文件限制,单位为 Byte,平台默认为限制为 32 * 220 Byte,取值有: |
MaxSize | Integer | 否 | POST 请求上传文件流式传输最大限制,单位为 Byte,取值:1 * 220 Byte~500 * 220 Byte。 |
PrepaidPlanParam
预付费套餐计费参数
被如下接口引用:CreatePlan。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Period | Integer | 否 | 订阅预付费套餐的周期,单位:月,取值有:1,2,3,4,5,6,7,8,9,10,11,12,24,36。 不填写使用默认值 1。 |
RenewFlag | String | 否 | 预付费套餐的自动续费标志,取值有: 不填写使用默认值 off,自动续费时,默认续费1个月。 |
PrivateParameter
对象存储源站私有鉴权参数
被如下接口引用:CreateAccelerationDomain, CreateOriginGroup, DescribeAccelerationDomains, DescribeOriginGroup, ModifyAccelerationDomain, ModifyOriginGroup。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Name | String | 是 | 私有鉴权参数名称,取值有: |
Value | String | 是 | 私有鉴权参数值。 |
QUICParameters
QUIC 配置项。
被如下接口引用:CreateL7AccRules, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 否 | QUIC 配置开关,取值有: |
QueryCondition
查询条件
被如下接口引用:CreateRealtimeLogDeliveryTask, DescribeOverviewL7Data, DescribeTimingL4Data, DescribeTimingL7AnalysisData, DescribeTimingL7CacheData, DescribeTopL7AnalysisData, DescribeTopL7CacheData, ModifyRealtimeLogDeliveryTask。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Key | String | 是 | 筛选条件的key。 |
Operator | String | 是 | 查询条件操作符,操作类型有: |
Value | Array of String | 是 | 筛选条件的值。 |
QueryString
CacheKey中包含请求参数
被如下接口引用:DescribeHostsSetting, ModifyZoneSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | CacheKey是否由QueryString组成,取值有: |
Action | String | 否 | CacheKey使用QueryString的方式,取值有: 注意:此字段可能返回 null,表示取不到有效值。 |
Value | Array of String | 否 | 使用/排除的url参数数组。 注意:此字段可能返回 null,表示取不到有效值。 |
Quic
Quic配置项
被如下接口引用:DescribeZoneSetting, ModifyZoneSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | 是否开启 Quic 配置,取值有: |
Quota
刷新/预热 可用量及配额
被如下接口引用:DescribeContentQuota。
名称 | 类型 | 描述 |
---|---|---|
Batch | Integer | 单次批量提交配额上限。 |
Daily | Integer | 每日提交配额上限。 |
DailyAvailable | Integer | 每日剩余的可提交配额。 |
Type | String | 刷新预热缓存类型,取值有: |
RangeOriginPullParameters
分片回源配置参数。
被如下接口引用:CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 否 | 分片回源开关,取值有: |
RateLimitConfig
速率限制规则
被如下接口引用:ModifySecurityPolicy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | 开关,取值有: |
RateLimitUserRules | Array of RateLimitUserRule | 否 | 速率限制-用户规则列表。如果为null,默认使用历史配置。 |
RateLimitTemplate | RateLimitTemplate | 否 | 速率限制模板功能。如果为null,默认使用历史配置。 注意:此字段可能返回 null,表示取不到有效值。 |
RateLimitIntelligence | RateLimitIntelligence | 否 | 智能客户端过滤。如果为null,默认使用历史配置。 注意:此字段可能返回 null,表示取不到有效值。 |
RateLimitCustomizes | Array of RateLimitUserRule | 否 | 速率限制-托管定制规则。如果为null,默认使用历史配置。 注意:此字段可能返回 null,表示取不到有效值。 |
RateLimitIntelligence
智能客户端过滤
被如下接口引用:ModifySecurityPolicy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | 功能开关,取值有: |
Action | String | 是 | 执行动作,取值有: |
RuleId | Integer | 否 | 规则id,仅出参使用。 |
RateLimitTemplate
速率限制模板
被如下接口引用:ModifySecurityPolicy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Mode | String | 是 | 模板等级名称,取值有: |
Action | String | 否 | 模板处置方式,取值有: |
RateLimitTemplateDetail | RateLimitTemplateDetail | 否 | 模板值详情。仅出参返回。 |
RateLimitTemplateDetail
模板当前详细配置
被如下接口引用:ModifySecurityPolicy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Mode | String | 是 | 模板等级名称,取值有: 注意:此字段可能返回 null,表示取不到有效值。 |
ID | Integer | 是 | 唯一id。 |
Action | String | 是 | 模板处置方式,取值有: 注意:此字段可能返回 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 | 是 | 处置动作,取值有: |
PunishTime | Integer | 是 | 惩罚时长,0-2天。 |
PunishTimeUnit | String | 是 | 处罚时长单位,取值有: |
RuleStatus | String | 是 | 规则状态,取值有: |
AclConditions | Array of AclCondition | 是 | 规则详情。 |
RulePriority | Integer | 是 | 规则权重,取值范围0-100。 |
RuleID | Integer | 否 | 规则 Id。仅出参使用。 |
FreqFields | Array of String | 否 | 过滤词,取值有: 默认为空字符串。 |
UpdateTime | String | 否 | 更新时间。仅出参使用。修改时默认为当前时间。 |
FreqScope | Array of String | 否 | 统计范围。取值有: 默认为 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 | 实时日志投递任务的状态,取值有: |
TaskType | String | 实时日志投递任务类型,取值有: |
EntityList | Array of String | 实时日志投递任务对应的实体(七层域名或者四层代理实例)列表。取值示例如下: |
LogType | String | 数据投递类型,取值有: |
Area | String | 数据投递区域,取值有: |
Fields | Array of String | 投递的预设字段列表。 |
CustomFields | Array of CustomField | 投递的自定义字段列表。 |
DeliveryConditions | Array of DeliveryCondition | 日志投递的过滤条件。 |
Sample | Integer | 采样比例,采用千分制,取值范围为1-1000,例如:605 表示采样比例为 60.5%。 |
LogFormat | LogFormat | 日志投递的输出格式。出参为 null 时表示为默认格式,默认格式逻辑如下: 注意:此字段可能返回 null,表示取不到有效值。 |
CLS | CLSTopic | CLS 的配置信息。 注意:此字段可能返回 null,表示取不到有效值。 |
CustomEndpoint | CustomEndpoint | 自定义 HTTP 服务的配置信息。 注意:此字段可能返回 null,表示取不到有效值。 |
S3 | S3 | AWS S3 兼容存储桶的配置信息。 注意:此字段可能返回 null,表示取不到有效值。 |
CreateTime | Timestamp ISO8601 | 创建时间。 |
UpdateTime | Timestamp ISO8601 | 更新时间。 |
RenewFlag
预付费套餐自动续费配置项。
被如下接口引用:ModifyPlan。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | 预付费套餐的自动续费标志,取值有: |
Resource
计费资源
被如下接口引用:DescribeZones。
名称 | 类型 | 描述 |
---|---|---|
Id | String | 资源 ID。 |
PayMode | Integer | 付费模式,取值有: |
CreateTime | Timestamp ISO8601 | 创建时间。 |
EnableTime | Timestamp ISO8601 | 生效时间。 |
ExpireTime | Timestamp ISO8601 | 失效时间。 |
Status | String | 套餐状态,取值有: |
Sv | Array of Sv | 询价参数。 |
AutoRenewFlag | Integer | 是否自动续费,取值有: |
PlanId | String | 套餐关联资源 ID。 |
Area | String | 地域,取值有: |
Group | String | 资源类型,取值有: 注意:此字段可能返回 null,表示取不到有效值。 |
ZoneNumber | Integer | 当前资源绑定的站点数量。 注意:此字段可能返回 null,表示取不到有效值。 |
Type | String | 资源标记类型,取值有: |
ResponseSpeedLimitParameters
单连接下载限速配置参数。
被如下接口引用:CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Mode | String | 是 | 下载限速模式,取值有: |
MaxSpeed | String | 是 | 限速值,单位为:KB/s,填写数值,指定限速大小。 |
StartAt | String | 否 | 限速开始值,可以为下载大小或指定时长,单位为:KB或s,当 Mode 取值为 LimitAfterSpecificBytesDownloaded 或 LimitAfterSpecificSecondsDownloaded 时,该参数必填。填写数值,指定下载大小或指定时长。 |
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 | 参数值类型。 |
ChoicesValue | Array of String | 参数值的可选值。 注意:若参数值为用户自定义则该数组为空数组。 |
Min | Integer | 数值参数的最小值,非数值参数或 Min 和 Max 值都为 0 则此项无意义。 |
Max | Integer | 数值参数的最大值,非数值参数或 Min 和 Max 值都为 0 则此项无意义。 |
IsMultiple | Boolean | 参数值是否支持多选或者填写多个。 |
IsAllowEmpty | Boolean | 是否允许为空。 |
ExtraParameter | RuleExtraParameter | 特殊参数。 |
RuleCodeActionParams
规则引擎条件使用StatusCode字段动作参数
被如下接口引用:CreateRule, DescribeRules, ModifyRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
StatusCode | Integer | 是 | 状态 Code。 |
Name | String | 是 | 参数名称,参数填写规范可调用接口 查询规则引擎的设置参数 查看。 |
Values | Array of String | 是 | 参数值。 |
RuleCondition
规则引擎条件参数
被如下接口引用:CreateFunctionRule, CreateRule, DescribeRules, ModifyFunctionRule, ModifyRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Operator | String | 是 | 运算符,取值有: |
Target | String | 是 | 匹配类型,取值有: |
Values | Array of String | 否 | 对应匹配类型的参数值,仅在匹配类型为查询字符串或HTTP请求头并且运算符取值为存在或不存在时允许传空数组,对应匹配类型有: |
IgnoreCase | Boolean | 否 | 是否忽略参数值的大小写,默认值为 false。 |
Name | String | 否 | 对应匹配类型的参数名称,在 Target 值为以下取值时有效,有效时值不能为空: |
RuleEngineAction
规则引擎操作。
被如下接口引用:CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Name | String | 是 | 操作名称。名称需要与参数结构体对应,例如 Name=Cache,则 CacheParameters 必填。 注意:此字段可能返回 null,表示取不到有效值。 |
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,表示取不到有效值。 |
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 取值为 HttpResponse 时,该参数必填。 注意:此字段可能返回 null,表示取不到有效值。 |
RuleEngineItem
规则引擎规则详情。
被如下接口引用:CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Status | String | 否 | 规则状态。取值有: |
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 | 参数名,取值有: |
Type | String | 参数值类型。 |
Choices | Array of String | 可选参数值。 注意:当 Id 的值为 StatusCode 时数组中的值为整型,填写参数值时请填写字符串的整型数值。 |
RuleItem
规则引擎规则详情
被如下接口引用:DescribeRules。
名称 | 类型 | 描述 |
---|---|---|
RuleId | String | 规则ID。 |
RuleName | String | 规则名称,名称字符串长度 1~255。 |
Status | String | 规则状态,取值有: |
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 | 是 | 功能参数名称,参数填写规范可调用接口 查询规则引擎的设置参数 查看。现在只有三种取值: |
Name | String | 是 | 参数名称。 |
Values | Array of String | 是 | 参数值。 |
RulesProperties
规则引擎可应用于匹配请求的设置详细信息。
被如下接口引用:DescribeRulesSetting。
名称 | 类型 | 描述 |
---|---|---|
Name | String | 值为参数名称。 |
Min | Integer | 数值参数的最小值,非数值参数或 Min 和 Max 值都为 0 则此项无意义。 |
ChoicesValue | Array of String | 参数值的可选值。 注意:若参数值为用户自定义则该数组为空数组。 |
Type | String | 参数值类型。 |
Max | Integer | 数值参数的最大值,非数值参数或 Min 和 Max 值都为 0 则此项无意义。 |
IsMultiple | Boolean | 参数值是否支持多选或者填写多个。 |
IsAllowEmpty | Boolean | 是否允许为空。 |
ChoiceProperties | Array of RuleChoicePropertiesItem | 该参数对应的关联配置参数,属于调用接口的必填参数。 注意:如果可选参数无特殊新增参数则该数组为空数组。 |
ExtraParameter | RuleExtraParameter | 注意:此字段可能返回 null,表示取不到有效值。 |
RulesSettingAction
规则引擎可应用于匹配请求的设置列表及其详细信息
被如下接口引用:DescribeRulesSetting。
名称 | 类型 | 描述 |
---|---|---|
Action | String | 功能名称,取值有: (ErrorPage); |
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 | 否 | 数据压缩类型,取值有: |
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 | 是 | 安全类型开关,取值为: |
ServerCertInfo
https 服务端证书配置
被如下接口引用:DescribeHostsSetting, ModifyHostsCertificate, ModifyZoneSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
CertId | String | 是 | 服务器证书 ID。来源于 SSL 侧,您可以前往 SSL 证书列表 查看 CertId。 注意:此字段可能返回 null,表示取不到有效值。 |
Alias | String | 否 | 证书备注名。 注意:此字段可能返回 null,表示取不到有效值。 |
Type | String | 否 | 证书类型,取值有: 注意:此字段可能返回 null,表示取不到有效值。 |
ExpireTime | Timestamp ISO8601 | 否 | 证书过期时间。 注意:此字段可能返回 null,表示取不到有效值。 |
DeployTime | Timestamp ISO8601 | 否 | 证书部署时间。 注意:此字段可能返回 null,表示取不到有效值。 |
SignAlgo | String | 否 | 签名算法。 注意:此字段可能返回 null,表示取不到有效值。 |
CommonName | String | 否 | 证书归属域名名称。 注意:此字段可能返回 null,表示取不到有效值。 |
SetContentIdentifierParameters
内容标识配置参数。
被如下接口引用:CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ContentIdentifier | String | 否 | 内容标识id |
SkipCondition
例外规则的跳过匹配条件,即在例外时根据本匹配条件,略过指定字段及内容。
被如下接口引用:ModifySecurityPolicy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Type | String | 是 | 例外跳过类型,取值为: |
Selector | String | 是 | 选择跳过的字段,取值为: |
MatchFromType | String | 否 | 匹配Key所使用的匹配方式,取值为: |
MatchFrom | Array of String | 否 | 匹配Key的值。 注意:此字段可能返回 null,表示取不到有效值。 |
MatchContentType | String | 否 | 匹配Content所使用的匹配方式,取值为: |
MatchContent | Array of String | 否 | 匹配Value的值。 注意:此字段可能返回 null,表示取不到有效值。 |
SlowPostConfig
慢速攻击配置。
被如下接口引用:ModifySecurityPolicy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | 开关,取值有: |
FirstPartConfig | FirstPartConfig | 否 | 首包配置。 注意:此字段可能返回 null,表示取不到有效值。 |
SlowRateConfig | SlowRateConfig | 否 | 基础配置。 注意:此字段可能返回 null,表示取不到有效值。 |
Action | String | 否 | 慢速攻击的处置动作,取值有: 注意:此字段可能返回 null,表示取不到有效值。 |
RuleId | Integer | 否 | 本规则的Id。 注意:此字段可能返回 null,表示取不到有效值。 |
SlowRateConfig
慢速攻击的基础配置。
被如下接口引用:ModifySecurityPolicy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | 开关,取值有: |
Interval | Integer | 否 | 统计的间隔,单位是秒,即在首段包传输结束后,将数据传输轴按照本参数切分,每个分片独立计算慢速攻击。 注意:此字段可能返回 null,表示取不到有效值。 |
Threshold | Integer | 否 | 统计时应用的速率阈值,单位是bps,即如果本分片中的传输速率没达到本参数的值,则判定为慢速攻击,应用慢速攻击的处置方式。 注意:此字段可能返回 null,表示取不到有效值。 |
SmartRouting
智能加速配置
被如下接口引用:DescribeHostsSetting, DescribeZoneSetting, ModifyZoneSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | 智能加速配置开关,取值有: |
SmartRoutingParameters
智能加速配置。
被如下接口引用:CreateL7AccRules, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 否 | 智能加速配置开关,取值有: |
StandardDebug
支持标准debug结构体
被如下接口引用:DescribeZoneSetting, ModifyZoneSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | Debug 功能开关,取值有: |
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 功能开关,取值有: |
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 | 否 | 询价参数映射的配额,取值有: 注意:此字段可能返回 null,表示取不到有效值。 |
InstanceId | String | 否 | 询价参数映射的四层代理实例Id。 注意:此字段可能返回 null,表示取不到有效值。 |
ProtectionSpecs | String | 否 | 询价参数对应的防护等级。 取值有: 注意:此字段可能返回 null,表示取不到有效值。 |
SwitchConfig
功能总开关
被如下接口引用:ModifySecurityPolicy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
WebSwitch | String | 是 | Web类型的安全总开关,取值有: |
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。取值有: |
CipherSuite | String | 否 | 密码套件。详细介绍请参考 TLS 版本及密码套件说明。取值有: |
Tag
标签配置
被如下接口引用:CreateContentIdentifier, CreateZone, DescribeContentIdentifiers, DescribeZones。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TagKey | String | 是 | 标签键。 注意:此字段可能返回 null,表示取不到有效值。 |
TagValue | String | 是 | 标签值。 注意:此字段可能返回 null,表示取不到有效值。 |
Task
内容管理任务结果
被如下接口引用:DescribePrefetchTasks, DescribePurgeTasks。
名称 | 类型 | 描述 |
---|---|---|
JobId | String | 任务 ID。 |
Target | String | 资源。 |
Type | String | 任务类型。 |
Method | String | 节点缓存清除方法,取值有: 注意:此字段可能返回 null,表示取不到有效值。 |
Status | 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 | 排序实体数量。 |
URLPath
访问 URL 重定向路径配置参数。
被如下接口引用:CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Action | String | 否 | 执行动作,取值有: |
Regex | String | 否 | 正则匹配的表达式,长度范围为 1~1024。 注意:当 Action 为 regex 时,此字段必填;当 Action 为 follow 或 custom 时,无需填写此字段,若填写则不生效。 |
Value | String | 否 | 重定向的目标URL,长度范围为 1~1024。 注意:当 Action 为 regex 或 custom 时,此字段必填;当 Action 为 follow 时,无需填写此字段,若填写则不生效。 |
UpstreamCertInfo
用于 EO 节点回源时携带的证书,源站启用双向认证握手时使用,用于源站认证客户端证书是否有效,确保请求来源于受信任的 EO 节点。
被如下接口引用:DescribeAccelerationDomains。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
UpstreamMutualTLS | MutualTLS | 否 | 在回源双向认证场景下,该字段为 EO 节点回源时携带的证书(包含公钥、私钥即可),部署在 EO 节点,用于源站对 EO 节点进行认证。在作为入参使用时,不填写表示保持原有配置。 |
UpstreamFollowRedirectParameters
回源跟随重定向参数配置。
被如下接口引用:CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 否 | 回源跟随重定向配置开关,取值有: |
MaxTimes | Integer | 否 | 最大重定向次数。取值为 1-5。 注意:当 Switch 为 on 时,此字段必填;当 Switch 为 off 时,无需填写此字段,若填写则不生效。 |
UpstreamHTTP2Parameters
HTTP2 回源配置。
被如下接口引用:CreateL7AccRules, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 否 | HTTP2 回源配置开关,取值有: |
UpstreamHttp2
Http2回源配置
被如下接口引用:DescribeZoneSetting, ModifyZoneSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | http2 回源配置开关,取值有: |
UpstreamRequestCookie
回源请求参数 Cookie 配置。
被如下接口引用:CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 否 | 回源请求参数 Cookie 配置开关,取值有: |
Action | String | 否 | 回源请求参数 Cookie 模式。当 Switch 为 on 时,该参数必填。取值有: |
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 | 否 | 回源请求参数查询字符串配置开关,取值有: |
Action | String | 否 | 查询字符串模式。当 Switch 为 on 时,该参数必填。取值有: |
Values | Array of String | 否 | 指定参数值。仅当查询字符串模式 Action 为 includeCustom 或者 excludeCustom 时该参数生效,用于指定需要保留或者忽略的参数。最大支持 10 个参数。 |
UpstreamURLRewriteParameters
回源 URL 重写 配置参数。
被如下接口引用:CreateL7AccRules, DescribeL7AccRules, ModifyL7AccRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Type | String | 否 | 回源 URL 重写类型,仅支持填写 Path。 |
Action | String | 否 | 回源 URL 重写动作。取值有: |
Value | String | 否 | 回源 URL 重写值,最大长度 1024,必须以 / 开头。 注意:当 Action 为 addPrefix 时,不能以 / 结尾;当 Action 为 rmvPrefix 时,不能存在 *。 |
VanityNameServers
自定义 nameservers
被如下接口引用:DescribeZones, ModifyZone。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | 自定义 ns 开关,取值有: |
Servers | Array of String | 否 | 自定义 ns 列表。 |
VanityNameServersIps
自定义名字服务器 IP 信息
被如下接口引用:DescribeZones。
名称 | 类型 | 描述 |
---|---|---|
Name | String | 自定义名字服务器名称。 |
IPv4 | String | 自定义名字服务器 IPv4 地址。 |
Waf
无
被如下接口引用:DescribeHostsSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | Waf开关,取值为: |
PolicyId | Integer | 否 | 策略ID。 |
WafConfig
Waf配置。
被如下接口引用:ModifySecurityPolicy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | WafConfig开关,取值有: |
Level | String | 是 | 上一次设置的防护级别,取值有: |
Mode | String | 是 | 全局WAF模式,取值有: |
WafRule | WafRule | 否 | 托管规则详细配置。如果为null,默认使用历史配置。 |
AiRule | AiRule | 否 | AI规则引擎防护配置。如果为null,默认使用历史配置。 |
WafRule
Waf规则
被如下接口引用:ModifySecurityPolicy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | 托管规则开关,取值有: |
BlockRuleIDs | Array of Integer | 是 | 黑名单ID列表,将规则ID加入本参数列表中代表该ID关闭,即该规则ID不再生效。 |
ObserveRuleIDs | Array of Integer | 是 | 观察模式ID列表,将规则ID加入本参数列表中代表该ID使用观察模式生效,即该规则ID进入观察模式。 |
WebSocket
WebSocket配置
被如下接口引用:DescribeZoneSetting, ModifyZoneSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 是 | WebSocket 超时时间配置开关,取值有: |
Timeout | Integer | 否 | 超时时间,单位为秒,最大超时时间120秒。 |
WebSocketParameters
WebSocket 配置。
被如下接口引用:CreateL7AccRules, DescribeL7AccRules, DescribeL7AccSetting, ModifyL7AccRule, ModifyL7AccSetting。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Switch | String | 否 | WebSocket 超时时间配置开关,取值有: |
Timeout | Integer | 否 | 超时时间,单位为秒,最大超时时间 120 秒。 注意:当 Switch 为 on 时,此字段必填,否则此字段不生效。 |
Zone
站点信息
被如下接口引用:DescribeZones。
名称 | 类型 | 描述 |
---|---|---|
ZoneId | String | 站点 ID。 |
ZoneName | String | 站点名称。 |
OriginalNameServers | Array of String | 站点当前使用的 NS 列表。 |
NameServers | Array of String | 腾讯云分配的 NS 列表。 |
Status | String | 站点状态,取值有: |
Type | String | 站点接入方式,取值有: |
Paused | Boolean | 站点是否关闭。 |
CnameSpeedUp | String | 是否开启 CNAME 加速,取值有: |
CnameStatus | String | CNAME 接入状态,取值有: |
Tags | Array of Tag | 资源标签列表。 |
Resources | Array of Resource | 计费资源列表。 |
CreatedOn | Timestamp ISO8601 | 站点创建时间。 |
ModifiedOn | Timestamp ISO8601 | 站点修改时间。 |
Area | String | 站点接入地域,取值有: |
VanityNameServers | VanityNameServers | 用户自定义 NS 信息。 注意:此字段可能返回 null,表示取不到有效值。 |
VanityNameServersIps | Array of VanityNameServersIps | 用户自定义 NS IP 信息。 注意:此字段可能返回 null,表示取不到有效值。 |
ActiveStatus | String | 展示状态,取值有: |
AliasZoneName | String | 站点别名。数字、英文、-和_组合,限制20个字符。 注意:此字段可能返回 null,表示取不到有效值。 |
IsFake | Integer | 是否伪站点,取值有: |
LockStatus | String | 锁定状态,取值有: |
OwnershipVerification | OwnershipVerification | 归属权验证信息。 注意:此字段可能返回 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,表示取不到有效值。 |
ZoneSetting
站点配置。
被如下接口引用:DescribeZoneSetting。
名称 | 类型 | 描述 |
---|---|---|
ZoneName | String | 站点名称。 |
Area | String | 站点加速区域信息,取值有: |
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,表示取不到有效值。 |