数据结构

最近更新时间:2025-08-06 01:14:59

我的收藏

AccessControl

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

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

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

AccessControlRule

访问控制规则

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

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

AdvanceCacheRule

缓存配置高级版本规则

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

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

AdvanceConfig

高级配置集合

被如下接口引用:DescribeDomainsConfig。

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

AdvanceHttps

回源的自定义Https配置

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

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

AdvancedAuthentication

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

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

名称 类型 必选 描述
Switch String 防盗链配置开关,取值有:
on:开启
off:关闭
开启时必须且只配置一种模式,其余模式需要设置为 null
示例值:off
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配置。

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

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

AdvancedAuthenticationTypeB

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

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

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

AdvancedAuthenticationTypeC

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

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

名称 类型 必选 描述
AccessKey String 访问密钥。
示例值:AKIDz8dbsf3pJ9a1XqN
SecretKey String 鉴权密钥。
示例值:S8fKj3#WpQ2mL9Zx!

AdvancedAuthenticationTypeD

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

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

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

AdvancedAuthenticationTypeE

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

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

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

AdvancedAuthenticationTypeF

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

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

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

AdvancedCache

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

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

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

Authentication

时间戳防盗链配置

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

名称 类型 必选 描述
Switch String 防盗链配置开关,取值有:
on:开启
off:关闭
开启时必须且只配置一种模式,其余模式需要设置为 null
示例值:off
AuthAlgorithm String 鉴权算法,取值有:
md5:按MD5算法取hash值
sha256:按SHA-256算法取hash值
默认为 md5
注意:此字段可能返回 null,表示取不到有效值。
示例值:md5
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, DescribeDomainsConfig, UpdateDomainConfig。

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

AuthenticationTypeB

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

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

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

AuthenticationTypeC

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

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

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

AuthenticationTypeD

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

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

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

AvifAdapter

图片优化-AvifAdapter配置

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

名称 类型 必选 描述
Switch String 图片优化AvifAdapter配置项开关,取值有:
on:开启
off:关闭
注意:此字段可能返回 null,表示取不到有效值。
示例值:on/off
FallbackFormats Array of String 当原图是 avif 且客户端 Accept 头包含 image/avif 时,直接返回原图。
当原图是 avif 且客户端 Accept 头不包含 image/avif 时但包含 image/webp,将 avif 转 webp 格式返回。如果 Accept 头不包含 image/webp, 则转 jpeg 返回。

可用的枚举值:
- []
- ["webp"]
- ["jpeg"]
- ["webp", "jpeg"]

"webp":是否开启 avif 转 webp,"jpeg": 是否开启 avif 转 jpeg。如果 webp 和 jpeg 都开启的情况下,webp 必须在 jpeg 前面。
注意:此字段可能返回 null,表示取不到有效值。
示例值:["webp", "jpeg"]

AwsPrivateAccess

s3源站回源鉴权。

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

名称 类型 必选 描述
Switch String s3源站回源鉴权配置项开关,取值有:
on:开启
off:关闭
示例值:on
AccessKey String 访问ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:dfss12nk
SecretKey String 密钥,字段为脱敏返回。
注意:此字段可能返回 null,表示取不到有效值。
示例值:wn***mg
Region String 地域
注意:此字段可能返回 null,表示取不到有效值。
示例值:gz
Bucket String Bucketname
注意:此字段可能返回 null,表示取不到有效值。
示例值:hw-oss

BandwidthAlert

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

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

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

BriefDomain

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

被如下接口引用:DescribeDomains。

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

Cache

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

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

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

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

CacheConfig

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

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

名称 类型 必选 描述
HeuristicCacheTimeSwitch String 启发式自定义时间缓存配置开关,取值有:
on:开启
off:关闭
注意:此字段可能返回 null,表示取不到有效值。
示例值:on
HeuristicCacheTime Integer 单位 秒.
注意:此字段可能返回 null,表示取不到有效值。
示例值:10

CacheConfigCache

路径缓存缓存配置

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

名称 类型 必选 描述
Switch String 路径缓存配置开关,取值有:
on:开启
off:关闭
注意:此字段可能返回 null,表示取不到有效值。
示例值:on
CacheTime Integer 缓存过期时间设置
单位为秒,最大可设置为 365 天
注意:此字段可能返回 null,表示取不到有效值。
示例值:600
CompareMaxAge String 高级缓存过期配置,开启时会对比源站返回的 max-age 值与 CacheRules 中设置的缓存过期时间,取最小值在节点进行缓存
on:开启
off:关闭
默认为关闭状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:off
IgnoreCacheControl String 强制缓存
on:开启
off:关闭
默认为关闭状态,开启后,源站返回的 no-store、no-cache 资源,也将按照 CacheRules 规则进行缓存
注意:此字段可能返回 null,表示取不到有效值。
示例值:off
IgnoreSetCookie String 当源站返回Set-Cookie头部时,节点是否缓存该头部及body
on:开启,不缓存该头部及body
off:关闭,遵循用户自定义的节点缓存规则
默认为关闭状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:off
OriginMtimeCheckType String 当缓存过期后,是否开启源站 mtime 校验,配置值为equal、since、none 和 null。默认配置值为equal,会校验源站文件的mtime与长度。2024-09-12 18:00 之前创建的域名默认值 null,行为保持不变。
equal:源站响应mtime必须和缓存mtime一致,若mtime值不一致,清除缓存。
since:若源站响应mtime大于缓存mtime,清除缓存。
none: 缓存过期回源重新获取文件mtime和长度后,不会校验源站响应mtime,若源站响应携带Content-Length头部,只有文件大小改变时才会更新缓存;若源站响应不携带Content-Length头部,会更新缓存。
注意:此字段可能返回 null,表示取不到有效值。
示例值:equal

