数据结构

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

Cache

缓存配置简单版本,该版本不支持设置源站未返回max-age情况下的缓存规则。

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

名称 类型 必选 描述
CacheRules Array of CacheRule 缓存配置规则数组。
FollowOrigin String 遵循源站 Cache-Control: max-age 配置,白名单功能。
on:开启
off:关闭
开启后,未能匹配 CacheRules 规则的资源将根据源站返回的 max-age 值进行节点缓存;匹配了 CacheRules 规则的资源将按照 CacheRules 中设置的缓存过期时间在节点进行缓存
注意:此字段可能返回 null,表示取不到有效值。

CacheKey

缓存相关配置。

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

名称 类型 必选 描述
FullUrlCache String 是否开启全路径缓存,on或off。

CacheRule

缓存配置规则。

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

名称 类型 必选 描述
CacheType String 缓存类型,支持all,file,directory,path,index,分别表示全部文件,后缀类型,目录,完整路径,首页。
CacheContents Array of String 缓存内容列表。
CacheTime Integer 缓存时间,单位秒。

ClientCert

https客户端证书配置。

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

名称 类型 必选 描述
Certificate String 客户端证书,pem格式。
注意:此字段可能返回 null,表示取不到有效值。
CertName String 客户端证书名称。
注意:此字段可能返回 null,表示取不到有效值。
ExpireTime Timestamp 证书过期时间。
注意:此字段可能返回 null,表示取不到有效值。
DeployTime Timestamp 证书颁发时间。
注意:此字段可能返回 null,表示取不到有效值。

DetailData

排序类型的数据结构

被如下接口引用:DescribeEcdnDomainStatistics。

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

DomainBriefInfo

CDN域名简要信息。

被如下接口引用:DescribeDomains。

名称 类型 描述
ResourceId String 域名ID。
AppId Integer 腾讯云账号ID。
Domain String CDN加速域名。
Cname String 域名CName。
Status String 域名状态,pending,rejected,processing, online,offline,deleted分别表示审核中,审核未通过,审核通过部署中,已开启,已关闭,已删除。
ProjectId Integer 项目ID。
CreateTime Timestamp 域名创建时间。
UpdateTime Timestamp 域名更新时间。
Origin Origin 源站配置详情。
Disable String 域名封禁状态,normal,overdue,quota,malicious,ddos,idle,unlicensed,capping,readonly分别表示 正常,欠费停服,试用客户流量包耗尽,恶意用户,ddos攻击,无流量域名,未备案,带宽封顶,只读
Area String 加速区域,mainland,oversea或global。
Readonly String 域名锁定状态,normal、global,分别表示未被锁定、全球锁定。

DomainData

排序类型数据结构

被如下接口引用:DescribeEcdnDomainStatistics。

名称 类型 描述
Resource String 域名
DetailData Array of DetailData 结果详情

DomainDetailInfo

ECDN域名详细配置信息。

被如下接口引用:DescribeDomainsConfig。

名称 类型 描述
ResourceId String 域名ID。
AppId Integer 腾讯云账号ID。
Domain String 加速域名。
Cname String 域名CName。
注意:此字段可能返回 null,表示取不到有效值。
Status String 域名状态,pending,rejected,processing, online,offline,deleted分别表示审核中,审核未通过,审核通过部署中,已开启,已关闭,已删除。
ProjectId Integer 项目ID。
CreateTime Timestamp 域名创建时间。
UpdateTime Timestamp 域名更新时间。
Origin Origin 源站配置。
IpFilter IpFilter IP黑白名单配置。
注意:此字段可能返回 null,表示取不到有效值。
IpFreqLimit IpFreqLimit IP限频配置。
注意:此字段可能返回 null,表示取不到有效值。
ResponseHeader ResponseHeader 源站响应头部配置。
注意:此字段可能返回 null,表示取不到有效值。
CacheKey CacheKey 节点缓存配置。
注意:此字段可能返回 null,表示取不到有效值。
Cache Cache 缓存规则配置。
注意:此字段可能返回 null,表示取不到有效值。
Https Https Https配置。
注意:此字段可能返回 null,表示取不到有效值。
Disable String 域名封禁状态,normal,overdue,quota,malicious,ddos,idle,unlicensed,capping,readonly分别表示 正常,欠费停服,试用客户流量包耗尽,恶意用户,ddos攻击,无流量域名,未备案,带宽封顶,只读。
注意:此字段可能返回 null,表示取不到有效值。
ForceRedirect ForceRedirect 访问协议强制跳转配置。
注意:此字段可能返回 null,表示取不到有效值。
Area String 加速区域,mainland,overseas或global。
注意:此字段可能返回 null,表示取不到有效值。
Readonly String 域名锁定状态,normal、global 分别表示未被锁定,全球锁定。
注意:此字段可能返回 null,表示取不到有效值。

DomainFilter

域名查询时过滤条件。

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

