数据结构

最近更新时间:2020-07-22 08:07:25

AccessControl

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

被如下接口引用:DescribeDomainsConfig。

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

AccessControlRule

访问控制规则

被如下接口引用:DescribeDomainsConfig。

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

AdvanceCacheRule

缓存配置高级版本规则

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, 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,表示取不到有效值。

AdvancedCache

缓存过期配置高级版(功能灰度中,尚未全量) 注意:该版本不支持设置首页缓存规则

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

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

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, DescribeDomainsConfig, UpdateDomainConfig。

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

AuthenticationTypeB

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

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

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

AuthenticationTypeC

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

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

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

AuthenticationTypeD

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

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

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

AwsPrivateAccess

s3源站回源鉴权。

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

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

BandwidthAlert

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

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

名称 类型 必选 描述
Switch String 带宽封顶配置开关
on:开启
off:关闭
BpsThreshold Integer 带宽封顶阈值,单位为bps
注意:此字段可能返回 null,表示取不到有效值。
CounterMeasure String 达到阈值后的操作
RESOLVE_DNS_TO_ORIGIN:直接回源,仅自有源站域名支持
RETURN_404:全部请求返回 404
注意:此字段可能返回 null,表示取不到有效值。
LastTriggerTime Timestamp 上次触发带宽封顶阈值的时间
注意:此字段可能返回 null,表示取不到有效值。

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:全球锁定

Cache

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

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

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

名称 类型 必选 描述
SimpleCache SimpleCache 基础缓存过期时间配置
注意:此字段可能返回 null,表示取不到有效值。
AdvancedCache AdvancedCache 高级缓存过期时间配置(功能灰度中,尚未全量)
注意:此字段可能返回 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,表示取不到有效值。

CacheOptResult

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

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

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

CacheTagKey

组成CacheKey的一部分

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

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

CappingRule

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

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, 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

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:服务地域无法获取

CdnIpHistory

CDN 节点上下线历史记录

被如下接口引用:DescribeCdnIp。

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

ClientCert

https 客户端证书配置

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

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

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

压缩规则配置,最多可设置 100 条

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

名称 类型 必选 描述
Compress Boolean true:需要设置为 ture,启用压缩
注意:此字段可能返回 null,表示取不到有效值。
FileExtensions Array of String 根据文件后缀类型压缩
例如 jpg、txt
注意:此字段可能返回 null,表示取不到有效值。
MinLength Integer 触发压缩的文件长度最小值,单位为字节数
注意:此字段可能返回 null,表示取不到有效值。
MaxLength Integer 触发压缩的文件长度最大值,单位为字节数
最大可设置为 30MB
注意:此字段可能返回 null,表示取不到有效值。
Algorithms Array of String 文件压缩算法
gzip:指定 GZIP 压缩
brotli:需要同时指定 GZIP 压缩才可启用
注意:此字段可能返回 null,表示取不到有效值。

CookieKey

组成CacheKey的一部分

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

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

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:流媒体点播加速
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,表示取不到有效值。

DomainAreaConfig

域名地区配置

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

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

DomainFilter

域名查询时过滤条件。

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

名称 类型 必选 描述
Name String 过滤字段名,支持的列表如下:
- origin:主源站。
- domain:域名。
- resourceId:域名id。
- status:域名状态,online,offline或processing。
- serviceType:业务类型,web,download或media。
- projectId:项目ID。
- domainType:主源站类型,cname表示自有源,cos表示cos接入。
- 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, DescribeDomainsConfig, UpdateDomainConfig。

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

FollowRedirect

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

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

名称 类型 必选 描述
Switch String 回源跟随开关
on:开启
off:关闭

ForceRedirect

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

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

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

GuetzliAdapter

图片优化-GuetzliAdapter配置

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

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

HeaderKey

组成CacheKey

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

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

Hsts

HSTS 配置。

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

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

HttpHeaderPathRule

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

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

名称 类型 必选 描述
HeaderMode String http 头部设置方式
add:添加头部,若已存在头部,则会存在重复头部
set:仅回源头部配置支持,若头部已存在则会覆盖原有头部值,若不存在,则会增加该头部及值
del:删除头部
注意:此字段可能返回 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,表示取不到有效值。

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

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

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

Ipv6启用配置,不可更改

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

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

LogSetInfo

日志集信息

被如下接口引用:ListClsLogTopics。

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

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,表示取不到有效值。
StatusCodeCache StatusCodeCache 状态码缓存配置。
注意:此字段可能返回 null,表示取不到有效值。
VideoSeek VideoSeek 视频拖拽配置。
注意:此字段可能返回 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, DescribeDomainsConfig, UpdateDomainConfig。