CacheConfigFollowOrigin

路径缓存遵循源站配置

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

名称 类型 必选 描述
Switch String 路径缓存遵循源站配置开关,取值有:
on:开启
off:关闭
示例值:on
HeuristicCache HeuristicCache 启发式缓存配置
注意:此字段可能返回 null,表示取不到有效值。
OriginMtimeCheckType String 当缓存过期后,是否开启源站 mtime 校验,配置值为equal、since、none 和 null。默认配置值为equal,会校验源站文件的mtime与长度。2024-09-12 18:00 之前创建的域名默认值 null,行为保持不变。
equal:源站响应mtime必须和缓存mtime一致,若mtime值不一致,清除缓存。
since:若源站响应mtime大于缓存mtime,清除缓存。
none: 缓存过期回源重新获取文件mtime和长度后,不会校验源站响应mtime,若源站响应携带Content-Length头部,只有文件大小改变时才会更新缓存;若源站响应不携带Content-Length头部,会更新缓存。
注意:此字段可能返回 null,表示取不到有效值。
示例值:equal

CacheConfigNoCache

路径缓存不缓存配置

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

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

CacheKey

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

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

名称 类型 必选 描述
FullUrlCache String 是否开启全路径缓存
on:开启全路径缓存(即关闭参数忽略)
off:关闭全路径缓存(即开启参数忽略)
示例值:off
IgnoreCase String 是否忽略大小写缓存
on:开启
off:关闭
注意:此字段可能返回 null,表示取不到有效值。
示例值:off
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,表示取不到有效值。
示例值:https://qq.com/SuccessUrls
FailUrls Array of String 失败的url列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:https://qq.com/FailUrls

CacheTagKey

组成CacheKey的一部分

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

名称 类型 必选 描述
Switch String 使用CacheTag作为CacheKey的一部分配置开关,取值有
on:开启,使用CacheTag作为CacheKey的一部分
off:关闭,不使用CacheTag作为CacheKey的一部分
注意:此字段可能返回 null,表示取不到有效值。
示例值:off
Value String 自定义CacheTag的值
注意:此字段可能返回 null,表示取不到有效值。
示例值:CacheTagValue

CappingRule

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

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

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

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 开头状态码数据,单位为 个
或指定查询的某一具体状态码
示例值:flux
DetailData Array of TimestampData 明细数据组合
SummarizedData SummarizedData 汇总数据组合

CdnIp

IP 属性信息

被如下接口引用:DescribeCdnIp。

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

CdnIpHistory

CDN 节点上下线历史记录

被如下接口引用:DescribeCdnIp。

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

ClientCert

https 客户端证书配置

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

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

ClientInfo

客户端信息

被如下接口引用:ListDiagnoseReport。

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

ClsLogIpData

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

被如下接口引用:ListTopClsLogData。

名称 类型 描述
ClientIp String IP
示例值:1.1.1.1
Request Integer 在给定的时间段中,1秒内的最大请求量
示例值:10
Count Integer 在获取的Top信息中,IP出现的次数
示例值:2
Time String 在给定的时间段中,1秒内的最大请求量对应的时间
示例值:2021-10-01 00:00:00

ClsLogObject

CLS日志搜索对象

被如下接口引用:SearchClsLog。

名称 类型 描述
TopicId String 主题ID
示例值:0c1bbb5a-2141-4db8-a1f8-2dsa93ec842d
TopicName String 主题名字
示例值:topic-name
Timestamp String 日志时间
示例值:1744353242526
Content String 日志内容
示例值:content
Filename String 采集路径
示例值:/data/log
Source String 日志来源设备
示例值:10.0.0.1

ClsSearchLogs

Cls日志搜索结果

被如下接口引用:SearchClsLog。

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

Compatibility

是否兼容旧版配置

被如下接口引用:DescribeDomainsConfig。

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

Compression

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

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

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

CompressionRule

智能压缩规则配置

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

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

CookieKey

组成CacheKey的一部分

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

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

DetailDomain

加速域名全量配置信息

被如下接口引用:DescribeDomainsConfig。

