配置指南

API 文档

参与文档共建赢好礼> HOT

数据结构

最近更新时间:2022-08-04 06:11:00

我的收藏

AccessControl

请求头部及请求url访问控制

被如下接口引用:DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String on | off 是否启用请求头部及请求url访问控制
AccessControlRules Array of AccessControlRule 请求头部及请求url访问规则
注意:此字段可能返回 null,表示取不到有效值。
ReturnCode Integer 返回状态码
注意:此字段可能返回 null,表示取不到有效值。

AccessControlRule

访问控制规则

被如下接口引用:UpdateDomainConfig。

名称 类型 必选 描述
RuleType String requestHeader :对请求头部进行访问控制
url : 对访问url进行访问控制
注意:此字段可能返回 null,表示取不到有效值。
RuleContent String 封禁内容
注意:此字段可能返回 null,表示取不到有效值。
Regex String on :正则匹配
off :字面匹配
注意:此字段可能返回 null,表示取不到有效值。
RuleHeader String RuleType为requestHeader时必填,否则不需要填
注意:此字段可能返回 null,表示取不到有效值。

AdvanceCacheRule

缓存配置高级版本规则

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
CacheType String 规则类型:
all:所有文件生效
file:指定文件后缀生效
directory:指定路径生效
path:指定绝对路径生效
default:源站未返回 max-age 情况下的缓存规则
注意:此字段可能返回 null,表示取不到有效值。
CacheContents Array of String 对应类型下的匹配内容:
all 时填充 *
file 时填充后缀名,如 jpg、txt
directory 时填充路径,如 /xxx/test/
path 时填充绝对路径,如 /xxx/test.html
default 时填充 "no max-age"
注意:此字段可能返回 null,表示取不到有效值。
CacheTime Integer 缓存过期时间
单位为秒,最大可设置为 365 天
注意:此字段可能返回 null,表示取不到有效值。

AdvanceConfig

高级配置集合

被如下接口引用:DescribeDomainsConfig。

名称 类型 描述
Name String 高级配置名称。
注意:此字段可能返回 null,表示取不到有效值。
Value String 是否支持高级配置,
on:支持
off:不支持
注意:此字段可能返回 null,表示取不到有效值。

AdvanceHttps

回源的自定义Https配置

被如下接口引用:AddCdnDomain, DescribeDomains, UpdateDomainConfig。

名称 类型 必选 描述
CustomTlsStatus String 自定义Tls数据开关
注意:此字段可能返回 null,表示取不到有效值。
TlsVersion Array of String Tls版本列表,支持设置 TLSv1, TLSV1.1, TLSV1.2, TLSv1.3,修改时必须开启连续的版本
注意:此字段可能返回 null,表示取不到有效值。
Cipher String 自定义加密套件
注意:此字段可能返回 null,表示取不到有效值。
VerifyOriginType String 回源双向校验开启状态
off - 关闭校验
oneWay - 校验源站
twoWay - 双向校验
注意:此字段可能返回 null,表示取不到有效值。
CertInfo ServerCert 回源层证书配置信息
注意:此字段可能返回 null,表示取不到有效值。
OriginCertInfo ClientCert 源站证书配置信息
注意:此字段可能返回 null,表示取不到有效值。

AdvancedAuthentication

时间戳防盗链高级版配置,白名单功能

被如下接口引用:DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String 防盗链配置开关,on或off,开启时必须且只能配置一种模式,其余模式为null。
TypeA AdvancedAuthenticationTypeA 时间戳防盗链高级版模式A配置。
注意:此字段可能返回 null,表示取不到有效值。
TypeB AdvancedAuthenticationTypeB 时间戳防盗链高级版模式B配置。
注意:此字段可能返回 null,表示取不到有效值。
TypeC AdvancedAuthenticationTypeC 时间戳防盗链高级版模式C配置。
注意:此字段可能返回 null,表示取不到有效值。
TypeD AdvancedAuthenticationTypeD 时间戳防盗链高级版模式D配置。
注意:此字段可能返回 null,表示取不到有效值。
TypeE AdvancedAuthenticationTypeE 时间戳防盗链高级版模式E配置。
注意:此字段可能返回 null,表示取不到有效值。
TypeF AdvancedAuthenticationTypeF 时间戳防盗链高级版模式F配置。
注意:此字段可能返回 null,表示取不到有效值。

AdvancedAuthenticationTypeA

时间戳防盗链高级版模式A配置。

被如下接口引用:UpdateDomainConfig。