名称 类型 必选 描述
MaxAgeType String 规则类型:
all:所有文件生效
file:指定文件后缀生效
directory:指定路径生效
path:指定绝对路径生效
MaxAgeContents Array of String MaxAgeType 对应类型下的匹配内容:
all 时填充 *
file 时填充后缀名,如 jpg、txt
directory 时填充路径,如 /xxx/test/
path 时填充绝对路径,如 /xxx/test.html
MaxAgeTime Integer MaxAge 时间设置,单位秒

Origin

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

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

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

名称 类型 必选 描述
Origins Array of String 主源站列表
修改源站时,需要同时填充对应的 OriginType
注意:此字段可能返回 null,表示取不到有效值。
OriginType String 主源站类型
入参支持以下几种类型:
domain:域名类型
cos:对象存储源站
ip:IP 列表作为源站
ipv6:源站列表为一个单独的 IPv6 地址
ip_ipv6:源站列表为多个 IPv4 地址和一个 IPv6 地址
出参增加以下几种类型:
image:数据万象源站
ftp:历史 FTP 托管源源站,现已不维护
修改 Origins 时需要同时填充对应的 OriginType
IPv6 功能目前尚未全量,需要先申请试用
注意:此字段可能返回 null,表示取不到有效值。
ServerName String 回主源站时 Host 头部,不填充则默认为加速域名
若接入的是泛域名,则回源 Host 默认为访问时的子域名
注意:此字段可能返回 null,表示取不到有效值。
CosPrivateAccess String OriginType 为对象存储(COS)时,可以指定是否允许访问私有 bucket
注意:需要先授权 CDN 访问该私有 Bucket 的权限后,才可开启此配置。
注意:此字段可能返回 null,表示取不到有效值。
OriginPullProtocol String 回源协议配置
http:强制 http 回源
follow:协议跟随回源
https:强制 https 回源,https 回源时仅支持源站 443 端口
注意:此字段可能返回 null,表示取不到有效值。
BackupOrigins Array of String 备源站列表
修改备源站时,需要同时填充对应的 BackupOriginType
注意:此字段可能返回 null,表示取不到有效值。
BackupOriginType String 备源站类型,支持以下类型:
domain:域名类型
ip:IP 列表作为源站
修改 BackupOrigins 时需要同时填充对应的 BackupOriginType
注意:此字段可能返回 null,表示取不到有效值。
BackupServerName String 回备源站时 Host 头部,不填充则默认为主源站的 ServerName
注意:此字段可能返回 null,表示取不到有效值。
BasePath String 回源路径
注意:此字段可能返回 null,表示取不到有效值。

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

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,表示取不到有效值。
StatusCodeCache StatusCodeCache 状态码缓存配置。
注意:此字段可能返回 null,表示取不到有效值。
VideoSeek VideoSeek 视频拖拽配置。
注意:此字段可能返回 null,表示取不到有效值。

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:预热中
Percent Integer 预热进度百分比
CreateTime Timestamp 预热任务提交时间
Area String 预热区域
mainland:境内
overseas:境外
global:全球
UpdateTime Timestamp 预热任务更新时间
注意:此字段可能返回 null,表示取不到有效值。

QueryStringKey

组成CacheKey的一部分

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

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

Quota

刷新/预热 可用量及配额

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

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

RangeOriginPull

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

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

名称 类型 必选 描述
Switch String 分片回源配置开关
on:开启
off:关闭

Referer

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

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

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

RefererRule

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

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, 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

RegionMapRelation

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

被如下接口引用:DescribeMapInfo。

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

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 资源名称,根据查询条件不同分为以下几类:
具体域名:表示该域名明细数据
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, DescribeDomainsConfig, UpdateDomainConfig。

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

SchemeKey

作为CacheKey的一部分

被如下接口引用:AddCdnDomain, DescribeDomainsConfig, 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, DescribeDomainsConfig, 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,表示取不到有效值。

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

StatusCodeCache

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

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

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

StatusCodeCacheRule

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

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

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

SummarizedData

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

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

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

TimestampData

时间戳与其对应的数值

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

名称 类型 描述
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 排序结果详情

TopDetailData

排序类型的数据结构

被如下接口引用:ListTopData。

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

TopicInfo

CLS主题信息

被如下接口引用:ListClsLogTopics。

名称 类型 描述
TopicId String 主题ID
TopicName String 主题名字
Enabled Integer 是否启用投递
CreateTime Timestamp 创建时间
注意:此字段可能返回 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 流量包来源

UrlRecord

封禁url的详细信息

被如下接口引用:GetDisableRecords。

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

UserAgentFilter

UserAgent黑白名单配置

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

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

UserAgentFilterRule

UserAgent黑白名单规则配置

被如下接口引用:DescribeDomainsConfig, 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 更新时间

WebpAdapter

图片优化-WebpAdapter配置

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

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