名称 类型 描述
ResourceId String 域名 ID
示例值:cdn-00001x
AppId Integer 腾讯云账号ID
示例值:100000001
Domain String 加速域名
示例值:www.test.com
Cname String 域名对应的 CNAME 地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:www.test.com.cdn.dnsv1.com
Status String 加速服务状态
rejected:域名审核未通过,域名备案过期/被注销导致
processing:部署中
closing:关闭中
online:已启动
offline:已关闭
示例值:online
ProjectId Integer 项目 ID,可前往腾讯云项目管理页面查看
示例值:0
ServiceType String 加速域名业务类型
web:网页小文件
download:下载大文件
media:音视频点播
hybrid: 动静加速
dynamic: 动态加速
示例值:web
CreateTime Timestamp 域名创建时间
示例值:2020-01-01 00:00:00
UpdateTime Timestamp 域名更新时间
示例值:2021-01-01 00:00:00
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,表示取不到有效值。
示例值:normal
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,表示取不到有效值。
示例值:mainland
Readonly String 域名锁定状态
normal:未锁定
mainland:中国境内锁定
overseas:中国境外锁定
global:全球锁定
注意:此字段可能返回 null,表示取不到有效值。
示例值:normal
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,表示取不到有效值。
示例值:on
UrlRedirect UrlRedirect URL重定向配置
注意:此字段可能返回 null,表示取不到有效值。
AccessPort Array of Integer 访问端口配置
注意:此字段可能返回 null,表示取不到有效值。
示例值:[80,8080,443]
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,表示取不到有效值。
示例值:qq.com
HwPrivateAccess HwPrivateAccess 华为云对象存储回源鉴权
注意:此字段可能返回 null,表示取不到有效值。
QnPrivateAccess QnPrivateAccess 七牛云对象存储回源鉴权
注意:此字段可能返回 null,表示取不到有效值。
HttpsBilling HttpsBilling HTTPS服务,缺省时默认开启
注意:此字段可能返回 null,表示取不到有效值。
OthersPrivateAccess OthersPrivateAccess 其他厂商对象存储回源鉴权
注意:此字段可能返回 null,表示取不到有效值。
ParamFilter ParamFilter 参数黑名单
注意:此字段可能返回 null,表示取不到有效值。

DiagnoseData

诊断报告内容数据

被如下接口引用:DescribeDiagnoseReport。

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

DiagnoseInfo

诊断信息

被如下接口引用:ListDiagnoseReport。

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

DiagnoseList

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

被如下接口引用:ListDiagnoseReport。

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

DiagnoseUnit

诊断报告单元信息

被如下接口引用:DescribeDiagnoseReport。

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

DistrictIspInfo

地区运营商明细数据

被如下接口引用:DescribeDistrictIspData。

名称 类型 描述
Domain String 域名
示例值:qq.com
Protocol String 协议类型
示例值:https
IpProtocol String IP协议类型
示例值:ipv4
StartTime Timestamp 起始时间
示例值:2023-06-28 17:02:24
EndTime Timestamp 结束时间
示例值:2023-06-28 18:02:24
Interval Integer 时间间隔,单位为分钟
示例值:5
Metric String 指标名称
示例值:flux
District Integer 地区ID
示例值:1
Isp Integer 运营商ID
示例值:1
DataPoints Array of Integer 指标数据点
示例值:100
DistrictName String 地区名称
示例值:广东
IspName String 运营商名称
示例值:电信

DomainAreaConfig

域名地区配置

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

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

DomainFilter

域名查询时过滤条件。

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

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

DomainLog

日志包下载链接详情

被如下接口引用:DescribeCdnDomainLogs。

名称 类型 描述
StartTime Timestamp 日志包起始时间
示例值:2025-03-25 12:00:00
EndTime Timestamp 日志包结束时间
示例值:2025-03-25 17:00:00
LogPath String 日志包下载链接
示例值:https://log-download.cdn.qcloud.com/20250325/19/2025032519-qq.com.gz
Area String 日志包对应加速区域
mainland:境内
overseas:境外
示例值:mainland
LogName String 日志包文件名
示例值:2025032519-qq.com-mainland
FileSize Integer 文件大小,单位: Byte
注意:此字段可能返回 null,表示取不到有效值。
示例值:1024

DownstreamCapping

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

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

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

EdgePackTaskFilter

动态打包任务过滤器

被如下接口引用:DescribeEdgePackTaskStatus。

名称 类型 必选 描述
Name String 过滤字段名
apk: apk名称
status: 母包处理进度 done, failed, processing
示例值:apk
Value Array of String 过滤字段值
示例值:["test.apk"]
Fuzzy Boolean 是否启用模糊查询,仅支持过滤字段名为 apk。
模糊查询时,Value长度最大为1。
示例值:true

EdgePackTaskStatus

动态打包任务状态

被如下接口引用:DescribeEdgePackTaskStatus。

名称 类型 描述
Apk String APK 名称
示例值:test.apk
DstDir String 输出目录
示例值:/ext/
UploadTime Timestamp ISO8601 上传时间
示例值:2023-01-10T18:51:44+08:00
Status String 任务状态
created: 创建成功
processing: 处理中
done: 处理完成
failed: 处理失败
示例值:created
SrcDir Array of String 上传目录
示例值:/src/
StatusDesc String 失败任务状态详情
示例值:APK 签名不一致

ErrorPage

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

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

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

ErrorPageRule

状态码重定向规则配置

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

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

ExtraLogset

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

被如下接口引用:ListClsLogTopics。

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

FollowRedirect

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

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

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

ForceRedirect

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

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

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

GuetzliAdapter

图片优化-GuetzliAdapter配置

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

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

HTTPHeader

HTTP 请求头

被如下接口引用:PushUrlsCache。

