tenyun
Version:
Promise based and chained Tencent Cloud OpenAPI client for NodeJS
1,743 lines (1,617 loc) • 161 kB
TypeScript
/// <reference types="node" />
import { AxiosPromise, AxiosRequestConfig } from "axios";
/** 请求头部及请求url访问控制 */
declare interface AccessControl {
/** 启用请求头部及请求url访问控制开关,取值有:on:开启off:关闭 */
Switch: string;
/** 请求头部及请求url访问规则 */
AccessControlRules?: AccessControlRule[] | null;
/** 返回状态码 */
ReturnCode?: number | null;
}
/** 访问控制规则 */
declare interface AccessControlRule {
/** requestHeader :对请求头部进行访问控制url : 对访问url进行访问控制 */
RuleType: string | null;
/** 封禁内容 */
RuleContent: string | null;
/** on :正则匹配off :字面匹配 */
Regex: string | null;
/** RuleType为requestHeader时必填,否则不需要填 */
RuleHeader?: string | null;
}
/** 缓存配置高级版本规则 */
declare interface AdvanceCacheRule {
/** 规则类型:all:所有文件生效file:指定文件后缀生效directory:指定路径生效path:指定绝对路径生效default:源站未返回 max-age 情况下的缓存规则 */
CacheType: string | null;
/** 对应类型下的匹配内容:all 时填充 *file 时填充后缀名,如 jpg、txtdirectory 时填充路径,如 /xxx/test/path 时填充绝对路径,如 /xxx/test.htmldefault 时填充 "no max-age" */
CacheContents: string[] | null;
/** 缓存过期时间单位为秒,最大可设置为 365 天 */
CacheTime: number | null;
}
/** 高级配置集合 */
declare interface AdvanceConfig {
/** 高级配置名称。 */
Name?: string | null;
/** 是否支持高级配置,on:支持off:不支持 */
Value?: string | null;
}
/** 回源的自定义Https配置 */
declare interface AdvanceHttps {
/** 自定义Tls数据开关 */
CustomTlsStatus?: string | null;
/** Tls版本列表,支持设置 TLSv1, TLSV1.1, TLSV1.2, TLSv1.3,修改时必须开启连续的版本 */
TlsVersion?: string[] | null;
/** 自定义加密套件 */
Cipher?: string | null;
/** 回源双向校验开启状态off - 关闭校验oneWay - 校验源站twoWay - 双向校验 */
VerifyOriginType?: string | null;
/** 回源层证书配置信息 */
CertInfo?: ServerCert | null;
/** 源站证书配置信息 */
OriginCertInfo?: ClientCert | null;
}
/** 时间戳防盗链高级版配置,白名单功能 */
declare interface AdvancedAuthentication {
/** 防盗链配置开关,取值有:on:开启off:关闭开启时必须且只配置一种模式,其余模式需要设置为 null */
Switch: string;
/** 时间戳防盗链高级版模式A配置。 */
TypeA?: AdvancedAuthenticationTypeA | null;
/** 时间戳防盗链高级版模式B配置。 */
TypeB?: AdvancedAuthenticationTypeB | null;
/** 时间戳防盗链高级版模式C配置。 */
TypeC?: AdvancedAuthenticationTypeC | null;
/** 时间戳防盗链高级版模式D配置。 */
TypeD?: AdvancedAuthenticationTypeD | null;
/** 时间戳防盗链高级版模式E配置。 */
TypeE?: AdvancedAuthenticationTypeE | null;
/** 时间戳防盗链高级版模式F配置。 */
TypeF?: AdvancedAuthenticationTypeF | null;
}
/** 时间戳防盗链高级版模式A配置。 */
declare interface AdvancedAuthenticationTypeA {
/** 用于计算签名的密钥,只允许字母和数字,长度6-32字节。 */
SecretKey: string;
/** uri串中签名的字段名,字母,数字或下划线构成,同时必须以字母开头。 */
SignParam: string;
/** uri串中时间的字段名,字母,数字或下划线构成,同时必须以字母开头。 */
TimeParam: string;
/** 过期时间,单位秒。 */
ExpireTime: number;
/** 是否必须提供过期时间参数。 */
ExpireTimeRequired: boolean;
/** URL 组成格式,如:${private_key}${schema}${host}${full_uri}。 */
Format: string;
/** 时间格式,dec,hex分别表示十进制,十六进制。 */
TimeFormat: string;
/** 鉴权失败时返回的状态码。 */
FailCode: number;
/** 链接过期时返回的状态码。 */
ExpireCode: number;
/** 需要鉴权的url路径列表。 */
RulePaths: string[];
/** 保留字段。 */
Transformation?: number;
}
/** 时间戳防盗链高级版模式B配置。 */
declare interface AdvancedAuthenticationTypeB {
/** alpha键名。 */
KeyAlpha: string;
/** beta键名。 */
KeyBeta: string;
/** gamma键名。 */
KeyGamma: string;
/** uri串中签名的字段名,字母,数字或下划线构成,同时必须以字母开头。 */
SignParam: string;
/** uri串中时间的字段名,字母,数字或下划线构成,同时必须以字母开头。 */
TimeParam: string;
/** 过期时间,单位秒。 */
ExpireTime: number;
/** 时间格式,dec,hex分别表示十进制,十六进制。 */
TimeFormat: string;
/** 鉴权失败时返回的状态码。 */
FailCode: number;
/** 链接过期时返回的状态码。 */
ExpireCode: number;
/** 需要鉴权的url路径列表。 */
RulePaths: string[];
}
/** 时间戳防盗链高级版模式C配置。 */
declare interface AdvancedAuthenticationTypeC {
/** 访问密钥。 */
AccessKey: string;
/** 鉴权密钥。 */
SecretKey: string;
}
/** 时间戳防盗链高级版模式D配置。 */
declare interface AdvancedAuthenticationTypeD {
/** 用于计算签名的密钥,只允许字母和数字,长度6-32字节。 */
SecretKey: string;
/** 备份密钥,当使用SecretKey鉴权失败时会使用该密钥重新鉴权。 */
BackupSecretKey: string;
/** uri串中签名的字段名,字母,数字或下划线构成,同时必须以字母开头。 */
SignParam: string;
/** uri串中时间的字段名,字母,数字或下划线构成,同时必须以字母开头。 */
TimeParam: string;
/** 过期时间,单位秒。 */
ExpireTime: number;
/** 时间格式,dec,hex分别表示十进制,十六进制。 */
TimeFormat: string;
}
/** 时间戳防盗链高级版模式E配置。 */
declare interface AdvancedAuthenticationTypeE {
/** 用于计算签名的密钥,只允许字母和数字,长度6-32字节。 */
SecretKey: string | null;
/** uri串中签名的字段名,字母,数字或下划线构成,同时必须以字母开头。 */
SignParam: string | null;
/** uri串中Acl签名的字段名,字母,数字或下划线构成,同时必须以字母开头。 */
AclSignParam: string | null;
/** uri串中开始时间字段名,字母,数字或下划线构成,同时必须以字母开头。 */
StartTimeParam: string | null;
/** uri串中过期时间字段名,字母,数字或下划线构成,同时必须以字母开头。 */
ExpireTimeParam: string | null;
/** 时间格式,dec */
TimeFormat: string | null;
}
/** 时间戳防盗链高级鉴权模式TypeF配置 */
declare interface AdvancedAuthenticationTypeF {
/** uri串中签名的字段名,字母,数字或下划线构成,同时必须以字母开头。 */
SignParam: string | null;
/** uri串中时间的字段名,字母,数字或下划线构成,同时必须以字母开头。 */
TimeParam: string | null;
/** uri串中Transaction字段名,字母,数字或下划线构成,同时必须以字母开头。 */
TransactionParam: string | null;
/** 用于计算签名的主密钥,只允许字母和数字,长度6-32字节。 */
SecretKey: string | null;
/** 用于计算签名的备选密钥,主密钥校验失败后再次尝试备选密钥,只允许字母和数字,长度6-32字节。 */
BackupSecretKey?: string | null;
}
/** 缓存过期配置高级版,注意:此字段已经弃用,请使用RuleCache */
declare interface AdvancedCache {
/** 缓存过期规则 */
CacheRules: AdvanceCacheRule[] | null;
/** 强制缓存配置on:开启off:关闭开启时,源站返回 no-cache、no-store 头部时,仍按照缓存过期规则进行节点缓存默认为关闭状态 */
IgnoreCacheControl: string | null;
/** 当源站返回Set-Cookie头部时,节点是否缓存该头部及bodyon:开启,不缓存该头部及bodyoff:关闭,遵循用户自定义的节点缓存规则默认为关闭状态 */
IgnoreSetCookie: string | null;
}
/** 时间戳防盗链配置 */
declare interface Authentication {
/** 防盗链配置开关,取值有:on:开启off:关闭开启时必须且只配置一种模式,其余模式需要设置为 null */
Switch: string;
/** 鉴权算法,取值有:md5:按MD5算法取hash值sha256:按SHA-256算法取hash值默认为 md5 */
AuthAlgorithm?: string | null;
/** 时间戳防盗链模式 A 配置 */
TypeA?: AuthenticationTypeA | null;
/** 时间戳防盗链模式 B 配置(模式 B 后台升级中,暂时不支持配置) */
TypeB?: AuthenticationTypeB | null;
/** 时间戳防盗链模式 C 配置 */
TypeC?: AuthenticationTypeC | null;
/** 时间戳防盗链模式 D 配置 */
TypeD?: AuthenticationTypeD | null;
}
/** 时间戳防盗链模式 A 配置时间戳防盗链模式 A 的访问 URL 格式为:http://DomainName/Filename?sign=timestamp-rand-uid-md5hash其中 timestamp 为十进制 UNIX 时间戳;rand 为随机字符串,0 ~ 100 位大小写字母与数字组成;uid 为 0;md5hash:MD5(文件路径-timestamp-rand-uid-自定义密钥) */
declare interface AuthenticationTypeA {
/** 计算签名的密钥仅允许大小写字母与数字,长度 6~32 位 */
SecretKey: string | null;
/** 签名参数名设置仅允许大小写字母、数字或下划线,长度 1~100 位,不能以数字开头 */
SignParam: string;
/** 签名过期时间设置单位为秒,最大可设置为 630720000 */
ExpireTime: number;
/** 鉴权/不做鉴权的文件扩展名列表设置如果包含字符 * 则表示所有文件 */
FileExtensions: string[];
/** whitelist:白名单,表示对除了 FileExtensions 列表之外的所有类型进行鉴权blacklist:黑名单,表示仅对 FileExtensions 中的类型进行鉴权 */
FilterType: string;
/** 计算签名的备用密钥仅允许大小写字母与数字,长度 6~32 位 */
BackupSecretKey?: string | null;
}
/** 时间戳防盗链模式 B 配置(B 模式正在进行平台升级,暂不支持配置) */
declare interface AuthenticationTypeB {
/** 计算签名的密钥仅允许大小写字母与数字,长度 6~32 位 */
SecretKey: string | null;
/** 签名过期时间设置单位为秒,最大可设置为 630720000 */
ExpireTime: number;
/** 鉴权/不做鉴权的文件扩展名列表设置如果包含字符 * 则表示所有文件 */
FileExtensions: string[];
/** whitelist:白名单,表示对除了 FileExtensions 列表之外的所有类型进行鉴权blacklist:黑名单,表示仅对 FileExtensions 中的类型进行鉴权 */
FilterType: string;
/** 计算签名的备用密钥仅允许大小写字母与数字,长度 6~32 位 */
BackupSecretKey?: string | null;
}
/** 时间戳防盗链模式 C 配置时间戳防盗链模式 C 的访问 URL 格式为:http://DomainName/md5hash/timestamp/FileName其中 timestamp 为十六进制 UNIX 时间戳;md5hash:MD5(自定义密钥 + 文件路径 + timestamp) */
declare interface AuthenticationTypeC {
/** 计算签名的密钥仅允许大小写字母与数字,长度 6~32 位 */
SecretKey: string | null;
/** 签名过期时间设置单位为秒,最大可设置为 630720000 */
ExpireTime: number;
/** 鉴权/不做鉴权的文件扩展名列表设置如果包含字符 * 则表示所有文件 */
FileExtensions: string[];
/** whitelist:白名单,表示对除了 FileExtensions 列表之外的所有类型进行鉴权blacklist:黑名单,表示仅对 FileExtensions 中的类型进行鉴权 */
FilterType: string;
/** 时间戳进制设置dec:十进制hex:十六进制 */
TimeFormat?: string | null;
/** 计算签名的备用密钥仅允许大小写字母与数字,长度 6~32 位 */
BackupSecretKey?: string | null;
}
/** 时间戳防盗链模式 D 配置时间戳防盗链模式 D 的访问 URL 格式为:http://DomainName/FileName?sign=md5hash&t=timestamp其中 timestamp 为十进制或十六进制 UNIX 时间戳;md5hash:MD5(自定义密钥 + 文件路径 + timestamp) */
declare interface AuthenticationTypeD {
/** 计算签名的密钥仅允许大小写字母与数字,长度 6~32 位 */
SecretKey: string | null;
/** 签名过期时间设置单位为秒,最大可设置为 630720000 */
ExpireTime: number;
/** 鉴权/不做鉴权的文件扩展名列表设置如果包含字符 * 则表示所有文件 */
FileExtensions: string[];
/** whitelist:白名单,表示对除了 FileExtensions 列表之外的所有类型进行鉴权blacklist:黑名单,表示仅对 FileExtensions 中的类型进行鉴权 */
FilterType: string;
/** 签名参数名设置仅允许大小写字母、数字或下划线,长度 1~100 位,不能以数字开头 */
SignParam: string;
/** 时间戳参数名设置仅允许大小写字母、数字或下划线,长度 1~100 位,不能以数字开头 */
TimeParam: string;
/** 时间戳进制设置dec:十进制hex:十六进制 */
TimeFormat: string;
/** 计算签名的备用密钥仅允许大小写字母与数字,长度 6~32 位 */
BackupSecretKey?: string | null;
}
/** 图片优化-AvifAdapter配置 */
declare interface AvifAdapter {
/** 图片优化AvifAdapter配置项开关,取值有:on:开启off:关闭 */
Switch?: string | null;
/** 当原图是 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 前面。 */
FallbackFormats?: string[] | null;
}
/** s3源站回源鉴权。 */
declare interface AwsPrivateAccess {
/** s3源站回源鉴权配置项开关,取值有:on:开启off:关闭 */
Switch: string;
/** 访问ID。 */
AccessKey?: string | null;
/** 密钥,字段为脱敏返回。 */
SecretKey?: string | null;
/** 地域 */
Region?: string | null;
/** Bucketname */
Bucket?: string | null;
}
/** 带宽封顶配置,默认为关闭状态 */
declare interface BandwidthAlert {
/** 用量封顶配置开关,取值有:on:开启off:关闭 */
Switch: string;
/** 用量封顶阈值,带宽单位为bps,流量单位byte */
BpsThreshold?: number | null;
/** 达到阈值后的操作RETURN_404:全部请求返回 404 */
CounterMeasure?: string | null;
/** 境内区域上次触发用量封顶阈值的时间 */
LastTriggerTime?: string | null;
/** 用量封顶提醒配置开关,取值有:on:开启off:关闭 */
AlertSwitch?: string | null;
/** 用量封顶阈值提醒百分比 */
AlertPercentage?: number | null;
/** 海外区域上次触发用量封顶阈值的时间 */
LastTriggerTimeOverseas?: string | null;
/** 用量阈值触发的维度带宽:bandwidth流量:flux */
Metric?: string | null;
/** 累计用量配置 */
StatisticItems?: StatisticItem[] | null;
}
/** 域名基础配置信息,含 CNAME、状态、业务类型、加速区域、创建时间、更新时间、源站配置等。 */
declare interface BriefDomain {
/** 域名 ID */
ResourceId?: string;
/** 腾讯云账号 ID */
AppId?: number;
/** 加速域名 */
Domain?: string;
/** 域名对应的 CNAME 地址 */
Cname?: string;
/** 加速服务状态rejected:域名审核未通过,域名备案过期/被注销导致processing:部署中closing:关闭中online:已启动offline:已关闭 */
Status?: string;
/** 项目 ID,可前往腾讯云项目管理页面查看 */
ProjectId?: number;
/** 域名业务类型web:静态加速download:下载加速media:流媒体点播加速 */
ServiceType?: string;
/** 域名创建时间 */
CreateTime?: string;
/** 域名更新时间 */
UpdateTime?: string;
/** 源站配置详情 */
Origin?: Origin;
/** 域名封禁状态normal:正常状态overdue:账号欠费导致域名关闭,充值完成后可自行启动加速服务malicious:域名出现恶意行为,强制关闭加速服务ddos:域名被大规模 DDoS 攻击,关闭加速服务idle:域名超过 90 天内无任何操作、数据产生,判定为不活跃域名自动关闭加速服务,可自行启动加速服务unlicensed:域名未备案/备案注销,自动关闭加速服务,备案完成后可自行启动加速服务capping:触发配置的带宽阈值上限readonly:域名存在特殊配置,被锁定 */
Disable: string;
/** 加速区域mainland:中国境内加速overseas:中国境外加速global:全球加速 */
Area: string;
/** 域名锁定状态normal:未锁定mainland:中国境内锁定overseas:中国境外锁定global:全球锁定 */
Readonly: string;
/** 域名所属产品,cdn/ecdn */
Product: string;
/** 主域名 */
ParentHost: string;
}
/** 节点缓存过期时间配置,分为以下两种:+ 基础版缓存过期规则配置+ 高级版缓存过期规则配置 */
declare interface Cache {
/** 基础缓存过期时间配置 */
SimpleCache?: SimpleCache | null;
/** 高级缓存过期时间配置(已弃用) */
AdvancedCache?: AdvancedCache | null;
/** 高级路径缓存配置 */
RuleCache?: RuleCache[] | null;
}
/** 启发式自定义时间缓存配置 */
declare interface CacheConfig {
/** 启发式自定义时间缓存配置开关,取值有:on:开启off:关闭 */
HeuristicCacheTimeSwitch: string | null;
/** 单位 秒. */
HeuristicCacheTime: number | null;
}
/** 路径缓存缓存配置 */
declare interface CacheConfigCache {
/** 路径缓存配置开关,取值有:on:开启off:关闭 */
Switch: string | null;
/** 缓存过期时间设置单位为秒,最大可设置为 365 天 */
CacheTime: number | null;
/** 高级缓存过期配置,开启时会对比源站返回的 max-age 值与 CacheRules 中设置的缓存过期时间,取最小值在节点进行缓存on:开启off:关闭默认为关闭状态 */
CompareMaxAge: string | null;
/** 强制缓存on:开启off:关闭默认为关闭状态,开启后,源站返回的 no-store、no-cache 资源,也将按照 CacheRules 规则进行缓存 */
IgnoreCacheControl: string | null;
/** 当源站返回Set-Cookie头部时,节点是否缓存该头部及bodyon:开启,不缓存该头部及bodyoff:关闭,遵循用户自定义的节点缓存规则默认为关闭状态 */
IgnoreSetCookie: string | null;
/** 当缓存过期后,是否开启源站 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头部,会更新缓存。 */
OriginMtimeCheckType?: string | null;
}
/** 路径缓存遵循源站配置 */
declare interface CacheConfigFollowOrigin {
/** 路径缓存遵循源站配置开关,取值有:on:开启off:关闭 */
Switch: string;
/** 启发式缓存配置 */
HeuristicCache?: HeuristicCache | null;
/** 当缓存过期后,是否开启源站 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头部,会更新缓存。 */
OriginMtimeCheckType?: string | null;
}
/** 路径缓存不缓存配置 */
declare interface CacheConfigNoCache {
/** 路径缓存不缓存配置配置开关,取值有:on:开启off:关闭 */
Switch: string | null;
/** 总是回源站校验on:开启off:关闭默认为关闭状态 */
Revalidate: string | null;
}
/** 缓存键配置(忽略参数配置) */
declare interface CacheKey {
/** 是否开启全路径缓存on:开启全路径缓存(即关闭参数忽略)off:关闭全路径缓存(即开启参数忽略) */
FullUrlCache?: string;
/** 是否忽略大小写缓存 */
IgnoreCase?: string | null;
/** CacheKey中包含请求参数 */
QueryString?: QueryStringKey | null;
/** CacheKey中包含Cookie */
Cookie?: CookieKey | null;
/** CacheKey中包含请求头部 */
Header?: HeaderKey | null;
/** CacheKey中包含自定义字符串 */
CacheTag?: CacheTagKey | null;
/** CacheKey中包含请求协议 */
Scheme?: SchemeKey | null;
/** 分路径缓存键配置 */
KeyRules?: KeyRule[] | null;
}
/** 违规资源封禁/解封返回类型 */
declare interface CacheOptResult {
/** 成功的url列表 */
SuccessUrls?: string[] | null;
/** 失败的url列表 */
FailUrls?: string[] | null;
}
/** 组成CacheKey的一部分 */
declare interface CacheTagKey {
/** 使用CacheTag作为CacheKey的一部分配置开关,取值有on:开启,使用CacheTag作为CacheKey的一部分off:关闭,不使用CacheTag作为CacheKey的一部分 */
Switch: string | null;
/** 自定义CacheTag的值 */
Value?: string | null;
}
/** 下行限速配置规则,最多可配置 100 条 */
declare interface CappingRule {
/** 规则类型:all:所有文件生效file:指定文件后缀生效directory:指定路径生效path:指定绝对路径生效 */
RuleType: string;
/** RuleType 对应类型下的匹配内容: all 时填充 *file 时填充后缀名,如 jpg、txtdirectory 时填充路径,如 /xxx/test/path 时填充绝对路径,如 /xxx/test.html */
RulePaths: string[];
/** 下行速度值设置,单位为 KB/s */
KBpsThreshold: number;
}
/** 访问明细数据类型 */
declare interface CdnData {
/** 查询指定的指标名称:flux:流量,单位为 bytebandwidth:带宽,单位为 bpsrequest:请求数,单位为 次fluxHitRate:流量命中率,单位为 %statusCode:状态码,返回 2XX、3XX、4XX、5XX 汇总数据,单位为 个2XX:返回 2XX 状态码汇总及各 2 开头状态码数据,单位为 个3XX:返回 3XX 状态码汇总及各 3 开头状态码数据,单位为 个4XX:返回 4XX 状态码汇总及各 4 开头状态码数据,单位为 个5XX:返回 5XX 状态码汇总及各 5 开头状态码数据,单位为 个或指定查询的某一具体状态码 */
Metric?: string;
/** 明细数据组合 */
DetailData?: TimestampData[];
/** 汇总数据组合 */
SummarizedData?: SummarizedData;
}
/** IP 属性信息 */
declare interface CdnIp {
/** 指定查询的 IP */
Ip?: string;
/** IP 归属:yes:节点归属于腾讯云 CDNno:节点不属于腾讯云 CDN */
Platform?: string;
/** 节点所处的省份/国家unknown 表示节点位置未知 */
Location?: string;
/** 节点上下线历史记录 */
History?: CdnIpHistory[];
/** 节点的所在区域mainland:中国境内加速节点overseas:中国境外加速节点unknown:服务地域无法获取 */
Area?: string;
/** 节点的所在城市 */
City?: string | null;
}
/** CDN 节点上下线历史记录 */
declare interface CdnIpHistory {
/** 操作类型online:节点上线offline:节点下线 */
Status?: string;
/** 操作类型对应的操作时间当该值为 null 时表示无历史状态变更记录 */
Datetime?: string | null;
}
/** https 客户端证书配置 */
declare interface ClientCert {
/** 客户端证书PEM 格式,需要进行 Base 64 编码 */
Certificate: string | null;
/** 客户端证书名称 */
CertName?: string | null;
/** 证书过期时间作为入参时无需填充 */
ExpireTime?: string | null;
/** 证书颁发时间作为入参时无需填充 */
DeployTime?: string | null;
}
/** 客户端信息 */
declare interface ClientInfo {
/** 省份。 */
ProvName?: string | null;
/** 国家。 */
Country?: string | null;
/** 运营商。 */
IspName?: string | null;
/** 客户端IP */
Ip?: string | null;
}
/** 通过Cls日志,计算出来的IP每秒访问数量 */
declare interface ClsLogIpData {
/** IP */
ClientIp: string;
/** 在给定的时间段中,1秒内的最大请求量 */
Request: number;
/** 在获取的Top信息中,IP出现的次数 */
Count: number;
/** 在给定的时间段中,1秒内的最大请求量对应的时间 */
Time: string;
}
/** CLS日志搜索对象 */
declare interface ClsLogObject {
/** 主题ID */
TopicId?: string;
/** 主题名字 */
TopicName?: string;
/** 日志时间 */
Timestamp?: string;
/** 日志内容 */
Content?: string;
/** 采集路径 */
Filename?: string;
/** 日志来源设备 */
Source?: string;
}
/** Cls日志搜索结果 */
declare interface ClsSearchLogs {
/** 获取更多检索结果的游标 */
Context?: string;
/** 搜索结果是否已经全部返回 */
Listover?: boolean;
/** 日志内容信息 */
Results?: ClsLogObject[];
}
/** 是否兼容旧版配置 */
declare interface Compatibility {
/** 兼容标志状态码。 */
Code?: number | null;
}
/** 智能压缩配置,默认对 js、html、css、xml、json、shtml、htm 后缀且大小为 256 ~ 2097152 字节的文件进行 GZIP 压缩 */
declare interface Compression {
/** 智能压缩配置开关,取值有:on:开启off:关闭 */
Switch: string;
/** 压缩规则数组 */
CompressionRules?: CompressionRule[] | null;
}
/** 智能压缩规则配置 */
declare interface CompressionRule {
/** true:需要设置为 ture,启用压缩 */
Compress: boolean | null;
/** 触发压缩的文件长度最小值,单位为字节数 */
MinLength: number | null;
/** 触发压缩的文件长度最大值,单位为字节数最大可设置为 30MB */
MaxLength: number | null;
/** 文件压缩算法gzip:指定 GZIP 压缩brotli:指定Brotli压缩 */
Algorithms: string[] | null;
/** 根据文件后缀类型压缩例如 jpg、txt */
FileExtensions?: string[] | null;
/** 规则类型:all:所有文件生效file:指定文件后缀生效directory:指定路径生效path:指定绝对路径生效contentType:指定Content-Type头为特定值时生效当指定了此字段时,FileExtensions字段不生效 */
RuleType?: string | null;
/** CacheType 对应类型下的匹配内容:all 时填充 *file 时填充后缀名,如 jpg、txtdirectory 时填充路径,如 /xxx/testpath 时填充绝对路径,如 /xxx/test.htmlcontentType 时填充 text/html */
RulePaths?: string[] | null;
}
/** 组成CacheKey的一部分 */
declare interface CookieKey {
/** 使用Cookie作为Cache的一部分配置开关,取值有:on:开启,使用Cookie作为Cache的一部分off:关闭,不使用Cookie作为Cache的一部分 */
Switch: string | null;
/** 使用的cookie,';' 分割 */
Value?: string | null;
}
/** 加速域名全量配置信息 */
declare interface DetailDomain {
/** 域名 ID */
ResourceId?: string;
/** 腾讯云账号ID */
AppId?: number;
/** 加速域名 */
Domain?: string;
/** 域名对应的 CNAME 地址 */
Cname?: string | null;
/** 加速服务状态rejected:域名审核未通过,域名备案过期/被注销导致processing:部署中closing:关闭中online:已启动offline:已关闭 */
Status?: string;
/** 项目 ID,可前往腾讯云项目管理页面查看 */
ProjectId?: number;
/** 加速域名业务类型web:网页小文件download:下载大文件media:音视频点播hybrid: 动静加速dynamic: 动态加速 */
ServiceType?: string;
/** 域名创建时间 */
CreateTime?: string;
/** 域名更新时间 */
UpdateTime?: string;
/** 源站配置 */
Origin?: Origin;
/** IP 黑白名单配置 */
IpFilter?: IpFilter | null;
/** IP 访问限频配置 */
IpFreqLimit?: IpFreqLimit | null;
/** 状态码缓存配置 */
StatusCodeCache?: StatusCodeCache | null;
/** 智能压缩配置 */
Compression?: Compression | null;
/** 带宽封顶配置 */
BandwidthAlert?: BandwidthAlert | null;
/** Range 回源配置 */
RangeOriginPull?: RangeOriginPull | null;
/** 301/302 回源自动跟随配置 */
FollowRedirect?: FollowRedirect | 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;
/** 域名封禁状态normal:正常状态overdue:账号欠费导致域名关闭,充值完成后可自行启动加速服务malicious:域名出现恶意行为,强制关闭加速服务ddos:域名被大规模 DDoS 攻击,关闭加速服务idle:域名超过 90 天内无任何操作、数据产生,判定为不活跃域名自动关闭加速服务,可自行启动加速服务unlicensed:域名未备案/备案注销,自动关闭加速服务,备案完成后可自行启动加速服务capping:触发配置的带宽阈值上限readonly:域名存在特殊配置,被锁定 */
Disable?: string | null;
/** 访问协议强制跳转配置 */
ForceRedirect?: ForceRedirect | null;
/** Referer 防盗链配置 */
Referer?: Referer | null;
/** 浏览器缓存过期规则配置(功能灰度中,敬请期待) */
MaxAge?: MaxAge | null;
/** Ipv6 回源配置(功能灰度中,敬请期待) */
Ipv6?: Ipv6 | null;
/** 是否兼容旧版本配置(内部兼容性字段) */
Compatibility?: Compatibility | null;
/** 区域特殊配置 */
SpecificConfig?: SpecificConfig | null;
/** 加速区域mainland:中国境内加速overseas:中国境外加速global:全球加速 */
Area?: string | null;
/** 域名锁定状态normal:未锁定mainland:中国境内锁定overseas:中国境外锁定global:全球锁定 */
Readonly?: string | null;
/** 回源超时配置 */
OriginPullTimeout?: OriginPullTimeout | null;
/** 回源S3鉴权配置 */
AwsPrivateAccess?: AwsPrivateAccess | null;
/** Scdn配置 */
SecurityConfig?: SecurityConfig | null;
/** ImageOptimization配置 */
ImageOptimization?: ImageOptimization | null;
/** UA黑白名单配置 */
UserAgentFilter?: UserAgentFilter | null;
/** 访问控制 */
AccessControl?: AccessControl | null;
/** 是否支持高级配置项on:支持off:不支持 */
Advance?: string | null;
/** URL重定向配置 */
UrlRedirect?: UrlRedirect | null;
/** 访问端口配置 */
AccessPort?: number[] | null;
/** 标签配置 */
Tag?: Tag[] | null;
/** 时间戳防盗链高级配置,白名单功能 */
AdvancedAuthentication?: AdvancedAuthentication | null;
/** 回源鉴权高级配置,白名单功能 */
OriginAuthentication?: OriginAuthentication | null;
/** Ipv6访问配置 */
Ipv6Access?: Ipv6Access | null;
/** 高级配置集合 */
AdvanceSet?: AdvanceConfig[] | null;
/** 离线缓存(功能灰度中,尚未全量,请等待后续全量发布) */
OfflineCache?: OfflineCache | null;
/** 合并回源(白名单功能) */
OriginCombine?: OriginCombine | null;
/** POST上传配置项 */
PostMaxSize?: PostSize | null;
/** Quic配置 */
Quic?: Quic | null;
/** 回源OSS私有鉴权 */
OssPrivateAccess?: OssPrivateAccess | null;
/** WebSocket配置 */
WebSocket?: WebSocket | null;
/** 远程鉴权配置 */
RemoteAuthentication?: RemoteAuthentication | null;
/** 共享CNAME配置(白名单功能) */
ShareCname?: ShareCname | null;
/** 规则引擎 */
RuleEngine?: RuleEngine | null;
/** 主域名 */
ParentHost?: string | null;
/** 华为云对象存储回源鉴权 */
HwPrivateAccess?: HwPrivateAccess | null;
/** 七牛云对象存储回源鉴权 */
QnPrivateAccess?: QnPrivateAccess | null;
/** HTTPS服务,缺省时默认开启 */
HttpsBilling?: HttpsBilling | null;
/** 其他厂商对象存储回源鉴权 */
OthersPrivateAccess?: OthersPrivateAccess | null;
/** 参数黑名单 */
ParamFilter?: ParamFilter | null;
}
/** 诊断报告内容数据 */
declare interface DiagnoseData {
/** 诊断报告内容 */
Data?: DiagnoseUnit[] | null;
/** 当前诊断项是否正常。"ok":正常"error":异常"warning":"警告" */
Status?: string | null;
}
/** 诊断信息 */
declare interface DiagnoseInfo {
/** 待诊断的URL。 */
DiagnoseUrl?: string | null;
/** 由系统生成的诊断链接。 */
DiagnoseLink?: string | null;
/** 诊断创建时间。 */
CreateTime?: string | null;
/** 诊断链接过期时间。 */
ExpireDate?: string | null;
/** 诊断链接当前访问次数,一个诊断链接最多可访问10次。 */
VisitCount?: number | null;
/** 访问诊断链接的客户端简易信息 */
ClientList?: DiagnoseList[] | null;
/** 域名加速区域 */
Area?: string | null;
}
/** 客户端访问诊断URL信息列表 */
declare interface DiagnoseList {
/** 诊断任务标签。 */
DiagnoseTag?: string | null;
/** 报告ID,用于获取详细诊断报告。 */
ReportId?: string | null;
/** 客户端信息。 */
ClientInfo?: ClientInfo[] | null;
/** 最终诊断结果。-1:已提交0 :检测中1 :检测正常2 : 检测异常3 : 诊断页面异常关闭 */
FinalDiagnose?: number | null;
/** 诊断任务创建时间。 */
CreateTime?: string | null;
}
/** 诊断报告单元信息 */
declare interface DiagnoseUnit {
/** 内容单元英文名称。 */
Key?: string | null;
/** 内容单元中文名称。 */
KeyText?: string | null;
/** 报告内容。 */
Value?: string | null;
/** 报告内容。 */
ValueText?: string | null;
}
/** 地区运营商明细数据 */
declare interface DistrictIspInfo {
/** 域名 */
Domain?: string;
/** 协议类型 */
Protocol?: string;
/** IP协议类型 */
IpProtocol?: string;
/** 起始时间 */
StartTime?: string;
/** 结束时间 */
EndTime?: string;
/** 时间间隔,单位为分钟 */
Interval?: number;
/** 指标名称 */
Metric?: string;
/** 地区ID */
District?: number;
/** 运营商ID */
Isp?: number;
/** 指标数据点 */
DataPoints?: number[];
/** 地区名称 */
DistrictName?: string;
/** 运营商名称 */
IspName?: string;
}
/** 域名地区配置 */
declare interface DomainAreaConfig {
/** 域名 */
Domain: string;
/** 地区列表,其中元素可为mainland/overseas */
Area: string[];
}
/** 域名查询时过滤条件。 */
declare interface DomainFilter {
/** 过滤字段名,支持的列表如下:- 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:标签键。 */
Name: string;
/** 过滤字段值,默认最多传 5 个。当 Name 是 origin/domain 且 Fuzzy 传 true,最多传 1 个。 */
Value: string[];
/** 是否启用模糊查询,仅支持过滤字段名为origin,domain。模糊查询时,Value长度最大为1,否则Value长度最大为5。 */
Fuzzy?: boolean;
}
/** 日志包下载链接详情 */
declare interface DomainLog {
/** 日志包起始时间 */
StartTime?: string;
/** 日志包结束时间 */
EndTime?: string;
/** 日志包下载链接 */
LogPath?: string;
/** 日志包对应加速区域mainland:境内overseas:境外 */
Area?: string;
/** 日志包文件名 */
LogName?: string;
/** 文件大小,单位: Byte */
FileSize?: number | null;
}
/** 单链接下行限速配置,默认为关闭状态 */
declare interface DownstreamCapping {
/** 下行速度配置开关,取值有:on:开启off:关闭 */
Switch: string;
/** 下行限速规则 */
CappingRules?: CappingRule[] | null;
}
/** 动态打包任务过滤器 */
declare interface EdgePackTaskFilter {
/** 过滤字段名apk: apk名称status: 母包处理进度 done, failed, processing */
Name: string;
/** 过滤字段值 */
Value: string[];
/** 是否启用模糊查询,仅支持过滤字段名为 apk。模糊查询时,Value长度最大为1。 */
Fuzzy: boolean;
}
/** 动态打包任务状态 */
declare interface EdgePackTaskStatus {
/** APK 名称 */
Apk?: string;
/** 输出目录 */
DstDir?: string;
/** 上传时间 */
UploadTime?: string;
/** 任务状态created: 创建成功processing: 处理中done: 处理完成failed: 处理失败 */
Status?: string;
/** 上传目录 */
SrcDir?: string[];
/** 失败任务状态详情 */
StatusDesc?: string;
}
/** 状态码重定向配置,默认为关闭状态 */
declare interface ErrorPage {
/** 状态码重定向配置开关,取值有:on:开启off:关闭 */
Switch: string | null;
/** 状态码重定向规则配置 */
PageRules?: ErrorPageRule[] | null;
}
/** 状态码重定向规则配置 */
declare interface ErrorPageRule {
/** 状态码支持 400、403、404、500 */
StatusCode: number;
/** 重定向状态码设置支持 301 或 302 */
RedirectCode: number;
/** 重定向 URL需要为完整跳转路径,如 https://www.test.com/error.html */
RedirectUrl: string;
}
/** 除上海外其他区域日志集和日志主题信息 */
declare interface ExtraLogset {
/** 日志集信息 */
Logset: LogSetInfo | null;
/** 日志主题信息列表 */
Topics: TopicInfo[] | null;
}
/** 回源 301/302 状态码自动跟随配置,默认为关闭状态 */
declare interface FollowRedirect {
/** 回源跟随配置开关,取值有:on:开启off:关闭 */
Switch: string;
/** 自定义回源302 follow请求host配置,该功能为白名单功能,需要开启请联系腾讯云工程师。 */
RedirectConfig?: RedirectConfig | null;
}
/** 访问协议强制跳转配置,默认为关闭状态 */
declare interface ForceRedirect {
/** 访问强制跳转配置开关,取值有:on:开启off:关闭 */
Switch: string | null;
/** 访问强制跳转类型http:强制 http 跳转https:强制 https 跳转 */
RedirectType?: string | null;
/** 强制跳转时返回状态码 支持 301、302、307、308 */
RedirectStatusCode?: number | null;
/** 强制跳转时是否返回增加的头部。 */
CarryHeaders?: string | null;
}
/** 图片优化-GuetzliAdapter配置 */
declare interface GuetzliAdapter {
/** 图片优化-GuetzliAdapter配置开关,取值有:on:开启off:关闭 */
Switch?: string | null;
}
/** HTTP 请求头 */
declare interface HTTPHeader {
/** 请求头名称 */
Name: string;
/** 请求头值 */
Value: string;
}
/** 组成CacheKey */
declare interface HeaderKey {
/** 组成Cachekey配置开关,取值有:on:开启off:关闭 */
Switch?: string | null;
/** 组成CacheKey的header数组,';' 分割 */
Value?: string | null;
}
/** 启发式缓存配置 */
declare interface HeuristicCache {
/** 启发式缓存配置开关,取值有:on:开启off:关闭(默认) */
Switch: string | null;
/** 自定义启发式缓存时间配置 */
CacheConfig?: CacheConfig | null;
}
/** HSTS 配置。 */
declare interface Hsts {
/** HSTS 配置开关,取值有:on:开启off:关闭 */
Switch: string;
/** MaxAge数值。 */
MaxAge?: number | null;
/** 是否包含子域名,on或off。 */
IncludeSubDomains?: string | null;
}
/** Http 头部设置规则,最多可设置 100 条 */
declare interface HttpHeaderPathRule {
/** http 头部设置方式set:设置。变更指定头部参数的取值为设置后的值;若设置的头部不存在,则会增加该头部;若存在多个重复的头部参数,则会全部变更,同时合并为一个头部。del:删除。删除指定的头部参数add:增加。增加指定的头部参数,默认允许重复添加,即重复添加相同的头部(注:重复添加可能会影响浏览器响应,请优先使用set操作) */
HeaderMode: string | null;
/** http 头部名称,最多可设置 100 个字符 */
HeaderName: string | null;
/** http 头部值,最多可设置 2000 个字符Mode 为 del 时非必填Mode 为 add/set 时必填 */
HeaderValue: string | null;
/** 规则类型:all:所有文件生效file:指定文件后缀生效directory:指定路径生效path:指定绝对路径生效 */
RuleType: string | null;
/** RuleType 对应类型下的匹配内容:all 时填充 *file 时填充后缀名,如 jpg、txtdirectory 时填充路径,如 /xxx/test/path 时填充绝对路径,如 /xxx/test.html */
RulePaths: string[] | null;
}
/** http头部设置规则。 */
declare interface HttpHeaderRule {
/** http头部设置方式,支持add,set或del,分别表示新增,设置或删除头部。 */
HeaderMode: string;
/** http头部名称。 */
HeaderName: string;
/** http头部值。 */
HeaderValue: string;
}
/** 域名 https 加速配置,默认为关闭状态 */
declare interface Https {
/** https 配置开关,取值有:on:开启off:关闭 */
Switch: string | null;
/** http2 配置开关on:开启off:关闭 */
Http2?: string | null;
/** OCSP 配置开关on:开启off:关闭默认为关闭状态 */
OcspStapling?: string | null;
/** 客户端证书校验功能on:开启off:关闭默认为关闭状态,开启时需要上传客户端证书信息,该配置项目前在灰度中,尚未全量 */
VerifyClient?: string | null;
/** 服务端证书配置信息 */
CertInfo?: ServerCert | null;
/** 客户端证书配置信息 */
ClientCertInfo?: ClientCert | null;
/** Spdy 配置开关on:开启off:关闭默认为关闭状态 */
Spdy?: string | null;
/** https 证书部署状态closed:已关闭deploying:部署中deployed:部署成功failed:部署失败 */
SslStatus?: string | null;
/** Hsts配置 */
Hsts?: Hsts | null;
/** Tls版本设置,仅支持部分Advance域名,支持设置 TLSv1, TLSv1.1, TLSv1.2, TLSv1.3,修改时必须开启连续的版本 */
TlsVersion?: string[] | null;
}
/** HTTPS服务,若关闭,下发配置拦截https请求,开启时会产生计费 */
declare interface HttpsBilling {
/** HTTPS服务配置开关,取值有:on:开启,缺省时默认开启,会产生计费off:关闭,拦截https请求 */
Switch: string;
}
/** CDN HTTPS请求包。 */
declare interface HttpsPackage {
/** HTTPS请求包 Id */
Id?: number;
/** HTTPS请求包类型 */
Type?: string;
/** HTTPS请求包大小(单位为:次) */
Size?: number;
/** 已消耗HTTPS请求包(单位为:次) */
SizeUsed?: number;
/** HTTPS请求包状态enabled:已启用expired:已过期disabled:未启用 */
Status?: string;
/** HTTPS请求包发放时间 */
CreateTime?: string;
/** HTTPS请求包生效时间 */
EnableTime?: string;
/** HTTPS请求包过期时间 */
ExpireTime?: string;
/** HTTPS请求包来源 */
Channel?: string;
/** HTTPS请求包生命周期月数 */
LifeTimeMonth?: number;
/** HTTPS请求包是否支持退费 */
RefundAvailable?: boolean;
/** HTTPS请求包类型id */
ConfigId?: number;
/** HTTPS请求包实际生效时间 */
TrueEnableTime?: string;
/** HTTPS请求包实际过期时间 */
TrueExpireTime?: string;
/** HTTPS请求包生效区域 global:全球 */
Area?: string;
/** HTTPS请求包是否续订 */
ContractExtension?: boolean;
/** HTTPS请求包是否支持续订 */
ExtensionAvailable?: boolean;
/** HTTPS请求包当前续订模式0:未续订1:到期续订2:用完续订3:到期或用完续订 */
ExtensionMode?: number;
/** HTTPS请求包是否自动续订 */
AutoExtension?: boolean | null;
}
/** 华为云对象存储回源鉴权 */
declare interface HwPrivateAccess {
/** 华为云对象存储回源鉴权配置开关,取值有:on:开启off:关闭 */
Switch: string;
/** 访问 ID */
AccessKey?: string | null;
/** 密钥,字段为脱敏返回。 */
SecretKey?: string | null;
/** bucketname */
Bucket?: string | null;
}
/** ImageOptimization配置 */
declare interface ImageOptimization {
/** WebpAdapter配置 */
WebpAdapter: WebpAdapter | null;
/** TpgAdapter配置 */
TpgAdapter: TpgAdapter | null;
/** GuetzliAdapter配置 */
GuetzliAdapter: GuetzliAdapter | null;
/** AvifAdapter配置 */
AvifAdapter: AvifAdapter | null;
}
/** IP 黑白名单配置,默认为关闭状态 */
declare interface IpFilter {
/** IP 黑白名单配置开关,取值有on:开启off:关闭 */
Switch: string;
/** IP 黑白名单类型whitelist:白名单blacklist:黑名单 */
FilterType?: string | null;
/** 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 个黑名单; */
Filters?: string[] | null;
/** IP 黑白名单分路径配置,白名单功能。黑白名单 IP 总数不能超过 1000 个。 */
FilterRules?: IpFilterPathRule[] | null;
/** IP 黑白名单验证失败时返回的 code 已下线,参数失效,不支持自定义状态码,固定返回514 */
ReturnCode?: number | null;
}
/** IP黑白名单分路径配置 */
declare interface IpFilterPathRule {
/** IP 黑白名单类型whitelist:白名单blacklist:黑名单 */
FilterType: string | null;
/** 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 个黑名单; */
Filters: string[] | null;
/** 规则类型:all:所有文件生效file:指定文件后缀生效directory:指定路径生效path:指定绝对路径生效 */
RuleType: string | null;
/** RuleType 对应类型下的匹配内容:all 时填充 *file 时填充后缀名,如 jpg、txtdirectory 时填充路径,如 /xxx/test/path 时填充绝对路径,如 /xxx/test.html */
RulePaths: string[] | null;
/** 备注信息, 最多支持50个字符 */
Remark?: string;
}
/** 单节点单 IP 访问限频配置,默认为关闭状态 */
declare interface IpFreqLimit {
/** IP 限频配置开关,取值有:on:开启off:关闭 */
Switch: string;
/** 设置每秒请求数限制超出限制的请求会直接返回 514 */
Qps?: number | null;
}
/** 节点 IP 信息 */
declare interface IpStatus {
/** 节点 IP */
Ip?: string;
/** 节点所属区域 */
District?: string;
/** 节点所属运营商 */
Isp?: string;
/** 节点所在城市 */
City?: string;
/** 节点状态online:上线状态,正常调度服务中offline:下线状态 */
Status?: string;
/** 节点 IPV6 */
Ipv6?: string | null;
}
/** Ipv6源站启用配置,不可更改 */
declare interface Ipv6 {
/** 域名开启源站ipv6配置开关,取值有:on:开启off:关闭 */
Switch: string | null;
}
/** Ipv6访问配置 */
declare interface Ipv6Access {
/** 域名开启ipv6访问配置开关,取值有:on:开启off:关闭 */
Switch: string | null;
}
/** 缓存键分路径配置 */
declare interface KeyRule {
/** CacheType 对应类型下的匹配内容:file 时填充后缀名,如 jpg、txtdirectory 时填充路径,如 /xxx/testpath 时填充绝对路径,如 /xxx/test.htmlindex 时填充 / */
RulePaths: string[] | null;
/** 规则类型:file:指定文件后缀生效directory:指定路径生效path:指定绝对路径生效index:首页 */
RuleType: string | null;
/** 是否开启全路径缓存on:开启全路径缓存(即关闭参数忽略)off:关闭全路径缓存(即开启参数忽略) */
FullUrlCache: string | null;
/** 是否忽略大小写缓存 */
IgnoreCase: string | null;
/** CacheKey中包含请求参数 */
QueryString: RuleQueryString | null;
/** 路径缓存键标签,传 user */
RuleTag: string | null;
}
/** 日志集信息 */
declare interface LogSetInfo {
/** 开发者ID */
AppId: number;
/** 渠道 */
Channel: string | null;
/** 日志集ID */
LogsetId: string;
/** 日志集名字 */
LogsetName: string;
/** 是否默认日志集 */
IsDefault: number;
/** 日志保存时间,单位为天 */
LogsetSavePeriod: number;
/** 创建日期 */
CreateTime: string;
/** 区域 */
Region: string;
/** cls侧是否已经被删除 */
Deleted: string | null;
/** 英文区域 */
RegionEn: string | null;
}
/** 域名国内地区特殊配置。分地区特殊配置。UpdateDomainConfig接口只支持修改部分地区配置,为了兼容旧版本配置,本类型会列出旧版本所有可能存在差异的配置列表,支持修改的配置列表如下:+ Authentication+ BandwidthAlert+ ErrorPage+ IpFilter+ Origin+ Referer */
declare interface MainlandConfig {
/** 时间戳防盗链配置。 */
Authentication?: Authentication | null;
/** 带宽封顶配置。 */
BandwidthAlert?: BandwidthAlert | null;
/** 缓存规则配置。 */
Cache?: Cache | null;
/** 缓存相关配置。 */
CacheKey?: CacheKey | null;
/** 智能压缩配置。 */
Compression?: Compression | null;
/** 下载限速配置。 */
DownstreamCapping?: DownstreamCapping | null;
/** 错误码重定向配置。 */
ErrorPage?: ErrorPage | null;
/** 301和302自动回源跟随配置。 */
FollowRedirect?: FollowRedirect | null;
/** 访问协议强制跳转配置。 */
ForceRedirect?: ForceRedirect | null;
/** Https配置。 */
Https?: Https | null;
/** IP黑白名单配置。 */
IpFilter?: IpFilter | null;
/** IP限频配置。 */
IpFreqLimit?: IpFreqLimit | null;
/** 浏览器缓存规则配置。 */
MaxAge?: MaxAge | null;
/** 源站配置。 */
Origin?: Origin | null;
/** 跨国优化配置。 */
OriginPullOptimization?: OriginPullOptimization | null;
/** Range回源配置。 */
RangeOriginPull?: RangeOriginPull | null;
/** 防盗链配置。 */
Referer?: Referer | null;
/** 回源请求头部配置。 */
RequestHeader?: RequestHeader | null;
/** 源站响应头部配置。 */
ResponseHeader?: ResponseHeader | null;
/** 遵循源站缓存头部配置。 */
ResponseHeaderCache?: ResponseHeaderCache | null;
/** seo优化配置。 */
Seo?: Seo | null;
/** 域名业务类型,web,download,media分别表示静态加速,下载加速和流媒体加速。 */
ServiceType?: string | null;
/** 状态码缓存配置。 */
StatusCodeCache?: StatusCodeCache | null;
/** 视频拖拽配置。 */
VideoSeek?: VideoSeek | null;
/** 回源S3私有鉴权。 */
AwsPrivateAccess?: AwsPrivateAccess | null;
/** 回源OSS私有鉴权。 */
OssPrivateAccess?: OssPrivateAccess | null;
/** 华为云对象存储回源鉴权 */
HwPrivateAccess?: HwPrivateAccess | null;
/** 七牛云对象存储回源鉴权 */
QnPrivateAccess?: QnPrivateAccess | null;
}
/** 名称与ID映射关系 */
declare interface MapInfo {
/** 对象 Id */
Id?: number;
/** 对象名称 */
Name?: string;
}
/** 浏览器缓存规则配置,用于设置 MaxAge 默认值,默认为关闭状态 */
declare interface MaxAge {
/** 浏览器缓存配置开关,取值有:on:开启off:关闭 */
Switch: string | null;
/** MaxAge 规则 */
MaxAgeRules?: MaxAgeRule[] | null;
/** MaxAge 状态码相关规则 */
MaxAgeCodeRule?: MaxAgeCodeRule | null;
}
/** MaxAge 状态码相关规则配置 */
declare interface MaxAgeCodeRule {
/** 处理动作clear:清除 cache-control 头部 */
Action: string;
/** 指定HTTP状态码生效,当前仅支持填写"400-599" */
StatusCodes: string[];
}
/** MagAge 规则配置 */
declare interface MaxAgeRule {
/** 规则类型:all:所有文件生效file:指定文件后缀生效directory:指定路径生效path:指定绝对路径生效index: 指定主页生效 */
MaxAgeType: string;
/** MaxAgeType 对应类型下的匹配内容:all 时填充 *file 时填充后缀名,如 jpg、txtdirectory 时填充路径,如 /xxx/test/path 时填充绝对路径,如 /xxx/test.htmlindex 时填充 /注意:all规则不可删除,默认遵循源站,可修改。 */
MaxAgeContents: string[];
/** MaxAge 时间设置,单位秒注意:时间为0,即不缓存。 */
MaxAgeTime: number;
/** 是否遵循源站,on或off,开启时忽略时间设置。 */
FollowOrigin?: string | null;
}
/** 离线缓存是否开启 */
declare interface OfflineCache {
/** 离线缓存配置开关,取值有:on:开启off:关闭 */
Switch: string;
}
/** 源站配置复杂类型,支持以下配置:+ 源站指定为单个域名+ 源站指定为多个 IP,可配置端口(1\~65535),可配置权重(1\~100),格式为 IP:端口:权重+ 回源域名配置+ 对象存储(COS)作为源站+ 热备源站指定为单个域名+ 热备源站指定为多个 IP,可配置端口(1\~65535),暂不支持权重配置+ 热备源站回源域名配置 */
declare interface Origin {
/** 主源站列表修改源站时,需要同时填充对应的 OriginType */
Origins?: string[] | null;
/** 主源站类型当源站列表 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 时需要同时填充对应的 OriginTypeIPv6 功能目前尚未全量,需要先申请试用 */
OriginType?: string | null;
/** 回主源站时 Host 头部当源站类型为cos或者第三方存储加速时,ServerName字段必填不填充则默认为加速域名若接入的是泛域名,则回源 Host 默认为访问时的子域名 */
ServerName?: string | null;
/** OriginType 为对象存储(COS)时,可以指定是否允许访问私有 bucket注意:需要先授权 CDN 访问该私有 Bucket 的权限后,才可开启此配置。取值范围: on/off */
CosPrivateAccess?: string | null;
/** 回源协议配置http:强制 http 回源follow:协议跟随回源https:强制 https 回源 */
OriginPullProtocol?: string | null;
/** 备源站列表修改备源站时,需要同时填充对应的 BackupOriginType */
BackupOrigins?: string[] | null;
/** 备源站类型备源站列表BackupOrigins 不为空时必填支持以下类型:domain:域名类型ip:IP 列表作为源站以下备源源站类型尚未全量支持,需要申请试用:ipv6_domain: 源站列表为多个 IPv6 地址以及域名ip_ipv6:源站列表为多个 IPv4 地址和IPv6 地址ipv6_domain: 源站列表为多个 IPv6 地址以及域名ip_ipv6_domain:源站列表为多个 IPv4 地址IPv6 地址以及域名 */
BackupOriginType?: string | null;
/** 回备源站时 Host 头部,不填充则默认为主源站的 ServerName */
BackupServerName?: string | null;
/** 回源路径 */
BasePath?: string | null;
/** 回源路径重写规则配置 */
PathRules?: PathRule[] | null;
/** 分路径回源配置 */
PathBasedOrigin?: PathBasedOriginRule[] | null;
/** HTTPS回源SNI配置 */
Sni?: OriginSni | null;
/** HTTPS回源高级配置 */
AdvanceHttps?: AdvanceHttps | null;
/** 对象存储回源厂商当源站类型为第三方存储源站(third_party)时必填可选值包括以下:aws_s3: AWS S3ali_oss: 阿里云 OSShw_obs: 华为 OBSqiniu_kodo: 七牛云 kodoothers: 其它厂商对象存储,仅支持兼容以AWS签名算法的对象存储,如腾讯云金融专区COS */
OriginCompany?: string | null;
}
/** 回源鉴权高级配置 */
declare interface OriginAuthentication {
/** 回源鉴权高级配置开关,取值有:on:开启off:关闭 */
Switch: string | null;
/** 鉴权类型A配置 */
TypeA?: OriginAuthenticationTypeA | null;
}
/** 回源鉴权高级配置TypeA */
declare interface OriginAuthenticationTypeA {
/** 用于计算签名的密钥,只允许字母和数字,长度6-32字节。 */
SecretKey: string | null;
}
/** 合并回源配置项 */
declare interface OriginCombine {
/** 合并回源配置开关,取值有:on:开启off:关闭 */
Switch: string;
}
/** CDN回源节点IP信息 */
declare interface OriginIp {
/** 回源IP段/回源IP,默认返回IP段信息。 */
Ip?: string;
}
/** 跨国回源优化配置,默认为关闭状态 (已下线) */
declare interface OriginPullOptimization {
/** 跨国回源优化配置开关,取值有:on:开启off:关闭 */
Switch: string;
/** 跨国类型OVToCN:境外回源境内CNToOV:境内回源境外 */
OptimizationType?: string | null;
}
/** 回源超时配置 */
declare interface OriginPullTimeout {
/** 回源建连超时时间,单位为秒,要求5~60之间 */
ConnectTimeout: number | null;
/** 回源接收超时时间,单位为秒,要求10 ~ 300之间 */
ReceiveTimeout: number | null;
}
/** HTTPS回源SNI */
declare interface OriginSni {
/** 是否开启HTTPS回源SNI。开启:on,关闭:off */
Switch: string;
/** 回源域名。 */
ServerName: string | null;
}
/** oss回源鉴权 */
declare interface OssPrivateAccess {
/** oss回源鉴权配置开关,取值有:on:开启off:关闭 */
Switch: string;
/** 访问ID。 */
AccessKey?: string | null;
/** 密钥,字段为脱敏返回。 */
SecretKey?: string | null;
/** 地域 */
Region?: string | null;
/** Bucketname */
Bucket?: string | null;
}
/** 其他厂商对象存储回源鉴权 */
declare interface OthersPrivateAccess {
/** 其他厂商对象存储回源鉴权配置开关,取值有:on:开启off:关闭 */
Switch: string;
/** 访问ID。 */
AccessKey?: string | null;
/** 密钥,字段位脱敏返回。 */
SecretKey?: string | null;
/** 地域。 */
Region?: string | null;
/** 存储桶名称。 */
Bucket?: string | null;
}
/** 域名海外地区特殊配置。UpdateDomainConfig接口只支持修改部分地区配置,为了兼容旧版本配置,本类型会列出旧版本所有可能存在差异的配置列表,支持修改的配置列表如下:+ Authentication+ BandwidthAlert+ ErrorPage+ IpFilter+ Origin+ Referer */
declare interface OverseaConfig {
/** 时间戳防盗链配置。 */
Authentication?: Authentication | null;
/** 带宽封顶配置。 */
BandwidthAlert?: BandwidthAlert | null;
/** 缓存规则配置。 */
Cache?: Cache | null;
/** 缓存相关配置。 */
CacheKey?: CacheKey | null;
/** 智能压缩配置。 */
Compression?: Compression | null;
/** 下载限速配置。 */
DownstreamCapping?: DownstreamCapping | null;
/** 错误码重定向配置。 */
ErrorPage?: ErrorPage | null;
/** 301和302自动回源跟随配置。 */
FollowRedirect?: FollowRedirect | null;
/** 访问协议强制跳转配置。 */
ForceRedirect?: ForceRedirect | null;
/** Https配置。 */
Https?: Https | null;
/** IP黑白名单配置。 */
IpFilter?: IpFilter | null;
/** IP限频配置。 */
IpFreqLimit?: IpFreqLimit | null;
/** 浏览器缓存规则配置。 */
MaxAge?: MaxAge | null;
/** 源站配置。 */
Origin?: Origin | null;
/** 跨国优化配置。 */
OriginPullOptimization?: OriginPullOptimization | null;
/** Range回源配置。 */
RangeOriginPull?: RangeOriginPull | null;
/** 防盗链配置。 */
Referer?: Referer | null;
/** 回源请求头部配置。 */
RequestHeader?: RequestHeader | null;
/** 源站响应头部配置。 */
ResponseHeader?: ResponseHeader | null;
/** 遵循源站缓存头部配置。 */
ResponseHeaderCache?: ResponseHeaderCache | null;
/** seo优化配置。 */
Seo?: Seo | null;
/** 域名业务类型,web,download,media分别表示静态加速,下载加速和流媒体加速。 */
ServiceType?: string | null;
/** 状态码缓存配置。 */
StatusCodeCache?: StatusCodeCache | null;
/** 视频拖拽配置。 */
VideoSeek?: VideoSeek | null;
/** 回源S3私有鉴权。 */
AwsPrivateAccess?: AwsPrivateAccess | null;
/** 回源OSS私有鉴权。 */
OssPrivateAccess?: OssPrivateAccess | null;
/** 华为云对象存储鉴权 */
HwPrivateAccess?: HwPrivateAccess | null;
/** 七牛云对象存储鉴权 */
QnPrivateAccess?: QnPrivateAccess | null;
}
/** 参数黑名单 */
declare interface ParamFilter {
/** 参数黑名单开关 */
Switch: string | null;
/** 参数黑名单规则 */
FilterRules?: ParamFilterRule[] | null;
}
/** 参数黑名单规则 */
declare interface ParamFilterRule {
/** 参数名 */
Key: string | null;
/** 参数值数组, 小于10个 */
Values: string[] | null;
/** http 返回码 ( 暂仅支持403) */
ReturnCode?: string | null;
}
/** 分路径回源规则 */
declare interface PathBasedOriginRule {
/** 规则类型:file:指定文件后缀生效directory:指定路径生效path:指定绝对路径生效index: 指定主页生效 */
RuleType: string;
/** RuleType 对应类型下的匹配内容:file 时填充后缀名,如 jpg、txtdirectory 时填充路径,如 /xxx/test/path 时填充绝对路径,如 /xxx/test.htmlindex 时填充 / */
RulePaths: string[];
/** 源站列表,支持域名或ipv4地址 */
Origin: string[];
}
/** 分路径回源配置规则。 */
declare interface PathRule {
/** 是否开启通配符“*”匹配:false:关闭true:开启 */
Regex: boolean | null;
/** 匹配的URL路径,仅支持Url路径,不支持参数。默认完全匹配,开启通配符“*”匹配后,最多支持5个通配符,最大长度为1024个字符。 */
Path: string | null;
/** 路径匹配时的回源源站。暂不支持开了私有读写的COS源。不填写时沿用默认源站。 */
Origin?: string | null;
/** 路径匹配时回源的Host头部。不填写时沿用默认ServerName。 */
ServerName?: string | null;
/** 源站所属区域,支持CN,OV:CN:中国境内OV:中国境外默认为CN。 */
OriginArea?: string | null;
/** 路径匹配时回源的URI路径,必须以“/”开头,不包含参数部分。最大长度为1024个字符。可使用$1, $2, $3, $4, $5分别捕获匹配路径中的通配符号“*”,最多支持10个捕获值。 */
ForwardUri?: string | null;
/** 路径匹配时回源的头部设置。 */
RequestHeaders?: HttpHeaderRule[] | null;
/** 当Regex为false时,Path是否开启完全匹配。false:关闭true:开启 */
FullMatch?: boolean | null;
}
/** POST请求上传文件流式传输最大限制 */
declare interface PostSize {
/** POST请求上传文件流式传输最大限制配置开关,取值有:on:开启,平台默认为32MBoff:关闭 */
Switch: string;
/** 最大限制,取值在1MB和200MB之间。 */
MaxSize?: number;
}
/** 刷新任务详情 */
declare interface PurgeTask {
/** 刷新任务 ID */
TaskId?: string;
/** 刷新 URL */
Url?: string;
/** 刷新任务状态fail:刷新失败done:刷新成功process:刷新中 */
Status?: string;
/** 刷新类型url:URL 刷新path:目录刷新 */
PurgeType?: string;
/** 刷新方式flush:刷新更新资源(仅目录刷新时有此类型)delete:刷新全部资源 */
FlushType?: string;
/** 刷新任务提交时间 */
CreateTime?: string;
}
/** 预热任务详情 */
declare interface PushTask {
/** 预热任务 ID */
TaskId?: string;
/** 预热 URL */
Url?: string;
/** 预热任务状态fail:预热失败done:预热成功process:预热中invalid:预热无效(源站返回4xx或5xx状态码) */
Status?: string;
/** 预热进度百分比 */
Percent?: number;
/** 预热任务提交时间 */
CreateTime?: string;
/** 预热区域mainland:境内overseas:境外global:全球 */
Area?: string;
/** 预热任务更新时间 */
UpdateTime?: string | null;
}
/** 七牛元对象存储回源鉴权配置 */
declare interface QnPrivateAccess {
/** 七牛元对象存储回源鉴权配置开关,取值有:on:开启off:关闭 */
Switch: string;
/** 访问 ID */
AccessKey?: string | null;
/** 密钥,字段为脱敏返回。 */
SecretKey?: string;
}
/** 组成CacheKey的一部分 */
declare interface QueryStringKey {
/** CacheKey是否由QueryString组成配置开关,取值有:on:开启off:关闭 */
Switch: string | null;
/** 是否重新排序 */
Reorder?: string | null;
/** 使用/排除部分url参数,取值有:includeAll:包含所有excludeAll:排除所有includeCustom:自定义包含excludeCustom:自定义排除 */
Action?: string | null;
/** 使用/排除的url参数数组,';' 分割 */
Value?: string | null;
}
/** Quic配置项 */
declare interface Quic {
/** Quic功能配置开关,取值有:on:开启off:关闭 */
Switch: string;
}
/** 刷新/预热 可用量及配额 */
declare interface Quota {
/** 单次批量提交配额上限。 */
Batch?: number;
/** 每日提交配额上限。 */
Total?: number;
/** 每日剩余的可提交配额。 */
Available?: number;
/** 配额的区域。 */
Area?: string;
}
/** 分片回源配置,默认为开启状态 */
declare interface RangeOriginPull {
/** 分片回源配置开关,取值有:on:开启off:关闭 */
Switch: string;
/** 分路径分片回源配置 */
RangeRules?: RangeOriginPullRule[] | null;
}
/** 分路径分片回源配置 */
declare interface RangeOriginPullRule {
/** 分片回源配置开关,取值有:on:开启off:关闭 */
Switch: string;
/** 规则类型:file:指定文件后缀生效directory:指定路径生效path:指定绝对路径生效 */
RuleType: string | null;
/** RuleType 对应类型下的匹配内容:file 时填充后缀名,如 jpg、txtdirectory 时填充路径,如 /xxx/testpath 时填充绝对路径,如 /xxx/test.html */
RulePaths: string[] | null;
}
/** 自定义回源302 follow请求host配置 */
declare interface RedirectConfig {
/** 自定义回源302 follow请求host配置开关,取值有:on:开启off:关闭 */
Switch: string;
/** 主源站follow302请求时带的自定义的host头部 */
FollowRedirectHost: string;
/** 备份源站follow302请求时带的自定义的host头部 */
FollowRedirectBackupHost?: string;
}
/** Referer 黑白名单配置,默认为关闭状态 */
declare interface Referer {
/** referer 黑白名单配置开关,取值有:on:开启off:关闭 */
Switch: string;
/** referer 黑白名单配置规则 */
RefererRules?: RefererRule[] | null;
}
/** Referer 黑白名单配置规则,针对特定资源生效 */
declare interface RefererRule {
/** 规则类型:all:所有文件生效file:指定文件后缀生效directory:指定路径生效path:指定绝对路径生效 */
RuleType: string;
/** RuleType 对应类型下的匹配内容:all 时填充 *file 时填充后缀名,如 jpg、txtdirectory 时填充路径,如 /xxx/test/path 时填充绝对路径,如 /xxx/test.html */
RulePaths: string[];
/** referer 配置类型whitelist:白名单blacklist:黑名单 */
RefererType: string;
/** referer 内容列表 */
Referers: string[];
/** 是否允许空 referer防盗链类型为白名单时,true表示允许空 referer,false表示不允许空 referer;防盗链类型为黑名单时,true表示拒绝空referer,false表示不拒绝空referer; */
AllowEmpty: boolean;
}
/** 区域映射id和子区域id的关联信息。 */
declare interface RegionMapRelation {
/** 区域ID。 */
RegionId?: number;
/** 子区域ID列表 */
SubRegionIdList?: number[];
}
/** 远程鉴权规则配置,可以包含多种规则配置。RemoteAuthenticationRules和Server 互斥,只需要配置其中一个。若只配置Server ,RemoteAuthenticationRules中详细规则参数将采用默认参数;默认参数值见各个配置项中说明; */
declare interface RemoteAuthentication {
/** 远程鉴权配置开关,取值有:on:开启off:关闭 */
Switch: string | null;
/** 远程鉴权规则配置 */
RemoteAuthenticationRules?: RemoteAuthenticationRule[] | null;
/** 远程鉴权Server */
Server?: string | null;
}
/** 远程鉴权规则。 */
declare interface RemoteAuthenticationRule {
/** 远程鉴权Server。默认值:和上层配置的"Server"一致; */
Server: string;
/** 请求远程鉴权服务器的http方法;取值范围[get,post,head,all]; all: 表示"遵循终端用户请求方法"默认值: all */
AuthMethod: string;
/** 规则类型:all:所有文件生效file:指定文件后缀生效directory:指定目录生效path:指定文件绝对路径生效默认值:all */
RuleType: string;
/** 对应类型下的匹配内容:all 时填充 *file 时填充后缀名,如 jpg、txtdirectory 时填充路径,如 /xxx/testpath 时填充绝对路径,如 /xxx/test.htmlindex 时填充 /默认值:* */
RulePaths: string[];
/** 请求远程鉴权服务器超时时间,单位毫秒;取值范围:[1,30 000]默认值:20000 */
AuthTimeout: number;
/** 请求远程鉴权服务器超时后执行拦截或者放行;RETURN_200: 超时后放行;RETURN_403:超时拦截;默认值:RETURN_200 */
AuthTimeoutAction: string;
}
/** CDN报表数据 */
declare interface ReportData {
/** 项目ID/域名ID。 */
ResourceId?: string;
/** 项目名称/域名。 */
Resource?: string;
/** 流量总和/带宽最大值,单位分别为bytes,bps。 */
Value?: number;
/** 单个资源占总体百分比。 */
Percentage?: number;
/** 计费流量总和/计费带宽最大值,单位分别为bytes,bps。 */
BillingValue?: number;
/** 计费数值占总体百分比。 */
BillingPercentage?: number;
}
/** 自定义请求头配置,默认为关闭状态 */
declare interface RequestHeader {
/** 自定义请求头配置开关,取值有:on:开启off:关闭 */
Switch: string;
/** 自定义请求头配置规则 */
HeaderRules?: HttpHeaderPathRule[] | null;
}
/** 计费数据明细 */
declare interface ResourceBillingData {
/** 资源名称,根据查询条件不同分为以下几类:某一个具体域名:表示该域名明细数据multiDomains:表示多域名汇总明细数据某一个项目 ID:指定项目查询时,显示为项目 IDall:账号维度数据明细 */
Resource?: string;
/** 计费数据详情 */
BillingData?: CdnData[];
}
/** 查询对象及其对应的访问明细数据 */
declare interface ResourceData {
/** 资源名称,根据查询条件不同分为以下几类:单域名:指定单域名查询,表示该域名明细数据,当传入参数 detail 指定为 true 时,显示该域名( detail 参数默认为 false )多域名:指定多个域名查询,表示多域名汇总明细数据,显示 multiDomains项目 ID:指定项目查询时,表示该项目下的域名汇总明细数据,显示该项目 IDall:账号维度明细数据,即账号下所有域名的汇总明细数据 */
Resource: string;
/** 资源对应的数据明细 */
CdnData: CdnData[];
}
/** 查询对象及其对应的回源明细数据 */
declare interface ResourceOriginData {
/** 资源名称,根据查询条件不同分为以下几类:具体域名:表示该域名明细数据multiDomains:表示多域名汇总明细数据项目 ID:指定项目查询时,显示为项目 IDall:账号维度明细数据 */
Resource?: string;
/** 回源数据详情 */
OriginData?: CdnData[];
}
/** 自定义响应头配置,默认为关闭状态 */
declare interface ResponseHeader {
/** 自定义响应头配置开关,取值有:on:开启off:关闭 */
Switch: string;
/** 自定义响应头规则 */
HeaderRules?: HttpHeaderPathRule[] | null;
}
/** 源站头部缓存配置,默认为开启状态,缓存所有头部信息 */
declare interface ResponseHeaderCache {
/** 源站头部缓存配置开关,取值有:on:开启off:关闭 */
Switch: string;
}
/** 是否回源站校验 */
declare interface Revalidate {
/** 总是回源校验配置开关,取值有:on:开启off:关闭 */
Switch: string | null;
/** 只在特定请求路径回源站校验 */
Path?: string | null;
}
/** 缓存配置分路径版本。默认情况下所有文件缓存过期时间为 30 天 默认情况下静态加速类型的域名 .php;.jsp;.asp;.aspx 不缓存 */
declare interface RuleCache {
/** CacheType 对