名称 类型 必选 描述
Name String 过滤字段名,支持的列表如下:
- origin:主源站。
- domain:域名。
- resourceId:域名id。
- status:域名状态,online,offline,processing。
- disable:域名封禁状态,normal,unlicensed。
- projectId:项目ID。
- fullUrlCache:全路径缓存,on或off。
- https:是否配置https,on,off或processing。
- originPullProtocol:回源协议类型,支持http,follow或https。
- area:加速区域,支持mainland,overseas或global。
Value Array of String 过滤字段值。
Fuzzy Boolean 是否启用模糊查询,仅支持过滤字段名为origin,domain。

DomainLogs

域名日志信息

被如下接口引用:DescribeEcdnDomainLogs。

名称 类型 描述
StartTime Timestamp 日志起始时间。
EndTime Timestamp 日志结束时间。
LogPath String 日志下载路径。

EcdnData

访问明细数据类型

被如下接口引用:DescribeEcdnStatistics。

名称 类型 描述
Metrics Array of String 查询指定的指标名称:Bandwidth,Flux,Request,Delay,状态码,LogBandwidth,LogFlux,LogRequest
DetailData Array of TimestampData 明细数据组合

ForceRedirect

访问协议强制跳转配置。

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

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

Hsts

HSTS 配置。

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

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

HttpHeaderPathRule

分路径的http头部设置规则。

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

名称 类型 必选 描述
HeaderMode String http头部设置方式,支持add,set或del,分别表示新增,设置或删除头部。
请求头部暂不支持set。
注意:此字段可能返回 null,表示取不到有效值。
HeaderName String http头部名称。
注意:此字段可能返回 null,表示取不到有效值。
HeaderValue String http头部值。del时可不填写该字段。
注意:此字段可能返回 null,表示取不到有效值。
RuleType String 生效的url路径规则类型,支持all,file,directory或path,分别表示全部路径,文件后缀类型,目录或绝对路径生效。
注意:此字段可能返回 null,表示取不到有效值。
RulePaths Array of String url路径或文件类型列表。
注意:此字段可能返回 null,表示取不到有效值。

Https

域名https配置。

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

名称 类型 必选 描述
Switch String https配置开关,on或off。开启https配置的域名在部署中状态,开关保持off。
注意:此字段可能返回 null,表示取不到有效值。
Http2 String 是否开启http2,on或off。
注意:此字段可能返回 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,表示取不到有效值。

IpFilter

IP黑白名单。

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

名称 类型 必选 描述
Switch String IP黑白名单开关,on或off。
FilterType String IP黑白名单类型,whitelist或blacklist。
注意:此字段可能返回 null,表示取不到有效值。
Filters Array of String IP黑白名单列表。
注意:此字段可能返回 null,表示取不到有效值。

IpFreqLimit

IP限频配置。

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

名称 类型 必选 描述
Switch String IP限频配置开关,on或off。
Qps Integer 每秒请求数。
注意:此字段可能返回 null,表示取不到有效值。

Origin

源站配置。

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

名称 类型 必选 描述
Origins Array of String 主源站列表,默认格式为 ["ip1:port1", "ip2:port2"]。
支持在源站列表中配置权重,配置IP源站权重格式为 ["ip1:port1:weight1", "ip2:port2:weight2"]。
OriginType String 主源站类型,支持domain,ip,分别表示域名源站,ip源站。
设置Origins时必须填写。
注意:此字段可能返回 null,表示取不到有效值。
ServerName String 回源时Host头部值。
注意:此字段可能返回 null,表示取不到有效值。
OriginPullProtocol String 回源协议类型,支持http,follow,https,分别表示强制http回源,协议跟随回源,https回源。
注意:此字段可能返回 null,表示取不到有效值。
BackupOrigins Array of String 备份源站列表。
BackupOriginType String 备份源站类型,同OriginType。
设置BackupOrigins时必须填写。
注意:此字段可能返回 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 刷新任务提交时间

Quota

刷新用量及刷新配额

被如下接口引用:DescribePurgeQuota。

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

ResourceData

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

被如下接口引用:DescribeEcdnStatistics。

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

ResponseHeader

自定义响应头配置。

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

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

ServerCert

https服务端证书配置。

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

名称 类型 必选 描述
CertId String 服务器证书id,当证书为腾讯云托管证书时必填。
注意:此字段可能返回 null,表示取不到有效值。
CertName String 服务器证书名称,当证书为腾讯云托管证书时必填。
注意:此字段可能返回 null,表示取不到有效值。
Certificate String 服务器证书信息,上传自有证书时必填,必须包含完整的证书链信息。
注意:此字段可能返回 null,表示取不到有效值。
PrivateKey String 服务器密钥信息,上传自有证书时必填。
注意:此字段可能返回 null,表示取不到有效值。
ExpireTime Timestamp 证书过期时间。
注意:此字段可能返回 null,表示取不到有效值。
DeployTime Timestamp 证书颁发时间。
注意:此字段可能返回 null,表示取不到有效值。
Message String 证书备注信息。
注意:此字段可能返回 null,表示取不到有效值。

Sort

查询结果排序条件。

被如下接口引用:DescribeDomainsConfig。

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

TimestampData

时间戳与其对应的数值

被如下接口引用:DescribeEcdnStatistics。

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