名称 类型 必选 描述
Name String 请求头名称
示例值:User-Agent
Value String 请求头值
示例值:TencentCDN

HeaderKey

组成CacheKey

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

名称 类型 必选 描述
Switch String 组成Cachekey配置开关,取值有:
on:开启
off:关闭
注意:此字段可能返回 null,表示取不到有效值。
示例值:off
Value String 组成CacheKey的header数组,';' 分割
注意:此字段可能返回 null,表示取不到有效值。
示例值:header value

HeuristicCache

启发式缓存配置

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

名称 类型 必选 描述
Switch String 启发式缓存配置开关,取值有:
on:开启
off:关闭(默认)
注意:此字段可能返回 null,表示取不到有效值。
示例值:on
CacheConfig CacheConfig 自定义启发式缓存时间配置
注意:此字段可能返回 null,表示取不到有效值。

Hsts

HSTS 配置。

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

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

HttpHeaderPathRule

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

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

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

HttpHeaderRule

http头部设置规则。

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

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

Https

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

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

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

HttpsBilling

HTTPS服务,若关闭,下发配置拦截https请求,开启时会产生计费

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

名称 类型 必选 描述
Switch String HTTPS服务配置开关,取值有:
on:开启,缺省时默认开启,会产生计费
off:关闭,拦截https请求

示例值:on/off

HttpsPackage

CDN HTTPS请求包。

被如下接口引用:DescribeHttpsPackages。

名称 类型 描述
Id Integer HTTPS请求包 Id
示例值:30000001
Type String HTTPS请求包类型
示例值:Https请求资源包
Size Integer HTTPS请求包大小(单位为:次)
示例值:10000
SizeUsed Integer 已消耗HTTPS请求包(单位为:次)
示例值:100
Status String HTTPS请求包状态
enabled:已启用
expired:已过期
disabled:未启用
示例值:enable
CreateTime String HTTPS请求包发放时间
示例值:2021-09-01 00:00:00
EnableTime String HTTPS请求包生效时间
示例值:2021-09-01 00:00:00
ExpireTime String HTTPS请求包过期时间
示例值:2021-09-01 00:00:00
Channel String HTTPS请求包来源
示例值:CDN_GIFT
LifeTimeMonth Integer HTTPS请求包生命周期月数
示例值:1
RefundAvailable Boolean HTTPS请求包是否支持退费
示例值:false
ConfigId Integer HTTPS请求包类型id
示例值:101
TrueEnableTime String HTTPS请求包实际生效时间
示例值:2022-08-02 10:00:00
TrueExpireTime String HTTPS请求包实际过期时间
示例值:2022-08-02 23:59:59
Area String HTTPS请求包生效区域
global:全球
示例值:global
ContractExtension Boolean HTTPS请求包是否续订
示例值:false
ExtensionAvailable Boolean HTTPS请求包是否支持续订
示例值:false
ExtensionMode Integer HTTPS请求包当前续订模式
0:未续订
1:到期续订
2:用完续订
3:到期或用完续订
示例值:0
AutoExtension Boolean HTTPS请求包是否自动续订
注意:此字段可能返回 null,表示取不到有效值。
示例值:false

HwPrivateAccess

华为云对象存储回源鉴权

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

名称 类型 必选 描述
Switch String 华为云对象存储回源鉴权配置开关,取值有:
on:开启
off:关闭
示例值:on
AccessKey String 访问 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:SYWKY0DAR8I5NXZO93YT
SecretKey String 密钥,字段为脱敏返回。
注意:此字段可能返回 null,表示取不到有效值。
示例值:wn***mg
Bucket String bucketname
注意:此字段可能返回 null,表示取不到有效值。
示例值:hw-1-163

ImageOptimization

ImageOptimization配置

被如下接口引用:DescribeDomainsConfig。

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

IpFilter

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

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

名称 类型 必选 描述
Switch String IP 黑白名单配置开关,取值有
on:开启
off:关闭
示例值:on
FilterType String IP 黑白名单类型
whitelist:白名单
blacklist:黑名单
注意:此字段可能返回 null,表示取不到有效值。
示例值:blacklist
Filters Array of String IP 黑白名单列表
支持 X.X.X.X 格式IPV4地址 或X:X:X:X:X:X:X:X 格式IPV6地址, 或网段格式/X(IPV4:1≤X≤32;IPV6:1≤X≤128)
最多可填充 200 个白名单或 200 个黑名单;
注意:此字段可能返回 null,表示取不到有效值。
示例值:["1.1.1.1"]
FilterRules Array of IpFilterPathRule IP 黑白名单分路径配置,白名单功能。黑白名单 IP 总数不能超过 1000 个。
注意:此字段可能返回 null,表示取不到有效值。
示例值:null
ReturnCode Integer IP 黑白名单验证失败时返回的 code
已下线,参数失效,不支持自定义状态码,固定返回514
注意:此字段可能返回 null,表示取不到有效值。
示例值:514

IpFilterPathRule

IP黑白名单分路径配置

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