名称 类型 必选 描述
SecretKey String 用于计算签名的密钥,只允许字母和数字,长度6-32字节。
SignParam String uri串中签名的字段名,字母,数字或下划线构成,同时必须以字母开头。
TimeParam String uri串中时间的字段名,字母,数字或下划线构成,同时必须以字母开头。
ExpireTime Integer 过期时间,单位秒。
ExpireTimeRequired Boolean 是否必须提供过期时间参数。
Format String Url组成格式,如:${private_key}${schema}${host}${full_uri。
TimeFormat String 时间格式,dec,hex分别表示十进制,十六进制。
FailCode Integer 鉴权失败时返回的状态码。
ExpireCode Integer 链接过期时返回的状态码。
RulePaths Array of String 需要鉴权的url路径列表。
Transformation Integer 保留字段。

AdvancedAuthenticationTypeB

时间戳防盗链高级版模式B配置。

被如下接口引用:UpdateDomainConfig。

名称 类型 必选 描述
KeyAlpha String alpha键名。
KeyBeta String beta键名。
KeyGamma String gamma键名。
SignParam String uri串中签名的字段名,字母,数字或下划线构成,同时必须以字母开头。
TimeParam String uri串中时间的字段名,字母,数字或下划线构成,同时必须以字母开头。
ExpireTime Integer 过期时间,单位秒。
TimeFormat String 时间格式,dec,hex分别表示十进制,十六进制。
FailCode Integer 鉴权失败时返回的状态码。
ExpireCode Integer 链接过期时返回的状态码。
RulePaths Array of String 需要鉴权的url路径列表。

AdvancedAuthenticationTypeC

时间戳防盗链高级版模式C配置。

被如下接口引用:UpdateDomainConfig。

名称 类型 必选 描述
AccessKey String 访问密钥。
SecretKey String 鉴权密钥。

AdvancedAuthenticationTypeD

时间戳防盗链高级版模式D配置。

被如下接口引用:UpdateDomainConfig。

名称 类型 必选 描述
SecretKey String 用于计算签名的密钥,只允许字母和数字,长度6-32字节。
BackupSecretKey String 备份密钥,当使用SecretKey鉴权失败时会使用该密钥重新鉴权。
SignParam String uri串中签名的字段名,字母,数字或下划线构成,同时必须以字母开头。
TimeParam String uri串中时间的字段名,字母,数字或下划线构成,同时必须以字母开头。
ExpireTime Integer 过期时间,单位秒。
TimeFormat String 时间格式,dec,hex分别表示十进制,十六进制。

AdvancedAuthenticationTypeE

时间戳防盗链高级版模式E配置。

被如下接口引用:UpdateDomainConfig。

名称 类型 必选 描述
SecretKey String 用于计算签名的密钥,只允许字母和数字,长度6-32字节。
注意:此字段可能返回 null,表示取不到有效值。
SignParam String uri串中签名的字段名,字母,数字或下划线构成,同时必须以字母开头。
注意:此字段可能返回 null,表示取不到有效值。
AclSignParam String uri串中Acl签名的字段名,字母,数字或下划线构成,同时必须以字母开头。
注意:此字段可能返回 null,表示取不到有效值。
StartTimeParam String uri串中开始时间字段名,字母,数字或下划线构成,同时必须以字母开头。
注意:此字段可能返回 null,表示取不到有效值。
ExpireTimeParam String uri串中过期时间字段名,字母,数字或下划线构成,同时必须以字母开头。
注意:此字段可能返回 null,表示取不到有效值。
TimeFormat String 时间格式,dec
注意:此字段可能返回 null,表示取不到有效值。

AdvancedAuthenticationTypeF

时间戳防盗链高级鉴权模式TypeF配置

被如下接口引用:UpdateDomainConfig。

名称 类型 必选 描述
SignParam String uri串中签名的字段名,字母,数字或下划线构成,同时必须以字母开头。
注意:此字段可能返回 null,表示取不到有效值。
TimeParam String uri串中时间的字段名,字母,数字或下划线构成,同时必须以字母开头。
注意:此字段可能返回 null,表示取不到有效值。
TransactionParam String uri串中Transaction字段名,字母,数字或下划线构成,同时必须以字母开头。
注意:此字段可能返回 null,表示取不到有效值。
SecretKey String 用于计算签名的主密钥,只允许字母和数字,长度6-32字节。
注意:此字段可能返回 null,表示取不到有效值。
BackupSecretKey String 用于计算签名的备选密钥,主密钥校验失败后再次尝试备选密钥,只允许字母和数字,长度6-32字节。
注意:此字段可能返回 null,表示取不到有效值。

AdvancedCCRules

scdn 的自定义 cc 规则

被如下接口引用:CreateScdnDomain, DescribeScdnConfig, UpdateScdnDomain。

名称 类型 必选 描述
RuleName String 规则名称
DetectionTime Integer 探测时长
注意:此字段可能返回 null,表示取不到有效值。
FrequencyLimit Integer 限频阈值
注意:此字段可能返回 null,表示取不到有效值。
PunishmentSwitch String IP 惩罚开关,可选on|off
注意:此字段可能返回 null,表示取不到有效值。
PunishmentTime Integer IP 惩罚时长
注意:此字段可能返回 null,表示取不到有效值。
Action String 执行动作,intercept|redirect
注意:此字段可能返回 null,表示取不到有效值。
RedirectUrl String 动作为 redirect 时,重定向的url
注意:此字段可能返回 null,表示取不到有效值。
Configure Array of ScdnSevenLayerRules 七层限频具体配置
注意:此字段可能返回 null,表示取不到有效值。
Switch String 是否开启改规则 on 开启,off关闭
注意:此字段可能返回 null,表示取不到有效值。

AdvancedCache

缓存过期配置高级版,注意:此字段已经弃用,请使用RuleCache

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
CacheRules Array of AdvanceCacheRule 缓存过期规则
注意:此字段可能返回 null,表示取不到有效值。
IgnoreCacheControl String 强制缓存配置
on:开启
off:关闭
开启时,源站返回 no-cache、no-store 头部时,仍按照缓存过期规则进行节点缓存
默认为关闭状态
注意:此字段可能返回 null,表示取不到有效值。
IgnoreSetCookie String 当源站返回Set-Cookie头部时,节点是否缓存该头部及body
on:开启,不缓存该头部及body
off:关闭,遵循用户自定义的节点缓存规则
默认为关闭状态
注意:此字段可能返回 null,表示取不到有效值。

AdvancedScdnAclGroup

SCDN精准访问控制配置

被如下接口引用:CreateScdnDomain, DescribeScdnConfig, UpdateScdnDomain。

名称 类型 必选 描述
RuleName String 规则名称
Configure Array of AdvancedScdnAclRule 具体配置
Result String 执行动作,intercept|redirect
Status String 规则是否生效,active|inactive
ErrorPage ScdnErrorPage 错误页面配置

AdvancedScdnAclRule

精准访问控制匹配规则

被如下接口引用:CreateScdnDomain, DescribeScdnConfig, UpdateScdnDomain。

名称 类型 必选 描述
MatchKey String 匹配关键字:
protocol:HTTP协议
httpVersion:HTTP版本
method:请求方法
ip:请求源IP
ipAsn:请求源IP自治域号
ipCountry:请求源IP所在国家
ipArea:请求源IP所在大区
xForwardFor:请求头X-Forward-For
directory:路径
index:首页
path:文件全路径
file:文件扩展名
param:请求参数
referer:请求头Referer
cookie:请求头Cookie
userAgent:请求头User-Agent
head:自定义请求头
LogicOperator String 逻辑操作符,取值如下:
不包含:exclude
包含:include
不等于:notequal
等于:equal
前缀匹配:matching
内容为空或不存在:null
MatchValue Array of String 匹配值。
当MatchKey为protocol时
取值:HTTP、HTTPS

当MatchKey为httpVersion时
取值:HTTP/1.0、HTTP/1.1、HTTP/1.2、HTTP/2、HTTP/3

当MatchKey为method时
取值:HEAD、GET、POST、PUT、OPTIONS、TRACE、DELETE、PATCH、CONNECT

当MatchKey为ipCountry时,取值为:
其他:OTHER
委内瑞拉:VE
乌拉圭:UY
苏里南:SR
巴拉圭:PY
秘鲁:PE
圭亚那:GY
厄瓜多尔:EC
哥伦比亚:CO
智利:CL
巴西:BR
玻利维亚:BO
阿根廷:AR
新西兰:NZ
萨摩亚:WS
瓦努阿图:VU
图瓦卢:TV
汤加:TO
托克劳:TK
帕劳:PW
纽埃:NU
瑙鲁:NR
基里巴斯:KI
关岛:GU
密克罗尼西亚:FM
澳大利亚:AU
美国:US
波多黎各:PR
多米尼加共和国:DO
哥斯达黎加:CR
东萨摩亚:AS
安提瓜和巴布达:AG
巴拿马:PA
尼加拉瓜:NI
墨西哥:MX
牙买加:JM
海地:HT
洪都拉斯:HN
危地马拉:GT
瓜德罗普岛:GP
格陵兰:GL
格林纳达:GD
古巴:CU
加拿大:CA
伯利兹:BZ
巴哈马:BS
百慕大:BM
巴巴多斯:BB
阿鲁巴:AW
安圭拉:AI
梵蒂冈:VA
斯洛伐克:SK
俄罗斯:RU
英国:GB
捷克共和国:CZ
乌克兰:UA
土耳其:TR
斯洛文尼亚:SI
瑞典:SE
塞尔维亚:RS
罗马尼亚:RO
葡萄牙:PT
波兰:PL
挪威:NO
荷兰:NL
马耳他:MT
马其顿:MK
黑山:ME
摩尔多瓦:MD
摩纳哥:MC
拉脱维亚:LV
卢森堡:LU
立陶宛:LT
列支敦士登:LI
哈萨克斯坦:KZ
意大利:IT
冰岛:IS
爱尔兰:IE
匈牙利:HU
克罗地亚:HR
希腊:GR
直布罗陀:GI
根西岛:GG
格鲁吉亚:GE
法国:FR
芬兰:FI
西班牙:ES
爱沙尼亚:EE
丹麦:DK
德国:DE
塞浦路斯:CY
瑞士:CH
白俄罗斯:BY
保加利亚:BG
比利时:BE
阿塞拜疆:AZ
奥地利:AT
亚美尼亚:AM
阿尔巴尼亚:AL
安道尔:AD
东帝汶:TL
叙利亚:SY
沙特阿拉伯:SA
巴勒斯坦:PS
斯里兰卡:LK
斯里兰卡:LK
朝鲜:KP
吉尔吉斯斯坦:KG
中国香港:HK
文莱:BN
孟加拉:BD
阿联酋:AE
也门:YE
越南:VN
乌兹别克斯坦:UZ
中国台湾:TW
土库曼斯坦:TM
塔吉克斯坦:TJ
泰国:TH
新加坡:SG
卡塔尔:QA
巴基斯坦:PK
菲律宾:PH
阿曼:OM
尼泊尔:NP
马来西亚:MY
马尔代夫:MV
中国澳门:MO
蒙古:MN
缅甸:MM
黎巴嫩:LB
科威特:KW
韩国:KR
柬埔寨:KH
日本:JP
约旦:JO
伊朗:IR
伊拉克:IQ
印度:IN
以色列:IL
印度尼西亚:ID
中国:CN
不丹:BT
巴林:BH
阿富汗:AF
利比亚:LY
刚果金:CG
留尼汪岛:RE
斯威士兰:SZ
津巴布韦:ZW
赞比亚:ZM
马约特:YT
乌干达:UG
坦桑尼亚:TZ
突尼斯:TN
多哥:TG
乍得:TD
索马里:SO
塞内加尔:SN
苏丹:SD
塞舌尔:SC
卢旺达:RW
尼日利亚:NG
尼日尔:NE
纳米比亚:NA
莫桑比克:MZ
马拉维:MW
毛里求斯:MU
毛里塔尼亚:MR
马里:ML
马达加斯加:MG
摩洛哥:MA
莱索托:LS
利比里亚:LR
科摩罗:KM
肯尼亚:KE
几内亚:GN
冈比亚:GM
加纳:GH
加蓬:GA
埃塞俄比亚:ET
厄立特里亚:ER
埃及:EG
阿尔及利亚:DZ
吉布提:DJ
喀麦隆:CM
刚果:CG
博茨瓦纳:BW
贝宁:BJ
布隆迪:BI
安哥拉:AO

当MatchKey为ipArea时,取值为:
其他:OTHER
亚洲:AS
欧洲:EU
南极洲:AN
非洲:AF
大洋洲:OC
北美洲:NA
南美洲:SA

当MatchKey为index时
取值为:/;/index.html
CaseSensitive Boolean 是否区分大小写 true:区分 false:不区分
MatchKeyParam String 当MatchKey为param时必填:表示请求参数Key 当MatchKey为cookie时必填:表示请求头Cookie中参数的

Authentication

时间戳防盗链配置

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String 防盗链配置开关
on:开启
off:关闭
开启时必须且只配置一种模式,其余模式需要设置为 null
TypeA AuthenticationTypeA 时间戳防盗链模式 A 配置
注意:此字段可能返回 null,表示取不到有效值。
TypeB AuthenticationTypeB 时间戳防盗链模式 B 配置(模式 B 后台升级中,暂时不支持配置)
注意:此字段可能返回 null,表示取不到有效值。
TypeC AuthenticationTypeC 时间戳防盗链模式 C 配置
注意:此字段可能返回 null,表示取不到有效值。
TypeD AuthenticationTypeD 时间戳防盗链模式 D 配置
注意:此字段可能返回 null,表示取不到有效值。

AuthenticationTypeA

时间戳防盗链模式 A 配置
时间戳防盗链模式 A 的访问 URL 格式为:http://DomainName/Filename?sign=timestamp-rand-uid-md5hash
其中 timestamp 为十进制 UNIX 时间戳;
rand 为随机字符串,0 ~ 100 位大小写字母与数字组成;
uid 为 0;
md5hash:MD5(文件路径-timestamp-rand-uid-自定义密钥)

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
SecretKey String 计算签名的密钥
仅允许大小写字母与数字,长度 6~32 位
注意:此字段可能返回 null,表示取不到有效值。
SignParam String 签名参数名设置
仅允许大小写字母、数字或下划线,长度 1~100 位,不能以数字开头
ExpireTime Integer 签名过期时间设置
单位为秒,最大可设置为 630720000
FileExtensions Array of String 鉴权/不做鉴权的文件扩展名列表设置
如果包含字符 * 则表示所有文件
FilterType String whitelist:白名单,表示对除了 FileExtensions 列表之外的所有类型进行鉴权
blacklist:黑名单,表示仅对 FileExtensions 中的类型进行鉴权
BackupSecretKey String 计算签名的备用密钥
仅允许大小写字母与数字,长度 6~32 位
注意:此字段可能返回 null,表示取不到有效值。

AuthenticationTypeB

时间戳防盗链模式 B 配置(B 模式正在进行平台升级,暂不支持配置)

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
SecretKey String 计算签名的密钥
仅允许大小写字母与数字,长度 6~32 位
注意:此字段可能返回 null,表示取不到有效值。
ExpireTime Integer 签名过期时间设置
单位为秒,最大可设置为 630720000
FileExtensions Array of String 鉴权/不做鉴权的文件扩展名列表设置
如果包含字符 * 则表示所有文件
FilterType String whitelist:白名单,表示对除了 FileExtensions 列表之外的所有类型进行鉴权
blacklist:黑名单,表示仅对 FileExtensions 中的类型进行鉴权
BackupSecretKey String 计算签名的备用密钥
仅允许大小写字母与数字,长度 6~32 位
注意:此字段可能返回 null,表示取不到有效值。

AuthenticationTypeC

时间戳防盗链模式 C 配置
时间戳防盗链模式 C 的访问 URL 格式为:http://DomainName/md5hash/timestamp/FileName
其中 timestamp 为十六进制 UNIX 时间戳;
md5hash:MD5(自定义密钥 + 文件路径 + timestamp)

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
SecretKey String 计算签名的密钥
仅允许大小写字母与数字,长度 6~32 位
注意:此字段可能返回 null,表示取不到有效值。
ExpireTime Integer 签名过期时间设置
单位为秒,最大可设置为 630720000
FileExtensions Array of String 鉴权/不做鉴权的文件扩展名列表设置
如果包含字符 * 则表示所有文件
FilterType String whitelist:白名单,表示对除了 FileExtensions 列表之外的所有类型进行鉴权
blacklist:黑名单,表示仅对 FileExtensions 中的类型进行鉴权
TimeFormat String 时间戳进制设置
dec:十进制
hex:十六进制
注意:此字段可能返回 null,表示取不到有效值。
BackupSecretKey String 计算签名的备用密钥
仅允许大小写字母与数字,长度 6~32 位
注意:此字段可能返回 null,表示取不到有效值。

AuthenticationTypeD

时间戳防盗链模式 D 配置
时间戳防盗链模式 D 的访问 URL 格式为:http://DomainName/FileName?sign=md5hash&t=timestamp
其中 timestamp 为十进制或十六进制 UNIX 时间戳;
md5hash:MD5(自定义密钥 + 文件路径 + timestamp)

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
SecretKey String 计算签名的密钥
仅允许大小写字母与数字,长度 6~32 位
注意:此字段可能返回 null,表示取不到有效值。
ExpireTime Integer 签名过期时间设置
单位为秒,最大可设置为 630720000
FileExtensions Array of String 鉴权/不做鉴权的文件扩展名列表设置
如果包含字符 * 则表示所有文件
FilterType String whitelist:白名单,表示对除了 FileExtensions 列表之外的所有类型进行鉴权
blacklist:黑名单,表示仅对 FileExtensions 中的类型进行鉴权
SignParam String 签名参数名设置
仅允许大小写字母、数字或下划线,长度 1~100 位,不能以数字开头
TimeParam String 时间戳参数名设置
仅允许大小写字母、数字或下划线,长度 1~100 位,不能以数字开头
TimeFormat String 时间戳进制设置
dec:十进制
hex:十六进制
BackupSecretKey String 计算签名的备用密钥
仅允许大小写字母与数字,长度 6~32 位
注意:此字段可能返回 null,表示取不到有效值。

AwsPrivateAccess

s3源站回源鉴权。

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String 开关,on/off。
AccessKey String 访问ID。
注意:此字段可能返回 null,表示取不到有效值。
SecretKey String 密钥。
注意:此字段可能返回 null,表示取不到有效值。
Region String 地域
注意:此字段可能返回 null,表示取不到有效值。
Bucket String Bucketname
注意:此字段可能返回 null,表示取不到有效值。

BandwidthAlert

带宽封顶配置,默认为关闭状态

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String 用量封顶配置开关
on:开启
off:关闭
BpsThreshold Integer 用量封顶阈值,带宽单位为bps,流量单位byte
注意:此字段可能返回 null,表示取不到有效值。
CounterMeasure String 达到阈值后的操作
RESOLVE_DNS_TO_ORIGIN:直接回源,仅自有源站域名支持
RETURN_404:全部请求返回 404
注意:此字段可能返回 null,表示取不到有效值。
LastTriggerTime Timestamp 境内区域上次触发用量封顶阈值的时间
注意:此字段可能返回 null,表示取不到有效值。
AlertSwitch String 用量封顶提醒开关
on:开启
off:关闭
注意:此字段可能返回 null,表示取不到有效值。
AlertPercentage Integer 用量封顶阈值提醒百分比
注意:此字段可能返回 null,表示取不到有效值。
LastTriggerTimeOverseas Timestamp 海外区域上次触发用量封顶阈值的时间
注意:此字段可能返回 null,表示取不到有效值。
Metric String 用量阈值触发的维度
带宽:bandwidth
流量:flux
注意:此字段可能返回 null,表示取不到有效值。
StatisticItems Array of StatisticItem 累计用量配置
注意:此字段可能返回 null,表示取不到有效值。

BotCookie

Bot cookie策略

被如下接口引用:CreateScdnDomain, DescribeScdnConfig, UpdateScdnDomain。

名称 类型 必选 描述
Switch String on|off
RuleType String 规则类型,当前只有all
RuleValue Array of String 规则值,['*']
Action String 执行动作,monitor|intercept|redirect|captcha
RedirectUrl String 重定向时设置的重定向页面
注意:此字段可能返回 null,表示取不到有效值。
UpdateTime Timestamp 更新时间
注意:此字段可能返回 null,表示取不到有效值。

BotJavaScript

Bot js策略

被如下接口引用:CreateScdnDomain, DescribeScdnConfig, UpdateScdnDomain。

名称 类型 必选 描述
Switch String on|off
RuleType String 规则类型,当前只有file
RuleValue Array of String 规则值,['html', 'htm']
Action String 执行动作,monitor|intercept|redirect|captcha
RedirectUrl String 重定向时设置的重定向页面
注意:此字段可能返回 null,表示取不到有效值。
UpdateTime Timestamp 更新时间
注意:此字段可能返回 null,表示取不到有效值。

BotRecord

BOT记录详细内容

被如下接口引用:DescribeScdnBotRecords。

名称 类型 描述
Action String 动作,取值为以为3个类型中的一个:"intercept","permit","monitor",分别表示: 拦截, 放行,监控
Nums Integer 会话总次数
RuleName String BotType=UB时,表示预测标签,取值如下:
"crawler_unregular",
"crawler_regular",
"request_repeat",
"credential_miss_user",
"credential_without_user",
"credential_only_action",
"credential_user_password",
"credential_cracking",
"credential_stuffing",
"brush_sms",
"brush_captcha",
"reg_malicious"
BotType=TCB时,表示Bot分类,取值如下:
"Uncategorised",
"Search engine bot",
"Site monitor",
"Screenshot creator",
"Link checker",
"Web scraper",
"Vulnerability scanner",
"Virus scanner",
"Speed tester",
"Feed Fetcher",
"Tool",
"Marketing"
BotType=UCB时,为二期接口,暂时未定义内容
SessionDuration Float 会话持续时间
SrcIp String 访问源IP
BotFeature Array of String 异常特征
Time Timestamp 最新检测时间
Score Integer BOT得分
AvgSpeed Float 平均速率
TcbDetail String BotType=TCB,表示TCB名称
注意:此字段可能返回 null,表示取不到有效值。
Id String BOT记录唯一ID,用于查询访问详情
Domain String 域名
注意:此字段可能返回 null,表示取不到有效值。

BotSortBy

Bot记录的排序选项

被如下接口引用:DescribeScdnBotRecords。

名称 类型 必选 描述
Key String 排序参数名称, 取值为:timestamp, nums, session_duration,score.total,stat.avg_speed分别表示按照:最新检测时间,会话总次数,会话持续时间,BOT得分,平均速率排序
Sequence String asc/desc

BotStatisticsCount

session/ip维度的bot统计复杂对象

被如下接口引用:ListScdnTopBotData。

名称 类型 描述
Count Integer BOT次数
Value String Top指标值,如果是ip维度就是ip如果是session维度就是域名
Country String ip所在国家
Province String ip所在省份
Isp String ip归属的idc

BotStats

BOT统计结果数据

被如下接口引用:DescribeScdnBotData。

名称 类型 描述
Metric String 指标名称
DetailData Array of BotStatsDetailData 指标详细数据

BotStatsDetailData

BOT统计结果数据详细数据

被如下接口引用:DescribeScdnBotData。

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

BriefDomain

域名基础配置信息,含 CNAME、状态、业务类型、加速区域、创建时间、更新时间、源站配置等。

被如下接口引用:DescribeDomains。

名称 类型 描述
ResourceId String 域名 ID
AppId Integer 腾讯云账号 ID
Domain String 加速域名
Cname String 域名对应的 CNAME 地址
Status String 加速服务状态
rejected:域名审核未通过,域名备案过期/被注销导致
processing:部署中
online:已启动
offline:已关闭
ProjectId Integer 项目 ID,可前往腾讯云项目管理页面查看
ServiceType String 域名业务类型
web:静态加速
download:下载加速
media:流媒体点播加速
CreateTime Timestamp 域名创建时间
UpdateTime Timestamp 域名更新时间
Origin Origin 源站配置详情
Disable String 域名封禁状态
normal:正常状态
overdue:账号欠费导致域名关闭,充值完成后可自行启动加速服务
malicious:域名出现恶意行为,强制关闭加速服务
ddos:域名被大规模 DDoS 攻击,关闭加速服务
idle:域名超过 90 天内无任何操作、数据产生,判定为不活跃域名自动关闭加速服务,可自行启动加速服务
unlicensed:域名未备案/备案注销,自动关闭加速服务,备案完成后可自行启动加速服务
capping:触发配置的带宽阈值上限
readonly:域名存在特殊配置,被锁定
Area String 加速区域
mainland:中国境内加速
overseas:中国境外加速
global:全球加速
Readonly String 域名锁定状态
normal:未锁定
mainland:中国境内锁定
overseas:中国境外锁定
global:全球锁定
Product String 域名所属产品,cdn/ecdn
ParentHost String 主域名

Cache

节点缓存过期时间配置,分为以下两种:

  • 基础版缓存过期规则配置
  • 高级版缓存过期规则配置

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
SimpleCache SimpleCache 基础缓存过期时间配置
注意:此字段可能返回 null,表示取不到有效值。
AdvancedCache AdvancedCache 高级缓存过期时间配置(已弃用)
注意:此字段可能返回 null,表示取不到有效值。
RuleCache Array of RuleCache 高级路径缓存配置
注意:此字段可能返回 null,表示取不到有效值。

CacheConfig

启发式自定义时间缓存配置

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
HeuristicCacheTimeSwitch String on 代表开启自定义启发式缓存时间
off 代表关闭自定义启发式缓存时间
HeuristicCacheTime Integer 单位 秒.

CacheConfigCache

路径缓存缓存配置

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
Switch String 缓存配置开关
on:开启
off:关闭
注意:此字段可能返回 null,表示取不到有效值。
CacheTime Integer 缓存过期时间设置
单位为秒,最大可设置为 365 天
注意:此字段可能返回 null,表示取不到有效值。
CompareMaxAge String 高级缓存过期配置,开启时会对比源站返回的 max-age 值与 CacheRules 中设置的缓存过期时间,取最小值在节点进行缓存
on:开启
off:关闭
默认为关闭状态
注意:此字段可能返回 null,表示取不到有效值。
IgnoreCacheControl String 强制缓存
on:开启
off:关闭
默认为关闭状态,开启后,源站返回的 no-store、no-cache 资源,也将按照 CacheRules 规则进行缓存
注意:此字段可能返回 null,表示取不到有效值。
IgnoreSetCookie String 当源站返回Set-Cookie头部时,节点是否缓存该头部及body
on:开启,不缓存该头部及body
off:关闭,遵循用户自定义的节点缓存规则
默认为关闭状态
注意:此字段可能返回 null,表示取不到有效值。

CacheConfigFollowOrigin

路径缓存遵循源站配置

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
Switch String 遵循源站配置开关
on:开启
off:关闭
HeuristicCache HeuristicCache 启发式缓存配置
注意:此字段可能返回 null,表示取不到有效值。

CacheConfigNoCache

路径缓存不缓存配置

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
Switch String 不缓存配置开关
on:开启
off:关闭
注意:此字段可能返回 null,表示取不到有效值。
Revalidate String 总是回源站校验
on:开启
off:关闭
默认为关闭状态
注意:此字段可能返回 null,表示取不到有效值。

CacheKey

缓存键配置(忽略参数配置)

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
FullUrlCache String 是否开启全路径缓存
on:开启全路径缓存(即关闭参数忽略)
off:关闭全路径缓存(即开启参数忽略)
IgnoreCase String 是否忽略大小写缓存
注意:此字段可能返回 null,表示取不到有效值。
QueryString QueryStringKey CacheKey中包含请求参数
注意:此字段可能返回 null,表示取不到有效值。
Cookie CookieKey CacheKey中包含Cookie
注意:此字段可能返回 null,表示取不到有效值。
Header HeaderKey CacheKey中包含请求头部
注意:此字段可能返回 null,表示取不到有效值。
CacheTag CacheTagKey CacheKey中包含自定义字符串
注意:此字段可能返回 null,表示取不到有效值。
Scheme SchemeKey CacheKey中包含请求协议
注意:此字段可能返回 null,表示取不到有效值。
KeyRules Array of KeyRule 分路径缓存键配置
注意:此字段可能返回 null,表示取不到有效值。

CacheOptResult

违规资源封禁/解封返回类型

被如下接口引用:DisableCaches, EnableCaches。

名称 类型 描述
SuccessUrls Array of String 成功的url列表
注意:此字段可能返回 null,表示取不到有效值。
FailUrls Array of String 失败的url列表
注意:此字段可能返回 null,表示取不到有效值。

CacheTagKey

组成CacheKey的一部分

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
Switch String 是否使用CacheTag作为CacheKey的一部分
注意:此字段可能返回 null,表示取不到有效值。
Value String 自定义CacheTag的值
注意:此字段可能返回 null,表示取不到有效值。

CappingRule

下行限速配置规则,最多可配置 100 条

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
RuleType String 规则类型:
all:所有文件生效
file:指定文件后缀生效
directory:指定路径生效
path:指定绝对路径生效
RulePaths Array of String RuleType 对应类型下的匹配内容:
all 时填充 *
file 时填充后缀名,如 jpg、txt
directory 时填充路径,如 /xxx/test/
path 时填充绝对路径,如 /xxx/test.html
KBpsThreshold Integer 下行速度值设置,单位为 KB/s

CcTopData

CC攻击Top数据

被如下接口引用:ListTopCcData。

名称 类型 描述
Ip String 客户端Ip
注意:此字段可能返回 null,表示取不到有效值。
Url String 访问URL
注意:此字段可能返回 null,表示取不到有效值。
UserAgent String 客户端UserAgent
注意:此字段可能返回 null,表示取不到有效值。
Value Integer 请求数
注意:此字段可能返回 null,表示取不到有效值。
Domain String 域名
注意:此字段可能返回 null,表示取不到有效值。

CdnData

访问明细数据类型

被如下接口引用:DescribeBillingData, DescribeCdnData, DescribeIpVisit, DescribeOriginData。

名称 类型 描述
Metric String 查询指定的指标名称:
flux:流量,单位为 byte
bandwidth:带宽,单位为 bps
request:请求数,单位为 次
fluxHitRate:流量命中率,单位为 %
statusCode:状态码,返回 2XX、3XX、4XX、5XX 汇总数据,单位为 个
2XX:返回 2XX 状态码汇总及各 2 开头状态码数据,单位为 个
3XX:返回 3XX 状态码汇总及各 3 开头状态码数据,单位为 个
4XX:返回 4XX 状态码汇总及各 4 开头状态码数据,单位为 个
5XX:返回 5XX 状态码汇总及各 5 开头状态码数据,单位为 个
或指定查询的某一具体状态码
DetailData Array of TimestampData 明细数据组合
SummarizedData SummarizedData 汇总数据组合

CdnIp

IP 属性信息

被如下接口引用:DescribeCdnIp。

名称 类型 描述
Ip String 指定查询的 IP
Platform String IP 归属:
yes:节点归属于腾讯云 CDN
no:节点不属于腾讯云 CDN
Location String 节点所处的省份/国家
unknown 表示节点位置未知
History Array of CdnIpHistory 节点上下线历史记录
Area String 节点的所在区域
mainland:中国境内加速节点
overseas:中国境外加速节点
unknown:服务地域无法获取
City String 节点的所在城市
注意:此字段可能返回 null,表示取不到有效值。

CdnIpHistory

CDN 节点上下线历史记录

被如下接口引用:DescribeCdnIp。

名称 类型 描述
Status String 操作类型
online:节点上线
offline:节点下线
Datetime Timestamp 操作类型对应的操作时间
当该值为 null 时表示无历史状态变更记录
注意:此字段可能返回 null,表示取不到有效值。

ClientCert

https 客户端证书配置

被如下接口引用:AddCdnDomain, DescribeDomains, UpdateDomainConfig。

名称 类型 必选 描述
Certificate String 客户端证书
PEM 格式,需要进行 Base 64 编码
注意:此字段可能返回 null,表示取不到有效值。
CertName String 客户端证书名称
注意:此字段可能返回 null,表示取不到有效值。
ExpireTime Timestamp 证书过期时间
作为入参时无需填充
注意:此字段可能返回 null,表示取不到有效值。
DeployTime Timestamp 证书颁发时间
作为入参时无需填充
注意:此字段可能返回 null,表示取不到有效值。

ClientInfo

客户端信息

被如下接口引用:ListDiagnoseReport。

名称 类型 描述
ProvName String 省份。
注意:此字段可能返回 null,表示取不到有效值。
Country String 国家。
注意:此字段可能返回 null,表示取不到有效值。
IspName String 运营商。
注意:此字段可能返回 null,表示取不到有效值。
Ip String 客户端IP
注意:此字段可能返回 null,表示取不到有效值。

ClsLogIpData

通过Cls日志,计算出来的IP每秒访问数量

被如下接口引用:ListTopClsLogData。

名称 类型 描述
ClientIp String IP
Request Integer 在给定的时间段中,1秒内的最大请求量
Count Integer 在获取的Top信息中,IP出现的次数
Time String 在给定的时间段中,1秒内的最大请求量对应的时间

ClsLogObject

CLS日志搜索对象

被如下接口引用:SearchClsLog。

名称 类型 描述
TopicId String 主题ID
TopicName String 主题名字
Timestamp String 日志时间
Content String 日志内容
Filename String 采集路径
Source String 日志来源设备

ClsSearchLogs

Cls日志搜索结果

被如下接口引用:SearchClsLog。

名称 类型 描述
Context String 获取更多检索结果的游标
Listover Boolean 搜索结果是否已经全部返回
Results Array of ClsLogObject 日志内容信息

Compatibility

是否兼容旧版配置

被如下接口引用:DescribeDomainsConfig。

名称 类型 描述
Code Integer 兼容标志状态码。
注意:此字段可能返回 null,表示取不到有效值。

Compression

智能压缩配置,默认对 js、html、css、xml、json、shtml、htm 后缀且大小为 256 ~ 2097152 字节的文件进行 GZIP 压缩

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String 智能压缩配置开关
on:开启
off:关闭
CompressionRules Array of CompressionRule 压缩规则数组
注意:此字段可能返回 null,表示取不到有效值。

CompressionRule

智能压缩规则配置

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
Compress Boolean true:需要设置为 ture,启用压缩
注意:此字段可能返回 null,表示取不到有效值。
MinLength Integer 触发压缩的文件长度最小值,单位为字节数
注意:此字段可能返回 null,表示取不到有效值。
MaxLength Integer 触发压缩的文件长度最大值,单位为字节数
最大可设置为 30MB
注意:此字段可能返回 null,表示取不到有效值。
Algorithms Array of String 文件压缩算法
gzip:指定 GZIP 压缩
brotli:指定Brotli压缩
注意:此字段可能返回 null,表示取不到有效值。
FileExtensions Array of String 根据文件后缀类型压缩
例如 jpg、txt
注意:此字段可能返回 null,表示取不到有效值。
RuleType String 规则类型:
all:所有文件生效
file:指定文件后缀生效
directory:指定路径生效
path:指定绝对路径生效
contentType:指定Content-Type头为特定值时生效
当指定了此字段时,FileExtensions字段不生效
注意:此字段可能返回 null,表示取不到有效值。
RulePaths Array of String CacheType 对应类型下的匹配内容:
all 时填充 *
file 时填充后缀名,如 jpg、txt
directory 时填充路径,如 /xxx/test
path 时填充绝对路径,如 /xxx/test.html
contentType 时填充 text/html
注意:此字段可能返回 null,表示取不到有效值。

CookieKey

组成CacheKey的一部分

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
Switch String on | off 是否使用Cookie作为Cache的一部分
注意:此字段可能返回 null,表示取不到有效值。
Value String 使用的cookie,';' 分割
注意:此字段可能返回 null,表示取不到有效值。

DDoSAttackBandwidthData

ddos攻击带宽峰值数据

被如下接口引用:DescribeDDoSData。

名称 类型 描述
AttackType String ddos攻击类型,当值为all的时候表示所有的攻击类型的总带宽峰值
Value Float ddos攻击带宽大小
Time String 攻击时间点

DDoSAttackIPTopData

攻击ip数据详细数据

被如下接口引用:ListTopDDoSData。

名称 类型 描述
AttackIP String 攻击ip
Province String 攻击ip所在省份
Country String 攻击ip所在国家
Isp String 红果电信
AttackCount Float 攻击次数

DDoSStatsData

DDoS统计数据

被如下接口引用:DescribeDDoSData。

名称 类型 描述
Time Timestamp 时间
Value Float 带宽数值,单位bps

DDoSTopData

DDoS攻击Top数据

被如下接口引用:ListTopDDoSData。

名称 类型 描述
AttackType String 攻击类型
Value Integer 攻击带宽,单位:bps

DetailDomain

加速域名全量配置信息

被如下接口引用:DescribeDomainsConfig。

名称 类型 描述
ResourceId String 域名 ID
AppId Integer 腾讯云账号ID
Domain String 加速域名
Cname String 域名对应的 CNAME 地址
注意:此字段可能返回 null,表示取不到有效值。
Status String 加速服务状态
rejected:域名审核未通过,域名备案过期/被注销导致
processing:部署中
online:已启动
offline:已关闭
ProjectId Integer 项目 ID,可前往腾讯云项目管理页面查看
ServiceType String 加速域名业务类型
web:网页小文件
download:下载大文件
media:音视频点播
hybrid: 动静加速
dynamic: 动态加速
CreateTime Timestamp 域名创建时间
UpdateTime Timestamp 域名更新时间
Origin Origin 源站配置
IpFilter IpFilter IP 黑白名单配置
注意:此字段可能返回 null,表示取不到有效值。
IpFreqLimit IpFreqLimit IP 访问限频配置
注意:此字段可能返回 null,表示取不到有效值。
StatusCodeCache StatusCodeCache 状态码缓存配置
注意:此字段可能返回 null,表示取不到有效值。
Compression Compression 智能压缩配置
注意:此字段可能返回 null,表示取不到有效值。
BandwidthAlert BandwidthAlert 带宽封顶配置
注意:此字段可能返回 null,表示取不到有效值。
RangeOriginPull RangeOriginPull Range 回源配置
注意:此字段可能返回 null,表示取不到有效值。
FollowRedirect FollowRedirect 301/302 回源自动跟随配置
注意:此字段可能返回 null,表示取不到有效值。
ErrorPage ErrorPage 自定义错误页面配置
注意:此字段可能返回 null,表示取不到有效值。
RequestHeader RequestHeader 自定义请求头部配置
注意:此字段可能返回 null,表示取不到有效值。
ResponseHeader ResponseHeader 自定义响应头部配置
注意:此字段可能返回 null,表示取不到有效值。
DownstreamCapping DownstreamCapping 单链接下行限速配置
注意:此字段可能返回 null,表示取不到有效值。
CacheKey CacheKey 带参/不带参缓存配置
注意:此字段可能返回 null,表示取不到有效值。
ResponseHeaderCache ResponseHeaderCache 源站头部缓存配置
注意:此字段可能返回 null,表示取不到有效值。
VideoSeek VideoSeek 视频拖拽配置
注意:此字段可能返回 null,表示取不到有效值。
Cache Cache 节点缓存过期规则配置
注意:此字段可能返回 null,表示取不到有效值。
OriginPullOptimization OriginPullOptimization 跨国链路优化配置(功能灰度中,敬请期待)
注意:此字段可能返回 null,表示取不到有效值。
Https Https Https 加速相关配置
注意:此字段可能返回 null,表示取不到有效值。
Authentication Authentication 时间戳防盗链配置
注意:此字段可能返回 null,表示取不到有效值。
Seo Seo SEO 优化配置
注意:此字段可能返回 null,表示取不到有效值。
Disable String 域名封禁状态
normal:正常状态
overdue:账号欠费导致域名关闭,充值完成后可自行启动加速服务
malicious:域名出现恶意行为,强制关闭加速服务
ddos:域名被大规模 DDoS 攻击,关闭加速服务
idle:域名超过 90 天内无任何操作、数据产生,判定为不活跃域名自动关闭加速服务,可自行启动加速服务
unlicensed:域名未备案/备案注销,自动关闭加速服务,备案完成后可自行启动加速服务
capping:触发配置的带宽阈值上限
readonly:域名存在特殊配置,被锁定
注意:此字段可能返回 null,表示取不到有效值。
ForceRedirect ForceRedirect 访问协议强制跳转配置
注意:此字段可能返回 null,表示取不到有效值。
Referer Referer Referer 防盗链配置
注意:此字段可能返回 null,表示取不到有效值。
MaxAge MaxAge 浏览器缓存过期规则配置(功能灰度中,敬请期待)
注意:此字段可能返回 null,表示取不到有效值。
Ipv6 Ipv6 Ipv6 回源配置(功能灰度中,敬请期待)
注意:此字段可能返回 null,表示取不到有效值。
Compatibility Compatibility 是否兼容旧版本配置(内部兼容性字段)
注意:此字段可能返回 null,表示取不到有效值。
SpecificConfig SpecificConfig 区域特殊配置
注意:此字段可能返回 null,表示取不到有效值。
Area String 加速区域
mainland:中国境内加速
overseas:中国境外加速
global:全球加速
注意:此字段可能返回 null,表示取不到有效值。
Readonly String 域名锁定状态
normal:未锁定
mainland:中国境内锁定
overseas:中国境外锁定
global:全球锁定
注意:此字段可能返回 null,表示取不到有效值。
OriginPullTimeout OriginPullTimeout 回源超时配置
注意:此字段可能返回 null,表示取不到有效值。
AwsPrivateAccess AwsPrivateAccess 回源S3鉴权配置
注意:此字段可能返回 null,表示取不到有效值。
SecurityConfig SecurityConfig Scdn配置
注意:此字段可能返回 null,表示取不到有效值。
ImageOptimization ImageOptimization ImageOptimization配置
注意:此字段可能返回 null,表示取不到有效值。
UserAgentFilter UserAgentFilter UA黑白名单配置
注意:此字段可能返回 null,表示取不到有效值。
AccessControl AccessControl 访问控制
注意:此字段可能返回 null,表示取不到有效值。
Advance String 是否支持高级配置项
on:支持
off:不支持
注意:此字段可能返回 null,表示取不到有效值。
UrlRedirect UrlRedirect URL重定向配置
注意:此字段可能返回 null,表示取不到有效值。
AccessPort Array of Integer 访问端口配置
注意:此字段可能返回 null,表示取不到有效值。
Tag Array of Tag 标签配置
注意:此字段可能返回 null,表示取不到有效值。
AdvancedAuthentication AdvancedAuthentication 时间戳防盗链高级配置,白名单功能
注意:此字段可能返回 null,表示取不到有效值。
OriginAuthentication OriginAuthentication 回源鉴权高级配置,白名单功能
注意:此字段可能返回 null,表示取不到有效值。
Ipv6Access Ipv6Access Ipv6访问配置
注意:此字段可能返回 null,表示取不到有效值。
AdvanceSet Array of AdvanceConfig 高级配置集合
注意:此字段可能返回 null,表示取不到有效值。
OfflineCache OfflineCache 离线缓存(功能灰度中,尚未全量,请等待后续全量发布)
注意:此字段可能返回 null,表示取不到有效值。
OriginCombine OriginCombine 合并回源(白名单功能)
注意:此字段可能返回 null,表示取不到有效值。
PostMaxSize PostSize POST上传配置项
注意:此字段可能返回 null,表示取不到有效值。
Quic Quic Quic配置
注意:此字段可能返回 null,表示取不到有效值。
OssPrivateAccess OssPrivateAccess 回源OSS私有鉴权
注意:此字段可能返回 null,表示取不到有效值。
WebSocket WebSocket WebSocket配置
注意:此字段可能返回 null,表示取不到有效值。
RemoteAuthentication RemoteAuthentication 远程鉴权配置
注意:此字段可能返回 null,表示取不到有效值。
ShareCname ShareCname 共享CNAME配置(白名单功能)
注意:此字段可能返回 null,表示取不到有效值。
RuleEngine RuleEngine 规则引擎
注意:此字段可能返回 null,表示取不到有效值。
ParentHost String 主域名
注意:此字段可能返回 null,表示取不到有效值。
HwPrivateAccess HwPrivateAccess 华为云对象存储回源鉴权
注意:此字段可能返回 null,表示取不到有效值。
QnPrivateAccess QnPrivateAccess 七牛云对象存储回源鉴权
注意:此字段可能返回 null,表示取不到有效值。

DiagnoseData

诊断报告内容数据

被如下接口引用:DescribeDiagnoseReport。

名称 类型 描述
Data Array of DiagnoseUnit 诊断报告内容
注意:此字段可能返回 null,表示取不到有效值。
Status String 当前诊断项是否正常。
"ok":正常
"error":异常
"warning":"警告"
注意:此字段可能返回 null,表示取不到有效值。

DiagnoseInfo

诊断信息

被如下接口引用:ListDiagnoseReport。

名称 类型 描述
DiagnoseUrl String 待诊断的URL。
注意:此字段可能返回 null,表示取不到有效值。
DiagnoseLink String 由系统生成的诊断链接。
注意:此字段可能返回 null,表示取不到有效值。
CreateTime Timestamp 诊断创建时间。
注意:此字段可能返回 null,表示取不到有效值。
ExpireDate Timestamp 诊断链接过期时间。
注意:此字段可能返回 null,表示取不到有效值。
VisitCount Integer 诊断链接当前访问次数,一个诊断链接最多可访问10次。
注意:此字段可能返回 null,表示取不到有效值。
ClientList Array of DiagnoseList 访问诊断链接的客户端简易信息
注意:此字段可能返回 null,表示取不到有效值。
Area String 域名加速区域
注意:此字段可能返回 null,表示取不到有效值。

DiagnoseList

客户端访问诊断URL信息列表

被如下接口引用:ListDiagnoseReport。

名称 类型 描述
DiagnoseTag String 诊断任务标签。
注意:此字段可能返回 null,表示取不到有效值。
ReportId String 报告ID,用于获取详细诊断报告。
注意:此字段可能返回 null,表示取不到有效值。
ClientInfo Array of ClientInfo 客户端信息。
注意:此字段可能返回 null,表示取不到有效值。
FinalDiagnose Integer 最终诊断结果。
-1:已提交
0 :检测中
1 :检测正常
2 : 检测异常
3 : 诊断页面异常关闭
注意:此字段可能返回 null,表示取不到有效值。
CreateTime Timestamp 诊断任务创建时间。
注意:此字段可能返回 null,表示取不到有效值。

DiagnoseUnit

诊断报告单元信息

被如下接口引用:DescribeDiagnoseReport。

名称 类型 描述
Key String 内容单元英文名称。
注意:此字段可能返回 null,表示取不到有效值。
KeyText String 内容单元中文名称。
注意:此字段可能返回 null,表示取不到有效值。
Value String 报告内容。
注意:此字段可能返回 null,表示取不到有效值。
ValueText String 报告内容。
注意:此字段可能返回 null,表示取不到有效值。

DistrictIspInfo

地区运营商明细数据

被如下接口引用:DescribeDistrictIspData。

名称 类型 描述
Domain String 域名
Protocol String 协议类型
IpProtocol String IP协议类型
StartTime Timestamp 起始时间
EndTime Timestamp 结束时间
Interval Integer 时间间隔,单位为分钟
Metric String 指标名称
District Integer 地区ID
Isp Integer 运营商ID
DataPoints Array of Integer 指标数据点
DistrictName String 地区名称
IspName String 运营商名称

DomainAreaConfig

域名地区配置

被如下接口引用:AddCLSTopicDomains, CreateClsLogTopic, ListClsTopicDomains, ManageClsTopicDomains。

名称 类型 必选 描述
Domain String 域名
Area Array of String 地区列表,其中元素可为mainland/overseas

DomainBotCount

域名及其他指标Bot次数

被如下接口引用:ListTopBotData。

名称 类型 描述
Domain String 域名
Count Integer BOT次数
Value String Top指标值
注意:此字段可能返回 null,表示取不到有效值。
Country String 国家/地区
注意:此字段可能返回 null,表示取不到有效值。
Province String 省份
注意:此字段可能返回 null,表示取不到有效值。
Isp String 运营商
注意:此字段可能返回 null,表示取不到有效值。

DomainFilter

域名查询时过滤条件。

被如下接口引用:DescribeDomains, DescribeDomainsConfig。

名称 类型 必选 描述
Name String 过滤字段名,支持的列表如下:
- origin:主源站。
- domain:域名。
- resourceId:域名id。
- status:域名状态,online,offline或processing。
- serviceType:业务类型,web,download,media,hybrid或dynamic。
- projectId:项目ID。
- domainType:主源站类型,cname表示自有源,cos表示cos接入,third_party表示第三方对象存储。
- fullUrlCache:全路径缓存,on或off。
- https:是否配置https,on,off或processing。
- originPullProtocol:回源协议类型,支持http,follow或https。
- tagKey:标签键。
Value Array of String 过滤字段值。
Fuzzy Boolean 是否启用模糊查询,仅支持过滤字段名为origin,domain。
模糊查询时,Value长度最大为1,否则Value长度最大为5。

DomainLog

日志包下载链接详情

被如下接口引用:DescribeCdnDomainLogs。

名称 类型 描述
StartTime Timestamp 日志包起始时间
EndTime Timestamp 日志包结束时间
LogPath String 日志包下载链接
Area String 日志包对应加速区域
mainland:境内
overseas:境外
LogName String 日志包文件名

DownstreamCapping

单链接下行限速配置,默认为关闭状态

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String 下行速度配置开关
on:开启
off:关闭
CappingRules Array of CappingRule 下行限速规则
注意:此字段可能返回 null,表示取不到有效值。

ErrorPage

状态码重定向配置,默认为关闭状态

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String 状态码重定向配置开关
on:开启
off:关闭
注意:此字段可能返回 null,表示取不到有效值。
PageRules Array of ErrorPageRule 状态码重定向规则配置
注意:此字段可能返回 null,表示取不到有效值。

ErrorPageRule

状态码重定向规则配置

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
StatusCode Integer 状态码
支持 400、403、404、500
RedirectCode Integer 重定向状态码设置
支持 301 或 302
RedirectUrl String 重定向 URL
需要为完整跳转路径,如 https://www.test.com/error.html

EventLogStatsData

事件日志统计数据结果

被如下接口引用:DescribeEventLogData。

名称 类型 描述
Datetime String 时间
Request Integer 请求数

ExtraLogset

除上海外其他区域日志集和日志主题信息

被如下接口引用:ListClsLogTopics。

名称 类型 描述
Logset LogSetInfo 日志集信息
注意:此字段可能返回 null,表示取不到有效值。
Topics Array of TopicInfo 日志主题信息列表
注意:此字段可能返回 null,表示取不到有效值。

FollowRedirect

回源 301/302 状态码自动跟随配置,默认为关闭状态

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String 回源跟随开关
on:开启
off:关闭
RedirectConfig RedirectConfig 自定义回源302 follow请求host配置,该功能为白名单功能,需要开启请联系腾讯云工程师。
注意:此字段可能返回 null,表示取不到有效值。

ForceRedirect

访问协议强制跳转配置,默认为关闭状态

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String 访问强制跳转配置开关
on:开启
off:关闭
注意:此字段可能返回 null,表示取不到有效值。
RedirectType String 访问强制跳转类型
http:强制 http 跳转
https:强制 https 跳转
注意:此字段可能返回 null,表示取不到有效值。
RedirectStatusCode Integer 强制跳转时返回状态码
支持 301、302
注意:此字段可能返回 null,表示取不到有效值。
CarryHeaders String 强制跳转时是否返回增加的头部。
注意:此字段可能返回 null,表示取不到有效值。

GuetzliAdapter

图片优化-GuetzliAdapter配置

被如下接口引用:DescribeDomainsConfig, DescribeImageConfig, UpdateImageConfig。

名称 类型 必选 描述
Switch String 开关,"on/off"
注意:此字段可能返回 null,表示取不到有效值。

HeaderKey

组成CacheKey

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
Switch String 是否组成Cachekey
注意:此字段可能返回 null,表示取不到有效值。
Value String 组成CacheKey的header数组,';' 分割
注意:此字段可能返回 null,表示取不到有效值。

HeuristicCache

启发式缓存配置

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
Switch String on 代表开启启发式缓存
off 代表关闭启发式缓存
CacheConfig CacheConfig 自定义启发式缓存时间配置

Hsts

HSTS 配置。

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
Switch String 是否开启,on或off。
MaxAge Integer MaxAge数值。
注意:此字段可能返回 null,表示取不到有效值。
IncludeSubDomains String 是否包含子域名,on或off。
注意:此字段可能返回 null,表示取不到有效值。

HttpHeaderPathRule

Http 头部设置规则,最多可设置 100 条

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
HeaderMode String http 头部设置方式
set:设置。变更指定头部参数的取值为设置后的值;若设置的头部不存在,则会增加该头部;若存在多个重复的头部参数,则会全部变更,同时合并为一个头部。
del:删除。删除指定的头部参数
add:增加。增加指定的头部参数,默认允许重复添加,即重复添加相同的头部(注:重复添加可能会影响浏览器响应,请优先使用set操作)
注意:此字段可能返回 null,表示取不到有效值。
HeaderName String http 头部名称,最多可设置 100 个字符
注意:此字段可能返回 null,表示取不到有效值。
HeaderValue String http 头部值,最多可设置 1000 个字符
Mode 为 del 时非必填
Mode 为 add/set 时必填
注意:此字段可能返回 null,表示取不到有效值。
RuleType String 规则类型:
all:所有文件生效
file:指定文件后缀生效
directory:指定路径生效
path:指定绝对路径生效
注意:此字段可能返回 null,表示取不到有效值。
RulePaths Array of String RuleType 对应类型下的匹配内容:
all 时填充 *
file 时填充后缀名,如 jpg、txt
directory 时填充路径,如 /xxx/test/
path 时填充绝对路径,如 /xxx/test.html
注意:此字段可能返回 null,表示取不到有效值。

HttpHeaderRule

http头部设置规则。

被如下接口引用:AddCdnDomain, DescribeDomains, UpdateDomainConfig。

名称 类型 必选 描述
HeaderMode String http头部设置方式,支持add,set或del,分别表示新增,设置或删除头部。
HeaderName String http头部名称。
HeaderValue String http头部值。

Https

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

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String https 配置开关
on:开启
off:关闭
注意:此字段可能返回 null,表示取不到有效值。
Http2 String http2 配置开关
on:开启
off:关闭
初次启用 https 加速会默认开启 http2 配置
注意:此字段可能返回 null,表示取不到有效值。
OcspStapling String OCSP 配置开关
on:开启
off:关闭
默认为关闭状态
注意:此字段可能返回 null,表示取不到有效值。
VerifyClient String 客户端证书校验功能
on:开启
off:关闭
默认为关闭状态,开启时需要上传客户端证书信息,该配置项目前在灰度中,尚未全量
注意:此字段可能返回 null,表示取不到有效值。
CertInfo ServerCert 服务端证书配置信息
注意:此字段可能返回 null,表示取不到有效值。
ClientCertInfo ClientCert 客户端证书配置信息
注意:此字段可能返回 null,表示取不到有效值。
Spdy String Spdy 配置开关
on:开启
off:关闭
默认为关闭状态
注意:此字段可能返回 null,表示取不到有效值。
SslStatus String https 证书部署状态
closed:已关闭
deploying:部署中
deployed:部署成功
failed:部署失败
注意:此字段可能返回 null,表示取不到有效值。
Hsts Hsts Hsts配置
注意:此字段可能返回 null,表示取不到有效值。
TlsVersion Array of String Tls版本设置,仅支持部分Advance域名,支持设置 TLSv1, TLSV1.1, TLSV1.2, TLSv1.3,修改时必须开启连续的版本
注意:此字段可能返回 null,表示取不到有效值。

HwPrivateAccess

华为云对象存储回源鉴权

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String 开关 on/off
AccessKey String 访问 ID
注意:此字段可能返回 null,表示取不到有效值。
SecretKey String 密钥
注意:此字段可能返回 null,表示取不到有效值。
Bucket String bucketname
注意:此字段可能返回 null,表示取不到有效值。

ImageOptimization

ImageOptimization配置

被如下接口引用:DescribeDomainsConfig。

名称 类型 描述
WebpAdapter WebpAdapter WebpAdapter配置
注意:此字段可能返回 null,表示取不到有效值。
TpgAdapter TpgAdapter TpgAdapter配置
注意:此字段可能返回 null,表示取不到有效值。
GuetzliAdapter GuetzliAdapter GuetzliAdapter配置
注意:此字段可能返回 null,表示取不到有效值。

IpFilter

IP 黑白名单配置,默认为关闭状态

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String IP 黑白名单配置开关
on:开启
off:关闭
FilterType String IP 黑白名单类型
whitelist:白名单
blacklist:黑名单
注意:此字段可能返回 null,表示取不到有效值。
Filters Array of String IP 黑白名单列表
支持 X.X.X.X 形式 IP,或 /8、 /16、/24 形式网段
最多可填充 50 个白名单或 50 个黑名单
注意:此字段可能返回 null,表示取不到有效值。
FilterRules Array of IpFilterPathRule IP 黑白名单分路径配置,白名单功能
注意:此字段可能返回 null,表示取不到有效值。
ReturnCode Integer IP 黑白名单验证失败时返回的 HTTP Code
合法值: 400~499
注意:此字段可能返回 null,表示取不到有效值。

IpFilterPathRule

IP黑白名单分路径配置

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
FilterType String IP 黑白名单类型
whitelist:白名单
blacklist:黑名单
注意:此字段可能返回 null,表示取不到有效值。
Filters Array of String IP 黑白名单列表
支持 X.X.X.X 形式 IP,或 /8、 /16、/24 形式网段
最多可填充 50 个白名单或 50 个黑名单
注意:此字段可能返回 null,表示取不到有效值。
RuleType String 规则类型:
all:所有文件生效
file:指定文件后缀生效
directory:指定路径生效
path:指定绝对路径生效
注意:此字段可能返回 null,表示取不到有效值。
RulePaths Array of String RuleType 对应类型下的匹配内容:
all 时填充 *
file 时填充后缀名,如 jpg、txt
directory 时填充路径,如 /xxx/test/
path 时填充绝对路径,如 /xxx/test.html
注意:此字段可能返回 null,表示取不到有效值。

IpFreqLimit

单节点单 IP 访问限频配置,默认为关闭状态

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String IP 限频配置开关
on:开启
off:关闭
Qps Integer 设置每秒请求数限制
超出限制的请求会直接返回 514
注意:此字段可能返回 null,表示取不到有效值。

IpStatus

节点 IP 信息

被如下接口引用:DescribeIpStatus。

名称 类型 描述
Ip String 节点 IP
District String 节点所属区域
Isp String 节点所属运营商
City String 节点所在城市
Status String 节点状态
online:上线状态,正常调度服务中
offline:下线状态
Ipv6 String 节点 IPV6
注意:此字段可能返回 null,表示取不到有效值。

Ipv6

Ipv6启用配置,不可更改

被如下接口引用:AddCdnDomain, DescribeDomainsConfig。

名称 类型 描述
Switch String 域名是否开启ipv6功能,on或off。
注意:此字段可能返回 null,表示取不到有效值。

Ipv6Access

Ipv6访问配置

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String 域名是否开启ipv6访问功能,on或off。
注意:此字段可能返回 null,表示取不到有效值。

KeyRule

缓存键分路径配置

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
RulePaths Array of String CacheType 对应类型下的匹配内容:
file 时填充后缀名,如 jpg、txt
directory 时填充路径,如 /xxx/test
path 时填充绝对路径,如 /xxx/test.html
index 时填充 /
注意:此字段可能返回 null,表示取不到有效值。
RuleType String 规则类型:
file:指定文件后缀生效
directory:指定路径生效
path:指定绝对路径生效
index:首页
注意:此字段可能返回 null,表示取不到有效值。
FullUrlCache String 是否开启全路径缓存
on:开启全路径缓存(即关闭参数忽略)
off:关闭全路径缓存(即开启参数忽略)
注意:此字段可能返回 null,表示取不到有效值。
IgnoreCase String 是否忽略大小写缓存
注意:此字段可能返回 null,表示取不到有效值。
QueryString RuleQueryString CacheKey中包含请求参数
注意:此字段可能返回 null,表示取不到有效值。
RuleTag String 路径缓存键标签,传 user
注意:此字段可能返回 null,表示取不到有效值。

LogSetInfo

日志集信息

被如下接口引用:ListClsLogTopics。

名称 类型 描述
AppId Integer 开发者ID
Channel String 渠道
注意:此字段可能返回 null,表示取不到有效值。
LogsetId String 日志集ID
LogsetName String 日志集名字
IsDefault Integer 是否默认日志集
LogsetSavePeriod Integer 日志保存时间,单位为天
CreateTime Timestamp 创建日期
Region String 区域
Deleted String cls侧是否已经被删除
注意:此字段可能返回 null,表示取不到有效值。
RegionEn String 英文区域
注意:此字段可能返回 null,表示取不到有效值。

MainlandConfig

域名国内地区特殊配置。分地区特殊配置。UpdateDomainConfig接口只支持修改部分分地区配置,为了兼容旧版本配置,本类型会列出旧版本所有可能存在差异的配置列表,支持修改的配置列表如下:

  • Authentication
  • BandwidthAlert
  • ErrorPage
  • IpFilter
  • Origin
  • Referer

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
Authentication Authentication 时间戳防盗链配置。
注意:此字段可能返回 null,表示取不到有效值。
BandwidthAlert BandwidthAlert 带宽封顶配置。
注意:此字段可能返回 null,表示取不到有效值。
Cache Cache 缓存规则配置。
注意:此字段可能返回 null,表示取不到有效值。
CacheKey CacheKey 缓存相关配置。
注意:此字段可能返回 null,表示取不到有效值。
Compression Compression 智能压缩配置。
注意:此字段可能返回 null,表示取不到有效值。
DownstreamCapping DownstreamCapping 下载限速配置。
注意:此字段可能返回 null,表示取不到有效值。
ErrorPage ErrorPage 错误码重定向配置。
注意:此字段可能返回 null,表示取不到有效值。
FollowRedirect FollowRedirect 301和302自动回源跟随配置。
注意:此字段可能返回 null,表示取不到有效值。
ForceRedirect ForceRedirect 访问协议强制跳转配置。
注意:此字段可能返回 null,表示取不到有效值。
Https Https Https配置。
注意:此字段可能返回 null,表示取不到有效值。
IpFilter IpFilter IP黑白名单配置。
注意:此字段可能返回 null,表示取不到有效值。
IpFreqLimit IpFreqLimit IP限频配置。
注意:此字段可能返回 null,表示取不到有效值。
MaxAge MaxAge 浏览器缓存规则配置。
注意:此字段可能返回 null,表示取不到有效值。
Origin Origin 源站配置。
注意:此字段可能返回 null,表示取不到有效值。
OriginPullOptimization OriginPullOptimization 跨国优化配置。
注意:此字段可能返回 null,表示取不到有效值。
RangeOriginPull RangeOriginPull Range回源配置。
注意:此字段可能返回 null,表示取不到有效值。
Referer Referer 防盗链配置。
注意:此字段可能返回 null,表示取不到有效值。
RequestHeader RequestHeader 回源请求头部配置。
注意:此字段可能返回 null,表示取不到有效值。
ResponseHeader ResponseHeader 源站响应头部配置。
注意:此字段可能返回 null,表示取不到有效值。
ResponseHeaderCache ResponseHeaderCache 遵循源站缓存头部配置。
注意:此字段可能返回 null,表示取不到有效值。
Seo Seo seo优化配置。
注意:此字段可能返回 null,表示取不到有效值。
ServiceType String 域名业务类型,web,download,media分别表示静态加速,下载加速和流媒体加速。
注意:此字段可能返回 null,表示取不到有效值。
StatusCodeCache StatusCodeCache 状态码缓存配置。
注意:此字段可能返回 null,表示取不到有效值。
VideoSeek VideoSeek 视频拖拽配置。
注意:此字段可能返回 null,表示取不到有效值。
AwsPrivateAccess AwsPrivateAccess 回源S3私有鉴权。
注意:此字段可能返回 null,表示取不到有效值。
OssPrivateAccess OssPrivateAccess 回源OSS私有鉴权。
注意:此字段可能返回 null,表示取不到有效值。
HwPrivateAccess HwPrivateAccess 华为云对象存储回源鉴权
注意:此字段可能返回 null,表示取不到有效值。
QnPrivateAccess QnPrivateAccess 七牛云对象存储回源鉴权
注意:此字段可能返回 null,表示取不到有效值。

MapInfo

名称与ID映射关系

被如下接口引用:DescribeMapInfo。

名称 类型 描述
Id Integer 对象 Id
Name String 对象名称

MaxAge

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

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String 浏览器缓存配置开关
on:开启
off:关闭
注意:此字段可能返回 null,表示取不到有效值。
MaxAgeRules Array of MaxAgeRule MaxAge 规则
注意:此字段可能返回 null,表示取不到有效值。

MaxAgeRule

MagAge 规则配置

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
MaxAgeType String 规则类型:
all:所有文件生效
file:指定文件后缀生效
directory:指定路径生效
path:指定绝对路径生效
index: 指定主页生效
MaxAgeContents Array of String MaxAgeType 对应类型下的匹配内容:
all 时填充 *
file 时填充后缀名,如 jpg、txt
directory 时填充路径,如 /xxx/test/
path 时填充绝对路径,如 /xxx/test.html
index 时填充 /
注意:all规则不可删除,默认遵循源站,可修改。
MaxAgeTime Integer MaxAge 时间设置,单位秒
注意:时间为0,即不缓存。
FollowOrigin String 是否遵循源站,on或off,开启时忽略时间设置。
注意:此字段可能返回 null,表示取不到有效值。

OfflineCache

离线缓存是否开启

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String on | off, 离线缓存是否开启

Origin

源站配置复杂类型,支持以下配置:

  • 源站指定为单个域名
  • 源站指定为多个 IP,可配置端口(165535),可配置权重(1100),格式为 IP:端口:权重
  • 回源域名配置
  • 对象存储(COS)作为源站
  • 热备源站指定为单个域名
  • 热备源站指定为多个 IP,可配置端口(1~65535),暂不支持权重配置
  • 热备源站回源域名配置

被如下接口引用:AddCdnDomain, DescribeDomains, DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Origins Array of String 主源站列表
修改源站时,需要同时填充对应的 OriginType
注意:此字段可能返回 null,表示取不到有效值。
OriginType String 主源站类型
入参支持以下几种类型:
domain:域名类型
domainv6:域名解析V6类型
cos:对象存储源站
ip:IP 列表作为源站
ipv6:源站列表为一个单独的 IPv6 地址
ip_ipv6:源站列表为多个 IPv4 地址和IPv6 地址
ip_domain: 支持IP和域名形式源站混填(白名单功能)
ip_domainv6:源站列表为多个 IPv4 地址以及域名解析v6地址
ipv6_domain: 源站列表为多个 IPv6 地址以及域名
ipv6_domainv6:源站列表为多个 IPv6 地址以及域名解析v6地址
domain_domainv6:源站列表为多个域名解析v4 地址以及域名解析v6地址
ip_ipv6_domain:源站列表为多个 IPv4 地址IPv6 地址以及域名
ip_ipv6_domainv6:源站列表为多个 IPv4 地址IPv6 地址以及域名解析v6地址
ip_domain_domainv6:源站列表为多个 IPv4 地址域名解析v4 地址以及域名解析v6地址
ipv6_domain_domainv6:源站列表为多个 域名解析v4 地址IPv6 地址以及域名解析v6地址
ip_ipv6_domain_domainv6:源站列表为多个 IPv4 地址IPv6 地址 域名解析v4 地址以及域名解析v6地址
出参增加以下几种类型:
image:数据万象源站
ftp:历史 FTP 托管源源站,现已不维护
修改 Origins 时需要同时填充对应的 OriginType
IPv6 功能目前尚未全量,需要先申请试用
注意:此字段可能返回 null,表示取不到有效值。
ServerName String 当源站类型为cos或者第三方存储加速时,ServerName字段必填
回主源站时 Host 头部,不填充则默认为加速域名
若接入的是泛域名,则回源 Host 默认为访问时的子域名
注意:此字段可能返回 null,表示取不到有效值。
CosPrivateAccess String OriginType 为对象存储(COS)时,可以指定是否允许访问私有 bucket
注意:需要先授权 CDN 访问该私有 Bucket 的权限后,才可开启此配置。取值范围: on/off
注意:此字段可能返回 null,表示取不到有效值。
OriginPullProtocol String 回源协议配置
http:强制 http 回源
follow:协议跟随回源
https:强制 https 回源,https 回源时仅支持源站 443 端口
注意:此字段可能返回 null,表示取不到有效值。
BackupOrigins Array of String 备源站列表
修改备源站时,需要同时填充对应的 BackupOriginType
注意:此字段可能返回 null,表示取不到有效值。
BackupOriginType String 备源站类型,支持以下类型:
domain:域名类型
ip:IP 列表作为源站
修改 BackupOrigins 时需要同时填充对应的 BackupOriginType
以下备源源站类型尚未全量支持,需要申请试用:
ipv6_domain: 源站列表为多个 IPv6 地址以及域名
ip_ipv6:源站列表为多个 IPv4 地址和IPv6 地址
ipv6_domain: 源站列表为多个 IPv6 地址以及域名
ip_ipv6_domain:源站列表为多个 IPv4 地址IPv6 地址以及域名
注意:此字段可能返回 null,表示取不到有效值。
BackupServerName String 回备源站时 Host 头部,不填充则默认为主源站的 ServerName
注意:此字段可能返回 null,表示取不到有效值。
BasePath String 回源路径
注意:此字段可能返回 null,表示取不到有效值。
PathRules Array of PathRule 回源路径重写规则配置
注意:此字段可能返回 null,表示取不到有效值。
PathBasedOrigin Array of PathBasedOriginRule 分路径回源配置
注意:此字段可能返回 null,表示取不到有效值。
AdvanceHttps AdvanceHttps HTTPS回源高级配置
注意:此字段可能返回 null,表示取不到有效值。
OriginCompany String 对象存储回源厂商
注意:此字段可能返回 null,表示取不到有效值。

OriginAuthentication

回源鉴权高级配置

被如下接口引用:DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String 鉴权开关,on或off
注意:此字段可能返回 null,表示取不到有效值。
TypeA OriginAuthenticationTypeA 鉴权类型A配置
注意:此字段可能返回 null,表示取不到有效值。

OriginAuthenticationTypeA

回源鉴权高级配置TypeA

被如下接口引用:UpdateDomainConfig。

名称 类型 必选 描述
SecretKey String 用于计算签名的密钥,只允许字母和数字,长度6-32字节。
注意:此字段可能返回 null,表示取不到有效值。

OriginCombine

合并回源配置项

被如下接口引用:DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String on|off 是否开启合并回源

OriginIp

CDN回源节点IP信息

被如下接口引用:DescribeCdnOriginIp。

名称 类型 描述
Ip String 回源IP段/回源IP,默认返回IP段信息。

OriginPullOptimization

跨国回源优化配置,默认为关闭状态(功能灰度中,尚未全量)

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String 跨国回源优化配置开关
on:开启
off:关闭
OptimizationType String 跨国类型
OVToCN:境外回源境内
CNToOV:境内回源境外
注意:此字段可能返回 null,表示取不到有效值。

OriginPullTimeout

回源超时配置

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
ConnectTimeout Integer 回源建连超时时间,单位为秒,要求5~60之间
注意:此字段可能返回 null,表示取不到有效值。
ReceiveTimeout Integer 回源接收超时时间,单位为秒,要求10 ~ 60之间
注意:此字段可能返回 null,表示取不到有效值。

OssPrivateAccess

oss回源鉴权

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String 开关, on/off。
AccessKey String 访问ID。
注意:此字段可能返回 null,表示取不到有效值。
SecretKey String 密钥。
注意:此字段可能返回 null,表示取不到有效值。
Region String 地域
注意:此字段可能返回 null,表示取不到有效值。
Bucket String Bucketname
注意:此字段可能返回 null,表示取不到有效值。

OverseaConfig

域名海外地区特殊配置。UpdateDomainConfig接口只支持修改部分分地区配置,为了兼容旧版本配置,本类型会列出旧版本所有可能存在差异的配置列表,支持修改的配置列表如下:

  • Authentication
  • BandwidthAlert
  • ErrorPage
  • IpFilter
  • Origin
  • Referer

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
Authentication Authentication 时间戳防盗链配置。
注意:此字段可能返回 null,表示取不到有效值。
BandwidthAlert BandwidthAlert 带宽封顶配置。
注意:此字段可能返回 null,表示取不到有效值。
Cache Cache 缓存规则配置。
注意:此字段可能返回 null,表示取不到有效值。
CacheKey CacheKey 缓存相关配置。
注意:此字段可能返回 null,表示取不到有效值。
Compression Compression 智能压缩配置。
注意:此字段可能返回 null,表示取不到有效值。
DownstreamCapping DownstreamCapping 下载限速配置。
注意:此字段可能返回 null,表示取不到有效值。
ErrorPage ErrorPage 错误码重定向配置。
注意:此字段可能返回 null,表示取不到有效值。
FollowRedirect FollowRedirect 301和302自动回源跟随配置。
注意:此字段可能返回 null,表示取不到有效值。
ForceRedirect ForceRedirect 访问协议强制跳转配置。
注意:此字段可能返回 null,表示取不到有效值。
Https Https Https配置。
注意:此字段可能返回 null,表示取不到有效值。
IpFilter IpFilter IP黑白名单配置。
注意:此字段可能返回 null,表示取不到有效值。
IpFreqLimit IpFreqLimit IP限频配置。
注意:此字段可能返回 null,表示取不到有效值。
MaxAge MaxAge 浏览器缓存规则配置。
注意:此字段可能返回 null,表示取不到有效值。
Origin Origin 源站配置。
注意:此字段可能返回 null,表示取不到有效值。
OriginPullOptimization OriginPullOptimization 跨国优化配置。
注意:此字段可能返回 null,表示取不到有效值。
RangeOriginPull RangeOriginPull Range回源配置。
注意:此字段可能返回 null,表示取不到有效值。
Referer Referer 防盗链配置。
注意:此字段可能返回 null,表示取不到有效值。
RequestHeader RequestHeader 回源请求头部配置。
注意:此字段可能返回 null,表示取不到有效值。
ResponseHeader ResponseHeader 源站响应头部配置。
注意:此字段可能返回 null,表示取不到有效值。
ResponseHeaderCache ResponseHeaderCache 遵循源站缓存头部配置。
注意:此字段可能返回 null,表示取不到有效值。
Seo Seo seo优化配置。
注意:此字段可能返回 null,表示取不到有效值。
ServiceType String 域名业务类型,web,download,media分别表示静态加速,下载加速和流媒体加速。
注意:此字段可能返回 null,表示取不到有效值。
StatusCodeCache StatusCodeCache 状态码缓存配置。
注意:此字段可能返回 null,表示取不到有效值。
VideoSeek VideoSeek 视频拖拽配置。
注意:此字段可能返回 null,表示取不到有效值。
AwsPrivateAccess AwsPrivateAccess 回源S3私有鉴权。
注意:此字段可能返回 null,表示取不到有效值。
OssPrivateAccess OssPrivateAccess 回源OSS私有鉴权。
注意:此字段可能返回 null,表示取不到有效值。
HwPrivateAccess HwPrivateAccess 华为云对象存储鉴权
注意:此字段可能返回 null,表示取不到有效值。
QnPrivateAccess QnPrivateAccess 七牛云对象存储鉴权
注意:此字段可能返回 null,表示取不到有效值。

PathBasedOriginRule

分路径回源规则

被如下接口引用:AddCdnDomain, DescribeDomains, UpdateDomainConfig。

名称 类型 必选 描述
RuleType String 规则类型:
file:指定文件后缀生效
directory:指定路径生效
path:指定绝对路径生效
index: 指定主页生效
RulePaths Array of String RuleType 对应类型下的匹配内容:
file 时填充后缀名,如 jpg、txt
directory 时填充路径,如 /xxx/test/
path 时填充绝对路径,如 /xxx/test.html
index 时填充 /
Origin Array of String 源站列表,支持域名或ipv4地址

PathRule

分路径回源配置规则。

被如下接口引用:AddCdnDomain, DescribeDomains, UpdateDomainConfig。

名称 类型 必选 描述
Regex Boolean 是否开启通配符“*”匹配:
false:关闭
true:开启
注意:此字段可能返回 null,表示取不到有效值。
Path String 匹配的URL路径,仅支持Url路径,不支持参数。默认完全匹配,开启通配符“*”匹配后,最多支持5个通配符,最大长度为1024个字符。
注意:此字段可能返回 null,表示取不到有效值。
Origin String 路径匹配时的回源源站。暂不支持开了私有读写的COS源。不填写时沿用默认源站。
注意:此字段可能返回 null,表示取不到有效值。
ServerName String 路径匹配时回源的Host头部。不填写时沿用默认ServerName。
注意:此字段可能返回 null,表示取不到有效值。
OriginArea String 源站所属区域,支持CN,OV:
CN:中国境内
OV:中国境外
默认为CN。
注意:此字段可能返回 null,表示取不到有效值。
ForwardUri String 路径匹配时回源的URI路径,必须以“/”开头,不包含参数部分。最大长度为1024个字符。可使用$1, $2, $3, $4, $5分别捕获匹配路径中的通配符号“*”,最多支持10个捕获值。
注意:此字段可能返回 null,表示取不到有效值。
RequestHeaders Array of HttpHeaderRule 路径匹配时回源的头部设置。
注意:此字段可能返回 null,表示取不到有效值。
FullMatch Boolean 当Regex为false时,Path是否开启完全匹配。
false:关闭
true:开启
注意:此字段可能返回 null,表示取不到有效值。

PostSize

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

被如下接口引用:DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String 是调整POST请求限制,平台默认为32MB。
关闭:off,
开启:on。
MaxSize Integer 最大限制,取值在1MB和200MB之间。

PurgeTask

刷新任务详情

被如下接口引用:DescribePurgeTasks。

名称 类型 描述
TaskId String 刷新任务 ID
Url String 刷新 URL
Status String 刷新任务状态
fail:刷新失败
done:刷新成功
process:刷新中
PurgeType String 刷新类型
url:URL 刷新
path:目录刷新
FlushType String 刷新方式
flush:刷新更新资源(仅目录刷新时有此类型)
delete:刷新全部资源
CreateTime Timestamp 刷新任务提交时间

PushTask

预热任务详情

被如下接口引用:DescribePushTasks。

名称 类型 描述
TaskId String 预热任务 ID
Url String 预热 URL
Status String 预热任务状态
fail:预热失败
done:预热成功
process:预热中
invalid:预热无效(源站返回4xx或5xx状态码)
Percent Integer 预热进度百分比
CreateTime Timestamp 预热任务提交时间
Area String 预热区域
mainland:境内
overseas:境外
global:全球
UpdateTime Timestamp 预热任务更新时间
注意:此字段可能返回 null,表示取不到有效值。

QnPrivateAccess

七牛元对象存储回源鉴权配置

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String 开关 on/off
AccessKey String 访问 ID
注意:此字段可能返回 null,表示取不到有效值。
SecretKey String 密钥

QueryStringKey

组成CacheKey的一部分

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
Switch String on | off CacheKey是否由QueryString组成
注意:此字段可能返回 null,表示取不到有效值。
Reorder String 是否重新排序
注意:此字段可能返回 null,表示取不到有效值。
Action String includeAll | excludeAll | includeCustom | excludeAll 使用/排除部分url参数
注意:此字段可能返回 null,表示取不到有效值。
Value String 使用/排除的url参数数组,';' 分割
注意:此字段可能返回 null,表示取不到有效值。

Quic

Quic配置项

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String 是否启动Quic配置

Quota

刷新/预热 可用量及配额

被如下接口引用:DescribePurgeQuota, DescribePushQuota。

名称 类型 描述
Batch Integer 单次批量提交配额上限。
Total Integer 每日提交配额上限。
Available Integer 每日剩余的可提交配额。
Area String 配额的区域。

RangeOriginPull

分片回源配置,默认为开启状态

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String 分片回源配置开关
on:开启
off:关闭
RangeRules Array of RangeOriginPullRule 分路径分片回源配置
注意:此字段可能返回 null,表示取不到有效值。

RangeOriginPullRule

分路径分片回源配置

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
Switch String 分片回源配置开关
RuleType String 规则类型:
file:指定文件后缀生效
directory:指定路径生效
path:指定绝对路径生效
注意:此字段可能返回 null,表示取不到有效值。
RulePaths Array of String RuleType 对应类型下的匹配内容:
file 时填充后缀名,如 jpg、txt
directory 时填充路径,如 /xxx/test
path 时填充绝对路径,如 /xxx/test.html
注意:此字段可能返回 null,表示取不到有效值。

RedirectConfig

自定义回源302 follow请求host配置

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
Switch String 配置开关
FollowRedirectHost String 主源站follow302请求时带的自定义的host头部
FollowRedirectBackupHost String 备份源站follow302请求时带的自定义的host头部

Referer

Referer 黑白名单配置,默认为关闭状态

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String referer 黑白名单配置开关
on:开启
off:关闭
RefererRules Array of RefererRule referer 黑白名单配置规则
注意:此字段可能返回 null,表示取不到有效值。

RefererRule

Referer 黑白名单配置规则,针对特定资源生效

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
RuleType String 规则类型:
all:所有文件生效
file:指定文件后缀生效
directory:指定路径生效
path:指定绝对路径生效
RulePaths Array of String RuleType 对应类型下的匹配内容:
all 时填充 *
file 时填充后缀名,如 jpg、txt
directory 时填充路径,如 /xxx/test/
path 时填充绝对路径,如 /xxx/test.html
RefererType String referer 配置类型
whitelist:白名单
blacklist:黑名单
Referers Array of String referer 内容列表列表
AllowEmpty Boolean 是否允许空 referer
防盗链类型为白名单时,true表示允许空 referer,false表示不允许空 referer;
防盗链类型为黑名单时,true表示拒绝空referer,false表示不拒绝空referer;

RegionMapRelation

区域映射id和子区域id的关联信息。

被如下接口引用:DescribeMapInfo。

名称 类型 描述
RegionId Integer 区域ID。
SubRegionIdList Array of Integer 子区域ID列表

RemoteAuthentication

远程鉴权规则配置,可以包含多种规则配置。
RemoteAuthenticationRules和Server 互斥,只需要配置其中一个。
若只配置Server ,RemoteAuthenticationRules中详细规则参数将采用默认参数;默认参数值见各个配置项中说明;

被如下接口引用:DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String 远程鉴权开关;
on : 开启;
off: 关闭;
注意:此字段可能返回 null,表示取不到有效值。
RemoteAuthenticationRules Array of RemoteAuthenticationRule 远程鉴权规则配置
注意:此字段可能返回 null,表示取不到有效值。
Server String 远程鉴权Server
注意:此字段可能返回 null,表示取不到有效值。

RemoteAuthenticationRule

远程鉴权规则。

被如下接口引用:UpdateDomainConfig。

名称 类型 必选 描述
Server String 远程鉴权Server。
默认值:和上层配置的"Server"一致;
AuthMethod String 请求远程鉴权服务器的http方法;取值范围[get,post,head,all];
all: 表示"遵循终端用户请求方法"
默认值: all
RuleType String 规则类型:
all:所有文件生效
file:指定文件后缀生效
directory:指定目录生效
path:指定文件绝对路径生效
默认值:all
RulePaths Array of String 对应类型下的匹配内容:
all 时填充 *
file 时填充后缀名,如 jpg、txt
directory 时填充路径,如 /xxx/test
path 时填充绝对路径,如 /xxx/test.html
index 时填充 /
默认值:*
AuthTimeout Integer 请求远程鉴权服务器超时时间,单位毫秒;
取值范围:[1,30 000]
默认值:20000
AuthTimeoutAction String 请求远程鉴权服务器超时后执行拦截或者放行;
RETURN_200: 超时后放行;
RETURN_403:超时拦截;
默认值:RETURN_200

ReportData

CDN报表数据

被如下接口引用:DescribeReportData。

名称 类型 描述
ResourceId String 项目ID/域名ID。
Resource String 项目名称/域名。
Value Integer 流量总和/带宽最大值,单位分别为bytes,bps。
Percentage Float 单个资源占总体百分比。
BillingValue Integer 计费流量总和/计费带宽最大值,单位分别为bytes,bps。
BillingPercentage Float 计费数值占总体百分比。

RequestHeader

自定义请求头配置,默认为关闭状态

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String 自定义请求头配置开关
on:开启
off:关闭
HeaderRules Array of HttpHeaderPathRule 自定义请求头配置规则
注意:此字段可能返回 null,表示取不到有效值。

ResourceBillingData

计费数据明细

被如下接口引用:DescribeBillingData。

名称 类型 描述
Resource String 资源名称,根据查询条件不同分为以下几类:
某一个具体域名:表示该域名明细数据
multiDomains:表示多域名汇总明细数据
某一个项目 ID:指定项目查询时,显示为项目 ID
all:账号维度数据明细
BillingData Array of CdnData 计费数据详情

ResourceData

查询对象及其对应的访问明细数据

被如下接口引用:DescribeCdnData, DescribeIpVisit。

名称 类型 描述
Resource String 资源名称,根据查询条件不同分为以下几类:
单域名:指定单域名查询,表示该域名明细数据,当传入参数 detail 指定为 true 时,显示该域名( detail 参数默认为 false )
多域名:指定多个域名查询,表示多域名汇总明细数据,显示 multiDomains
项目 ID:指定项目查询时,表示该项目下的域名汇总明细数据,显示该项目 ID
all:账号维度明细数据,即账号下所有域名的汇总明细数据
CdnData Array of CdnData 资源对应的数据明细

ResourceOriginData

查询对象及其对应的回源明细数据

被如下接口引用:DescribeOriginData。

名称 类型 描述
Resource String 资源名称,根据查询条件不同分为以下几类:
具体域名:表示该域名明细数据
multiDomains:表示多域名汇总明细数据
项目 ID:指定项目查询时,显示为项目 ID
all:账号维度明细数据
OriginData Array of CdnData 回源数据详情

ResponseHeader

自定义响应头配置,默认为关闭状态

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String 自定义响应头开关
on:开启
off:关闭
HeaderRules Array of HttpHeaderPathRule 自定义响应头规则
注意:此字段可能返回 null,表示取不到有效值。

ResponseHeaderCache

源站头部缓存配置,默认为开启状态,缓存所有头部信息

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String 源站头部缓存开关
on:开启
off:关闭

Revalidate

是否回源站校验

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
Switch String on | off 是否总是回源校验
注意:此字段可能返回 null,表示取不到有效值。
Path String 只在特定请求路径回源站校验
注意:此字段可能返回 null,表示取不到有效值。

RuleCache

缓存配置分路径版本。
默认情况下所有文件缓存过期时间为 30 天
默认情况下静态加速类型的域名 .php;.jsp;.asp;.aspx 不缓存

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
RulePaths Array of String CacheType 对应类型下的匹配内容:
all 时填充 *
file 时填充后缀名,如 jpg、txt
directory 时填充路径,如 /xxx/test
path 时填充绝对路径,如 /xxx/test.html
index 时填充 /
注意:此字段可能返回 null,表示取不到有效值。
RuleType String 规则类型:
all:所有文件生效
file:指定文件后缀生效
directory:指定路径生效
path:指定绝对路径生效
index:首页
注意:此字段可能返回 null,表示取不到有效值。
CacheConfig RuleCacheConfig 缓存配置。
注意:此字段可能返回 null,表示取不到有效值。

RuleCacheConfig

路径缓存缓存配置(三种缓存模式中选取一种)

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

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

RuleEngine

规则引擎配置

被如下接口引用:DescribeDomainsConfig。

名称 类型 必选 描述
Switch String 规则引擎配置开关
on:开启
off:关闭
Content String 规则
注意:此字段可能返回 null,表示取不到有效值。

RuleQueryString

路径保留参数配置

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
Switch String on | off CacheKey是否由QueryString组成
注意:此字段可能返回 null,表示取不到有效值。
Action String includeCustom 包含部分url参数
注意:此字段可能返回 null,表示取不到有效值。
Value String 使用/排除的url参数数组,';' 分割
注意:此字段可能返回 null,表示取不到有效值。

ScdnAclConfig

SCDN访问控制

被如下接口引用:CreateScdnDomain, DescribeScdnConfig, UpdateScdnDomain。

名称 类型 必选 描述
Switch String 是否开启,on | off
ScriptData Array of ScdnAclGroup 新版本请使用AdvancedScriptData
注意:此字段可能返回 null,表示取不到有效值。
ErrorPage ScdnErrorPage 错误页面配置
注意:此字段可能返回 null,表示取不到有效值。
AdvancedScriptData Array of AdvancedScdnAclGroup Acl规则组,switch为on时必填
注意:此字段可能返回 null,表示取不到有效值。

ScdnAclGroup

SCDN精准访问控制配置

被如下接口引用:CreateScdnDomain, DescribeScdnConfig, UpdateScdnDomain。

名称 类型 必选 描述
RuleName String 规则名称
Configure Array of ScdnAclRule 具体配置
Result String 执行动作,intercept|redirect
Status String 规则是否生效,active|inactive
ErrorPage ScdnErrorPage 错误页面配置
注意:此字段可能返回 null,表示取不到有效值。

ScdnAclRule

精准访问控制匹配规则

被如下接口引用:CreateScdnDomain, DescribeScdnConfig, UpdateScdnDomain。

名称 类型 必选 描述
MatchKey String 匹配关键字
LogiOperator String 逻辑操作符,取值如下
MatchValue String 匹配值。

ScdnBotConfig

bot配置类型

被如下接口引用:CreateScdnDomain, DescribeScdnConfig, UpdateScdnDomain。

名称 类型 必选 描述
Switch String on|off
BotCookie Array of BotCookie Bot cookie策略
注意:此字段可能返回 null,表示取不到有效值。
BotJavaScript Array of BotJavaScript Bot Js策略
注意:此字段可能返回 null,表示取不到有效值。

ScdnCCRules

scdn 的自定义 cc 规则

被如下接口引用:CreateScdnDomain, DescribeScdnConfig, UpdateScdnDomain。

名称 类型 必选 描述
RuleType String 规则类型:
all:所有文件生效
file:指定文件后缀生效
directory:指定路径生效
path:指定绝对路径生效
index:首页
RuleValue Array of String 规则值
Qps Integer 规则限频
DetectionTime Integer 探测时长
注意:此字段可能返回 null,表示取不到有效值。
FrequencyLimit Integer 限频阈值
注意:此字段可能返回 null,表示取不到有效值。
PunishmentSwitch String IP 惩罚开关,可选on|off
注意:此字段可能返回 null,表示取不到有效值。
PunishmentTime Integer IP 惩罚时长
注意:此字段可能返回 null,表示取不到有效值。
Action String 执行动作,intercept|redirect
注意:此字段可能返回 null,表示取不到有效值。
RedirectUrl String 动作为 redirect 时,重定向的url
注意:此字段可能返回 null,表示取不到有效值。

ScdnConfig

cc的配置类型

被如下接口引用:CreateScdnDomain, DescribeScdnConfig, UpdateScdnDomain。

名称 类型 必选 描述
Switch String on | off
Rules Array of ScdnCCRules 自定义 cc 防护规则
注意:此字段可能返回 null,表示取不到有效值。
AdvancedRules Array of AdvancedCCRules 增强自定义 cc 防护规则
注意:此字段可能返回 null,表示取不到有效值。
GlobalAdvancedRules Array of AdvancedCCRules 增强自定义 cc 防护规则, 全局
注意:此字段可能返回 null,表示取不到有效值。

ScdnDdosConfig

ddos配置类型

被如下接口引用:CreateScdnDomain, DescribeScdnConfig, UpdateScdnDomain。

名称 类型 必选 描述
Switch String on|off

ScdnDomain

聚合了SCDN域名的基本信息

被如下接口引用:ListScdnDomains。

名称 类型 描述
Domain String 域名
Status String 当前状态,取值online | offline | process
Waf String Waf 状态默认为‘/’,取值 close | intercept | observe
Acl String Acl 状态默认为‘/’,取值 close | open
CC String CC 状态默认为‘/’,取值 close | open
Ddos String Ddos 状态默认为‘/’,取值 close | open
ProjectId String 项目ID
AclRuleNumbers Integer Acl 规则数
Bot String Bot 状态默认为‘/’,取值 close | open
Area String 域名加速区域,取值global | mainland | overseas
注意:此字段可能返回 null,表示取不到有效值。
WafLevel Integer waf规则等级,可取100|200|300
注意:此字段可能返回 null,表示取不到有效值。

ScdnErrorPage

acl的错误页面

被如下接口引用:CreateScdnDomain, DescribeScdnConfig, UpdateScdnDomain。

名称 类型 必选 描述
RedirectCode Integer 状态码
执行动作为:intercept 默认传值 403
执行动作为:redirect 默认传值 301
RedirectUrl String 重定向url

ScdnEventLogConditions

SCDN 事件日志查询条件

被如下接口引用:CreateScdnLogTask, ListScdnLogTasks。

名称 类型 必选 描述
Key String 匹配关键字,ip, attack_location
Operator String 逻辑操作符,取值 exclude, include
Value String 匹配值,允许使用通配符()查询,匹配零个、单个、多个字符,例如 1.2.

ScdnIpStrategy

scdn的IP白名单策略

被如下接口引用:DescribeScdnIpStrategy。

名称 类型 描述
Domain String 域名|global表示全部域名
StrategyId String 策略ID
IpList Array of String IP白名单列表
UpdateTime Timestamp 更新时间
Remark String 备注
RuleType String 规则类型
注意:此字段可能返回 null,表示取不到有效值。
RuleValue Array of String 规则值
注意:此字段可能返回 null,表示取不到有效值。

ScdnIpStrategyFilter

IP策略查询过滤参数

被如下接口引用:DescribeScdnIpStrategy。

名称 类型 必选 描述
Name String 过滤字段名,支持domain, ip
Value Array of String 过滤字段值
Fuzzy Boolean 是否启用模糊查询,仅支持过滤字段名为domain。
模糊查询时,Value长度最大为1

ScdnLogTaskDetail

SCDN日志事件详细信息

被如下接口引用:ListScdnLogTasks。

名称 类型 描述
Domain String scdn域名
Mode String 防护类型
StartTime Timestamp 查询任务开始时间
EndTime Timestamp 查询任务结束时间
CreateTime Timestamp 任务创建时间
DownloadUrl String 日志包下载链接
成功返回下载链接,其他情况返回'-'
注意:此字段可能返回 null,表示取不到有效值。
Status String 任务状态
created->任务已经创建
processing->任务正在执行
done->任务执行成功
failed->任务执行失败
no-log->没有日志产生
TaskID String 日志任务唯一id
AttackType String 攻击类型, 可以为"all"
AttackType映射如下:
other = '未知类型'
malicious_scan = "恶意扫描"
sql_inject = "SQL注入攻击"
xss = "XSS攻击"
cmd_inject = "命令注入攻击"
ldap_inject = "LDAP注入攻击"
ssi_inject = "SSI注入攻击"
xml_inject = "XML注入攻击"
web_service = "WEB服务漏洞攻击"
web_app = "WEB应用漏洞攻击"
path_traversal = "路径跨越攻击"
illegal_access_core_file = "核心文件非法访问"
file_upload = "文件上传攻击"
trojan_horse = "木马后门攻击"
csrf = "CSRF攻击"
custom_policy = "自定义策略"
ai_engine= 'AI引擎检出'
malicious_file_upload= '恶意文件上传'
DefenceMode String 防御模式,可以为"all"
DefenceMode映射如下:
observe = '观察模式'
intercept = '防御模式'
Conditions Array of ScdnEventLogConditions 查询条件
注意:此字段可能返回 null,表示取不到有效值。
Area String mainland或overseas
注意:此字段可能返回 null,表示取不到有效值。

ScdnSevenLayerRules

Scdn的七层限频配置

被如下接口引用:CreateScdnDomain, DescribeScdnConfig, UpdateScdnDomain。

名称 类型 必选 描述
CaseSensitive Boolean 区分大小写
RuleType String 规则类型:
protocol:协议,填写 HTTP/HTTPS
method:请求方法,支持 HEAD、GET、POST、PUT、OPTIONS、TRACE、DELETE、PATCH、CONNECT
all:域名 匹配内容固定为"*",不可编辑修改
ip:IP 填写 CIDR 表达式
directory:路径,以/开头,支持目录和具体路径,128字符以内
index:首页 默认固定值:/;/index.html,不可编辑修改
path:文件全路径,资源地址,如/acb/test.png,支持通配符,如/abc/*.jpg
file:文件扩展名,填写具体扩展名,如 jpg;png;css
param:请求参数,填写具体 value 值,512字符以内
referer:Referer,填写具体 value 值,512字符以内
cookie:Cookie,填写具体 value 值,512字符以内
user-agent:User-Agent,填写具体 value 值,512字符以内
head:自定义请求头,填写具体value值,512字符以内;内容为空或者不存在时,无匹配内容输入框,填写匹配参数即可
LogicOperator String 逻辑操作符,取值 :
不包含:exclude,
包含:include,
不等于:notequal,
等于:equal,
前缀匹配:matching
内容为空或不存在:null
RuleValue Array of String 规则值
注意:此字段可能返回 null,表示取不到有效值。
RuleParam String 匹配参数,只有请求参数、Cookie、自定义请求头 有值
注意:此字段可能返回 null,表示取不到有效值。

ScdnTopData

SCDN攻击数据Top展示

被如下接口引用:DescribeScdnTopData, ListTopWafData。

名称 类型 描述
Time Timestamp 时间
Value Integer 数值
Isp String 运营商
Ip String IP地址
District String 区域

ScdnTopDomainData

SCDN攻击数据Top展示

被如下接口引用:ListTopWafData。

名称 类型 描述
Domain String 域名
Value Integer 请求量
Percent Float 百分比

ScdnTopUrlData

SCDN攻击数据Top URL展示

被如下接口引用:DescribeScdnTopData, ListTopWafData。

名称 类型 描述
Url String Top数据的URL
Value Integer 数值
Time Timestamp 时间
Domain String 域名
注意:此字段可能返回 null,表示取不到有效值。

ScdnTypeData

Scdn饼图数据,waf仅有

被如下接口引用:DescribeScdnTopData, ListTopWafData。

名称 类型 描述
AttackType String 攻击类型
Value Integer 攻击值

ScdnWafConfig

waf配置类型

被如下接口引用:CreateScdnDomain, DescribeScdnConfig, UpdateScdnDomain。

名称 类型 必选 描述
Switch String on|off
Mode String intercept|observe,默认intercept
注意:此字段可能返回 null,表示取不到有效值。
ErrorPage ScdnErrorPage 重定向的错误页面
注意:此字段可能返回 null,表示取不到有效值。
WebShellSwitch String webshell拦截开关,on|off,默认off
注意:此字段可能返回 null,表示取不到有效值。
Rules Array of ScdnWafRule 类型拦截规则
注意:此字段可能返回 null,表示取不到有效值。
Level Integer waf规则等级,可取100|200|300
注意:此字段可能返回 null,表示取不到有效值。
SubRuleSwitch Array of WafSubRuleStatus waf子规则开关
注意:此字段可能返回 null,表示取不到有效值。

ScdnWafRule

Waf 规则信息

被如下接口引用:CreateScdnDomain, DescribeScdnConfig, UpdateScdnDomain。

名称 类型 必选 描述
AttackType String 攻击类型
Operate String 防护措施,observe

SchemeKey

作为CacheKey的一部分

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
Switch String on | off 是否使用scheme作为cache key的一部分
注意:此字段可能返回 null,表示取不到有效值。

SecurityConfig

scdn相关的配置

被如下接口引用:DescribeDomainsConfig。

名称 类型 描述
Switch String on|off

Seo

SEO 搜索引擎优化配置,默认为关闭状态

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String SEO 配置开关
on:开启
off:关闭
注意:此字段可能返回 null,表示取不到有效值。

ServerCert

https 加速服务端证书配置:

  • 支持使用托管至 SSL 证书管理的证书进行部署
  • 支持上传 PEM 格式的证书进行部署
    注意:上传 PEM 证书时,需要进行 Base 64 编码

被如下接口引用:AddCdnDomain, DescribeDomains, UpdateDomainConfig。

名称 类型 必选 描述
CertId String 服务器证书 ID 在 SSL 证书管理进行证书托管时自动生成
注意:此字段可能返回 null,表示取不到有效值。
CertName String 服务器证书名称
在 SSL 证书管理进行证书托管时自动生成
注意:此字段可能返回 null,表示取不到有效值。
Certificate String 服务器证书信息
上传自有证书时必填,需要包含完整的证书链
注意:此字段可能返回 null,表示取不到有效值。
PrivateKey String 服务器密钥信息
上传自有证书时必填
注意:此字段可能返回 null,表示取不到有效值。
ExpireTime Timestamp 证书过期时间
作为入参配置时无需填充
注意:此字段可能返回 null,表示取不到有效值。
DeployTime Timestamp 证书颁发时间
作为入参配置时无需填充
注意:此字段可能返回 null,表示取不到有效值。
Message String 证书备注信息
注意:此字段可能返回 null,表示取不到有效值。
From String 证书来源
注意:此字段可能返回 null,表示取不到有效值。

ShareCname

ShareCname配置

被如下接口引用:DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String ShareCname 配置开关, 开关为off时,域名使用默认CNAME,若需要使用共享CNAME,将开关置为on.

* ShareCname 为内测功能,如需使用,请联系腾讯云工程师开白.
Cname String 设置共享CNAME.
注意:此字段可能返回 null,表示取不到有效值。

SimpleCache

缓存配置基础版本
默认情况下所有文件缓存过期时间为 30 天
默认情况下静态加速类型的域名 .php;.jsp;.asp;.aspx 不缓存
注意:该版本不支持设置源站未返回 max-age 情况下的缓存过期规则设置

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
CacheRules Array of SimpleCacheRule 缓存过期时间规则
注意:此字段可能返回 null,表示取不到有效值。
FollowOrigin String 遵循源站 Cache-Control: max-age 配置
on:开启
off:关闭
开启后,未能匹配 CacheRules 规则的资源将根据源站返回的 max-age 值进行节点缓存;匹配了 CacheRules 规则的资源将按照 CacheRules 中设置的缓存过期时间在节点进行缓存
与 CompareMaxAge 冲突,不能同时开启
注意:此字段可能返回 null,表示取不到有效值。
IgnoreCacheControl String 强制缓存
on:开启
off:关闭
默认为关闭状态,开启后,源站返回的 no-store、no-cache 资源,也将按照 CacheRules 规则进行缓存
注意:此字段可能返回 null,表示取不到有效值。
IgnoreSetCookie String 忽略源站的Set-Cookie头部
on:开启
off:关闭
默认为关闭状态
注意:此字段可能返回 null,表示取不到有效值。
CompareMaxAge String 高级缓存过期配置,开启时会对比源站返回的 max-age 值与 CacheRules 中设置的缓存过期时间,取最小值在节点进行缓存
on:开启
off:关闭
默认为关闭状态
注意:此字段可能返回 null,表示取不到有效值。
Revalidate Revalidate 总是回源站校验
注意:此字段可能返回 null,表示取不到有效值。

SimpleCacheRule

缓存过期规则配置

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
CacheType String 规则类型:
all:所有文件生效
file:指定文件后缀生效
directory:指定路径生效
path:指定绝对路径生效
index:首页
CacheContents Array of String CacheType 对应类型下的匹配内容:
all 时填充 *
file 时填充后缀名,如 jpg、txt
directory 时填充路径,如 /xxx/test
path 时填充绝对路径,如 /xxx/test.html
index 时填充 /
CacheTime Integer 缓存过期时间设置
单位为秒,最大可设置为 365 天

Sort

查询结果排序条件

被如下接口引用:DescribeDomainsConfig。

名称 类型 必选 描述
Key String 排序字段,当前支持:
createTime,域名创建时间
certExpireTime,证书过期时间
默认createTime。
Sequence String asc/desc,默认desc。

SpecificConfig

域名国内海外分地区特殊配置。

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Mainland MainlandConfig 国内特殊配置。
注意:此字段可能返回 null,表示取不到有效值。
Overseas OverseaConfig 海外特殊配置。
注意:此字段可能返回 null,表示取不到有效值。

StatisticItem

累计用量封顶的配置

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
Type String 封顶类型,累计用量total,瞬时用量moment
注意:此字段可能返回 null,表示取不到有效值。
UnBlockTime Integer 自动解封时间
注意:此字段可能返回 null,表示取不到有效值。
BpsThreshold Integer 带宽、流量阈值
注意:此字段可能返回 null,表示取不到有效值。
CounterMeasure String 关闭方式 返回404:RETURN_404, dns回源:RESOLVE_DNS_TO_ORIGIN
注意:此字段可能返回 null,表示取不到有效值。
AlertPercentage Integer 触发提醒阈值百分比
注意:此字段可能返回 null,表示取不到有效值。
AlertSwitch String 提醒开关 on/off
注意:此字段可能返回 null,表示取不到有效值。
Metric String 指标类型,流量flux或带宽bandwidth
注意:此字段可能返回 null,表示取不到有效值。
Cycle Integer 检测周期,单位分钟,60或1440
注意:此字段可能返回 null,表示取不到有效值。
Switch String 是否开启该选项,on/off
注意:此字段可能返回 null,表示取不到有效值。

StatusCodeCache

状态码缓存过期配置,默认情况下会对 404 状态码缓存 10 秒

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String 状态码缓存过期配置开关
on:开启
off:关闭
注意:此字段可能返回 null,表示取不到有效值。
CacheRules Array of StatusCodeCacheRule 状态码缓存过期规则明细
注意:此字段可能返回 null,表示取不到有效值。

StatusCodeCacheRule

状态码缓存过期时间规则配置

被如下接口引用:AddCdnDomain, UpdateDomainConfig。

名称 类型 必选 描述
StatusCode String http 状态码
支持 403、404 状态码
CacheTime Integer 状态码缓存过期时间,单位秒

SummarizedData

明细数据的汇总值,各指标根据其特性不同拥有不同汇总方式

被如下接口引用:DescribeBillingData, DescribeCdnData, DescribeIpVisit, DescribeOriginData。

名称 类型 描述
Name String 汇总方式,存在以下几种:
sum:累加求和
max:最大值,带宽模式下,采用 5 分钟粒度汇总数据,计算峰值带宽
avg:平均值
Value Float 汇总后的数据值

Tag

域名标签配置

被如下接口引用:AddCdnDomain, DescribeDomainsConfig。

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

TimestampData

时间戳与其对应的数值

被如下接口引用:DescribeBillingData, DescribeCcData, DescribeCdnData, DescribeIpVisit, DescribeOriginData, DescribeWafData。

名称 类型 描述
Time Timestamp 数据统计时间点,采用向前汇总模式
以 5 分钟粒度为例,13:35:00 时间点代表的统计数据区间为 13:35:00 至 13:39:59
Value Float 数据值

TopData

排序类型数据结构

被如下接口引用:ListTopData。

名称 类型 描述
Resource String 资源名称,根据查询条件不同分为以下几类:
具体域名:表示该域名明细数据
multiDomains:表示多域名汇总明细数据
项目 ID:指定项目查询时,显示为项目 ID
all:账号维度明细数据
DetailData Array of TopDetailData 排序结果详情

TopDataMore

排序类型数据结构

被如下接口引用:DescribeTopData。

名称 类型 描述
Resource String 资源名称,根据查询条件不同分为以下几类:
DetailData Array of TopDetailDataMore 排序结果详情

TopDetailData

排序类型的数据结构

被如下接口引用:ListTopData。

名称 类型 描述
Name String 数据类型的名称
Value Float 数据值

TopDetailDataMore

排序类型的数据结构,同时附带上该项的在总值的占比

被如下接口引用:DescribeTopData。

名称 类型 描述
Name String 数据类型的名称
Value Float 数据值
Percent Float 数据值在总值中的百分比
注意:此字段可能返回 null,表示取不到有效值。

TopicInfo

CLS主题信息

被如下接口引用:ListClsLogTopics。

名称 类型 描述
TopicId String 主题ID
TopicName String 主题名字
Enabled Integer 是否启用投递
CreateTime Timestamp 创建时间
注意:此字段可能返回 null,表示取不到有效值。
Channel String 归属于cdn或ecdn
注意:此字段可能返回 null,表示取不到有效值。
Deleted String cls侧是否已经被删除
注意:此字段可能返回 null,表示取不到有效值。

TpgAdapter

图片优化-TpgAdapter配置

被如下接口引用:DescribeDomainsConfig, DescribeImageConfig, UpdateImageConfig。

名称 类型 必选 描述
Switch String 开关,"on/off"
注意:此字段可能返回 null,表示取不到有效值。

TrafficPackage

CDN加速流量包。

被如下接口引用:DescribeTrafficPackages。

名称 类型 描述
Id Integer 流量包 Id
Type String 流量包类型
Bytes Integer 流量包大小(单位为 Byte)
BytesUsed Integer 已消耗流量(单位为 Byte)
Status String 流量包状态
enabled:已启用
expired:已过期
disabled:未启用
CreateTime Timestamp 流量包发放时间
EnableTime Timestamp 流量包生效时间
ExpireTime Timestamp 流量包过期时间
ContractExtension Boolean 流量包是否续订
AutoExtension Boolean 流量包是否自动续订
Channel String 流量包来源
Area String 流量包生效区域,mainland或overseas
LifeTimeMonth Integer 流量包生命周期月数
ExtensionAvailable Boolean 流量包是否支持续订
RefundAvailable Boolean 流量包是否支持退费
Region Integer 流量包生效区域
0:中国大陆
1:亚太一区
2:亚太二区
3:亚太三区
4:中东
5:北美
6:欧洲
7:南美
8:非洲
注意:此字段可能返回 null,表示取不到有效值。
ConfigId Integer 流量包类型id
注意:此字段可能返回 null,表示取不到有效值。
ExtensionMode Integer 流量包当前续订模式,0 未续订、1到期续订、2用完续订、3到期或用完续订
注意:此字段可能返回 null,表示取不到有效值。
TrueEnableTime String 流量包实际生效时间
注意:此字段可能返回 null,表示取不到有效值。
TrueExpireTime String 流量包实际过期时间
注意:此字段可能返回 null,表示取不到有效值。

UrlRecord

封禁url的详细信息

被如下接口引用:GetDisableRecords。

名称 类型 描述
Status String 状态(disable表示封禁,enable表示解封)
注意:此字段可能返回 null,表示取不到有效值。
RealUrl String 对应的url
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
UpdateTime String 更新时间
注意:此字段可能返回 null,表示取不到有效值。

UrlRedirect

访问URL重写配置

被如下接口引用:DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String 访问URL重写配置开关
on:开启
off:关闭
PathRules Array of UrlRedirectRule 访问URL重写规则,当Switch为on时必填,规则数量最大为10个。
注意:此字段可能返回 null,表示取不到有效值。

UrlRedirectRule

Url重定向规则配置

被如下接口引用:UpdateDomainConfig。

名称 类型 必选 描述
RedirectStatusCode Integer 重定向状态码,301 | 302
Pattern String 待匹配的Url,仅支持Url路径,不支持参数。默认完全匹配,支持通配符 *,最多支持5个通配符,最大长度1024字符。
RedirectUrl String 目标URL,必须以“/”开头,不包含参数部分。最大长度1024字符。可使用$1, $2, $3, $4, $5分别捕获匹配路径中的通配符号,最多支持10个捕获值。
RedirectHost String 目标host,必须以http://或https://开头,并填写标准格式域名,如果不填写,默认为http:// + 当前域名
注意:此字段可能返回 null,表示取不到有效值。
FullMatch Boolean 指定是全路径配置还是任意匹配
注意:此字段可能返回 null,表示取不到有效值。

UserAgentFilter

UserAgent黑白名单配置

被如下接口引用:DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String 开关,on或off
注意:此字段可能返回 null,表示取不到有效值。
FilterRules Array of UserAgentFilterRule UA黑白名单生效规则列表
注意:此字段可能返回 null,表示取不到有效值。

UserAgentFilterRule

UserAgent黑白名单规则配置

被如下接口引用:UpdateDomainConfig。

名称 类型 必选 描述
RuleType String 访问路径生效类型
all: 所有访问路径生效
file: 根据文件后缀类型生效
directory: 根据目录生效
path: 根据完整访问路径生效
注意:此字段可能返回 null,表示取不到有效值。
RulePaths Array of String 访问路径生效内容
注意:此字段可能返回 null,表示取不到有效值。
UserAgents Array of String UserAgent列表
注意:此字段可能返回 null,表示取不到有效值。
FilterType String 黑名单或白名单,blacklist或whitelist
注意:此字段可能返回 null,表示取不到有效值。

VideoSeek

视频拖拽配置,默认为关闭状态

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String 视频拖拽开关
on:开启
off:关闭

ViolationUrl

违规 URL 详情

被如下接口引用:DescribeUrlViolations。

名称 类型 描述
Id Integer ID
RealUrl String 违规资源原始访问 URL
DownloadUrl String 快照路径,用于控制台展示违规内容快照
UrlStatus String 违规资源当前状态
forbid:已封禁
release:已解封
delay : 延迟处理
reject :申诉驳回,状态仍为封禁态
complain:申诉进行中
CreateTime Timestamp 创建时间
UpdateTime Timestamp 更新时间

WafSubRuleStatus

Waf子规则开关状态

被如下接口引用:CreateScdnDomain, DescribeScdnConfig, UpdateScdnDomain。

名称 类型 必选 描述
Switch String 子规则状态,on|off
SubIds Array of Integer 规则id列表

WebSocket

WebSocket配置

被如下接口引用:DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
Switch String WebSocket 超时配置开关, 开关为off时,平台仍支持WebSocket连接,此时超时时间默认为15秒,若需要调整超时时间,将开关置为on.

* WebSocket 为ECDN产品功能,如需使用请通过ECDN域名配置.
Timeout Integer 设置超时时间,单位为秒,最大超时时间300秒。
注意:此字段可能返回 null,表示取不到有效值。

WebpAdapter

图片优化-WebpAdapter配置

被如下接口引用:DescribeDomainsConfig, DescribeImageConfig, UpdateImageConfig。

名称 类型 必选 描述
Switch String 开关,"on/off"
注意:此字段可能返回 null,表示取不到有效值。
目录