名称 类型 必选 描述
FilterType String IP 黑白名单类型
whitelist:白名单
blacklist:黑名单
注意:此字段可能返回 null,表示取不到有效值。
示例值:whitelist
Filters Array of String IP 黑白名单列表
支持 X.X.X.X 格式IPV4地址 或X:X:X:X:X:X:X:X 格式IPV6地址, 或网段格式/X(IPV4:1≤X≤32;IPV6:1≤X≤128)
最多可填充 500 个白名单或 200 个黑名单;
注意:此字段可能返回 null,表示取不到有效值。
示例值:1.1.1.1
RuleType String 规则类型:
all:所有文件生效
file:指定文件后缀生效
directory:指定路径生效
path:指定绝对路径生效
注意:此字段可能返回 null,表示取不到有效值。
示例值:file
RulePaths Array of String RuleType 对应类型下的匹配内容:
all 时填充 *
file 时填充后缀名,如 jpg、txt
directory 时填充路径,如 /xxx/test/
path 时填充绝对路径,如 /xxx/test.html
注意:此字段可能返回 null,表示取不到有效值。
示例值:jpg
Remark String 备注信息, 最多支持50个字符
示例值:remark

IpFreqLimit

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

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

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

IpStatus

节点 IP 信息

被如下接口引用:DescribeIpStatus。

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

Ipv6

Ipv6源站启用配置,不可更改

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

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

Ipv6Access

Ipv6访问配置

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

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

KeyRule

缓存键分路径配置

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

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

LogSetInfo

日志集信息

被如下接口引用:ListClsLogTopics。

名称 类型 描述
AppId Integer 开发者ID
示例值:1254086605
Channel String 渠道
注意:此字段可能返回 null,表示取不到有效值。
示例值:cdn
LogsetId String 日志集ID
示例值:4d849a88-13ef-40cd-9785-bd663ea47d7e
LogsetName String 日志集名字
示例值:cdn_logset_cn
IsDefault Integer 是否默认日志集
示例值:1
LogsetSavePeriod Integer 日志保存时间,单位为天
示例值:7
CreateTime Timestamp 创建日期
示例值:2021-09-01 17:33:22
Region String 区域
示例值:上海
Deleted String cls侧是否已经被删除
注意:此字段可能返回 null,表示取不到有效值。
示例值:no
RegionEn String 英文区域
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-shanghai

MainlandConfig

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

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

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, 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,表示取不到有效值。
示例值:web
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
示例值:-1
Name String 对象名称
示例值:海外

MaxAge

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

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

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

MaxAgeCodeRule

MaxAge 状态码相关规则配置

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

名称 类型 必选 描述
Action String 处理动作
clear:清除 cache-control 头部
示例值:clear
StatusCodes Array of String 指定HTTP状态码生效,当前仅支持填写"400-599"
示例值:["400-599"]

MaxAgeRule

MagAge 规则配置

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

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

OfflineCache

离线缓存是否开启

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

名称 类型 必选 描述
Switch String 离线缓存配置开关,取值有:
on:开启
off:关闭
示例值:off

Origin

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

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

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

名称 类型 必选 描述
Origins Array of String 主源站列表
修改源站时,需要同时填充对应的 OriginType
注意:此字段可能返回 null,表示取不到有效值。
示例值:["1.1.1.1"]
OriginType String 主源站类型
当源站列表 Origins 不为空时必填
入参支持以下几种类型:
domain:域名类型
domainv6:域名解析V6类型
cos:对象存储源站
third_party: 第三方存储源站
igtm: IGTM多活源
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,表示取不到有效值。
示例值:ip
ServerName String 回主源站时 Host 头部
当源站类型为cos或者第三方存储加速时,ServerName字段必填
不填充则默认为加速域名
若接入的是泛域名,则回源 Host 默认为访问时的子域名
注意:此字段可能返回 null,表示取不到有效值。
示例值:www.test.com
CosPrivateAccess String OriginType 为对象存储(COS)时,可以指定是否允许访问私有 bucket
注意:需要先授权 CDN 访问该私有 Bucket 的权限后,才可开启此配置。取值范围: on/off
注意:此字段可能返回 null,表示取不到有效值。
示例值:off
OriginPullProtocol String 回源协议配置
http:强制 http 回源
follow:协议跟随回源
https:强制 https 回源
注意:此字段可能返回 null,表示取不到有效值。
示例值:http
BackupOrigins Array of String 备源站列表
修改备源站时,需要同时填充对应的 BackupOriginType
注意:此字段可能返回 null,表示取不到有效值。
示例值:["2.2.2.2"]
BackupOriginType String 备源站类型
备源站列表BackupOrigins 不为空时必填
支持以下类型:
domain:域名类型
ip:IP 列表作为源站
以下备源源站类型尚未全量支持,需要申请试用:
ipv6_domain: 源站列表为多个 IPv6 地址以及域名
ip_ipv6:源站列表为多个 IPv4 地址和IPv6 地址
ipv6_domain: 源站列表为多个 IPv6 地址以及域名
ip_ipv6_domain:源站列表为多个 IPv4 地址IPv6 地址以及域名
注意:此字段可能返回 null,表示取不到有效值。
示例值:ip
BackupServerName String 回备源站时 Host 头部,不填充则默认为主源站的 ServerName
注意:此字段可能返回 null,表示取不到有效值。
示例值:www.test2.com
BasePath String 回源路径
注意:此字段可能返回 null,表示取不到有效值。
示例值:/data
PathRules Array of PathRule 回源路径重写规则配置
注意:此字段可能返回 null,表示取不到有效值。
PathBasedOrigin Array of PathBasedOriginRule 分路径回源配置
注意:此字段可能返回 null,表示取不到有效值。
Sni OriginSni HTTPS回源SNI配置
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"Switch":"on","ServerName":"abc.com"}
AdvanceHttps AdvanceHttps HTTPS回源高级配置
注意:此字段可能返回 null,表示取不到有效值。
示例值:null
OriginCompany String 对象存储回源厂商
当源站类型为第三方存储源站(third_party)时必填
可选值包括以下:
aws_s3: AWS S3
ali_oss: 阿里云 OSS
hw_obs: 华为 OBS
qiniu_kodo: 七牛云 kodo
others: 其它厂商对象存储,仅支持兼容以AWS签名算法的对象存储,如腾讯云金融专区COS
注意:此字段可能返回 null,表示取不到有效值。
示例值:hw-oss

OriginAuthentication

回源鉴权高级配置

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

名称 类型 必选 描述
Switch String 回源鉴权高级配置开关,取值有:
on:开启
off:关闭

注意:此字段可能返回 null,表示取不到有效值。
示例值:off
TypeA OriginAuthenticationTypeA 鉴权类型A配置
注意:此字段可能返回 null,表示取不到有效值。

OriginAuthenticationTypeA

回源鉴权高级配置TypeA

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

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

OriginCombine

合并回源配置项

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

名称 类型 必选 描述
Switch String 合并回源配置开关,取值有:
on:开启
off:关闭
示例值:off

OriginIp

CDN回源节点IP信息

被如下接口引用:DescribeCdnOriginIp。

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

OriginPullOptimization

跨国回源优化配置,默认为关闭状态 (已下线)

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

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

OriginPullTimeout

回源超时配置

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

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

OriginSni

HTTPS回源SNI

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

名称 类型 必选 描述
Switch String 是否开启HTTPS回源SNI。
开启:on,
关闭:off
示例值:on
ServerName String 回源域名。
注意:此字段可能返回 null,表示取不到有效值。
示例值:qq.com

OssPrivateAccess

oss回源鉴权

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

名称 类型 必选 描述
Switch String oss回源鉴权配置开关,取值有:
on:开启
off:关闭
示例值:on
AccessKey String 访问ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:AKkjqrfjaoidn
SecretKey String 密钥,字段为脱敏返回。
注意:此字段可能返回 null,表示取不到有效值。
示例值:wn***mg
Region String 地域
注意:此字段可能返回 null,表示取不到有效值。
示例值:gz
Bucket String Bucketname
注意:此字段可能返回 null,表示取不到有效值。
示例值:hw-oss

OthersPrivateAccess

其他厂商对象存储回源鉴权

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

名称 类型 必选 描述
Switch String 其他厂商对象存储回源鉴权配置开关,取值有:
on:开启
off:关闭
示例值:on
AccessKey String 访问ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:TXUIWY0BAR8I5NXZ693YU
SecretKey String 密钥,字段位脱敏返回。
注意:此字段可能返回 null,表示取不到有效值。
示例值:wn***mg
Region String 地域。
注意:此字段可能返回 null,表示取不到有效值。
示例值:gz
Bucket String 存储桶名称。
注意:此字段可能返回 null,表示取不到有效值。
示例值:bucket-name

OverseaConfig

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

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

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, 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,表示取不到有效值。
示例值:web
StatusCodeCache StatusCodeCache 状态码缓存配置。
注意:此字段可能返回 null,表示取不到有效值。
VideoSeek VideoSeek 视频拖拽配置。
注意:此字段可能返回 null,表示取不到有效值。
AwsPrivateAccess AwsPrivateAccess 回源S3私有鉴权。
注意:此字段可能返回 null,表示取不到有效值。
OssPrivateAccess OssPrivateAccess 回源OSS私有鉴权。
注意:此字段可能返回 null,表示取不到有效值。
HwPrivateAccess HwPrivateAccess 华为云对象存储鉴权
注意:此字段可能返回 null,表示取不到有效值。
QnPrivateAccess QnPrivateAccess 七牛云对象存储鉴权
注意:此字段可能返回 null,表示取不到有效值。

ParamFilter

参数黑名单

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

名称 类型 必选 描述
Switch String 参数黑名单开关
注意:此字段可能返回 null,表示取不到有效值。
示例值:off
FilterRules Array of ParamFilterRule 参数黑名单规则
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]

ParamFilterRule

参数黑名单规则

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

名称 类型 必选 描述
Key String 参数名
注意:此字段可能返回 null,表示取不到有效值。
示例值:exampleParam
Values Array of String 参数值数组, 小于10个
注意:此字段可能返回 null,表示取不到有效值。
示例值:['blacklistValue1', 'blacklistValue2']
ReturnCode String http 返回码 ( 暂仅支持403)
注意:此字段可能返回 null,表示取不到有效值。
示例值:403

PathBasedOriginRule

分路径回源规则

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

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

PathRule

分路径回源配置规则。

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

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

PostSize

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

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

名称 类型 必选 描述
Switch String POST请求上传文件流式传输最大限制配置开关,取值有:
on:开启,平台默认为32MB
off:关闭

示例值:on/off
MaxSize Integer 最大限制,取值在1MB和200MB之间。
示例值:32

PurgeTask

刷新任务详情

被如下接口引用:DescribePurgeTasks。

名称 类型 描述
TaskId String 刷新任务 ID
示例值:98547009889354471
Url String 刷新 URL
示例值:https://qq.com/purge
Status String 刷新任务状态
fail:刷新失败
done:刷新成功
process:刷新中
示例值:done
PurgeType String 刷新类型
url:URL 刷新
path:目录刷新
示例值:url
FlushType String 刷新方式
flush:刷新更新资源(仅目录刷新时有此类型)
delete:刷新全部资源
示例值:flush
CreateTime Timestamp 刷新任务提交时间
示例值:2023-06-28 16:13:27

PushTask

预热任务详情

被如下接口引用:DescribePushTasks。

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

QnPrivateAccess

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

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

名称 类型 必选 描述
Switch String 七牛元对象存储回源鉴权配置开关,取值有:
on:开启
off:关闭
示例值:on
AccessKey String 访问 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:ousbDM5xlzuAZJEhhwcLj8makXkYiaAvciZHqAQj
SecretKey String 密钥,字段为脱敏返回。
示例值:wn***mg

QueryStringKey

组成CacheKey的一部分

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

名称 类型 必选 描述
Switch String CacheKey是否由QueryString组成配置开关,取值有:
on:开启
off:关闭
注意:此字段可能返回 null,表示取不到有效值。
示例值:on
Reorder String 是否重新排序
注意:此字段可能返回 null,表示取不到有效值。
示例值:off
Action String 使用/排除部分url参数,取值有:
includeAll:包含所有
excludeAll:排除所有
includeCustom:自定义包含
excludeCustom:自定义排除
注意:此字段可能返回 null,表示取不到有效值。
示例值:includeCustom
Value String 使用/排除的url参数数组,';' 分割
注意:此字段可能返回 null,表示取不到有效值。
示例值:key1;key2

Quic

Quic配置项

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

名称 类型 必选 描述
Switch String Quic功能配置开关,取值有:
on:开启
off:关闭
示例值:on/off

Quota

刷新/预热 可用量及配额

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

名称 类型 描述
Batch Integer 单次批量提交配额上限。
示例值:10
Total Integer 每日提交配额上限。
示例值:100
Available Integer 每日剩余的可提交配额。
示例值:90
Area String 配额的区域。
示例值:mainland

RangeOriginPull

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

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

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

RangeOriginPullRule

分路径分片回源配置

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

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

RedirectConfig

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

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

名称 类型 必选 描述
Switch String 自定义回源302 follow请求host配置开关,取值有:
on:开启
off:关闭
示例值:on
FollowRedirectHost String 主源站follow302请求时带的自定义的host头部
示例值:main.host.com
FollowRedirectBackupHost String 备份源站follow302请求时带的自定义的host头部
示例值:backup.host.com

Referer

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

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

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

RefererRule

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

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

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

RegionMapRelation

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

被如下接口引用:DescribeMapInfo。

名称 类型 描述
RegionId Integer 区域ID。
示例值:-20
SubRegionIdList Array of Integer 子区域ID列表
示例值:-15,35

RemoteAuthentication

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

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

名称 类型 必选 描述
Switch String 远程鉴权配置开关,取值有:
on:开启
off:关闭
注意:此字段可能返回 null,表示取不到有效值。
示例值:on
RemoteAuthenticationRules Array of RemoteAuthenticationRule 远程鉴权规则配置
注意:此字段可能返回 null,表示取不到有效值。
示例值:"RemoteAuthentication":{"RemoteAuthenticationRule":[{"Server":"h
Server String 远程鉴权Server
注意:此字段可能返回 null,表示取不到有效值。
示例值:http://auth.com/a.php

RemoteAuthenticationRule

远程鉴权规则。

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

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

ReportData

CDN报表数据

被如下接口引用:DescribeReportData。

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

RequestHeader

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

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

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

ResourceBillingData

计费数据明细

被如下接口引用:DescribeBillingData。

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

ResourceData

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

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

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

ResourceOriginData

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

被如下接口引用:DescribeOriginData。

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

ResponseHeader

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

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

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

ResponseHeaderCache

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

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

名称 类型 必选 描述
Switch String 源站头部缓存配置开关,取值有:
on:开启
off:关闭
示例值:off

Revalidate

是否回源站校验

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

名称 类型 必选 描述
Switch String 总是回源校验配置开关,取值有:
on:开启
off:关闭

注意:此字段可能返回 null,表示取不到有效值。
示例值:off
Path String 只在特定请求路径回源站校验
注意:此字段可能返回 null,表示取不到有效值。
示例值:/data

RuleCache

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

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

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

RuleCacheConfig

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

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

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

RuleEngine

规则引擎配置

被如下接口引用:DescribeDomainsConfig。

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

RuleQueryString

路径保留参数配置

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

名称 类型 必选 描述
Switch String 路径保留参数配置开关,取值有:
on:开启,CacheKey由QueryString组成
off:关闭,CacheKey不由QueryString组成

注意:此字段可能返回 null,表示取不到有效值。
示例值:off
Action String includeCustom 包含部分url参数
注意:此字段可能返回 null,表示取不到有效值。
示例值:includeAll
Value String 使用/排除的url参数数组,';' 分割
注意:此字段可能返回 null,表示取不到有效值。
示例值:example-value

SchemeKey

作为CacheKey的一部分

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

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

SecurityConfig

scdn相关的配置

被如下接口引用:DescribeDomainsConfig。

名称 类型 描述
Switch String scdn 安全配置开关,取值有:
on:开启
off:关闭
示例值:on

Seo

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

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

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

ServerCert

https 加速服务端证书配置:

  • 支持使用托管至 SSL 证书管理的证书进行部署
  • 支持上传 PEM 格式的证书进行部署

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

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

ShareCname

ShareCname配置
ShareCname 为内测功能,如需使用,请联系腾讯云工程师开白.

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

名称 类型 必选 描述
Switch String ShareCname 配置开关, 取值有:
on:开启,使用共享CNAME
off:关闭,使用默认CNAME

示例值:off
Cname String 设置共享CNAME.
注意:此字段可能返回 null,表示取不到有效值。
示例值:mycname-12345.shared.cdn.dnsv1.com

SimpleCache

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

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

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

SimpleCacheRule

缓存过期规则配置

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

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

Sort

查询结果排序条件

被如下接口引用:DescribeDomainsConfig。

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

SpecificConfig

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

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

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

StatisticItem

累计用量封顶的配置

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

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

StatusCodeCache

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

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

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

StatusCodeCacheRule

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

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

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

SummarizedData

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

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

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

Tag

域名标签配置

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

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

TimestampData

时间戳与其对应的数值

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

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

TopData

排序类型数据结构

被如下接口引用:ListTopData。

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

TopDataMore

排序类型数据结构

被如下接口引用:DescribeTopData。

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

TopDetailData

排序类型的数据结构

被如下接口引用:ListTopData。

名称 类型 描述
Name String 数据类型的名称
示例值:qq.com
Value Float 数据值
示例值:10

TopDetailDataMore

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

被如下接口引用:DescribeTopData。

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

TopicInfo

CLS主题信息

被如下接口引用:ListClsLogTopics。

名称 类型 描述
TopicId String 主题ID
示例值:def811bf-867e-405c-bbc2-521crr2a3aea
TopicName String 主题名字
示例值:cdn-topic1
Enabled Integer 是否启用投递
示例值:1
CreateTime Timestamp 创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:YYYY-MM-DD HH:mm:ss
Channel String 归属于cdn或ecdn
注意:此字段可能返回 null,表示取不到有效值。
示例值:cdn
Deleted String cls侧是否已经被删除
注意:此字段可能返回 null,表示取不到有效值。
示例值:no

TpgAdapter

图片优化-TpgAdapter配置

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

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

TrafficPackage

CDN加速流量包。

被如下接口引用:DescribeTrafficPackages。

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

UrlRecord

封禁url的详细信息

被如下接口引用:GetDisableRecords。

名称 类型 描述
Status String 状态(disable表示封禁,enable表示解封)
注意:此字段可能返回 null,表示取不到有效值。
示例值:disable
RealUrl String 对应的url
注意:此字段可能返回 null,表示取不到有效值。
示例值:https://qq.com/disable
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2023-06-28 17:02:24
UpdateTime String 更新时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2023-06-28 17:02:24

UrlRedirect

访问URL重写配置

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

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

UrlRedirectRule

Url重定向规则配置

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

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

UserAgentFilter

UserAgent黑白名单配置

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

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

UserAgentFilterRule

UserAgent黑白名单规则配置

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

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

VideoSeek

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

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

名称 类型 必选 描述
Switch String 视频拖拽配置开关,取值有:
on:开启
off:关闭
示例值:off

ViolationUrl

违规 URL 详情

被如下接口引用:DescribeUrlViolations。

名称 类型 描述
Id Integer ID
示例值:1000001
RealUrl String 违规资源原始访问 URL
示例值:http://www.test.com\/a.jpeg
DownloadUrl String 快照路径,用于控制台展示违规内容快照
示例值:2019-11-18/2019-11-18-18-26-08-1794844604-29-21-a.jpeg
UrlStatus String 违规资源当前状态
forbid:已封禁
release:已解封
delay : 延迟处理
reject :申诉驳回,状态仍为封禁状态
complain:申诉进行中
示例值:forbid
CreateTime Timestamp 创建时间
示例值:2019-11-17 18:25:47
UpdateTime Timestamp 更新时间
示例值:2019-11-18 18:06:47

WebSocket

WebSocket配置
WebSocket 为ECDN产品功能,如需使用请通过ECDN域名配置.

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

名称 类型 必选 描述
Switch String WebSocket 超时配置开关,取值有:
on:开启,可以调整超时时间
off:关闭,平台仍支持WebSocket连接,此时超时时间默认为15秒

示例值:off
Timeout Integer 设置超时时间,单位为秒,最大超时时间300秒。
注意:此字段可能返回 null,表示取不到有效值。
示例值:10

WebpAdapter

图片优化-WebpAdapter配置

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

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