@nocobase/plugin-verification
Version:
User identity verification management, including SMS, TOTP authenticator, with extensibility.
10,154 lines • 264 kB
TypeScript
/**
* DescribeWafData请求参数结构体
*/
export interface DescribeWafDataRequest {
/**
* 查询起始时间，如：2018-09-04 10:40:00，返回结果大于等于指定时间
*/
StartTime: string;
/**
* 查询结束时间，如：2018-09-04 10:40:00，返回结果小于等于指定时间
*/
EndTime: string;
/**
* 时间粒度，支持以下几种模式：
min：1 分钟粒度，指定查询区间 24 小时内（含 24 小时），可返回 1 分钟粒度明细数据
5min：5 分钟粒度，指定查询区间 31 天内（含 31 天），可返回 5 分钟粒度明细数据
hour：1 小时粒度，指定查询区间 31 天内（含 31 天），可返回 1 小时粒度明细数据
day：天粒度，指定查询区间大于 31 天，可返回天粒度明细数据
仅支持30天内数据查询，且查询时间范围在 7 到 30 天最小粒度是 hour。
*/
Interval: string;
/**
* 指定域名查询
*/
Domain?: string;
/**
* 指定攻击类型
不填则查询所有攻击类型的数据分布
AttackType 映射如下:
"webshell" : Webshell检测防护
"oa" : 常见OA漏洞防护
"xss" : XSS跨站脚本攻击防护
"xxe" : XXE攻击防护
"webscan" : 扫描器攻击漏洞防护
"cms" : 常见CMS漏洞防护
"upload" : 恶意文件上传攻击防护
"sql" : SQL注入攻击防护
"cmd_inject": 命令/代码注入攻击防护
"osc" : 开源组件漏洞防护
"file_read" : 任意文件读取
"ldap" : LDAP注入攻击防护
"other" : 其它漏洞防护
*/
AttackType?: string;
/**
* 指定防御模式
不填则查询所有防御模式的数据总和
DefenceMode映射如下：
observe = '观察模式'
intercept = '拦截模式'
*/
DefenceMode?: string;
/**
* 地域：mainland 或 overseas
*/
Area?: string;
/**
* 指定多个攻击类型，取值参考AttackType
*/
AttackTypes?: Array<string>;
/**
* 指定域名列表查询
*/
Domains?: Array<string>;
}
/**
* DescribeCdnDomainLogs返回参数结构体
*/
export interface DescribeCdnDomainLogsResponse {
/**
* 日志包下载链接。
下载内容是gz后缀的压缩包，解压后是无扩展名的文本文件。
*/
DomainLogs?: Array<DomainLog>;
/**
* 查询到的总条数
*/
TotalCount?: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SCDN攻击数据Top URL展示
*/
export interface ScdnTopUrlData {
/**
* Top数据的URL
*/
Url: string;
/**
* 数值
*/
Value: number;
/**
* 时间
*/
Time: string;
/**
* 域名
注意：此字段可能返回 null，表示取不到有效值。
*/
Domain: string;
}
/**
* 智能压缩配置，默认对 js、html、css、xml、json、shtml、htm 后缀且大小为 256 ~ 2097152 字节的文件进行 GZIP 压缩
*/
export interface Compression {
/**
* 智能压缩配置开关，取值有：
on：开启
off：关闭
*/
Switch: string;
/**
* 压缩规则数组
注意：此字段可能返回 null，表示取不到有效值。
*/
CompressionRules?: Array<CompressionRule>;
}
/**
* ImageOptimization配置
*/
export interface ImageOptimization {
/**
* WebpAdapter配置
注意：此字段可能返回 null，表示取不到有效值。
*/
WebpAdapter: WebpAdapter;
/**
* TpgAdapter配置
注意：此字段可能返回 null，表示取不到有效值。
*/
TpgAdapter: TpgAdapter;
/**
* GuetzliAdapter配置
注意：此字段可能返回 null，表示取不到有效值。
*/
GuetzliAdapter: GuetzliAdapter;
/**
* AvifAdapter配置
注意：此字段可能返回 null，表示取不到有效值。
*/
AvifAdapter: AvifAdapter;
}
/**
* DescribeCdnDomainLogs请求参数结构体
*/
export interface DescribeCdnDomainLogsRequest {
/**
* 指定域名查询
*/
Domain: string;
/**
* 开始时间
*/
StartTime: string;
/**
* 结束时间
*/
EndTime: string;
/**
* 分页查询偏移量，默认为 0
*/
Offset?: number;
/**
* 分页查询限制数目，默认为 100，最大为 1000
*/
Limit?: number;
/**
* 指定区域下载日志，默认为 mainland，可取值有：
<li>mainland：获取境内加速日志包下载链接</li>
<li>overseas：获取境外加速日志包下载链接</li>
<li>global：同时获取境内、境外加速日志包下载链接（分开打包）</li>
*/
Area?: string;
/**
* 指定下载日志的类型，可取值有：
<li>access：访问日志</li>
*/
LogType?: string;
}
/**
* CC攻击Top数据
*/
export interface CcTopData {
/**
* 客户端Ip
注意：此字段可能返回 null，表示取不到有效值。
*/
Ip: string;
/**
* 访问URL
注意：此字段可能返回 null，表示取不到有效值。
*/
Url: string;
/**
* 客户端UserAgent
注意：此字段可能返回 null，表示取不到有效值。
*/
UserAgent: string;
/**
* 请求数
注意：此字段可能返回 null，表示取不到有效值。
*/
Value: number;
/**
* 域名
注意：此字段可能返回 null，表示取不到有效值。
*/
Domain: string;
}
/**
* ListTopBotData返回参数结构体
*/
export interface ListTopBotDataResponse {
/**
* 域名BOT次数列表
*/
Data: Array<DomainBotCount>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 域名国内海外分地区特殊配置。
*/
export interface SpecificConfig {
/**
* 国内特殊配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
Mainland?: MainlandConfig;
/**
* 海外特殊配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
Overseas?: OverseaConfig;
}
/**
* 缓存配置分路径版本。
默认情况下所有文件缓存过期时间为 30 天
默认情况下静态加速类型的域名 .php;.jsp;.asp;.aspx 不缓存
*/
export interface RuleCache {
/**
* CacheType 对应类型下的匹配内容：
all 时填充 *
file 时填充后缀名，如 jpg、txt
directory 时填充路径，如 /xxx/test
path 时填充绝对路径，如 /xxx/test.html
index 时填充 /
注意：此字段可能返回 null，表示取不到有效值。
*/
RulePaths: Array<string>;
/**
* 规则类型：
all：所有文件生效
file：指定文件后缀生效
directory：指定路径生效
path：指定绝对路径生效
index：首页
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleType: string;
/**
* 缓存配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
CacheConfig: RuleCacheConfig;
}
/**
* Http 头部设置规则，最多可设置 100 条
*/
export interface HttpHeaderPathRule {
/**
* http 头部设置方式
set：设置。变更指定头部参数的取值为设置后的值；若设置的头部不存在，则会增加该头部；若存在多个重复的头部参数，则会全部变更，同时合并为一个头部。
del：删除。删除指定的头部参数
add：增加。增加指定的头部参数，默认允许重复添加，即重复添加相同的头部（注：重复添加可能会影响浏览器响应，请优先使用set操作）
注意：此字段可能返回 null，表示取不到有效值。
*/
HeaderMode: string;
/**
* http 头部名称，最多可设置 100 个字符
注意：此字段可能返回 null，表示取不到有效值。
*/
HeaderName: string;
/**
* http 头部值，最多可设置 1000 个字符
Mode 为 del 时非必填
Mode 为 add/set 时必填
注意：此字段可能返回 null，表示取不到有效值。
*/
HeaderValue: string;
/**
* 规则类型：
all：所有文件生效
file：指定文件后缀生效
directory：指定路径生效
path：指定绝对路径生效
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleType: string;
/**
* RuleType 对应类型下的匹配内容：
all 时填充 *
file 时填充后缀名，如 jpg、txt
directory 时填充路径，如 /xxx/test/
path 时填充绝对路径，如 /xxx/test.html
注意：此字段可能返回 null，表示取不到有效值。
*/
RulePaths: Array<string>;
}
/**
* UserAgent黑白名单配置
*/
export interface UserAgentFilter {
/**
* UserAgent黑白名单配置开关，取值有：
on：开启
off：关闭
注意：此字段可能返回 null，表示取不到有效值。
*/
Switch: string;
/**
* UA黑白名单生效规则列表
注意：此字段可能返回 null，表示取不到有效值。
*/
FilterRules?: Array<UserAgentFilterRule>;
}
/**
* DescribeScdnTopData返回参数结构体
*/
export interface DescribeScdnTopDataResponse {
/**
* WAF 攻击类型统计
注意：此字段可能返回 null，表示取不到有效值。
*/
TopTypeData?: Array<ScdnTypeData>;
/**
* TOP 攻击源 IP 统计
注意：此字段可能返回 null，表示取不到有效值。
*/
TopIpData?: Array<ScdnTopData>;
/**
* 查询的SCDN类型，当前仅支持 waf
*/
Mode?: string;
/**
* TOP URL 统计
注意：此字段可能返回 null，表示取不到有效值。
*/
TopUrlData?: Array<ScdnTopUrlData>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 聚合了SCDN域名的基本信息
*/
export interface ScdnDomain {
/**
* 域名
*/
Domain: string;
/**
* 当前状态，取值online | offline | process
*/
Status: string;
/**
* Waf 状态默认为‘/’，取值 close | intercept | observe
*/
Waf: string;
/**
* Acl 状态默认为‘/’，取值 close | open
*/
Acl: string;
/**
* CC 状态默认为‘/’，取值 close | open
*/
CC: string;
/**
* Ddos 状态默认为‘/’，取值 close | open
*/
Ddos: string;
/**
* 项目ID
*/
ProjectId: string;
/**
* Acl 规则数
*/
AclRuleNumbers: number;
/**
* Bot 状态默认为‘/’，取值 close | open
*/
Bot: string;
/**
* 域名加速区域，取值global | mainland | overseas
注意：此字段可能返回 null，表示取不到有效值。
*/
Area: string;
/**
* waf规则等级，可取100|200|300
注意：此字段可能返回 null，表示取不到有效值。
*/
WafLevel: number;
}
/**
* 路径缓存不缓存配置
*/
export interface CacheConfigNoCache {
/**
* 路径缓存不缓存配置配置开关，取值有：
on：开启
off：关闭
注意：此字段可能返回 null，表示取不到有效值。
*/
Switch: string;
/**
* 总是回源站校验
on：开启
off：关闭
默认为关闭状态
注意：此字段可能返回 null，表示取不到有效值。
*/
Revalidate: string;
}
/**
* BOT记录详细内容
*/
export interface BotRecord {
/**
* 动作，取值为以为3个类型中的一个："intercept","permit","monitor"，分别表示： 拦截， 放行，监控
*/
Action: string;
/**
* 会话总次数
*/
Nums: number;
/**
* BotType=UB时，表示预测标签，取值如下：
"crawler_unregular",
"crawler_regular",
"request_repeat",
"credential_miss_user",
"credential_without_user",
"credential_only_action",
"credential_user_password",
"credential_cracking",
"credential_stuffing",
"brush_sms",
"brush_captcha",
"reg_malicious"
BotType=TCB时，表示Bot分类，取值如下：
"Uncategorised",
"Search engine bot",
"Site monitor",
"Screenshot creator",
"Link checker",
"Web scraper",
"Vulnerability scanner",
"Virus scanner",
"Speed tester",
"Feed Fetcher",
"Tool",
"Marketing"
BotType=UCB时，为二期接口，暂时未定义内容
*/
RuleName: string;
/**
* 会话持续时间
*/
SessionDuration: number;
/**
* 访问源IP
*/
SrcIp: string;
/**
* 异常特征
*/
BotFeature: Array<string>;
/**
* 最新检测时间
*/
Time: string;
/**
* BOT得分
*/
Score: number;
/**
* 平均速率
*/
AvgSpeed: number;
/**
* BotType=TCB，表示TCB名称
注意：此字段可能返回 null，表示取不到有效值。
*/
TcbDetail: string;
/**
* BOT记录唯一ID，用于查询访问详情
*/
Id: string;
/**
* 域名
注意：此字段可能返回 null，表示取不到有效值。
*/
Domain: string;
}
/**
* ListScdnTopBotData请求参数结构体
*/
export interface ListScdnTopBotDataRequest {
/**
* 获取Top量，取值范围[1-10]
*/
TopCount: number;
/**
* 开始时间
*/
StartTime: string;
/**
* 结束时间
*/
EndTime: string;
/**
* mainland 大陆地区 overseas境外地区
*/
Area: string;
/**
* session表示查询BOT会话的Top信息
ip表示查询BOT客户端IP的Top信息
不填代表获取会话信息
*/
Metric?: string;
/**
* 域名，仅当Metric=ip，并且Domain为空时有效，不填写表示获取AppID信息
*/
Domains?: Array<string>;
}
/**
* 自定义回源302 follow请求host配置
*/
export interface RedirectConfig {
/**
* 自定义回源302 follow请求host配置开关，取值有：
on：开启
off：关闭
*/
Switch: string;
/**
* 主源站follow302请求时带的自定义的host头部
*/
FollowRedirectHost: string;
/**
* 备份源站follow302请求时带的自定义的host头部
*/
FollowRedirectBackupHost?: string;
}
/**
* UpdateScdnDomain返回参数结构体
*/
export interface UpdateScdnDomainResponse {
/**
* 提交结果，Success表示成功
*/
Result?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 源站配置复杂类型，支持以下配置：
+ 源站指定为单个域名
+ 源站指定为多个 IP，可配置端口（1\~65535），可配置权重（1\~100），格式为 IP:端口:权重
+ 回源域名配置
+ 对象存储（COS）作为源站
+ 热备源站指定为单个域名
+ 热备源站指定为多个 IP，可配置端口（1\~65535），暂不支持权重配置
+ 热备源站回源域名配置
*/
export interface Origin {
/**
* 主源站列表
<font color=red>修改源站时，需要同时填充对应的 OriginType</font>
注意：此字段可能返回 null，表示取不到有效值。
*/
Origins?: Array<string>;
/**
* 主源站类型
<font color=red>当源站列表 Origins 不为空时必填</font>
入参支持以下几种类型：
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，表示取不到有效值。
*/
OriginType?: string;
/**
* 回主源站时 Host 头部
<font color=red>当源站类型为cos或者第三方存储加速时,ServerName字段必填</font>
不填充则默认为加速域名
若接入的是泛域名，则回源 Host 默认为访问时的子域名
注意：此字段可能返回 null，表示取不到有效值。
*/
ServerName?: string;
/**
* OriginType 为对象存储（COS）时，可以指定是否允许访问私有 bucket
注意：需要先授权 CDN 访问该私有 Bucket 的权限后，才可开启此配置。取值范围: on/off
注意：此字段可能返回 null，表示取不到有效值。
*/
CosPrivateAccess?: string;
/**
* 回源协议配置
http：强制 http 回源
follow：协议跟随回源
https：强制 https 回源，https 回源时仅支持源站 443 端口
注意：此字段可能返回 null，表示取不到有效值。
*/
OriginPullProtocol?: string;
/**
* 备源站列表
<font color=red>修改备源站时，需要同时填充对应的 BackupOriginType</font>
注意：此字段可能返回 null，表示取不到有效值。
*/
BackupOrigins?: Array<string>;
/**
* 备源站类型
<font color=red>备源站列表BackupOrigins 不为空时必填</font>
支持以下类型：
domain：域名类型
ip：IP 列表作为源站
以下备源源站类型尚未全量支持，需要申请试用：
ipv6_domain: 源站列表为多个 IPv6 地址以及域名
ip_ipv6：源站列表为多个 IPv4 地址和IPv6 地址
ipv6_domain: 源站列表为多个 IPv6 地址以及域名
ip_ipv6_domain：源站列表为多个 IPv4 地址IPv6 地址以及域名
注意：此字段可能返回 null，表示取不到有效值。
*/
BackupOriginType?: string;
/**
* 回备源站时 Host 头部，不填充则默认为主源站的 ServerName
注意：此字段可能返回 null，表示取不到有效值。
*/
BackupServerName?: string;
/**
* 回源路径
注意：此字段可能返回 null，表示取不到有效值。
*/
BasePath?: string;
/**
* 回源路径重写规则配置
注意：此字段可能返回 null，表示取不到有效值。
*/
PathRules?: Array<PathRule>;
/**
* 分路径回源配置
注意：此字段可能返回 null，表示取不到有效值。
*/
PathBasedOrigin?: Array<PathBasedOriginRule>;
/**
* HTTPS回源SNI配置
注意：此字段可能返回 null，表示取不到有效值。
*/
Sni?: OriginSni;
/**
* HTTPS回源高级配置
注意：此字段可能返回 null，表示取不到有效值。
*/
AdvanceHttps?: AdvanceHttps;
/**
* 对象存储回源厂商
<font color=red>当源站类型为第三方存储源站(third_party)时必填</font>
可选值包括以下:
aws_s3: AWS S3
ali_oss: 阿里云 OSS
hw_obs: 华为 OBS
qiniu_kodo: 七牛云 kodo
others: 其它厂商对象存储,仅支持兼容以AWS签名算法的对象存储，如腾讯云金融专区COS
注意：此字段可能返回 null，表示取不到有效值。
*/
OriginCompany?: string;
}
/**
* DescribeBillingData请求参数结构体
*/
export interface DescribeBillingDataRequest {
/**
* 查询起始时间，如：2018-09-04 10:40:00，返回结果大于等于指定时间
根据指定时间粒度参数不同，会进行向前取整，如指定起始时间为 2018-09-04 10:40:00 按小时粒度查询，返回的第一个数据对应时间点为 2018-09-04 10:00:00
起始时间与结束时间间隔小于等于 90 天
*/
StartTime: string;
/**
* 查询结束时间，如：2018-09-04 10:40:00，返回结果小于等于指定时间
根据指定时间粒度参数不同，会进行向前取整，如指定结束时间为 2018-09-04 10:40:00 按小时粒度查询时，返回的最后一个数据对应时间点为 2018-09-04 10:00:00
起始时间与结束时间间隔小于等于 90 天
*/
EndTime: string;
/**
* 时间粒度，支持模式如下：
min：1 分钟粒度，查询区间需要小于等于 24 小时
5min：5 分钟粒度，查询区间需要小于等于 31 天(计费数据粒度)
hour：1 小时粒度，查询区间需要小于等于 31 天内
day：天粒度，查询区间需要大于 31 天
Area 字段为 overseas 时暂不支持1分钟粒度数据查询
*/
Interval?: string;
/**
* 指定域名查询计费数据
*/
Domain?: string;
/**
* 指定项目 ID 查询，[前往查看项目 ID](https://console.cloud.tencent.com/project)
若 Domain 参数填充了具体域名信息，则返回该域名的计费数据，而非指定项目计费数据
*/
Project?: number;
/**
* 指定加速区域查询计费数据：
mainland：中国境内
overseas：中国境外
不填充时，默认为 mainland
*/
Area?: string;
/**
* Area 为 overseas 时，指定国家/地区查询
省份、国家/地区编码可以查看 [省份编码映射](https://cloud.tencent.com/document/product/228/6316#.E7.9C.81.E4.BB.BD.E6.98.A0.E5.B0.84)
不填充时，查询所有国家/地区
*/
District?: number;
/**
* 计费统计类型
flux：计费流量
bandwidth：计费带宽
默认为 bandwidth
*/
Metric?: string;
/**
* 指定查询的产品数据，可选为cdn或者ecdn，默认为cdn
*/
Product?: string;
/**
* 指定查询时间的时区，默认UTC+08:00
*/
TimeZone?: string;
}
/**
* 域名标签配置
*/
export interface Tag {
/**
* 标签键
注意：此字段可能返回 null，表示取不到有效值。
*/
TagKey: string;
/**
* 标签值
注意：此字段可能返回 null，表示取不到有效值。
*/
TagValue: string;
}
/**
* DescribeCdnOriginIp请求参数结构体
*/
export declare type DescribeCdnOriginIpRequest = null;
/**
* DescribeDiagnoseReport请求参数结构体
*/
export interface DescribeDiagnoseReportRequest {
/**
* 报告ID
*/
ReportId: string;
}
/**
* 域名基础配置信息，含 CNAME、状态、业务类型、加速区域、创建时间、更新时间、源站配置等。
*/
export 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;
}
/**
* 路径缓存缓存配置（三种缓存模式中选取一种）
*/
export interface RuleCacheConfig {
/**
* 缓存配置
注意：此字段可能返回 null，表示取不到有效值。
*/
Cache: CacheConfigCache;
/**
* 不缓存配置
注意：此字段可能返回 null，表示取不到有效值。
*/
NoCache: CacheConfigNoCache;
/**
* 遵循源站配置
注意：此字段可能返回 null，表示取不到有效值。
*/
FollowOrigin: CacheConfigFollowOrigin;
}
/**
* EnableClsLogTopic返回参数结构体
*/
export interface EnableClsLogTopicResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ListClsLogTopics返回参数结构体
*/
export interface ListClsLogTopicsResponse {
/**
* 上海区域日志集信息
*/
Logset: LogSetInfo;
/**
* 上海区域日志主题信息列表
注意：此字段可能返回 null，表示取不到有效值。
*/
Topics: Array<TopicInfo>;
/**
* 其他区域日志集信息列表
注意：此字段可能返回 null，表示取不到有效值。
*/
ExtraLogset: Array<ExtraLogset>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* VerifyDomainRecord返回参数结构体
*/
export interface VerifyDomainRecordResponse {
/**
* 是否验证成功
*/
Result?: boolean;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 时间戳防盗链高级版模式E配置。
*/
export interface AdvancedAuthenticationTypeE {
/**
* 用于计算签名的密钥，只允许字母和数字，长度6-32字节。
注意：此字段可能返回 null，表示取不到有效值。
*/
SecretKey: string;
/**
* uri串中签名的字段名，字母，数字或下划线构成，同时必须以字母开头。
注意：此字段可能返回 null，表示取不到有效值。
*/
SignParam: string;
/**
* uri串中Acl签名的字段名，字母，数字或下划线构成，同时必须以字母开头。
注意：此字段可能返回 null，表示取不到有效值。
*/
AclSignParam: string;
/**
* uri串中开始时间字段名，字母，数字或下划线构成，同时必须以字母开头。
注意：此字段可能返回 null，表示取不到有效值。
*/
StartTimeParam: string;
/**
* uri串中过期时间字段名，字母，数字或下划线构成，同时必须以字母开头。
注意：此字段可能返回 null，表示取不到有效值。
*/
ExpireTimeParam: string;
/**
* 时间格式，dec
注意：此字段可能返回 null，表示取不到有效值。
*/
TimeFormat: string;
}
/**
* 时间戳防盗链高级版模式D配置。
*/
export interface AdvancedAuthenticationTypeD {
/**
* 用于计算签名的密钥，只允许字母和数字，长度6-32字节。
*/
SecretKey: string;
/**
* 备份密钥，当使用SecretKey鉴权失败时会使用该密钥重新鉴权。
*/
BackupSecretKey: string;
/**
* uri串中签名的字段名，字母，数字或下划线构成，同时必须以字母开头。
*/
SignParam: string;
/**
* uri串中时间的字段名，字母，数字或下划线构成，同时必须以字母开头。
*/
TimeParam: string;
/**
* 过期时间，单位秒。
*/
ExpireTime: number;
/**
* 时间格式，dec，hex分别表示十进制，十六进制。
*/
TimeFormat: string;
}
/**
* 时间戳防盗链高级鉴权模式TypeF配置
*/
export interface AdvancedAuthenticationTypeF {
/**
* uri串中签名的字段名，字母，数字或下划线构成，同时必须以字母开头。
注意：此字段可能返回 null，表示取不到有效值。
*/
SignParam: string;
/**
* uri串中时间的字段名，字母，数字或下划线构成，同时必须以字母开头。
注意：此字段可能返回 null，表示取不到有效值。
*/
TimeParam: string;
/**
* uri串中Transaction字段名，字母，数字或下划线构成，同时必须以字母开头。
注意：此字段可能返回 null，表示取不到有效值。
*/
TransactionParam: string;
/**
* 用于计算签名的主密钥，只允许字母和数字，长度6-32字节。
注意：此字段可能返回 null，表示取不到有效值。
*/
SecretKey: string;
/**
* 用于计算签名的备选密钥，主密钥校验失败后再次尝试备选密钥，只允许字母和数字，长度6-32字节。
注意：此字段可能返回 null，表示取不到有效值。
*/
BackupSecretKey?: string;
}
/**
* 时间戳防盗链高级版模式A配置。
*/
export 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: Array<string>;
/**
* 保留字段。
*/
Transformation?: number;
}
/**
* ListTopCcData请求参数结构体
*/
export interface ListTopCcDataRequest {
/**
* 查询Top数据的开始时间，格式为：2020-01-01 00:00:00
*/
StartTime: string;
/**
* 查询Top数据的结束时间，格式为：2020-01-01 23:59:59
支持 90 天内数据查询，不传此参数，表示查当天数据
时间跨度要小于等于7天
*/
EndTime: string;
/**
* 域名，不传此参数，表示查询账号级别数据
*/
Domain?: string;
/**
* 统计指标：
ip_url : Top IP+URL 默认值
ua : Top UA
*/
Metric?: string;
/**
* cdn表示CDN数据，默认值
ecdn表示ECDN数据
*/
Source?: string;
/**
* 域名列表，不传此参数，表示查询账号级别数据
*/
Domains?: Array<string>;
/**
* 执行动作，取值为：intercept/redirect/observe
分别表示：拦截/重定向/观察
为空表示查询所有执行动作数据
*/
ActionName?: string;
/**
* 地域：mainland或overseas，表示国内或海外，不填写默认表示国内
*/
Area?: string;
}
/**
* 时间戳防盗链高级版模式B配置。
*/
export 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: Array<string>;
}
/**
* CreateScdnLogTask返回参数结构体
*/
export interface CreateScdnLogTaskResponse {
/**
* 创建结果,
"0" -> 创建成功
*/
Result: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 时间戳防盗链模式 C 配置
时间戳防盗链模式 C 的访问 URL 格式为：http://DomainName/md5hash/timestamp/FileName
其中 timestamp 为十六进制 UNIX 时间戳；
md5hash：MD5（自定义密钥 + 文件路径 + timestamp）
*/
export interface AuthenticationTypeC {
/**
* 计算签名的密钥
仅允许大小写字母与数字，长度 6~32 位
注意：此字段可能返回 null，表示取不到有效值。
*/
SecretKey: string;
/**
* 签名过期时间设置
单位为秒，最大可设置为 630720000
*/
ExpireTime: number;
/**
* 鉴权/不做鉴权的文件扩展名列表设置
如果包含字符 * 则表示所有文件
*/
FileExtensions: Array<string>;
/**
* whitelist：白名单，表示对除了 FileExtensions 列表之外的所有类型进行鉴权
blacklist：黑名单，表示仅对 FileExtensions 中的类型进行鉴权
*/
FilterType: string;
/**
* 时间戳进制设置
dec：十进制
hex：十六进制
注意：此字段可能返回 null，表示取不到有效值。
*/
TimeFormat?: string;
/**
* 计算签名的备用密钥
仅允许大小写字母与数字，长度 6~32 位
注意：此字段可能返回 null，表示取不到有效值。
*/
BackupSecretKey?: string;
}
/**
* 回源鉴权高级配置TypeA
*/
export interface OriginAuthenticationTypeA {
/**
* 用于计算签名的密钥，只允许字母和数字，长度6-32字节。
注意：此字段可能返回 null，表示取不到有效值。
*/
SecretKey: string;
}
/**
* DescribeScdnIpStrategy返回参数结构体
*/
export interface DescribeScdnIpStrategyResponse {
/**
* IP策略列表
注意：此字段可能返回 null，表示取不到有效值。
*/
IpStrategyList?: Array<ScdnIpStrategy>;
/**
* 配置的策略条数
注意：此字段可能返回 null，表示取不到有效值。
*/
TotalCount?: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 攻击ip数据详细数据
*/
export interface DDoSAttackIPTopData {
/**
* 攻击ip
*/
AttackIP: string;
/**
* 攻击ip所在省份
*/
Province: string;
/**
* 攻击ip所在国家
*/
Country: string;
/**
* 红果电信
*/
Isp: string;
/**
* 攻击次数
*/
AttackCount: number;
}
/**
* CreateDiagnoseUrl返回参数结构体
*/
export interface CreateDiagnoseUrlResponse {
/**
* 系统生成的诊断链接，一个诊断链接最多可访问10次，有效期为24h。
*/
DiagnoseLink?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ListScdnDomains返回参数结构体
*/
export interface ListScdnDomainsResponse {
/**
* 域名列表信息
注意：此字段可能返回 null，表示取不到有效值。
*/
DomainList?: Array<ScdnDomain>;
/**
* 域名的总条数。
注意：此字段可能返回 null，表示取不到有效值。
*/
TotalCount?: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateScdnLogTask请求参数结构体
*/
export interface CreateScdnLogTaskRequest {
/**
* 防护类型
Mode 映射如下：
waf = "Web攻击"
cc = "CC攻击"
bot = "Bot攻击"
*/
Mode: string;
/**
* 查询起始时间，如：2018-09-04 10:40:00，返回结果大于等于指定时间
*/
StartTime: string;
/**
* 查询结束时间，如：2018-09-04 10:40:00，返回结果小于等于指定时间
*/
EndTime: string;
/**
* 指定域名查询, 不填默认查询全部域名
*/
Domain?: string;
/**
* 指定攻击类型, 不填默认查询全部攻击类型
AttackType 映射如下:
other = '未知类型'
malicious_scan = "恶意扫描"
sql_inject = "SQL注入攻击"
xss = "XSS攻击"
cmd_inject = "命令注入攻击"
ldap_inject = "LDAP注入攻击"
ssi_inject = "SSI注入攻击"
xml_inject = "XML注入攻击"
web_service = "WEB服务漏洞攻击"
web_app = "WEB应用漏洞攻击"
path_traversal = "路径跨越攻击"
illegal_access_core_file = "核心文件非法访问"
trojan_horse = "木马后门攻击"
csrf = "CSRF攻击"
malicious_file_upload= '恶意文件上传'
js = "JS主动探测"
cookie = "Cookie指纹"
*/
AttackType?: string;
/**
* 指定执行动作, 不填默认查询全部执行动作
DefenceMode 映射如下：
observe = '观察模式'
intercept = '拦截模式'
captcha = "验证码"
redirect = "重定向"
*/
DefenceMode?: string;
/**
* 不填为全部ip
*/
Ip?: string;
/**
* 指定域名查询, 与 Domain 参数同时有值时使用 Domains 参数，不填默认查询全部域名，指定域名查询时最多支持同时选择 5 个域名查询
*/
Domains?: Array<string>;
/**
* 指定攻击类型查询, 与 AttackType 参数同时有值时使用 AttackTypes 参数，不填默认查询全部攻击类型
*/
AttackTypes?: Array<string>;
/**
* 查询条件
*/
Conditions?: Array<ScdnEventLogConditions>;
/**
* 来源产品 cdn ecdn
*/
Source?: string;
/**
* 地域：mainland 或 overseas
*/
Area?: string;
}
/**
* DescribeEdgePackTaskStatus返回参数结构体
*/
export interface DescribeEdgePackTaskStatusResponse {
/**
* 动态打包任务状态列表
*/
EdgePackTaskStatusSet?: Array<EdgePackTaskStatus>;
/**
* 总数，用于分页查询
*/
TotalCount?: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 启发式缓存配置
*/
export interface HeuristicCache {
/**
* 启发式缓存配置开关，取值有：
on：开启
off：关闭
注意：此字段可能返回 null，表示取不到有效值。
*/
Switch: string;
/**
* 自定义启发式缓存时间配置
注意：此字段可能返回 null，表示取不到有效值。
*/
CacheConfig?: CacheConfig;
}
/**
* 明细数据的汇总值，各指标根据其特性不同拥有不同汇总方式
*/
export interface SummarizedData {
/**
* 汇总方式，存在以下几种：
sum：累加求和
max：最大值，带宽模式下，采用 5 分钟粒度汇总数据，计算峰值带宽
avg：平均值
*/
Name: string;
/**
* 汇总后的数据值
*/
Value: number;
}
/**
* ManageClsTopicDomains请求参数结构体
*/
export interface ManageClsTopicDomainsRequest {
/**
* 日志集ID
*/
LogsetId: string;
/**
* 日志主题ID
*/
TopicId: string;
/**
* 接入渠道，cdn或者ecdn，默认值为cdn
*/
Channel?: string;
/**
* 域名区域配置，注意：如果此字段为空，则表示解绑对应主题下的所有域名
*/
DomainAreaConfigs?: Array<DomainAreaConfig>;
}
/**
* 域名及其他指标Bot次数
*/
export interface DomainBotCount {
/**
* 域名
*/
Domain: string;
/**
* BOT次数
*/
Count: number;
/**
* Top指标值
注意：此字段可能返回 null，表示取不到有效值。
*/
Value: string;
/**
* 国家/地区
注意：此字段可能返回 null，表示取不到有效值。
*/
Country: string;
/**
* 省份
注意：此字段可能返回 null，表示取不到有效值。
*/
Province: string;
/**
* 运营商
注意：此字段可能返回 null，表示取不到有效值。
*/
Isp: string;
}
/**
* POST请求上传文件流式传输最大限制
*/
export interface PostSize {
/**
* POST请求上传文件流式传输最大限制配置开关，取值有：
on：开启，平台默认为32MB
off：关闭
*/
Switch: string;
/**
* 最大限制，取值在1MB和200MB之间。
*/
MaxSize?: number;
}
/**
* 访问协议强制跳转配置，默认为关闭状态
*/
export interface ForceRedirect {
/**
* 访问强制跳转配置开关，取值有：
on：开启
off：关闭
注意：此字段可能返回 null，表示取不到有效值。
*/
Switch: string;
/**
* 访问强制跳转类型
http：强制 http 跳转
https：强制 https 跳转
注意：此字段可能返回 null，表示取不到有效值。
*/
RedirectType?: string;
/**
* 强制跳转时返回状态码
支持 301、302
注意：此字段可能返回 null，表示取不到有效值。
*/
RedirectStatusCode?: number;
/**
* 强制跳转时是否返回增加的头部。
注意：此字段可能返回 null，表示取不到有效值。
*/
CarryHeaders?: string;
}
/**
* ListClsTopicDomains请求参数结构体
*/
export interface ListClsTopicDomainsRequest {
/**
* 日志集ID
*/
LogsetId: string;
/**
* 日志主题ID
*/
TopicId: string;
/**
* 接入渠道，cdn或者ecdn，默认值为cdn
*/
Channel?: string;
}
/**
* DescribeReportData请求参数结构体
*/
export interface DescribeReportDataRequest {
/**
* 查询起始时间：yyyy-MM-dd
当报表类型为daily，起始时间和结束时间必须为同一天
当报表类型为weekly，起始时间须为周一，结束时间须为同一周的周日
当报表类型为monthly，起始时间须为自然月第一天，即1号，结束时间须为该自然月最后一天
*/
StartTime: string;
/**
* 查询结束时间：yyyy-MM-dd
当报表类型为daily，起始时间和结束时间必须为同一天
当报表类型为weekly，起始时间须为周一，结束时间须为同一周的周日
当报表类型为monthly，起始时间须为自然月第一天，即1号，结束时间须为该自然月最后一天
*/
EndTime: string;
/**
* 报表类型
daily：日报表
weekly：周报表（周一至周日）
monthly：月报表（自然月）
*/
ReportType: string;
/**
* 域名加速区域
mainland：中国境内
overseas：中国境外
*/
Area: string;
/**
* 偏移量，默认0。
*/
Offset?: number;
/**
* 数据个数，默认1000。
*/
Limit?: number;
/**
* 按项目ID筛选
*/
Project?: number;
}
/**
* 单链接下行限速配置，默认为关闭状态
*/
export interface DownstreamCapping {
/**
* 下行速度配置开关，取值有：
on：开启
off：关闭
*/
Switch: string;
/**
* 下行限速规则
注意：此字段可能返回 null，表示取不到有效值。
*/
CappingRules?: Array<CappingRule>;
}
/**
* 违规资源封禁/解封返回类型
*/
export interface CacheOptResult {
/**
* 成功的url列表
注意：此字段可能返回 null，表示取不到有效值。
*/
SuccessUrls?: Array<string>;
/**
* 失败的url列表
注意：此字段可能返回 null，表示取不到有效值。
*/
FailUrls: Array<string>;
}
/**
* StopCdnDomain请求参数结构体
*/
export interface StopCdnDomainRequest {
/**
* 域名
域名需要为【已启动】状态
*/
Domain: string;
}
/**
* EnableCaches返回参数结构体
*/
export interface EnableCachesResponse {
/**
* 结果列表
注意：此字段可能返回 null，表示取不到有效值。
*/
CacheOptResult?: CacheOptResult;
/**
* 任务ID
注意：此字段可能返回 null，表示取不到有效值。
*/
TaskId?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SCDN攻击数据Top展示
*/
export interface ScdnTopDomainData {
/**
* 域名
*/
Domain: string;
/**
* 请求量
*/
Value: number;
/**
* 百分比
*/
Percent: number;
}
/**
* StartScdnDomain返回参数结构体
*/
export interface StartScdnDomainResponse {
/**
* 开启结果，Success表示成功
*/
Result: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 自定义响应头配置，默认为关闭状态
*/
export interface ResponseHeader {
/**
* 自定义响应头配置开关，取值有：
on：开启
off：关闭
*/
Switch: string;
/**
* 自定义响应头规则
注意：此字段可能返回 null，表示取不到有效值。
*/
HeaderRules?: Array<HttpHeaderPathRule>;
}
/**
* DisableCaches返回参数结构体
*/
export interface DisableCachesResponse {
/**
* 提交结果
注意：此字段可能返回 null，表示取不到有效值。
*/
CacheOptResult?: CacheOptResult;
/**
* 任务ID
注意：此字段可能返回 null，表示取不到有效值。
*/
TaskId?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 事件日志统计数据结果
*/
export interface EventLogStatsData {
/**
* 时间
*/
Datetime: string;
/**
* 请求数
*/
Request: number;
}
/**
* DescribeIpStatus返回参数结构体
*/
export interface DescribeIpStatusResponse {
/**
* 节点列表
*/
Ips: Array<IpStatus>;
/**
* 节点总个数
*/
TotalCount: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDistrictIspData请求参数结构体
*/
export interface DescribeDistrictIspDataRequest {
/**
* 域名列表，最多支持20个域名
*/
Domains: Array<string>;
/**
* 查询起始时间，如：2018-09-04 10:40:00，返回结果大于等于指定时间
支持近 60 天内的数据查询，每次查询时间区间为 3 小时
*/
StartTime: string;
/**
* 查询结束时间，如：2018-09-04 10:40:00，返回结果小于等于指定时间
结束时间与起始时间区间最大为 3 小时
*/
EndTime: string;
/**
* 指定查询指标，支持:
bandwidth：带宽，单位为 bps
flux：流量，单位为 byte
request：请求数，单位为 次
statusCode：状态码，返回 0、2xx、3xx、4xx、5xx 汇总数据，单位为 次
2xx：返回 2xx 状态码汇总及各 2 开头状态码数据，单位为 次
3xx：返回 3xx 状态码汇总及各 3 开头状态码数据，单位为 次
4xx：返回 4xx 状态码汇总及各 4 开头状态码数据，单位为 次
5xx：返回 5xx 状态码汇总及各 5 开头状态码数据，单位为 次
支持指定具体状态码查询，若未产生过，则返回为空
*/
Metric: string;
/**
* 指定省份查询，不填充表示查询所有省份
省份、国家/地区编码可以查看 [省份编码映射](https://cloud.tencent.com/document/product/228/6316#.E5.8C.BA.E5.9F.9F-.2F-.E8.BF.90.E8.90.A5.E5.95.86.E6.98.A0.E5.B0.84.E8.A1.A8)
*/
Districts?: Array<number | bigint>;
/**
* 指定运营商查询，不填充表示查询所有运营商
运营商编码可以查看 [运营商编码映射](https://cloud.tencent.com/document/product/228/6316#.E5.8C.BA.E5.9F.9F-.2F-.E8.BF.90.E8.90.A5.E5.95.86.E6.98.A0.E5.B0.84.E8.A1.A8)
*/
Isps?: Array<number | bigint>;
/**
* 指定协议查询，不填充表示查询所有协议
all：所有协议
http：指定查询 HTTP 对应指标
https：指定查询 HTTPS 对应指标
*/
Protocol?: string;
/**
* 指定IP协议查询，不填充表示查询所有协议
all：所有协议
ipv4：指定查询 ipv4 对应指标
ipv6：指定查询 ipv6 对应指标
指定IP协议查询时，不可同时指定省份、运营商查询
*/
IpProtocol?: string;
/**
* 时间粒度，支持以下几种模式（默认5min）：
min：1 分钟粒度，支持近 60 天内的数据查询，每次查询时间区间不超过10分钟，可返回 1 分钟粒度明细数据
5min：5 分钟粒度，支持近 60 天内的数据查询，每次查询时间区间不超过3 小时，可返回 5 分钟粒度明细数据
*/
Interval?: string;
}
/**
* DeleteScdnDomain返回参数结构体
*/
export interface DeleteScdnDomainResponse {
/**
* 创建结果，Success表示成功
*/
Result: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateVerifyRecord请求参数结构体
*/
export interface CreateVerifyRecordRequest {
/**
* 要取回的域名
*/
Domain: string;
}
/**
* PurgePathCache请求参数结构体
*/
export interface PurgePathCacheRequest {
/**
* 目录列表，需要包含协议头部 http:// 或 https://
*/
Paths: Array<string>;
/**
* 刷新类型
flush：刷新产生更新的资源
delete：刷新全部资源
*/
FlushType: string;
/**
* 是否对中文字符进行编码后刷新
*/
UrlEncode?: boolean;
/**
* 刷新区域
无此参数时，默认刷新加速域名所在加速区域
填充 mainland 时，仅刷新中国境内加速节点上缓存内容
填充 overseas 时，仅刷新中国境外加速节点上缓存内容
指定刷新区域时，需要与域名加速区域匹配
*/
Area?: string;
}
/**
* ddos攻击带宽峰值数据
*/
export interface DDoSAttackBandwidthData {
/**
* ddos攻击类型，当值为all的时候表示所有的攻击类型的总带宽峰值
*/
AttackType: string;
/**
* ddos攻击带宽大小
*/
Value: number;
/**
* 攻击时间点
*/
Time: string;
}
/**
* 跨国回源优化配置，默认为关闭状态 (已下线)
*/
export interface OriginPullOptimization {
/**
* 跨国回源优化配置开关，取值有：
on：开启
off：关闭
*/
Switch: string;
/**
* 跨国类型
OVToCN：境外回源境内
CNToOV：境内回源境外
注意：此字段可能返回 null，表示取不到有效值。
*/
OptimizationType?: string;
}
/**
* 预热任务详情
*/
export 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;
/**
* 预热任务更新时间
注意：此字段可能返回 null，表示取不到有效值。
*/
UpdateTime: string;
}
/**
* scdn相关的配置
*/
export interface SecurityConfig {
/**
* scdn 安全配置开关，取值有：
on：开启
off：关闭
*/
Switch: string;
}
/**
* 组成CacheKey的一部分
*/
export interface QueryStringKey {
/**
* CacheKey是否由QueryString组成配置开关，取值有：
on：开启
off：关闭
注意：此字段可能返回 null，表示取不到有效值。
*/
Switch: string;
/**
* 是否重新排序
注意：此字段可能返回 null，表示取不到有效值。
*/
Reorder?: string;
/**
* 使用/排除部分url参数，取值有：
includeAll：包含所有
excludeAll：排除所有
includeCustom：自定义包含
excludeCustom：自定义排除
注意：此字段可能返回 null，表示取不到有效值。
*/
Action?: string;
/**
* 使用/排除的url参数数组，';' 分割
注意：此字段可能返回 null，表示取不到有效值。
*/
Value?: string;
}
/**
* 浏览器缓存规则配置，用于设置 MaxAge 默认值，默认为关闭状态
*/
export interface MaxAge {
/**
* 浏览器缓存配置开关，取值有：
on：开启
off：关闭
注意：此字段可能返回 null，表示取不到有效值。
*/
Switch: string;
/**
* MaxAge 规则
注意：此字段可能返回 null，表示取不到有效值。
*/
MaxAgeRules?: Array<MaxAgeRule>;
/**
* MaxAge 状态码相关规则
注意：此字段可能返回 null，表示取不到有效值。
*/
MaxAgeCodeRule?: MaxAgeCodeRule;
}
/**
* 日志集信息
*/
export interface LogSetInfo {
/**
* 开发者ID
*/
AppId: number;
/**
* 渠道
注意：此字段可能返回 null，表示取不到有效值。
*/
Channel: string;
/**
* 日志集ID
*/
LogsetId: string;
/**
* 日志集名字
*/
LogsetName: string;
/**
* 是否默认日志集
*/
IsDefault: number;
/**
* 日志保存时间，单位为天
*/
LogsetSavePeriod: number;
/**
* 创建日期
*/
CreateTime: string;
/**
* 区域
*/
Region: string;
/**
* cls侧是否已经被删除
注意：此字段可能返回 null，表示取不到有效值。
*/
Deleted: string;
/**
* 英文区域
注意：此字段可能返回 null，表示取不到有效值。
*/
RegionEn: string;
}
/**
* 高级配置集合
*/
export interface AdvanceConfig {
/**
* 高级配置名称。
注意：此字段可能返回 null，表示取不到有效值。
*/
Name: string;
/**
* 是否支持高级配置，
on：支持
off：不支持
注意：此字段可能返回 null，表示取不到有效值。
*/
Value: string;
}
/**
* s3源站回源鉴权。
*/
export interface AwsPrivateAccess {
/**
* s3源站回源鉴权配置项开关，取值有：
on：开启
off：关闭
*/
Switch: string;
/**
* 访问ID。
注意：此字段可能返回 null，表示取不到有效值。
*/
AccessKey?: string;
/**
* 密钥。
注意：此字段可能返回 null，表示取不到有效值。
*/
SecretKey?: string;
/**
* 地域
注意：此字段可能返回 null，表示取不到有效值。
*/
Region?: string;
/**
* Bucketname
注意：此字段可能返回 null，表示取不到有效值。
*/
Bucket?: string;
}
/**
* 视频拖拽配置，默认为关闭状态
*/
export interface VideoSeek {
/**
* 视频拖拽配置开关，取值有：
on：开启
off：关闭
*/
Switch: string;
}
/**
* 是否兼容旧版配置
*/
export interface Compatibility {
/**
* 兼容标志状态码。
注意：此字段可能返回 null，表示取不到有效值。
*/
Code: number;
}
/**
* ModifyDomainConfig请求参数结构体
*/
export interface ModifyDomainConfigRequest {
/**
* 域名
*/
Domain: string;
/**
* 配置路径
*/
Route: string;
/**
* 配置路径值，使用 json 进行序列化，其中固定 update 作为 key
*/
Value: string;
}
/**
* Cls日志搜索结果
*/
export interface ClsSearchLogs {
/**
* 获取更多检索结果的游标
*/
Context: string;
/**
* 搜索结果是否已经全部返回
*/
Listover: boolean;
/**
* 日志内容信息
*/
Results: Array<ClsLogObject>;
}
/**
* CDN回源节点IP信息
*/
export interface OriginIp {
/**
* 回源IP段/回源IP，默认返回IP段信息。
*/
Ip: string;
}
/**
* DescribeScdnBotData请求参数结构体
*/
export interface DescribeScdnBotDataRequest {
/**
* 开始时间
*/
StartTime: string;
/**
* 结束时间
*/
EndTime: string;
/**
* mainland 大陆地区 overseas境外地区
*/
Area: string;
/**
* 取值："2min"或者"hour"，表示查询2分钟或者1小时粒度的数据，如果查询时间范围>1天，则强制返回1小时粒度数据
*/
Interval?: string;
/**
* 域名数组，多选域名时，使用此参数,不填写表示查询所有域名的数据（AppID维度数据）
*/
Domains?: Array<string>;
}
/**
* cc的配置类型
*/
export interface ScdnConfig {
/**
* scdn cc配置开关，取值有：
on：开启
off：关闭
*/
Switch: string;
/**
* 自定义 cc 防护规则
注意：此字段可能返回 null，表示取不到有效值。
*/
Rules?: Array<ScdnCCRules>;
/**
* 增强自定义 cc 防护规则
注意：此字段可能返回 null，表示取不到有效值。
*/
AdvancedRules?: Array<AdvancedCCRules>;
/**
* 增强自定义 cc 防护规则， 全局
注意：此字段可能返回 null，表示取不到有效值。
*/
GlobalAdvancedRules?: Array<AdvancedCCRules>;
}
/**
* IP 属性信息
*/
export interface CdnIp {
/**
* 指定查询的 IP
*/
Ip: string;
/**
* IP 归属：
yes：节点归属于腾讯云 CDN
no：节点不属于腾讯云 CDN
*/
Platform: string;
/**
* 节点所处的省份/国家
unknown 表示节点位置未知
*/
Location: string;
/**
* 节点上下线历史记录
*/
History: Array<CdnIpHistory>;
/**
* 节点的所在区域
mainland：中国境内加速节点
overseas：中国境外加速节点
unknown：服务地域无法获取
*/
Area: string;
/**
* 节点的所在城市
注意：此字段可能返回 null，表示取不到有效值。
*/
City: string;
}
/**
* 除上海外其他区域日志集和日志主题信息
*/
export interface ExtraLogset {
/**
* 日志集信息
注意：此字段可能返回 null，表示取不到有效值。
*/
Logset: LogSetInfo;
/**
* 日志主题信息列表
注意：此字段可能返回 null，表示取不到有效值。
*/
Topics: Array<TopicInfo>;
}
/**
* 离线缓存是否开启
*/
export interface OfflineCache {
/**
* 离线缓存配置开关，取值有：
on：开启
off：关闭
*/
Switch: string;
}
/**
* 排序类型数据结构
*/
export interface TopDataMore {
/**
* 资源名称，根据查询条件不同分为以下几类：
*/
Resource: string;
/**
* 排序结果详情
*/
DetailData: Array<TopDetailDataMore>;
}
/**
* 客户端访问诊断URL信息列表
*/
export interface DiagnoseList {
/**
* 诊断任务标签。
注意：此字段可能返回 null，表示取不到有效值。
*/
DiagnoseTag: string;
/**
* 报告ID，用于获取详细诊断报告。
注意：此字段可能返回 null，表示取不到有效值。
*/
ReportId: string;
/**
* 客户端信息。
注意：此字段可能返回 null，表示取不到有效值。
*/
ClientInfo: Array<ClientInfo>;
/**
* 最终诊断结果。
-1：已提交
0 ：检测中
1 ：检测正常
2 ： 检测异常
3 ： 诊断页面异常关闭
注意：此字段可能返回 null，表示取不到有效值。
*/
FinalDiagnose: number;
/**
* 诊断任务创建时间。
注意：此字段可能返回 null，表示取不到有效值。
*/
CreateTime: string;
}
/**
* HTTP 请求头
*/
export interface HTTPHeader {
/**
* 请求头名称
*/
Name: string;
/**
* 请求头值
*/
Value: string;
}
/**
* IP黑白名单分路径配置
*/
export interface IpFilterPathRule {
/**
* IP 黑白名单类型
whitelist：白名单
blacklist：黑名单
注意：此字段可能返回 null，表示取不到有效值。
*/
FilterType: string;
/**
* IP 黑白名单列表
支持 X.X.X.X 形式 IP，或 /8、 /16、/24 形式网段
最多可填充 50 个白名单或 50 个黑名单
注意：此字段可能返回 null，表示取不到有效值。
*/
Filters: Array<string>;
/**
* 规则类型：
all：所有文件生效
file：指定文件后缀生效
directory：指定路径生效
path：指定绝对路径生效
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleType: string;
/**
* RuleType 对应类型下的匹配内容：
all 时填充 *
file 时填充后缀名，如 jpg、txt
directory 时填充路径，如 /xxx/test/
path 时填充绝对路径，如 /xxx/test.html
注意：此字段可能返回 null，表示取不到有效值。
*/
RulePaths: Array<string>;
}
/**
* CDN报表数据
*/
export interface ReportData {
/**
* 项目ID/域名ID。
*/
ResourceId: string;
/**
* 项目名称/域名。
*/
Resource: string;
/**
* 流量总和/带宽最大值，单位分别为bytes，bps。
*/
Value: number;
/**
* 单个资源占总体百分比。
*/
Percentage: number;
/**
* 计费流量总和/计费带宽最大值，单位分别为bytes，bps。
*/
BillingValue: number;
/**
* 计费数值占总体百分比。
*/
BillingPercentage: number;
}
/**
* 回源的自定义Https配置
*/
export interface AdvanceHttps {
/**
* 自定义Tls数据开关
注意：此字段可能返回 null，表示取不到有效值。
*/
CustomTlsStatus?: string;
/**
* Tls版本列表，支持设置 TLSv1, TLSV1.1, TLSV1.2, TLSv1.3，修改时必须开启连续的版本
注意：此字段可能返回 null，表示取不到有效值。
*/
TlsVersion?: Array<string>;
/**
* 自定义加密套件
注意：此字段可能返回 null，表示取不到有效值。
*/
Cipher?: string;
/**
* 回源双向校验开启状态
off - 关闭校验
oneWay - 校验源站
twoWay - 双向校验
注意：此字段可能返回 null，表示取不到有效值。
*/
VerifyOriginType?: string;
/**
* 回源层证书配置信息
注意：此字段可能返回 null，表示取不到有效值。
*/
CertInfo?: ServerCert;
/**
* 源站证书配置信息
注意：此字段可能返回 null，表示取不到有效值。
*/
OriginCertInfo?: ClientCert;
}
/**
* DescribePurgeQuota返回参数结构体
*/
export interface DescribePurgeQuotaResponse {
/**
* URL刷新用量及配额。
*/
UrlPurge: Array<Quota>;
/**
* 目录刷新用量及配额。
*/
PathPurge: Array<Quota>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 图片优化-AvifAdapter配置
*/
export interface AvifAdapter {
/**
* 图片优化AvifAdapter配置项开关，取值有：
on：开启
off：关闭
注意：此字段可能返回 null，表示取不到有效值。
*/
Switch?: string;
}
/**
* 远程鉴权规则。
*/
export 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、txt
directory 时填充路径，如 /xxx/test
path 时填充绝对路径，如 /xxx/test.html
index 时填充 /
默认值:*
*/
RulePaths: Array<string>;
/**
* 请求远程鉴权服务器超时时间，单位毫秒；
取值范围：[1,30 000]
默认值:20000
*/
AuthTimeout: number;
/**
* 请求远程鉴权服务器超时后执行拦截或者放行；
RETURN_200: 超时后放行；
RETURN_403:超时拦截；
默认值:RETURN_200
*/
AuthTimeoutAction: string;
}
/**
* PurgePathCache返回参数结构体
*/
export interface PurgePathCacheResponse {
/**
* 刷新任务 ID，同一批次提交的目录共用一个任务 ID
*/
TaskId?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeTopData请求参数结构体
*/
export interface DescribeTopDataRequest {
/**
* 查询起始日期：yyyy-MM-dd HH:mm:ss
仅支持按天粒度的数据查询，取入参中的天信息作为起始日期
返回大于等于起始日期当天 00:00:00 点产生的数据，如 StartTime为2018-09-04 10:40:00，返回数据的起始时间为2018-09-04 00:00:00
仅支持 90 天内数据查询
*/
StartTime: string;
/**
* 查询结束日期：yyyy-MM-dd HH:mm:ss
仅支持按天粒度的数据查询，取入参中的天信息作为结束日期
返回小于等于结束日期当天 23:59:59 产生的数据，如EndTime为2018-09-05 22:40:00，返回数据的结束时间为2018-09-05 23:59:59
EndTime 需要大于等于 StartTime
*/
EndTime: string;
/**
* 排序对象，支持以下几种形式：
ip、ua_device、ua_browser、ua_os、referer
*/
Metric: string;
/**
* 排序使用的指标名称：
flux：Metric 为 host 时指代访问流量
request：Metric 为 host 时指代访问请求数
*/
Filter: string;
/**
* 指定查询域名列表，最多可一次性查询 30 个加速域名明细
*/
Domains?: Array<string>;
/**
* 未填充域名情况下，指定项目查询，若填充了具体域名信息，以域名为主
*/
Project?: number;
/**
* 是否详细显示每个域名的的具体数值
*/
Detail?: boolean;
/**
* 指定服务地域查询，不填充表示查询中国境内 CDN 数据
mainland：指定查询中国境内 CDN 数据
overseas：指定查询中国境外 CDN 数据
*/
Area?: string;
/**
* 指定查询的产品数据，目前仅可使用cdn
*/
Product?: string;
}
/**
* CDN HTTPS请求包。
*/
export 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请求包是否自动续订
注意：此字段可能返回 null，表示取不到有效值。
*/
AutoExtension?: boolean;
}
/**
* ModifyPurgeFetchTaskStatus请求参数结构体
*/
export interface ModifyPurgeFetchTaskStatusRequest {
/**
* 执行时间
*/
ExecutionTime: string;
/**
* 执行状态
success: 成功
failed: 失败
*/
ExecutionStatus: string;
/**
* 任务 ID
*/
Id: string;
/**
* 执行状态详情
*/
ExecutionStatusDesc?: string;
}
/**
* Referer 黑白名单配置，默认为关闭状态
*/
export interface Referer {
/**
* referer 黑白名单配置开关，取值有：
on：开启
off：关闭
*/
Switch: string;
/**
* referer 黑白名单配置规则
注意：此字段可能返回 null，表示取不到有效值。
*/
RefererRules?: Array<RefererRule>;
}
/**
* 缓存配置高级版本规则
*/
export interface AdvanceCacheRule {
/**
* 规则类型：
all：所有文件生效
file：指定文件后缀生效
directory：指定路径生效
path：指定绝对路径生效
default：源站未返回 max-age 情况下的缓存规则
注意：此字段可能返回 null，表示取不到有效值。
*/
CacheType: string;
/**
* 对应类型下的匹配内容：
all 时填充 *
file 时填充后缀名，如 jpg、txt
directory 时填充路径，如 /xxx/test/
path 时填充绝对路径，如 /xxx/test.html
default 时填充 "no max-age"
注意：此字段可能返回 null，表示取不到有效值。
*/
CacheContents: Array<string>;
/**
* 缓存过期时间
单位为秒，最大可设置为 365 天
注意：此字段可能返回 null，表示取不到有效值。
*/
CacheTime: number;
}
/**
* ListTopDDoSData请求参数结构体
*/
export interface ListTopDDoSDataRequest {
/**
* 查询Top数据的开始时间，格式为：2020-01-01 00:00:00
*/
StartTime: string;
/**
* 查询Top数据的结束时间，格式为：2020-01-01 23:59:59
支持 90 天内数据查询，时间跨度要小于等于7天
*/
EndTime: string;
/**
* 查询Top的数量，不填默认值为10
*/
TopCount?: number;
/**
* AttackIP表示查询攻击ip的top排行，AttackType表示攻击类型的top排行，为空默认为AttackType
*/
Metric?: string;
}
/**
* DeleteCdnDomain请求参数结构体
*/
export interface DeleteCdnDomainRequest {
/**
* 域名
域名状态需要为【已停用】
*/
Domain: string;
}
/**
* DescribeEventLogData请求参数结构体
*/
export interface DescribeEventLogDataRequest {
/**
* 防护类型，映射如下：
waf = "Web攻击"
cc = "CC攻击"
*/
Mode: string;
/**
* 开始时间
*/
StartTime: string;
/**
* 结束时间，最长跨度为30分钟
*/
EndTime: string;
/**
* 域名
*/
Domain: string;
/**
* 执行动作，取值为：intercept/redirect/observe
分别表示：拦截/重定向/观察
参数放空，表示查询全部动作数据
*/
ActionName: string;
/**
* 请求URL，支持URL开头和结尾使用\*表示通配
如：
/files/* 表示所有以/files/开头的请求
*.jpg 表示所有以.jpg结尾的请求
*/
Url: string;
/**
* 地域 mainland 或者 overseas，为空时默认 mainland
*/
Area?: string;
/**
* 来源产品，cdn 或者 ecdn，为空时默认 cdn
*/
Source?: string;
}
/**
* 分路径回源配置规则。
*/
export interface PathRule {
/**
* 是否开启通配符“*”匹配：
false：关闭
true：开启
注意：此字段可能返回 null，表示取不到有效值。
*/
Regex: boolean;
/**
* 匹配的URL路径，仅支持Url路径，不支持参数。默认完全匹配，开启通配符“*”匹配后，最多支持5个通配符，最大长度为1024个字符。
注意：此字段可能返回 null，表示取不到有效值。
*/
Path: string;
/**
* 路径匹配时的回源源站。暂不支持开了私有读写的COS源。不填写时沿用默认源站。
注意：此字段可能返回 null，表示取不到有效值。
*/
Origin?: string;
/**
* 路径匹配时回源的Host头部。不填写时沿用默认ServerName。
注意：此字段可能返回 null，表示取不到有效值。
*/
ServerName?: string;
/**
* 源站所属区域，支持CN，OV：
CN：中国境内
OV：中国境外
默认为CN。
注意：此字段可能返回 null，表示取不到有效值。
*/
OriginArea?: string;
/**
* 路径匹配时回源的URI路径，必须以“/”开头，不包含参数部分。最大长度为1024个字符。可使用$1, $2, $3, $4, $5分别捕获匹配路径中的通配符号“*”，最多支持10个捕获值。
注意：此字段可能返回 null，表示取不到有效值。
*/
ForwardUri?: string;
/**
* 路径匹配时回源的头部设置。
注意：此字段可能返回 null，表示取不到有效值。
*/
RequestHeaders?: Array<HttpHeaderRule>;
/**
* 当Regex为false时，Path是否开启完全匹配。
false：关闭
true：开启
注意：此字段可能返回 null，表示取不到有效值。
*/
FullMatch?: boolean;
}
/**
* DescribeDomains返回参数结构体
*/
export interface DescribeDomainsResponse {
/**
* 域名列表
*/
Domains: Array<BriefDomain>;
/**
* 符合查询条件的域名总数
用于分页查询
*/
TotalNumber: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeScdnConfig请求参数结构体
*/
export interface DescribeScdnConfigRequest {
/**
* 域名
*/
Domain: string;
}
/**
* DescribeCcData返回参数结构体
*/
export interface DescribeCcDataResponse {
/**
* 指定执行动作的请求数数据，如果指定类型为空，表示所有类型的请求总数
*/
Data: Array<TimestampData>;
/**
* 粒度
*/
Interval: string;
/**
* 执行动作为拦截类型QPS统计数据
注意：此字段可能返回 null，表示取不到有效值。
*/
InterceptQpsData: Array<TimestampData>;
/**
* 执行动作为重定向类型QPS统计数据
注意：此字段可能返回 null，表示取不到有效值。
*/
RedirectQpsData: Array<TimestampData>;
/**
* 执行动作为观察类型QPS统计数据
注意：此字段可能返回 null，表示取不到有效值。
*/
ObserveQpsData: Array<TimestampData>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpdatePayType返回参数结构体
*/
export interface UpdatePayTypeResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CLS主题信息
*/
export interface TopicInfo {
/**
* 主题ID
*/
TopicId: string;
/**
* 主题名字
*/
TopicName: string;
/**
* 是否启用投递
*/
Enabled: number;
/**
* 创建时间
注意：此字段可能返回 null，表示取不到有效值。
*/
CreateTime: string;
/**
* 归属于cdn或ecdn
注意：此字段可能返回 null，表示取不到有效值。
*/
Channel: string;
/**
* cls侧是否已经被删除
注意：此字段可能返回 null，表示取不到有效值。
*/
Deleted: string;
}
/**
* scdn 的自定义 cc 规则
*/
export interface AdvancedCCRules {
/**
* 规则名称
*/
RuleName?: string;
/**
* 探测时长
注意：此字段可能返回 null，表示取不到有效值。
*/
DetectionTime?: number;
/**
* 限频阈值
注意：此字段可能返回 null，表示取不到有效值。
*/
FrequencyLimit?: number;
/**
* IP 惩罚配置开关，取值有：
on：开启
off：关闭
注意：此字段可能返回 null，表示取不到有效值。
*/
PunishmentSwitch?: string;
/**
* IP 惩罚时长
注意：此字段可能返回 null，表示取不到有效值。
*/
PunishmentTime?: number;
/**
* 执行动作，intercept|redirect
注意：此字段可能返回 null，表示取不到有效值。
*/
Action?: string;
/**
* 动作为 redirect 时，重定向的url
注意：此字段可能返回 null，表示取不到有效值。
*/
RedirectUrl?: string;
/**
* 七层限频具体配置
注意：此字段可能返回 null，表示取不到有效值。
*/
Configure?: Array<ScdnSevenLayerRules>;
/**
* 自定义cc规则配置开关，取值有：
on：开启
off：关闭
注意：此字段可能返回 null，表示取不到有效值。
*/
Switch?: string;
}
/**
* 路径缓存缓存配置
*/
export interface CacheConfigCache {
/**
* 路径缓存配置开关，取值有：
on：开启
off：关闭
注意：此字段可能返回 null，表示取不到有效值。
*/
Switch: string;
/**
* 缓存过期时间设置
单位为秒，最大可设置为 365 天
注意：此字段可能返回 null，表示取不到有效值。
*/
CacheTime: number;
/**
* 高级缓存过期配置，开启时会对比源站返回的 max-age 值与 CacheRules 中设置的缓存过期时间，取最小值在节点进行缓存
on：开启
off：关闭
默认为关闭状态
注意：此字段可能返回 null，表示取不到有效值。
*/
CompareMaxAge: string;
/**
* 强制缓存
on：开启
off：关闭
默认为关闭状态，开启后，源站返回的 no-store、no-cache 资源，也将按照 CacheRules 规则进行缓存
注意：此字段可能返回 null，表示取不到有效值。
*/
IgnoreCacheControl: string;
/**
* 当源站返回Set-Cookie头部时，节点是否缓存该头部及body
on：开启，不缓存该头部及body
off：关闭，遵循用户自定义的节点缓存规则
默认为关闭状态
注意：此字段可能返回 null，表示取不到有效值。
*/
IgnoreSetCookie: string;
}
/**
* ListScdnTopBotData返回参数结构体
*/
export interface ListScdnTopBotDataResponse {
/**
* 域名BOT次数列表
*/
Data?: Array<BotStatisticsCount>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DisableClsLogTopic请求参数结构体
*/
export interface DisableClsLogTopicRequest {
/**
* 日志集ID
*/
LogsetId: string;
/**
* 日志主题ID
*/
TopicId: string;
/**
* 接入渠道，cdn或者ecdn，默认值为cdn
*/
Channel?: string;
}
/**
* CDN加速流量包。
*/
export interface TrafficPackage {
/**
* 流量包 Id
*/
Id?: number;
/**
* 流量包类型
*/
Type?: string;
/**
* 流量包大小（单位为 Byte）
*/
Bytes?: number;
/**
* 已消耗流量（单位为 Byte）
*/
BytesUsed?: number;
/**
* 流量包状态
enabled：已启用
expired：已过期
disabled：未启用
*/
Status?: string;
/**
* 流量包发放时间
*/
CreateTime?: string;
/**
* 流量包生效时间
*/
EnableTime?: string;
/**
* 流量包过期时间
*/
ExpireTime?: string;
/**
* 流量包是否续订
*/
ContractExtension?: boolean;
/**
* 流量包是否自动续订
*/
AutoExtension?: boolean;
/**
* 流量包来源
*/
Channel?: string;
/**
* 流量包生效区域，mainland或overseas
*/
Area?: string;
/**
* 流量包生命周期月数
*/
LifeTimeMonth?: number;
/**
* 流量包是否支持续订
*/
ExtensionAvailable?: boolean;
/**
* 流量包是否支持退费
*/
RefundAvailable?: boolean;
/**
* 流量包生效区域
0：中国大陆
1：亚太一区
2：亚太二区
3：亚太三区
4：中东
5：北美
6：欧洲
7：南美
8：非洲
注意：此字段可能返回 null，表示取不到有效值。
*/
Region?: number;
/**
* 流量包类型id
注意：此字段可能返回 null，表示取不到有效值。
*/
ConfigId?: number;
/**
* 流量包当前续订模式，0 未续订、1到期续订、2用完续订、3到期或用完续订
注意：此字段可能返回 null，表示取不到有效值。
*/
ExtensionMode?: number;
/**
* 流量包实际生效时间
注意：此字段可能返回 null，表示取不到有效值。
*/
TrueEnableTime?: string;
/**
* 流量包实际过期时间
注意：此字段可能返回 null，表示取不到有效值。
*/
TrueExpireTime?: string;
}
/**
* Bot cookie策略
*/
export interface BotCookie {
/**
* Bot cookie策略配置开关，取值有：
on：开启
off：关闭
*/
Switch: string;
/**
* 规则类型，当前只有all
*/
RuleType: string;
/**
* 规则值，['*']
*/
RuleValue: Array<string>;
/**
* 执行动作，monitor|intercept|redirect|captcha
*/
Action: string;
/**
* 重定向时设置的重定向页面
注意：此字段可能返回 null，表示取不到有效值。
*/
RedirectUrl?: string;
/**
* 更新时间
注意：此字段可能返回 null，表示取不到有效值。
*/
UpdateTime?: string;
}
/**
* CreateScdnFailedLogTask返回参数结构体
*/
export interface CreateScdnFailedLogTaskResponse {
/**
* 创建结果,
"0" -> 创建成功
*/
Result: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 状态码缓存过期配置，默认情况下会对 404 状态码缓存 10 秒
*/
export interface StatusCodeCache {
/**
* 状态码缓存过期配置开关，取值有：
on：开启
off：关闭
注意：此字段可能返回 null，表示取不到有效值。
*/
Switch: string;
/**
* 状态码缓存过期规则明细
注意：此字段可能返回 null，表示取不到有效值。
*/
CacheRules?: Array<StatusCodeCacheRule>;
}
/**
* scdn 的自定义 cc 规则
*/
export interface ScdnCCRules {
/**
* 规则类型：
all：所有文件生效
file：指定文件后缀生效
directory：指定路径生效
path：指定绝对路径生效
index：首页
*/
RuleType: string;
/**
* 规则值
*/
RuleValue: Array<string>;
/**
* 规则限频
*/
Qps?: number;
/**
* 探测时长
注意：此字段可能返回 null，表示取不到有效值。
*/
DetectionTime?: number;
/**
* 限频阈值
注意：此字段可能返回 null，表示取不到有效值。
*/
FrequencyLimit?: number;
/**
* IP 惩罚配置开关，取值有：
on：开启
off：关闭
注意：此字段可能返回 null，表示取不到有效值。
*/
PunishmentSwitch?: string;
/**
* IP 惩罚时长
注意：此字段可能返回 null，表示取不到有效值。
*/
PunishmentTime?: number;
/**
* 执行动作，intercept|redirect
注意：此字段可能返回 null，表示取不到有效值。
*/
Action?: string;
/**
* 动作为 redirect 时，重定向的url
注意：此字段可能返回 null，表示取不到有效值。
*/
RedirectUrl?: string;
}
/**
* AddCdnDomain请求参数结构体
*/
export interface AddCdnDomainRequest {
/**
* 域名
*/
Domain: string;
/**
* 加速域名业务类型
web：网页小文件
download：下载大文件
media：音视频点播
hybrid: 动静加速
dynamic: 动态加速
*/
ServiceType: string;
/**
* 源站配置
*/
Origin: Origin;
/**
* 项目 ID，默认为 0，代表【默认项目】
*/
ProjectId?: number;
/**
* IP 黑白名单配置
*/
IpFilter?: IpFilter;
/**
* IP 限频配置
*/
IpFreqLimit?: IpFreqLimit;
/**
* 状态码缓存配置
*/
StatusCodeCache?: StatusCodeCache;
/**
* 智能压缩配置
*/
Compression?: Compression;
/**
* 带宽封顶配置
*/
BandwidthAlert?: BandwidthAlert;
/**
* Range 回源配置
*/
RangeOriginPull?: RangeOriginPull;
/**
* 301/302 回源跟随配置。
*/
FollowRedirect?: FollowRedirect;
/**
* 错误码重定向配置（功能灰度中，尚未全量）
*/
ErrorPage?: ErrorPage;
/**
* 请求头部配置
*/
RequestHeader?: RequestHeader;
/**
* 响应头部配置
*/
ResponseHeader?: ResponseHeader;
/**
* 下载速度配置
*/
DownstreamCapping?: DownstreamCapping;
/**
* 节点缓存键配置
*/
CacheKey?: CacheKey;
/**
* 头部缓存配置
*/
ResponseHeaderCache?: ResponseHeaderCache;
/**
* 视频拖拽配置
*/
VideoSeek?: VideoSeek;
/**
* 缓存过期时间配置
*/
Cache?: Cache;
/**
* 跨国链路优化配置
*/
OriginPullOptimization?: OriginPullOptimization;
/**
* Https 加速配置
*/
Https?: Https;
/**
* 时间戳防盗链配置
*/
Authentication?: Authentication;
/**
* SEO 优化配置
*/
Seo?: Seo;
/**
* 访问协议强制跳转配置
*/
ForceRedirect?: ForceRedirect;
/**
* Referer 防盗链配置
*/
Referer?: Referer;
/**
* 浏览器缓存配置（功能灰度中，尚未全量）
*/
MaxAge?: MaxAge;
/**
* Ipv6 配置（功能灰度中，尚未全量）
*/
Ipv6?: Ipv6;
/**
* 地域属性特殊配置
适用于域名境内加速、境外加速配置不一致场景
*/
SpecificConfig?: SpecificConfig;
/**
* 域名加速区域
mainland：中国境内加速
overseas：中国境外加速
global：全球加速
使用中国境外加速、全球加速时，需要先开通中国境外加速服务
*/
Area?: string;
/**
* 回源超时配置
*/
OriginPullTimeout?: OriginPullTimeout;
/**
* 标签配置
*/
Tag?: Array<Tag>;
/**
* Ipv6 访问配置
*/
Ipv6Access?: Ipv6Access;
/**
* 离线缓存
*/
OfflineCache?: OfflineCache;
/**
* Quic访问（收费服务，详见计费说明和产品文档）
*/
Quic?: Quic;
/**
* 回源S3私有鉴权
*/
AwsPrivateAccess?: AwsPrivateAccess;
/**
* 回源OSS私有鉴权
*/
OssPrivateAccess?: OssPrivateAccess;
/**
* 华为云对象存储回源鉴权
*/
HwPrivateAccess?: HwPrivateAccess;
/**
* 七牛云对象存储回源鉴权
*/
QnPrivateAccess?: QnPrivateAccess;
/**
* 其他厂商对象存储回源鉴权
*/
OthersPrivateAccess?: OthersPrivateAccess;
/**
* HTTPS服务，默认开启（收费服务，详见计费说明和产品文档）
*/
HttpsBilling?: HttpsBilling;
}
/**
* 路径缓存遵循源站配置
*/
export interface CacheConfigFollowOrigin {
/**
* 路径缓存遵循源站配置开关，取值有：
on：开启
off：关闭
*/
Switch: string;
/**
* 启发式缓存配置
注意：此字段可能返回 null，表示取不到有效值。
*/
HeuristicCache?: HeuristicCache;
}
/**
* DescribePayType请求参数结构体
*/
export interface DescribePayTypeRequest {
/**
* 指定服务地域查询
mainland：境内计费方式查询
overseas：境外计费方式查询
global：全球计费方式查询
未填充时，默认为 mainland
*/
Area?: string;
/**
* 指定查询的产品数据，可选为cdn或者ecdn，默认为cdn
*/
Product?: string;
/**
* 指定资源包查询
flux：流量包
https：HTTPS请求包
未填充时，默认为 flux
*/
Type?: string;
}
/**
* DeleteScdnDomain请求参数结构体
*/
export interface DeleteScdnDomainRequest {
/**
* 域名
*/
Domain: string;
}
/**
* DescribeHttpsPackages返回参数结构体
*/
export interface DescribeHttpsPackagesResponse {
/**
* HTTPS请求包总个数
*/
TotalCount?: number;
/**
* HTTPS请求包详情
*/
HttpsPackages?: Array<HttpsPackage>;
/**
* 即将过期的HTTPS请求包个数（7天内）
*/
ExpiringCount?: number;
/**
* 有效HTTPS请求包个数
*/
EnabledCount?: number;
/**
* 付费HTTPS请求包个数
*/
PaidCount?: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 七牛元对象存储回源鉴权配置
*/
export interface QnPrivateAccess {
/**
* 七牛元对象存储回源鉴权配置开关，取值有：
on：开启
off：关闭
*/
Switch: string;
/**
* 访问 ID
注意：此字段可能返回 null，表示取不到有效值。
*/
AccessKey?: string;
/**
* 密钥
*/
SecretKey?: string;
}
/**
* 名称与ID映射关系
*/
export interface MapInfo {
/**
* 对象 Id
*/
Id: number;
/**
* 对象名称
*/
Name: string;
}
/**
* DescribeCertDomains返回参数结构体
*/
export interface DescribeCertDomainsResponse {
/**
* 已接入CDN的域名列表
注意：此字段可能返回 null，表示取不到有效值。
*/
Domains: Array<string>;
/**
* 已配置证书的CDN域名列表
注意：此字段可能返回 null，表示取不到有效值。
*/
CertifiedDomains: Array<string>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* bot配置类型
*/
export interface ScdnBotConfig {
/**
* Scdn bot配置开关，取值有：
on：开启
off：关闭
*/
Switch: string;
/**
* Bot cookie策略
注意：此字段可能返回 null，表示取不到有效值。
*/
BotCookie?: Array<BotCookie>;
/**
* Bot Js策略
注意：此字段可能返回 null，表示取不到有效值。
*/
BotJavaScript?: Array<BotJavaScript>;
}
/**
* 查询对象及其对应的回源明细数据
*/
export interface ResourceOriginData {
/**
* 资源名称，根据查询条件不同分为以下几类：
具体域名：表示该域名明细数据
multiDomains：表示多域名汇总明细数据
项目 ID：指定项目查询时，显示为项目 ID
all：账号维度明细数据
*/
Resource: string;
/**
* 回源数据详情
*/
OriginData: Array<CdnData>;
}
/**
* ListScdnDomains请求参数结构体
*/
export interface ListScdnDomainsRequest {
/**
* 分页起始地址
*/
Offset?: number;
/**
* 列表分页记录条数，最大1000
*/
Limit?: number;
/**
* 域名信息
*/
Domain?: string;
}
/**
* DisableCaches请求参数结构体
*/
export interface DisableCachesRequest {
/**
* 禁用的 URL 列表（分协议生效，必须包含http://或https://）
每次最多可提交 100 条，每日最多可提交 3000 条
*/
Urls: Array<string>;
}
/**
* AddCLSTopicDomains返回参数结构体
*/
export interface AddCLSTopicDomainsResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeIpStatus请求参数结构体
*/
export interface DescribeIpStatusRequest {
/**
* 加速域名
*/
Domain: string;
/**
* 节点类型：
edge：表示边缘节点
last：表示回源层节点
不填充情况下，默认返回边缘节点信息
*/
Layer?: string;
/**
* 查询区域：
mainland: 国内节点
overseas: 海外节点
global: 全球节点
*/
Area?: string;
/**
* 是否以IP段的格式返回。
*/
Segment?: boolean;
/**
* 是否查询节点 IPV6 信息。
*/
ShowIpv6?: boolean;
/**
* 是否对IPV6进行缩写。
*/
AbbreviationIpv6?: boolean;
}
/**
* CreateScdnFailedLogTask请求参数结构体
*/
export interface CreateScdnFailedLogTaskRequest {
/**
* 重试失败任务的taskID
*/
TaskId: string;
/**
* 地域：mainland或overseas
*/
Area?: string;
}
/**
* DescribeCdnOriginIp返回参数结构体
*/
export interface DescribeCdnOriginIpResponse {
/**
* 回源节点IP详情。
*/
Ips?: Array<OriginIp>;
/**
* 回源节点IP总个数。
*/
TotalCount?: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 分片回源配置，默认为开启状态
*/
export interface RangeOriginPull {
/**
* 分片回源配置开关，取值有：
on：开启
off：关闭
*/
Switch: string;
/**
* 分路径分片回源配置
注意：此字段可能返回 null，表示取不到有效值。
*/
RangeRules?: Array<RangeOriginPullRule>;
}
/**
* 违规 URL 详情
*/
export interface ViolationUrl {
/**
* ID
*/
Id?: number;
/**
* 违规资源原始访问 URL
*/
RealUrl?: string;
/**
* 快照路径，用于控制台展示违规内容快照
*/
DownloadUrl?: string;
/**
* 违规资源当前状态
forbid：已封禁
release：已解封
delay ： 延迟处理
reject ：申诉驳回，状态仍为封禁状态
complain：申诉进行中
*/
UrlStatus?: string;
/**
* 创建时间
*/
CreateTime?: string;
/**
* 更新时间
*/
UpdateTime?: string;
}
/**
* SearchClsLog返回参数结构体
*/
export interface SearchClsLogResponse {
/**
* 查询结果
*/
Logs: ClsSearchLogs;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 分路径回源规则
*/
export interface PathBasedOriginRule {
/**
* 规则类型：
file：指定文件后缀生效
directory：指定路径生效
path：指定绝对路径生效
index: 指定主页生效
*/
RuleType: string;
/**
* RuleType 对应类型下的匹配内容：
file 时填充后缀名，如 jpg、txt
directory 时填充路径，如 /xxx/test/
path 时填充绝对路径，如 /xxx/test.html
index 时填充 /
*/
RulePaths: Array<string>;
/**
* 源站列表，支持域名或ipv4地址
*/
Origin: Array<string>;
}
/**
* PushUrlsCache请求参数结构体
*/
export interface PushUrlsCacheRequest {
/**
* URL 列表，需要包含协议头部 http:// 或 https://
*/
Urls: Array<string>;
/**
* 指定预热请求回源时 HTTP 请求的 User-Agent 头部
默认为 TencentCdn
*/
UserAgent?: string;
/**
* 预热生效区域
mainland：预热至境内节点
overseas：预热至境外节点
global：预热全球节点
不填充情况下，默认为 mainland， URL 中域名必须在对应区域启用了加速服务才能提交对应区域的预热任务
*/
Area?: string;
/**
* 中国境内区域默认预热至中间层节点，中国境外区域默认预热至边缘节点。预热至边缘产生的边缘层流量会计入计费流量。
填写"middle"或不填充时，可指定预热至中间层节点。
*/
Layer?: string;
/**
* 是否递归解析m3u8文件中的ts分片预热
注意事项：
1. 该功能要求m3u8索引文件能直接请求获取
2. 当前只支持递归解析一级索引和子索引中的ts分片，递归深度不超过3层
3. 解析获取的ts分片会正常累加每日预热用量，当用量超出配额时，会静默处理，不再执行预热
*/
ParseM3U8?: boolean;
/**
* 是否关闭Range回源
注意事项：
此功能灰度发布中，敬请期待
*/
DisableRange?: boolean;
/**
* 自定义 HTTP 请求头。最多定义 20 个，Name 长度不超过 128 字节，Value 长度不超过 1024 字节
*/
Headers?: Array<HTTPHeader>;
/**
* 是否对URL进行编码
*/
UrlEncode?: boolean;
}
/**
* DescribeUrlViolations请求参数结构体
*/
export interface DescribeUrlViolationsRequest {
/**
* 分页查询偏移量，默认为 0
*/
Offset?: number;
/**
* 分页查询限制数目，默认为 100
*/
Limit?: number;
/**
* 指定的域名查询
*/
Domains?: Array<string>;
}
/**
* Referer 黑白名单配置规则，针对特定资源生效
*/
export interface RefererRule {
/**
* 规则类型：
all：所有文件生效
file：指定文件后缀生效
directory：指定路径生效
path：指定绝对路径生效
*/
RuleType: string;
/**
* RuleType 对应类型下的匹配内容：
all 时填充 *
file 时填充后缀名，如 jpg、txt
directory 时填充路径，如 /xxx/test/
path 时填充绝对路径，如 /xxx/test.html
*/
RulePaths: Array<string>;
/**
* referer 配置类型
whitelist：白名单
blacklist：黑名单
*/
RefererType: string;
/**
* referer 内容列表
*/
Referers: Array<string>;
/**
* 是否允许空 referer
防盗链类型为白名单时，true表示允许空 referer，false表示不允许空 referer；
防盗链类型为黑名单时，true表示拒绝空referer，false表示不拒绝空referer；
*/
AllowEmpty: boolean;
}
/**
* DescribeScdnIpStrategy请求参数结构体
*/
export interface DescribeScdnIpStrategyRequest {
/**
* 分页起始地址
*/
Offset?: number;
/**
* 列表分页记录条数，最大1000
*/
Limit?: number;
/**
* 查询条件过滤器
*/
Filters?: Array<ScdnIpStrategyFilter>;
/**
* 指定查询返回结果的排序字段，支持domain，update_time
*/
Order?: string;
/**
* 排序方式，支持asc，desc
*/
Sequence?: string;
}
/**
* 单节点单 IP 访问限频配置，默认为关闭状态
*/
export interface IpFreqLimit {
/**
* IP 限频配置开关，取值有：
on：开启
off：关闭
*/
Switch: string;
/**
* 设置每秒请求数限制
超出限制的请求会直接返回 514
注意：此字段可能返回 null，表示取不到有效值。
*/
Qps?: number;
}
/**
* HTTPS回源SNI
*/
export interface OriginSni {
/**
* 是否开启HTTPS回源SNI。
开启：on，
关闭：off
*/
Switch: string;
/**
* 回源域名。
注意：此字段可能返回 null，表示取不到有效值。
*/
ServerName: string;
}
/**
* 动态打包任务过滤器
*/
export interface EdgePackTaskFilter {
/**
* 过滤字段名
apk: apk名称
status: 母包处理进度 done, failed, processing
*/
Name: string;
/**
* 过滤字段值
*/
Value: Array<string>;
/**
* 是否启用模糊查询，仅支持过滤字段名为 apk。
模糊查询时，Value长度最大为1。
*/
Fuzzy: boolean;
}
/**
* 排序类型的数据结构，同时附带上该项的在总值的占比
*/
export interface TopDetailDataMore {
/**
* 数据类型的名称
*/
Name: string;
/**
* 数据值
*/
Value: number;
/**
* 数据值在总值中的百分比
注意：此字段可能返回 null，表示取不到有效值。
*/
Percent: number;
}
/**
* DescribeIpVisit请求参数结构体
*/
export interface DescribeIpVisitRequest {
/**
* 查询起始时间，如：2018-09-04 10:40:10，返回结果大于等于指定时间
根据指定时间粒度不同，会进行向前归整，如 2018-09-04 10:40:10 在按 5 分钟的时间粒度查询时，返回的第一个数据对应时间点为 2018-09-04 10:40:00
*/
StartTime: string;
/**
* 查询结束时间，如：2018-09-04 10:40:10，返回结果小于等于指定时间
根据指定时间粒度不同，会进行向前归整，如 2018-09-04 10:40:10 在按 5 分钟的时间粒度查询时，返回的最后一个数据对应时间点为 2018-09-04 10:40:00
*/
EndTime: string;
/**
* 指定查询域名列表，最多可一次性查询 30 个加速域名明细
*/
Domains?: Array<string>;
/**
* 指定要查询的项目 ID，[前往查看项目 ID](https://console.cloud.tencent.com/project)
未填充域名情况下，指定项目查询，若填充了具体域名信息，以域名为主
*/
Project?: number;
/**
* 时间粒度，支持以下几种模式：
5min：5 分钟粒度，查询时间区间 24 小时内，默认返回 5 分钟粒度活跃用户数
day：天粒度，查询时间区间大于 1 天时，默认返回天粒度活跃用户数
*/
Interval?: string;
}
/**
* 状态码缓存过期时间规则配置
*/
export interface StatusCodeCacheRule {
/**
* http 状态码
支持 403、404 状态码
*/
StatusCode: string;
/**
* 状态码缓存过期时间，单位秒
*/
CacheTime: number;
}
/**
* DeleteCdnDomain返回参数结构体
*/
export interface DeleteCdnDomainResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteClsLogTopic返回参数结构体
*/
export interface DeleteClsLogTopicResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* session/ip维度的bot统计复杂对象
*/
export interface BotStatisticsCount {
/**
* BOT次数
*/
Count: number;
/**
* Top指标值,如果是ip维度就是ip如果是session维度就是域名
*/
Value: string;
/**
* ip所在国家
*/
Country: string;
/**
* ip所在省份
*/
Province: string;
/**
* ip归属的idc
*/
Isp: string;
}
/**
* 分路径分片回源配置
*/
export interface RangeOriginPullRule {
/**
* 分片回源配置开关，取值有：
on：开启
off：关闭
*/
Switch: string;
/**
* 规则类型：
file：指定文件后缀生效
directory：指定路径生效
path：指定绝对路径生效
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleType: string;
/**
* RuleType 对应类型下的匹配内容：
file 时填充后缀名，如 jpg、txt
directory 时填充路径，如 /xxx/test
path 时填充绝对路径，如 /xxx/test.html
注意：此字段可能返回 null，表示取不到有效值。
*/
RulePaths: Array<string>;
}
/**
* DescribeCdnIp返回参数结构体
*/
export interface DescribeCdnIpResponse {
/**
* 查询的节点归属详情。
*/
Ips?: Array<CdnIp>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* acl的错误页面
*/
export interface ScdnErrorPage {
/**
* 状态码
执行动作为：intercept 默认传值 403
执行动作为：redirect 默认传值 301
*/
RedirectCode: number;
/**
* 重定向url
*/
RedirectUrl: string;
}
/**
* UpdateImageConfig请求参数结构体
*/
export interface UpdateImageConfigRequest {
/**
* 域名
*/
Domain: string;
/**
* WebpAdapter配置项
*/
WebpAdapter?: WebpAdapter;
/**
* TpgAdapter配置项
*/
TpgAdapter?: TpgAdapter;
/**
* GuetzliAdapter配置项
*/
GuetzliAdapter?: GuetzliAdapter;
/**
* AvifAdapter配置项
*/
AvifAdapter?: AvifAdapter;
}
/**
* 排序类型数据结构
*/
export interface TopData {
/**
* 资源名称，根据查询条件不同分为以下几类：
具体域名：表示该域名明细数据
multiDomains：表示多域名汇总明细数据
项目 ID：指定项目查询时，显示为项目 ID
all：账号维度明细数据
*/
Resource: string;
/**
* 排序结果详情
*/
DetailData: Array<TopDetailData>;
}
/**
* ListTopClsLogData返回参数结构体
*/
export interface ListTopClsLogDataResponse {
/**
* 数据列表
*/
Data: Array<ClsLogIpData>;
/**
* 获取到Top总记录数
*/
TotalCount: number;
/**
* 获取到的不重复IP条数
*/
IpCount: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* https 客户端证书配置
*/
export interface ClientCert {
/**
* 客户端证书
PEM 格式，需要进行 Base 64 编码
注意：此字段可能返回 null，表示取不到有效值。
*/
Certificate: string;
/**
* 客户端证书名称
注意：此字段可能返回 null，表示取不到有效值。
*/
CertName?: string;
/**
* 证书过期时间
作为入参时无需填充
注意：此字段可能返回 null，表示取不到有效值。
*/
ExpireTime?: string;
/**
* 证书颁发时间
作为入参时无需填充
注意：此字段可能返回 null，表示取不到有效值。
*/
DeployTime?: string;
}
/**
* ShareCname配置
ShareCname 为内测功能,如需使用,请联系腾讯云工程师开白.
*/
export interface ShareCname {
/**
* ShareCname 配置开关, 取值有：
on：开启，使用共享CNAME
off：关闭，使用默认CNAME
*/
Switch: string;
/**
* 设置共享CNAME.
注意：此字段可能返回 null，表示取不到有效值。
*/
Cname?: string;
}
/**
* ListClsLogTopics请求参数结构体
*/
export interface ListClsLogTopicsRequest {
/**
* 接入渠道，cdn或者ecdn，默认值为cdn
*/
Channel?: string;
}
/**
* SEO 搜索引擎优化配置，默认为关闭状态
*/
export interface Seo {
/**
* SEO 搜索引擎优化配置开关，取值有：
on：开启
off：关闭
注意：此字段可能返回 null，表示取不到有效值。
*/
Switch: string;
}
/**
* CreateClsLogTopic请求参数结构体
*/
export interface CreateClsLogTopicRequest {
/**
* 日志主题名称
*/
TopicName: string;
/**
* 日志集ID
*/
LogsetId: string;
/**
* 接入渠道，cdn或者ecdn，默认值为cdn
*/
Channel?: string;
/**
* 域名区域信息
*/
DomainAreaConfigs?: Array<DomainAreaConfig>;
}
/**
* PurgeUrlsCache请求参数结构体
*/
export interface PurgeUrlsCacheRequest {
/**
* URL 列表，需要包含协议头部 http:// 或 https://
*/
Urls: Array<string>;
/**
* 刷新区域
无此参数时，默认刷新加速域名所在加速区域
填充 mainland 时，仅刷新中国境内加速节点上缓存内容
填充 overseas 时，仅刷新中国境外加速节点上缓存内容
指定刷新区域时，需要与域名加速区域匹配
*/
Area?: string;
/**
* 是否对中文字符进行编码后刷新
*/
UrlEncode?: boolean;
}
/**
* DescribeScdnConfig返回参数结构体
*/
export interface DescribeScdnConfigResponse {
/**
* 自定义防护策略配置
*/
Acl?: ScdnAclConfig;
/**
* Web 攻击防护（WAF）配置
*/
Waf?: ScdnWafConfig;
/**
* CC 防护配置
*/
CC?: ScdnConfig;
/**
* DDOS 防护配置
*/
Ddos?: ScdnDdosConfig;
/**
* BOT 防护配置
*/
Bot?: ScdnBotConfig;
/**
* 当前状态，取值online | offline
注意：此字段可能返回 null，表示取不到有效值。
*/
Status?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribePushQuota请求参数结构体
*/
export declare type DescribePushQuotaRequest = null;
/**
* DescribePurgeTasks请求参数结构体
*/
export interface DescribePurgeTasksRequest {
/**
* 指定刷新类型查询
url：url 刷新记录
path：目录刷新记录
*/
PurgeType?: string;
/**
* 根据时间区间查询时，填充开始时间，如 2018-08-08 00:00:00
*/
StartTime?: string;
/**
* 根据时间区间查询时，填充结束时间，如 2018-08-08 23:59:59
*/
EndTime?: string;
/**
* 根据任务 ID 查询时，填充任务 ID
查询时任务 ID 与起始时间必须填充一项
*/
TaskId?: string;
/**
* 分页查询偏移量，默认为 0
*/
Offset?: number;
/**
* 分页查询限制数目，默认为 20
*/
Limit?: number;
/**
* 支持域名过滤，或 http(s):// 开头完整 URL 过滤
*/
Keyword?: string;
/**
* 指定任务状态查询
fail：刷新失败
done：刷新成功
process：刷新中
*/
Status?: string;
/**
* 指定刷新地域查询
mainland：境内
overseas：境外
global：全球
*/
Area?: string;
}
/**
* CreateDiagnoseUrl请求参数结构体
*/
export interface CreateDiagnoseUrlRequest {
/**
* 需诊断的url，形如：http://www.test.com/test.txt。
*/
Url: string;
/**
* 请求源带协议头，形如：https://console.cloud.tencent.com
*/
Origin?: string;
}
/**
* 启发式自定义时间缓存配置
*/
export interface CacheConfig {
/**
* 启发式自定义时间缓存配置开关，取值有：
on：开启
off：关闭
注意：此字段可能返回 null，表示取不到有效值。
*/
HeuristicCacheTimeSwitch: string;
/**
* 单位 秒.
注意：此字段可能返回 null，表示取不到有效值。
*/
HeuristicCacheTime: number;
}
/**
* ListTopData返回参数结构体
*/
export interface ListTopDataResponse {
/**
* 各个资源的Top 访问数据详情。
*/
Data?: Array<TopData>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpdateDomainConfig返回参数结构体
*/
export interface UpdateDomainConfigResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ListDiagnoseReport返回参数结构体
*/
export interface ListDiagnoseReportResponse {
/**
* 诊断信息。
*/
Data?: Array<DiagnoseInfo>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 组成CacheKey
*/
export interface HeaderKey {
/**
* 组成Cachekey配置开关，取值有：
on：开启
off：关闭
注意：此字段可能返回 null，表示取不到有效值。
*/
Switch?: string;
/**
* 组成CacheKey的header数组，';' 分割
注意：此字段可能返回 null，表示取不到有效值。
*/
Value?: string;
}
/**
* Waf 规则信息
*/
export interface ScdnWafRule {
/**
* 攻击类型
*/
AttackType: string;
/**
* 防护措施，observe
*/
Operate: string;
}
/**
* DescribeHttpsPackages请求参数结构体
*/
export interface DescribeHttpsPackagesRequest {
/**
* 分页查询起始地址，默认 0
*/
Offset?: number;
/**
* 分页查询记录个数，默认100，最大1000
*/
Limit?: number;
}
/**
* IP 黑白名单配置，默认为关闭状态
*/
export interface IpFilter {
/**
* IP 黑白名单配置开关，取值有
on：开启
off：关闭
*/
Switch: string;
/**
* IP 黑白名单类型
whitelist：白名单
blacklist：黑名单
注意：此字段可能返回 null，表示取不到有效值。
*/
FilterType?: string;
/**
* IP 黑白名单列表
支持 X.X.X.X 形式 IP，或 /8、 /16、/24 形式网段
最多可填充 50 个白名单或 50 个黑名单
注意：此字段可能返回 null，表示取不到有效值。
*/
Filters?: Array<string>;
/**
* IP 黑白名单分路径配置，白名单功能
注意：此字段可能返回 null，表示取不到有效值。
*/
FilterRules?: Array<IpFilterPathRule>;
/**
* IP 黑白名单验证失败时返回的 code <br><font color=red>已下线，参数失效，不支持自定义状态码，固定返回514</font>
注意：此字段可能返回 null，表示取不到有效值。
*/
ReturnCode?: number;
}
/**
* 诊断报告单元信息
*/
export interface DiagnoseUnit {
/**
* 内容单元英文名称。
注意：此字段可能返回 null，表示取不到有效值。
*/
Key: string;
/**
* 内容单元中文名称。
注意：此字段可能返回 null，表示取不到有效值。
*/
KeyText: string;
/**
* 报告内容。
注意：此字段可能返回 null，表示取不到有效值。
*/
Value: string;
/**
* 报告内容。
注意：此字段可能返回 null，表示取不到有效值。
*/
ValueText: string;
}
/**
* 诊断信息
*/
export interface DiagnoseInfo {
/**
* 待诊断的URL。
注意：此字段可能返回 null，表示取不到有效值。
*/
DiagnoseUrl: string;
/**
* 由系统生成的诊断链接。
注意：此字段可能返回 null，表示取不到有效值。
*/
DiagnoseLink: string;
/**
* 诊断创建时间。
注意：此字段可能返回 null，表示取不到有效值。
*/
CreateTime: string;
/**
* 诊断链接过期时间。
注意：此字段可能返回 null，表示取不到有效值。
*/
ExpireDate: string;
/**
* 诊断链接当前访问次数，一个诊断链接最多可访问10次。
注意：此字段可能返回 null，表示取不到有效值。
*/
VisitCount: number;
/**
* 访问诊断链接的客户端简易信息
注意：此字段可能返回 null，表示取不到有效值。
*/
ClientList: Array<DiagnoseList>;
/**
* 域名加速区域
注意：此字段可能返回 null，表示取不到有效值。
*/
Area: string;
}
/**
* DescribeScdnBotRecords返回参数结构体
*/
export interface DescribeScdnBotRecordsResponse {
/**
* BOT拦截结果数组
*/
Data: Array<BotRecord>;
/**
* 记录数量
*/
TotalCount: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DDoS统计数据
*/
export interface DDoSStatsData {
/**
* 时间
*/
Time: string;
/**
* 带宽数值，单位bps
*/
Value: number;
}
/**
* DescribeCdnData请求参数结构体
*/
export interface DescribeCdnDataRequest {
/**
* 查询起始时间，如：2018-09-04 10:40:00，返回结果大于等于指定时间
根据指定时间粒度不同，会进行向前归整，如 2018-09-04 10:40:00 在按 1 小时的时间粒度查询时，返回的第一个数据对应时间点为 2018-09-04 10:00:00
起始时间与结束时间间隔小于等于 90 天
*/
StartTime: string;
/**
* 查询结束时间，如：2018-09-04 10:40:00，返回结果小于等于指定时间
根据指定时间粒度不同，会进行向前归整，如 2018-09-04 10:40:00 在按 1 小时的时间粒度查询时，返回的最后一个数据对应时间点为 2018-09-04 10:00:00
起始时间与结束时间间隔小于等于 90 天
*/
EndTime: string;
/**
* 指定查询指标，支持的类型有：
flux：流量，单位为 byte
fluxIn：上行流量，单位为 byte，该指标仅ecdn支持查询
fluxOut：下行流量，单位为 byte，该指标仅ecdn支持查询
bandwidth：带宽，单位为 bps
bandwidthIn：上行带宽，单位为 bps，该指标仅ecdn支持查询
bandwidthOut：下行带宽，单位为 bps，该指标仅ecdn支持查询
request：请求数，单位为 次
hitRequest：命中请求数，单位为 次
requestHitRate：请求命中率，单位为 %，保留小数点后两位
hitFlux：命中流量，单位为byte
fluxHitRate：流量命中率，单位为 %，保留小数点后两位
statusCode：状态码，返回 2xx、3xx、4xx、5xx 汇总数据，单位为 个
2xx：返回 2xx 状态码汇总及各 2 开头状态码数据，单位为 个
3xx：返回 3xx 状态码汇总及各 3 开头状态码数据，单位为 个
4xx：返回 4xx 状态码汇总及各 4 开头状态码数据，单位为 个
5xx：返回 5xx 状态码汇总及各 5 开头状态码数据，单位为 个
支持指定具体状态码查询，若未产生过，则返回为空
*/
Metric: string;
/**
* 指定查询域名列表
查询单域名：指定单个域名
查询多个域名：指定多个域名，最多可一次性查询 30 个
查询账号下所有域名：不传参，默认查询账号维度
*/
Domains?: Array<string>;
/**
* 指定要查询的项目 ID，[前往查看项目 ID](https://console.cloud.tencent.com/project)
未填充域名情况下，指定项目查询，若填充了具体域名信息，以域名为主
*/
Project?: number;
/**
* 时间粒度，支持以下几种模式：
min：1 分钟粒度，指定查询区间 24 小时内（含 24 小时），可返回 1 分钟粒度明细数据（指定查询服务地域为中国境外时不支持 1 分钟粒度）
5min：5 分钟粒度，指定查询区间 31 天内（含 31 天），可返回 5 分钟粒度明细数据
hour：1 小时粒度，指定查询区间 31 天内（含 31 天），可返回 1 小时粒度明细数据
day：天粒度，指定查询区间大于 31 天，可返回天粒度明细数据
*/
Interval?: string;
/**
* 多域名查询时，默认（false)返回多个域名的汇总数据
可按需指定为 true，返回每一个 Domain 的明细数据（statusCode 指标暂不支持）
*/
Detail?: boolean;
/**
* 查询中国境内CDN数据时，指定运营商查询，不填充表示查询所有运营商
运营商编码可以查看 [运营商编码映射](https://cloud.tencent.com/document/product/228/6316#.E5.8C.BA.E5.9F.9F-.2F-.E8.BF.90.E8.90.A5.E5.95.86.E6.98.A0.E5.B0.84.E8.A1.A8)
指定运营商查询时，不可同时指定省份、IP协议查询
*/
Isp?: number;
/**
* 查询中国境内CDN数据时，指定省份查询，不填充表示查询所有省份
查询中国境外CDN数据时，指定国家/地区查询，不填充表示查询所有国家/地区
省份、国家/地区编码可以查看 [省份编码映射](https://cloud.tencent.com/document/product/228/6316#.E5.8C.BA.E5.9F.9F-.2F-.E8.BF.90.E8.90.A5.E5.95.86.E6.98.A0.E5.B0.84.E8.A1.A8)
指定（中国境内）省份查询时，不可同时指定运营商、IP协议查询
*/
District?: number;
/**
* 指定协议查询，不填充表示查询所有协议
all：所有协议
http：指定查询 HTTP 对应指标
https：指定查询 HTTPS 对应指标
*/
Protocol?: string;
/**
* 指定数据源查询，白名单功能
*/
DataSource?: string;
/**
* 指定IP协议查询，不填充表示查询所有协议
all：所有协议
ipv4：指定查询 ipv4 对应指标
ipv6：指定查询 ipv6 对应指标
指定IP协议查询时，不可同时指定省份、运营商查询
注意：非IPv6白名单用户不可指定ipv4、ipv6进行查询
*/
IpProtocol?: string;
/**
* 指定服务地域查询，不填充表示查询中国境内CDN数据
mainland：指定查询中国境内 CDN 数据
overseas：指定查询中国境外 CDN 数据
*/
Area?: string;
/**
* 查询中国境外CDN数据时，可指定地区类型查询，不填充表示查询服务地区数据（仅在 Area 为 overseas 时可用）
server：指定查询服务地区（腾讯云 CDN 节点服务器所在地区）数据
client：指定查询客户端地区（用户请求终端所在地区）数据
*/
AreaType?: string;
/**
* 指定查询的产品数据，可选为cdn或者ecdn，默认为cdn
*/
Product?: string;
/**
* 指定查询时间的时区，默认UTC+08:00
*/
TimeZone?: string;
}
/**
* DescribeImageConfig返回参数结构体
*/
export interface DescribeImageConfigResponse {
/**
* WebpAdapter配置
注意：此字段可能返回 null，表示取不到有效值。
*/
WebpAdapter: WebpAdapter;
/**
* TpgAdapter配置
注意：此字段可能返回 null，表示取不到有效值。
*/
TpgAdapter: TpgAdapter;
/**
* GuetzliAdapter配置
注意：此字段可能返回 null，表示取不到有效值。
*/
GuetzliAdapter: GuetzliAdapter;
/**
* AvifAdapter配置项
注意：此字段可能返回 null，表示取不到有效值。
*/
AvifAdapter: AvifAdapter;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 节点缓存过期时间配置，分为以下两种：
+ 基础版缓存过期规则配置
+ 高级版缓存过期规则配置
*/
export interface Cache {
/**
* 基础缓存过期时间配置
注意：此字段可能返回 null，表示取不到有效值。
*/
SimpleCache?: SimpleCache;
/**
* 高级缓存过期时间配置（已弃用）
注意：此字段可能返回 null，表示取不到有效值。
*/
AdvancedCache?: AdvancedCache;
/**
* 高级路径缓存配置
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleCache?: Array<RuleCache>;
}
/**
* StopScdnDomain请求参数结构体
*/
export interface StopScdnDomainRequest {
/**
* 域名
*/
Domain: string;
}
/**
* 时间戳防盗链高级版配置，白名单功能
*/
export interface AdvancedAuthentication {
/**
* 防盗链配置开关，取值有：
on：开启
off：关闭
开启时必须且只配置一种模式，其余模式需要设置为 null
*/
Switch: string;
/**
* 时间戳防盗链高级版模式A配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
TypeA?: AdvancedAuthenticationTypeA;
/**
* 时间戳防盗链高级版模式B配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
TypeB?: AdvancedAuthenticationTypeB;
/**
* 时间戳防盗链高级版模式C配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
TypeC?: AdvancedAuthenticationTypeC;
/**
* 时间戳防盗链高级版模式D配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
TypeD?: AdvancedAuthenticationTypeD;
/**
* 时间戳防盗链高级版模式E配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
TypeE?: AdvancedAuthenticationTypeE;
/**
* 时间戳防盗链高级版模式F配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
TypeF?: AdvancedAuthenticationTypeF;
}
/**
* 是否回源站校验
*/
export interface Revalidate {
/**
* 总是回源校验配置开关，取值有：
on：开启
off：关闭
注意：此字段可能返回 null，表示取不到有效值。
*/
Switch: string;
/**
* 只在特定请求路径回源站校验
注意：此字段可能返回 null，表示取不到有效值。
*/
Path?: string;
}
/**
* 封禁url的详细信息
*/
export interface UrlRecord {
/**
* 状态(disable表示封禁，enable表示解封)
注意：此字段可能返回 null，表示取不到有效值。
*/
Status: string;
/**
* 对应的url
注意：此字段可能返回 null，表示取不到有效值。
*/
RealUrl: string;
/**
* 创建时间
注意：此字段可能返回 null，表示取不到有效值。
*/
CreateTime: string;
/**
* 更新时间
注意：此字段可能返回 null，表示取不到有效值。
*/
UpdateTime: string;
}
/**
* 其他厂商对象存储回源鉴权
*/
export interface OthersPrivateAccess {
/**
* 其他厂商对象存储回源鉴权配置开关，取值有：
on：开启
off：关闭
*/
Switch: string;
/**
* 访问ID。
注意：此字段可能返回 null，表示取不到有效值。
*/
AccessKey?: string;
/**
* 密钥。
注意：此字段可能返回 null，表示取不到有效值。
*/
SecretKey?: string;
/**
* 地域。
注意：此字段可能返回 null，表示取不到有效值。
*/
Region?: string;
/**
* 存储桶名称。
注意：此字段可能返回 null，表示取不到有效值。
*/
Bucket?: string;
}
/**
* DescribePushQuota返回参数结构体
*/
export interface DescribePushQuotaResponse {
/**
* Url预热用量及配额。
*/
UrlPush: Array<Quota>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 时间戳防盗链配置
*/
export interface Authentication {
/**
* 防盗链配置开关，取值有：
on：开启
off：关闭
开启时必须且只配置一种模式，其余模式需要设置为 null
*/
Switch: string;
/**
* 鉴权算法，取值有：
md5：按MD5算法取hash值
sha256：按SHA-256算法取hash值
默认为 md5
注意：此字段可能返回 null，表示取不到有效值。
*/
AuthAlgorithm?: string;
/**
* 时间戳防盗链模式 A 配置
注意：此字段可能返回 null，表示取不到有效值。
*/
TypeA?: AuthenticationTypeA;
/**
* 时间戳防盗链模式 B 配置（模式 B 后台升级中，暂时不支持配置）
注意：此字段可能返回 null，表示取不到有效值。
*/
TypeB?: AuthenticationTypeB;
/**
* 时间戳防盗链模式 C 配置
注意：此字段可能返回 null，表示取不到有效值。
*/
TypeC?: AuthenticationTypeC;
/**
* 时间戳防盗链模式 D 配置
注意：此字段可能返回 null，表示取不到有效值。
*/
TypeD?: AuthenticationTypeD;
}
/**
* CreateClsLogTopic返回参数结构体
*/
export interface CreateClsLogTopicResponse {
/**
* 主题ID
注意：此字段可能返回 null，表示取不到有效值。
*/
TopicId: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* MaxAge 状态码相关规则配置
*/
export interface MaxAgeCodeRule {
/**
* 处理动作
clear：清除 cache-control 头部
*/
Action: string;
/**
* 指定HTTP状态码生效，当前仅支持填写"400-599"
*/
StatusCodes: Array<string>;
}
/**
* 精准访问控制匹配规则
*/
export interface ScdnAclRule {
/**
* 匹配关键字
*/
MatchKey: string;
/**
* 逻辑操作符，取值如下
*/
LogiOperator: string;
/**
* 匹配值。
*/
MatchValue: string;
}
/**
* 域名查询时过滤条件。
*/
export 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;
/**
* 过滤字段值。
*/
Value: Array<string>;
/**
* 是否启用模糊查询，仅支持过滤字段名为origin，domain。
模糊查询时，Value长度最大为1，否则Value长度最大为5。
*/
Fuzzy?: boolean;
}
/**
* DescribePurgeQuota请求参数结构体
*/
export declare type DescribePurgeQuotaRequest = null;
/**
* StopScdnDomain返回参数结构体
*/
export interface StopScdnDomainResponse {
/**
* 关闭结果，Success表示成功
*/
Result: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribePayType返回参数结构体
*/
export interface DescribePayTypeResponse {
/**
* 计费类型
flux：流量计费
bandwidth：带宽计费
request：请求数计费
flux_sep：动静分离流量计费
bandwidth_sep：动静分离带宽计费
日结计费方式切换时，若当日产生消耗，则此字段表示第二天即将生效的计费方式，若未产生消耗，则表示已经生效的计费方式。
*/
PayType?: string;
/**
* 计费周期
day：日结计费
month：月结计费
hour：小时结计费
*/
BillingCycle?: string;
/**
* 统计类型
monthMax：日峰值月平均，月结模式
day95：日 95 带宽，月结模式
month95：月95带宽，月结模式
sum：总流量/总请求数，日结或月结模式
max：峰值带宽，日结模式
*/
StatType?: string;
/**
* 计费区域
all：全地区统一计费
multiple：分地区计费
*/
RegionType?: string;
/**
* 当前生效计费类型
flux：流量计费
bandwidth：带宽计费
request：请求数计费
flux_sep：动静分离流量计费
bandwidth_sep：动静分离带宽计费
*/
CurrentPayType?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ListTopData请求参数结构体
*/
export interface ListTopDataRequest {
/**
* 查询起始时间：yyyy-MM-dd HH:mm:ss
仅支持按分钟粒度的数据查询，按入参抹去秒位作为起始时间，如 StartTime为2018-09-04 10:40:23，返回数据的起始时间为2018-09-04 10:40:00
仅支持 90 天内数据查询
*/
StartTime: string;
/**
* 查询结束时间：yyyy-MM-dd HH:mm:ss
仅支持按天粒度的数据查询，取入参中的天信息作为结束日期 返回小于等于结束日期当天 23:59:59 产生的数据，如EndTime为2018-09-05 22:40:00，返回数据的结束时间为2018-09-05 23:59:59
EndTime 需要大于等于 StartTime
*/
EndTime: string;
/**
* 排序对象，支持以下几种形式：
url：访问 URL 排序（无参数的URL），支持的 Filter 为 flux、request
district：省份、国家/地区排序，支持的 Filter 为 flux、request
isp：运营商排序，支持的 Filter 为 flux、request
host：域名访问数据排序，支持的 Filter 为：flux、request、bandwidth、fluxHitRate、2XX、3XX、4XX、5XX、statusCode
originHost：域名回源数据排序，支持的 Filter 为 flux、request、bandwidth、origin_2XX、origin_3XX、origin_4XX、origin_5XX、OriginStatusCode
*/
Metric: string;
/**
* 排序使用的指标名称：
flux：Metric 为 host 时指代访问流量，originHost 时指代回源流量
bandwidth：Metric 为 host 时指代访问带宽，originHost 时指代回源带宽
request：Metric 为 host 时指代访问请求数，originHost 时指代回源请求数
fluxHitRate：平均流量命中率
2XX：访问 2XX 状态码
3XX：访问 3XX 状态码
4XX：访问 4XX 状态码
5XX：访问 5XX 状态码
origin_2XX：回源 2XX 状态码
origin_3XX：回源 3XX 状态码
origin_4XX：回源 4XX 状态码
origin_5XX：回源 5XX 状态码
statusCode：指定访问状态码统计，在 Code 参数中填充指定状态码
OriginStatusCode：指定回源状态码统计，在 Code 参数中填充指定状态码
*/
Filter: string;
/**
* 指定查询域名列表，最多可一次性查询 30 个加速域名明细
*/
Domains?: Array<string>;
/**
* 指定要查询的项目 ID，[前往查看项目 ID](https://console.cloud.tencent.com/project)
未填充域名情况下，指定项目查询，若填充了具体域名信息，以域名为主
*/
Project?: number;
/**
* 多域名查询时，默认（false)返回所有域名汇总排序结果
Metric 为 url、path、district、isp，Filter 为 flux、request 时，可设置为 true，返回每一个 Domain 的排序数据
*/
Detail?: boolean;
/**
* Filter 为 statusCode、OriginStatusCode 时，填充指定状态码查询排序结果
*/
Code?: string;
/**
* 指定服务地域查询，不填充表示查询中国境内 CDN 数据
mainland：指定查询中国境内 CDN 数据
overseas：指定查询中国境外 CDN 数据，支持的 Metric 为 url、district、host、originHost，当 Metric 为 originHost 时仅支持 flux、request、bandwidth Filter
*/
Area?: string;
/**
* 查询中国境外CDN数据，且仅当 Metric 为 district 或 host 时，可指定地区类型查询，不填充表示查询服务地区数据（仅在 Area 为 overseas，且 Metric 是 district 或 host 时可用）
server：指定查询服务地区（腾讯云 CDN 节点服务器所在地区）数据
client：指定查询客户端地区（用户请求终端所在地区）数据，当 Metric 为 host 时仅支持 flux、request、bandwidth Filter
*/
AreaType?: string;
/**
* 指定查询的产品数据，可选为cdn或者ecdn，默认为cdn
*/
Product?: string;
/**
* 只返回前N条数据，默认为最大值100，metric=url时默认为最大值1000
*/
Limit?: number;
}
/**
* 缓存键配置（忽略参数配置）
*/
export interface CacheKey {
/**
* 是否开启全路径缓存
on：开启全路径缓存（即关闭参数忽略）
off：关闭全路径缓存（即开启参数忽略）
*/
FullUrlCache?: string;
/**
* 是否忽略大小写缓存
注意：此字段可能返回 null，表示取不到有效值。
*/
IgnoreCase?: string;
/**
* CacheKey中包含请求参数
注意：此字段可能返回 null，表示取不到有效值。
*/
QueryString?: QueryStringKey;
/**
* CacheKey中包含Cookie
注意：此字段可能返回 null，表示取不到有效值。
*/
Cookie?: CookieKey;
/**
* CacheKey中包含请求头部
注意：此字段可能返回 null，表示取不到有效值。
*/
Header?: HeaderKey;
/**
* CacheKey中包含自定义字符串
注意：此字段可能返回 null，表示取不到有效值。
*/
CacheTag?: CacheTagKey;
/**
* CacheKey中包含请求协议
注意：此字段可能返回 null，表示取不到有效值。
*/
Scheme?: SchemeKey;
/**
* 分路径缓存键配置
注意：此字段可能返回 null，表示取不到有效值。
*/
KeyRules?: Array<KeyRule>;
}
/**
* DuplicateDomainConfig返回参数结构体
*/
export interface DuplicateDomainConfigResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 智能压缩规则配置
*/
export interface CompressionRule {
/**
* true：需要设置为 ture，启用压缩
注意：此字段可能返回 null，表示取不到有效值。
*/
Compress: boolean;
/**
* 触发压缩的文件长度最小值，单位为字节数
注意：此字段可能返回 null，表示取不到有效值。
*/
MinLength: number;
/**
* 触发压缩的文件长度最大值，单位为字节数
最大可设置为 30MB
注意：此字段可能返回 null，表示取不到有效值。
*/
MaxLength: number;
/**
* 文件压缩算法
gzip：指定 GZIP 压缩
brotli：指定Brotli压缩
注意：此字段可能返回 null，表示取不到有效值。
*/
Algorithms: Array<string>;
/**
* 根据文件后缀类型压缩
例如 jpg、txt
注意：此字段可能返回 null，表示取不到有效值。
*/
FileExtensions?: Array<string>;
/**
* 规则类型：
all：所有文件生效
file：指定文件后缀生效
directory：指定路径生效
path：指定绝对路径生效
contentType：指定Content-Type头为特定值时生效
当指定了此字段时，FileExtensions字段不生效
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleType?: string;
/**
* CacheType 对应类型下的匹配内容：
all 时填充 *
file 时填充后缀名，如 jpg、txt
directory 时填充路径，如 /xxx/test
path 时填充绝对路径，如 /xxx/test.html
contentType 时填充 text/html
注意：此字段可能返回 null，表示取不到有效值。
*/
RulePaths?: Array<string>;
}
/**
* 图片优化-GuetzliAdapter配置
*/
export interface GuetzliAdapter {
/**
* 图片优化-GuetzliAdapter配置开关，取值有：
on：开启
off：关闭
注意：此字段可能返回 null，表示取不到有效值。
*/
Switch?: string;
}
/**
* 合并回源配置项
*/
export interface OriginCombine {
/**
* 合并回源配置开关，取值有：
on：开启
off：关闭
*/
Switch: string;
}
/**
* EnableCaches请求参数结构体
*/
export interface EnableCachesRequest {
/**
* 解封 URL 列表
*/
Urls: Array<string>;
/**
* URL封禁日期
*/
Date?: string;
}
/**
* 通过Cls日志，计算出来的IP每秒访问数量
*/
export interface ClsLogIpData {
/**
* IP
*/
ClientIp: string;
/**
* 在给定的时间段中，1秒内的最大请求量
*/
Request: number;
/**
* 在获取的Top信息中，IP出现的次数
*/
Count: number;
/**
* 在给定的时间段中，1秒内的最大请求量对应的时间
*/
Time: string;
}
/**
* DeleteClsLogTopic请求参数结构体
*/
export interface DeleteClsLogTopicRequest {
/**
* 日志主题ID
*/
TopicId: string;
/**
* 日志集ID
*/
LogsetId: string;
/**
* 接入渠道，cdn或者ecdn，默认值为cdn
*/
Channel?: string;
}
/**
* 时间戳防盗链高级版模式C配置。
*/
export interface AdvancedAuthenticationTypeC {
/**
* 访问密钥。
*/
AccessKey: string;
/**
* 鉴权密钥。
*/
SecretKey: string;
}
/**
* VerifyDomainRecord请求参数结构体
*/
export interface VerifyDomainRecordRequest {
/**
* 域名
*/
Domain: string;
/**
* 验证方式
dns: DNS 解析验证（默认值）
file: 文件验证
*/
VerifyType?: string;
}
/**
* CreateVerifyRecord返回参数结构体
*/
export interface CreateVerifyRecordResponse {
/**
* 子解析
*/
SubDomain?: string;
/**
* 解析值
*/
Record?: string;
/**
* 解析类型
*/
RecordType?: string;
/**
* 文件验证 URL 指引
注意：此字段可能返回 null，表示取不到有效值。
*/
FileVerifyUrl?: string;
/**
* 文件校验域名列表
注意：此字段可能返回 null，表示取不到有效值。
*/
FileVerifyDomains?: Array<string>;
/**
* 文件校验文件名
注意：此字段可能返回 null，表示取不到有效值。
*/
FileVerifyName?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeReportData返回参数结构体
*/
export interface DescribeReportDataResponse {
/**
* 域名维度数据详情
*/
DomainReport: Array<ReportData>;
/**
* 项目维度数据详情
*/
ProjectReport: Array<ReportData>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ListClsTopicDomains返回参数结构体
*/
export interface ListClsTopicDomainsResponse {
/**
* 开发者ID
*/
AppId: number;
/**
* 渠道
*/
Channel: string;
/**
* 日志集ID
*/
LogsetId: string;
/**
* 日志主题ID
*/
TopicId: string;
/**
* 域名区域配置，其中可能含有已删除的域名，如果要再传回ManageClsTopicDomains接口，需要结合ListCdnDomains接口排除掉已删除的域名
*/
DomainAreaConfigs: Array<DomainAreaConfig>;
/**
* 日志主题名称
*/
TopicName: string;
/**
* 日志主题最近更新时间
注意：此字段可能返回 null，表示取不到有效值。
*/
UpdateTime: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* Ipv6源站启用配置，不可更改
*/
export interface Ipv6 {
/**
* 域名开启源站ipv6配置开关，取值有：
on：开启
off：关闭
注意：此字段可能返回 null，表示取不到有效值。
*/
Switch: string;
}
/**
* DescribeTrafficPackages请求参数结构体
*/
export interface DescribeTrafficPackagesRequest {
/**
* 分页查询起始地址，默认 0
*/
Offset?: number;
/**
* 分页查询记录个数，默认100，最大1000
*/
Limit?: number;
/**
* 流量包排序方式，支持以下值：
expireTimeDesc：默认值，按过期时间倒序
expireTimeAsc：按过期时间正序
createTimeDesc：按创建时间倒序
createTimeAsc：按创建时间正序
status：按状态排序，正常抵扣>未生效>已用尽>已过期
channel：按来源排序，主动购买>自动续订>CDN赠送
*/
SortBy?: string;
}
/**
* ManageClsTopicDomains返回参数结构体
*/
export interface ManageClsTopicDomainsResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 域名海外地区特殊配置。UpdateDomainConfig接口只支持修改部分地区配置，为了兼容旧版本配置，本类型会列出旧版本所有可能存在差异的配置列表，支持修改的配置列表如下：
+ Authentication
+ BandwidthAlert
+ ErrorPage
+ IpFilter
+ Origin
+ Referer
*/
export interface OverseaConfig {
/**
* 时间戳防盗链配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
Authentication?: Authentication;
/**
* 带宽封顶配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
BandwidthAlert?: BandwidthAlert;
/**
* 缓存规则配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
Cache?: Cache;
/**
* 缓存相关配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
CacheKey?: CacheKey;
/**
* 智能压缩配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
Compression?: Compression;
/**
* 下载限速配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
DownstreamCapping?: DownstreamCapping;
/**
* 错误码重定向配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
ErrorPage?: ErrorPage;
/**
* 301和302自动回源跟随配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
FollowRedirect?: FollowRedirect;
/**
* 访问协议强制跳转配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
ForceRedirect?: ForceRedirect;
/**
* Https配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
Https?: Https;
/**
* IP黑白名单配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
IpFilter?: IpFilter;
/**
* IP限频配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
IpFreqLimit?: IpFreqLimit;
/**
* 浏览器缓存规则配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
MaxAge?: MaxAge;
/**
* 源站配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
Origin?: Origin;
/**
* 跨国优化配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
OriginPullOptimization?: OriginPullOptimization;
/**
* Range回源配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
RangeOriginPull?: RangeOriginPull;
/**
* 防盗链配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
Referer?: Referer;
/**
* 回源请求头部配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
RequestHeader?: RequestHeader;
/**
* 源站响应头部配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
ResponseHeader?: ResponseHeader;
/**
* 遵循源站缓存头部配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
ResponseHeaderCache?: ResponseHeaderCache;
/**
* seo优化配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
Seo?: Seo;
/**
* 域名业务类型，web，download，media分别表示静态加速，下载加速和流媒体加速。
注意：此字段可能返回 null，表示取不到有效值。
*/
ServiceType?: string;
/**
* 状态码缓存配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
StatusCodeCache?: StatusCodeCache;
/**
* 视频拖拽配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
VideoSeek?: VideoSeek;
/**
* 回源S3私有鉴权。
注意：此字段可能返回 null，表示取不到有效值。
*/
AwsPrivateAccess?: AwsPrivateAccess;
/**
* 回源OSS私有鉴权。
注意：此字段可能返回 null，表示取不到有效值。
*/
OssPrivateAccess?: OssPrivateAccess;
/**
* 华为云对象存储鉴权
注意：此字段可能返回 null，表示取不到有效值。
*/
HwPrivateAccess?: HwPrivateAccess;
/**
* 七牛云对象存储鉴权
注意：此字段可能返回 null，表示取不到有效值。
*/
QnPrivateAccess?: QnPrivateAccess;
}
/**
* 缓存过期配置高级版，注意：此字段已经弃用，请使用RuleCache
*/
export interface AdvancedCache {
/**
* 缓存过期规则
注意：此字段可能返回 null，表示取不到有效值。
*/
CacheRules: Array<AdvanceCacheRule>;
/**
* 强制缓存配置
on：开启
off：关闭
开启时，源站返回 no-cache、no-store 头部时，仍按照缓存过期规则进行节点缓存
默认为关闭状态
注意：此字段可能返回 null，表示取不到有效值。
*/
IgnoreCacheControl: string;
/**
* 当源站返回Set-Cookie头部时，节点是否缓存该头部及body
on：开启，不缓存该头部及body
off：关闭，遵循用户自定义的节点缓存规则
默认为关闭状态
注意：此字段可能返回 null，表示取不到有效值。
*/
IgnoreSetCookie: string;
}
/**
* StartCdnDomain请求参数结构体
*/
export interface StartCdnDomainRequest {
/**
* 域名
域名状态需要为【已停用】
*/
Domain: string;
}
/**
* DescribePushTasks返回参数结构体
*/
export interface DescribePushTasksResponse {
/**
* 预热历史记录
注意：此字段可能返回 null，表示取不到有效值。
*/
PushLogs?: Array<PushTask>;
/**
* 任务总数，用于分页
注意：此字段可能返回 null，表示取不到有效值。
*/
TotalCount?: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AddCdnDomain返回参数结构体
*/
export interface AddCdnDomainResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* http头部设置规则。
*/
export interface HttpHeaderRule {
/**
* http头部设置方式，支持add，set或del，分别表示新增，设置或删除头部。
*/
HeaderMode: string;
/**
* http头部名称。
*/
HeaderName: string;
/**
* http头部值。
*/
HeaderValue: string;
}
/**
* 访问控制规则
*/
export interface AccessControlRule {
/**
* requestHeader ：对请求头部进行访问控制
url ： 对访问url进行访问控制
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleType: string;
/**
* 封禁内容
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleContent: string;
/**
* on ：正则匹配
off ：字面匹配
注意：此字段可能返回 null，表示取不到有效值。
*/
Regex: string;
/**
* RuleType为requestHeader时必填，否则不需要填
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleHeader?: string;
}
/**
* 地区运营商明细数据
*/
export interface DistrictIspInfo {
/**
* 域名
*/
Domain: string;
/**
* 协议类型
*/
Protocol: string;
/**
* IP协议类型
*/
IpProtocol: string;
/**
* 起始时间
*/
StartTime: string;
/**
* 结束时间
*/
EndTime: string;
/**
* 时间间隔，单位为分钟
*/
Interval: number;
/**
* 指标名称
*/
Metric: string;
/**
* 地区ID
*/
District: number;
/**
* 运营商ID
*/
Isp: number;
/**
* 指标数据点
*/
DataPoints: Array<number | bigint>;
/**
* 地区名称
*/
DistrictName: string;
/**
* 运营商名称
*/
IspName: string;
}
/**
* 缓存过期规则配置
*/
export interface SimpleCacheRule {
/**
* 规则类型：
all：所有文件生效
file：指定文件后缀生效
directory：指定路径生效
path：指定绝对路径生效
index：首页
*/
CacheType: string;
/**
* CacheType 对应类型下的匹配内容：
all 时填充 *
file 时填充后缀名，如 jpg、txt
directory 时填充路径，如 /xxx/test
path 时填充绝对路径，如 /xxx/test.html
index 时填充 /
*/
CacheContents: Array<string>;
/**
* 缓存过期时间设置
单位为秒，最大可设置为 365 天
*/
CacheTime: number;
}
/**
* ModifyPurgeFetchTaskStatus返回参数结构体
*/
export interface ModifyPurgeFetchTaskStatusResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DisableClsLogTopic返回参数结构体
*/
export interface DisableClsLogTopicResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 图片优化-TpgAdapter配置
*/
export interface TpgAdapter {
/**
* 图片优化-TpgAdapter配置开关，取值有：
on：开启
off：关闭
注意：此字段可能返回 null，表示取不到有效值。
*/
Switch?: string;
}
/**
* 加速域名全量配置信息
*/
export interface DetailDomain {
/**
* 域名 ID
*/
ResourceId?: string;
/**
* 腾讯云账号ID
*/
AppId?: number;
/**
* 加速域名
*/
Domain?: string;
/**
* 域名对应的 CNAME 地址
注意：此字段可能返回 null，表示取不到有效值。
*/
Cname?: string;
/**
* 加速服务状态
rejected：域名审核未通过，域名备案过期/被注销导致
processing：部署中
closing：关闭中
online：已启动
offline：已关闭
*/
Status?: string;
/**
* 项目 ID，可前往腾讯云项目管理页面查看
*/
ProjectId?: number;
/**
* 加速域名业务类型
web：网页小文件
download：下载大文件
media：音视频点播
hybrid: 动静加速
dynamic: 动态加速
*/
ServiceType?: string;
/**
* 域名创建时间
*/
CreateTime?: string;
/**
* 域名更新时间
*/
UpdateTime?: string;
/**
* 源站配置
*/
Origin?: Origin;
/**
* IP 黑白名单配置
注意：此字段可能返回 null，表示取不到有效值。
*/
IpFilter?: IpFilter;
/**
* IP 访问限频配置
注意：此字段可能返回 null，表示取不到有效值。
*/
IpFreqLimit?: IpFreqLimit;
/**
* 状态码缓存配置
注意：此字段可能返回 null，表示取不到有效值。
*/
StatusCodeCache?: StatusCodeCache;
/**
* 智能压缩配置
注意：此字段可能返回 null，表示取不到有效值。
*/
Compression?: Compression;
/**
* 带宽封顶配置
注意：此字段可能返回 null，表示取不到有效值。
*/
BandwidthAlert?: BandwidthAlert;
/**
* Range 回源配置
注意：此字段可能返回 null，表示取不到有效值。
*/
RangeOriginPull?: RangeOriginPull;
/**
* 301/302 回源自动跟随配置
注意：此字段可能返回 null，表示取不到有效值。
*/
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;
/**
* Https 加速相关配置
注意：此字段可能返回 null，表示取不到有效值。
*/
Https?: Https;
/**
* 时间戳防盗链配置
注意：此字段可能返回 null，表示取不到有效值。
*/
Authentication?: Authentication;
/**
* SEO 优化配置
注意：此字段可能返回 null，表示取不到有效值。
*/
Seo?: Seo;
/**
* 域名封禁状态
normal：正常状态
overdue：账号欠费导致域名关闭，充值完成后可自行启动加速服务
malicious：域名出现恶意行为，强制关闭加速服务
ddos：域名被大规模 DDoS 攻击，关闭加速服务
idle：域名超过 90 天内无任何操作、数据产生，判定为不活跃域名自动关闭加速服务，可自行启动加速服务
unlicensed：域名未备案/备案注销，自动关闭加速服务，备案完成后可自行启动加速服务
capping：触发配置的带宽阈值上限
readonly：域名存在特殊配置，被锁定
注意：此字段可能返回 null，表示取不到有效值。
*/
Disable?: string;
/**
* 访问协议强制跳转配置
注意：此字段可能返回 null，表示取不到有效值。
*/
ForceRedirect?: ForceRedirect;
/**
* Referer 防盗链配置
注意：此字段可能返回 null，表示取不到有效值。
*/
Referer?: Referer;
/**
* 浏览器缓存过期规则配置（功能灰度中，敬请期待）
注意：此字段可能返回 null，表示取不到有效值。
*/
MaxAge?: MaxAge;
/**
* Ipv6 回源配置（功能灰度中，敬请期待）
注意：此字段可能返回 null，表示取不到有效值。
*/
Ipv6?: Ipv6;
/**
* 是否兼容旧版本配置（内部兼容性字段）
注意：此字段可能返回 null，表示取不到有效值。
*/
Compatibility?: Compatibility;
/**
* 区域特殊配置
注意：此字段可能返回 null，表示取不到有效值。
*/
SpecificConfig?: SpecificConfig;
/**
* 加速区域
mainland：中国境内加速
overseas：中国境外加速
global：全球加速
注意：此字段可能返回 null，表示取不到有效值。
*/
Area?: string;
/**
* 域名锁定状态
normal：未锁定
mainland：中国境内锁定
overseas：中国境外锁定
global：全球锁定
注意：此字段可能返回 null，表示取不到有效值。
*/
Readonly?: string;
/**
* 回源超时配置
注意：此字段可能返回 null，表示取不到有效值。
*/
OriginPullTimeout?: OriginPullTimeout;
/**
* 回源S3鉴权配置
注意：此字段可能返回 null，表示取不到有效值。
*/
AwsPrivateAccess?: AwsPrivateAccess;
/**
* Scdn配置
注意：此字段可能返回 null，表示取不到有效值。
*/
SecurityConfig?: SecurityConfig;
/**
* ImageOptimization配置
注意：此字段可能返回 null，表示取不到有效值。
*/
ImageOptimization?: ImageOptimization;
/**
* UA黑白名单配置
注意：此字段可能返回 null，表示取不到有效值。
*/
UserAgentFilter?: UserAgentFilter;
/**
* 访问控制
注意：此字段可能返回 null，表示取不到有效值。
*/
AccessControl?: AccessControl;
/**
* 是否支持高级配置项
on：支持
off：不支持
注意：此字段可能返回 null，表示取不到有效值。
*/
Advance?: string;
/**
* URL重定向配置
注意：此字段可能返回 null，表示取不到有效值。
*/
UrlRedirect?: UrlRedirect;
/**
* 访问端口配置
注意：此字段可能返回 null，表示取不到有效值。
*/
AccessPort?: Array<number | bigint>;
/**
* 标签配置
注意：此字段可能返回 null，表示取不到有效值。
*/
Tag?: Array<Tag>;
/**
* 时间戳防盗链高级配置，白名单功能
注意：此字段可能返回 null，表示取不到有效值。
*/
AdvancedAuthentication?: AdvancedAuthentication;
/**
* 回源鉴权高级配置，白名单功能
注意：此字段可能返回 null，表示取不到有效值。
*/
OriginAuthentication?: OriginAuthentication;
/**
* Ipv6访问配置
注意：此字段可能返回 null，表示取不到有效值。
*/
Ipv6Access?: Ipv6Access;
/**
* 高级配置集合
注意：此字段可能返回 null，表示取不到有效值。
*/
AdvanceSet?: Array<AdvanceConfig>;
/**
* 离线缓存（功能灰度中，尚未全量，请等待后续全量发布）
注意：此字段可能返回 null，表示取不到有效值。
*/
OfflineCache?: OfflineCache;
/**
* 合并回源（白名单功能）
注意：此字段可能返回 null，表示取不到有效值。
*/
OriginCombine?: OriginCombine;
/**
* POST上传配置项
注意：此字段可能返回 null，表示取不到有效值。
*/
PostMaxSize?: PostSize;
/**
* Quic配置
注意：此字段可能返回 null，表示取不到有效值。
*/
Quic?: Quic;
/**
* 回源OSS私有鉴权
注意：此字段可能返回 null，表示取不到有效值。
*/
OssPrivateAccess?: OssPrivateAccess;
/**
* WebSocket配置
注意：此字段可能返回 null，表示取不到有效值。
*/
WebSocket?: WebSocket;
/**
* 远程鉴权配置
注意：此字段可能返回 null，表示取不到有效值。
*/
RemoteAuthentication?: RemoteAuthentication;
/**
* 共享CNAME配置（白名单功能）
注意：此字段可能返回 null，表示取不到有效值。
*/
ShareCname?: ShareCname;
/**
* 规则引擎
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleEngine?: RuleEngine;
/**
* 主域名
注意：此字段可能返回 null，表示取不到有效值。
*/
ParentHost?: string;
/**
* 华为云对象存储回源鉴权
注意：此字段可能返回 null，表示取不到有效值。
*/
HwPrivateAccess?: HwPrivateAccess;
/**
* 七牛云对象存储回源鉴权
注意：此字段可能返回 null，表示取不到有效值。
*/
QnPrivateAccess?: QnPrivateAccess;
/**
* HTTPS服务，缺省时默认开启
注意：此字段可能返回 null，表示取不到有效值。
*/
HttpsBilling?: HttpsBilling;
/**
* 其他厂商对象存储回源鉴权
注意：此字段可能返回 null，表示取不到有效值。
*/
OthersPrivateAccess?: OthersPrivateAccess;
}
/**
* GetDisableRecords返回参数结构体
*/
export interface GetDisableRecordsResponse {
/**
* 封禁历史记录
注意：此字段可能返回 null，表示取不到有效值。
*/
UrlRecordList?: Array<UrlRecord>;
/**
* 任务总数，用于分页
注意：此字段可能返回 null，表示取不到有效值。
*/
TotalCount?: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* Ipv6访问配置
*/
export interface Ipv6Access {
/**
* 域名开启ipv6访问配置开关，取值有：
on：开启
off：关闭
注意：此字段可能返回 null，表示取不到有效值。
*/
Switch: string;
}
/**
* Bot记录的排序选项
*/
export interface BotSortBy {
/**
* 排序参数名称， 取值为：timestamp， nums， session_duration，score.total，stat.avg_speed分别表示按照：最新检测时间，会话总次数，会话持续时间，BOT得分，平均速率排序
*/
Key: string;
/**
* asc/desc
*/
Sequence: string;
}
/**
* AddCLSTopicDomains请求参数结构体
*/
export interface AddCLSTopicDomainsRequest {
/**
* 日志集ID
*/
LogsetId: string;
/**
* 日志主题ID
*/
TopicId: string;
/**
* 域名区域配置
*/
DomainAreaConfigs: Array<DomainAreaConfig>;
/**
* 接入渠道，cdn或者ecdn，默认值为cdn
*/
Channel?: string;
}
/**
* 动态打包任务状态
*/
export interface EdgePackTaskStatus {
/**
* APK 名称
*/
Apk?: string;
/**
* 输出目录
*/
DstDir?: string;
/**
* 上传时间
*/
UploadTime?: string;
/**
* 任务状态
created: 创建成功
processing: 处理中
done: 处理完成
failed: 处理失败
*/
Status?: string;
/**
* 上传目录
*/
SrcDir?: Array<string>;
/**
* 失败任务状态详情
*/
StatusDesc?: string;
}
/**
* 域名国内地区特殊配置。分地区特殊配置。UpdateDomainConfig接口只支持修改部分地区配置，为了兼容旧版本配置，本类型会列出旧版本所有可能存在差异的配置列表，支持修改的配置列表如下：
+ Authentication
+ BandwidthAlert
+ ErrorPage
+ IpFilter
+ Origin
+ Referer
*/
export interface MainlandConfig {
/**
* 时间戳防盗链配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
Authentication?: Authentication;
/**
* 带宽封顶配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
BandwidthAlert?: BandwidthAlert;
/**
* 缓存规则配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
Cache?: Cache;
/**
* 缓存相关配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
CacheKey?: CacheKey;
/**
* 智能压缩配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
Compression?: Compression;
/**
* 下载限速配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
DownstreamCapping?: DownstreamCapping;
/**
* 错误码重定向配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
ErrorPage?: ErrorPage;
/**
* 301和302自动回源跟随配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
FollowRedirect?: FollowRedirect;
/**
* 访问协议强制跳转配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
ForceRedirect?: ForceRedirect;
/**
* Https配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
Https?: Https;
/**
* IP黑白名单配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
IpFilter?: IpFilter;
/**
* IP限频配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
IpFreqLimit?: IpFreqLimit;
/**
* 浏览器缓存规则配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
MaxAge?: MaxAge;
/**
* 源站配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
Origin?: Origin;
/**
* 跨国优化配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
OriginPullOptimization?: OriginPullOptimization;
/**
* Range回源配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
RangeOriginPull?: RangeOriginPull;
/**
* 防盗链配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
Referer?: Referer;
/**
* 回源请求头部配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
RequestHeader?: RequestHeader;
/**
* 源站响应头部配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
ResponseHeader?: ResponseHeader;
/**
* 遵循源站缓存头部配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
ResponseHeaderCache?: ResponseHeaderCache;
/**
* seo优化配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
Seo?: Seo;
/**
* 域名业务类型，web，download，media分别表示静态加速，下载加速和流媒体加速。
注意：此字段可能返回 null，表示取不到有效值。
*/
ServiceType?: string;
/**
* 状态码缓存配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
StatusCodeCache?: StatusCodeCache;
/**
* 视频拖拽配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
VideoSeek?: VideoSeek;
/**
* 回源S3私有鉴权。
注意：此字段可能返回 null，表示取不到有效值。
*/
AwsPrivateAccess?: AwsPrivateAccess;
/**
* 回源OSS私有鉴权。
注意：此字段可能返回 null，表示取不到有效值。
*/
OssPrivateAccess?: OssPrivateAccess;
/**
* 华为云对象存储回源鉴权
注意：此字段可能返回 null，表示取不到有效值。
*/
HwPrivateAccess?: HwPrivateAccess;
/**
* 七牛云对象存储回源鉴权
注意：此字段可能返回 null，表示取不到有效值。
*/
QnPrivateAccess?: QnPrivateAccess;
}
/**
* DescribeDDoSData请求参数结构体
*/
export interface DescribeDDoSDataRequest {
/**
* 查询起始时间，如：2018-09-04 10:40:00，返回结果大于等于指定时间
*/
StartTime: string;
/**
* 查询结束时间，如：2018-09-04 10:40:00，返回结果小于等于指定时间
*/
EndTime: string;
/**
* 时间粒度，支持以下几种模式：
min：1 分钟粒度，指定查询区间 24 小时内（含 24 小时），可返回 1 分钟粒度明细数据
5min：5 分钟粒度，指定查询区间 31 天内（含 31 天），可返回 5 分钟粒度明细数据
hour：1 小时粒度，指定查询区间 31 天内（含 31 天），可返回 1 小时粒度明细数据
day：天粒度，指定查询区间大于 31 天，可返回天粒度明细数据
*/
Interval: string;
}
/**
* CreateEdgePackTask请求参数结构体
*/
export interface CreateEdgePackTaskRequest {
/**
* apk 所在的 cos 存储桶, 如 edgepack-xxxxxxxx
*/
CosBucket: string;
/**
* apk 源文件的存储路径, 如 /apk/xxxx.apk
*/
CosUriFrom: string;
/**
* BlockID 的值, WALLE为1903654775(0x71777777)，VasDolly为2282837503(0x881155ff),传0或不传时默认为 WALLE 方案
*/
BlockID?: number;
/**
* 拓展之后的 apk 目标存储路径,如 /out/xxxx.apk
*/
CosUriTo?: string;
}
/**
* 累计用量封顶的配置
*/
export interface StatisticItem {
/**
* 封顶类型，累计用量total，瞬时用量moment
注意：此字段可能返回 null，表示取不到有效值。
*/
Type?: string;
/**
* 自动解封时间
注意：此字段可能返回 null，表示取不到有效值。
*/
UnBlockTime?: number;
/**
* 带宽、流量阈值
注意：此字段可能返回 null，表示取不到有效值。
*/
BpsThreshold?: number;
/**
* 关闭方式 返回404:RETURN_404, dns回源：RESOLVE_DNS_TO_ORIGIN
注意：此字段可能返回 null，表示取不到有效值。
*/
CounterMeasure?: string;
/**
* 触发提醒阈值百分比
注意：此字段可能返回 null，表示取不到有效值。
*/
AlertPercentage?: number;
/**
* 累计用量封顶告警配置，取值有：
on：开启
off：关闭
注意：此字段可能返回 null，表示取不到有效值。
*/
AlertSwitch?: string;
/**
* 指标类型，流量flux或带宽bandwidth
注意：此字段可能返回 null，表示取不到有效值。
*/
Metric?: string;
/**
* 检测周期，单位分钟，60或1440
注意：此字段可能返回 null，表示取不到有效值。
*/
Cycle?: number;
/**
* 累计用量封顶配置开关，取值有：
on：开启
off：关闭
注意：此字段可能返回 null，表示取不到有效值。
*/
Switch?: string;
}
/**
* 自定义请求头配置，默认为关闭状态
*/
export interface RequestHeader {
/**
* 自定义请求头配置开关，取值有：
on：开启
off：关闭
*/
Switch: string;
/**
* 自定义请求头配置规则
注意：此字段可能返回 null，表示取不到有效值。
*/
HeaderRules?: Array<HttpHeaderPathRule>;
}
/**
* HSTS 配置。
*/
export interface Hsts {
/**
* HSTS 配置开关，取值有：
on：开启
off：关闭
*/
Switch: string;
/**
* MaxAge数值。
注意：此字段可能返回 null，表示取不到有效值。
*/
MaxAge?: number;
/**
* 是否包含子域名，on或off。
注意：此字段可能返回 null，表示取不到有效值。
*/
IncludeSubDomains?: string;
}
/**
* ListTopClsLogData请求参数结构体
*/
export interface ListTopClsLogDataRequest {
/**
* 需要查询的日志集ID
*/
LogsetId: string;
/**
* 需要查询的日志主题ID组合，多个以逗号分隔
*/
TopicIds: string;
/**
* 需要查询的日志的起始时间，格式 YYYY-mm-dd HH:MM:SS
*/
StartTime: string;
/**
* 需要查询的日志的结束时间，格式 YYYY-mm-dd HH:MM:SS，时间跨度应小于10分钟
*/
EndTime: string;
/**
* 指定域名查询
*/
Domain: string;
/**
* 指定访问的URL查询，支持URL开头和结尾使用\*表示通配
如：
/files/* 表示所有以/files/开头的请求
*.jpg 表示所有以.jpg结尾的请求
*/
Url: string;
/**
* 接入渠道，cdn或者ecdn，默认值为cdn
*/
Channel?: string;
/**
* 要查询的Top条数，最大值为100，默认为10
*/
Limit?: number;
/**
* 按请求量排序， asc（升序）或者 desc（降序），默认为 desc
*/
Sort?: string;
}
/**
* DescribeTrafficPackages返回参数结构体
*/
export interface DescribeTrafficPackagesResponse {
/**
* 流量包总个数
*/
TotalCount?: number;
/**
* 流量包详情
*/
TrafficPackages?: Array<TrafficPackage>;
/**
* 即将过期的流量包个数（7天内）
*/
ExpiringCount?: number;
/**
* 有效流量包个数
*/
EnabledCount?: number;
/**
* 付费流量包个数
*/
PaidCount?: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeMapInfo请求参数结构体
*/
export interface DescribeMapInfoRequest {
/**
* 映射查询类别：
isp：运营商映射查询
district：省份（中国境内）、国家/地区（中国境外）映射查询
*/
Name: string;
}
/**
* 路径保留参数配置
*/
export interface RuleQueryString {
/**
* 路径保留参数配置开关，取值有：
on：开启，CacheKey由QueryString组成
off：关闭，CacheKey不由QueryString组成
注意：此字段可能返回 null，表示取不到有效值。
*/
Switch: string;
/**
* includeCustom 包含部分url参数
注意：此字段可能返回 null，表示取不到有效值。
*/
Action: string;
/**
* 使用/排除的url参数数组，';' 分割
注意：此字段可能返回 null，表示取不到有效值。
*/
Value: string;
}
/**
* 精准访问控制匹配规则
*/
export interface AdvancedScdnAclRule {
/**
* 匹配关键字，可取值有：
<li>protocol：HTTP协议</li>
<li>httpVersion：HTTP版本</li>
<li>method：请求方法</li>
<li>ip：请求源IP</li>
<li>ipAsn：请求源IP自治域号</li>
<li>ipCountry：请求源IP所在国家</li>
<li>ipArea：请求源IP所在大区</li>
<li>xForwardFor：请求头X-Forwarded-For</li>
<li>directory：路径</li>
<li>index：首页</li>
<li>path：文件全路径</li>
<li>file：文件扩展名</li>
<li>param：请求参数</li>
<li>referer：请求头Referer</li>
<li>cookie：请求头Cookie</li>
<li>userAgent：请求头User-Agent</li>
<li>head：自定义请求头</li>
*/
MatchKey: string;
/**
* 逻辑操作符，取值如下：
不包含：exclude
包含：include
不等于：notequal
等于：equal
前缀匹配：matching
内容为空或不存在：null
*/
LogicOperator: string;
/**
* 匹配值。
当MatchKey为protocol时
取值：HTTP、HTTPS
当MatchKey为httpVersion时
取值：HTTP/1.0、HTTP/1.1、HTTP/1.2、HTTP/2、HTTP/3
当MatchKey为method时
取值：HEAD、GET、POST、PUT、OPTIONS、TRACE、DELETE、PATCH、CONNECT
当MatchKey为ipCountry时，取值为：
其他：OTHER
委内瑞拉：VE
乌拉圭：UY
苏里南：SR
巴拉圭：PY
秘鲁：PE
圭亚那：GY
厄瓜多尔：EC
哥伦比亚：CO
智利：CL
巴西：BR
玻利维亚：BO
阿根廷：AR
新西兰：NZ
萨摩亚：WS
瓦努阿图：VU
图瓦卢：TV
汤加：TO
托克劳：TK
帕劳：PW
纽埃：NU
瑙鲁：NR
基里巴斯：KI
关岛：GU
密克罗尼西亚：FM
澳大利亚：AU
美国：US
波多黎各：PR
多米尼加共和国：DO
哥斯达黎加：CR
东萨摩亚：AS
安提瓜和巴布达：AG
巴拿马：PA
尼加拉瓜：NI
墨西哥：MX
牙买加：JM
海地：HT
洪都拉斯：HN
危地马拉：GT
瓜德罗普岛：GP
格陵兰：GL
格林纳达：GD
古巴：CU
加拿大：CA
伯利兹：BZ
巴哈马：BS
百慕大：BM
巴巴多斯：BB
阿鲁巴：AW
安圭拉：AI
梵蒂冈：VA
斯洛伐克：SK
英国：GB
捷克共和国：CZ
乌克兰：UA
土耳其：TR
斯洛文尼亚：SI
瑞典：SE
塞尔维亚：RS
罗马尼亚：RO
葡萄牙：PT
波兰：PL
挪威：NO
荷兰：NL
马耳他：MT
马其顿：MK
黑山：ME
摩尔多瓦：MD
摩纳哥：MC
拉脱维亚：LV
卢森堡：LU
立陶宛：LT
列支敦士登：LI
哈萨克斯坦：KZ
意大利：IT
冰岛：IS
爱尔兰：IE
匈牙利：HU
克罗地亚：HR
希腊：GR
直布罗陀：GI
根西岛：GG
格鲁吉亚：GE
法国：FR
芬兰：FI
西班牙：ES
爱沙尼亚：EE
丹麦：DK
德国：DE
塞浦路斯：CY
瑞士：CH
白俄罗斯：BY
保加利亚：BG
比利时：BE
阿塞拜疆：AZ
奥地利：AT
亚美尼亚：AM
阿尔巴尼亚：AL
安道尔：AD
东帝汶：TL
叙利亚：SY
沙特阿拉伯：SA
巴勒斯坦：PS
斯里兰卡：LK
斯里兰卡：LK
朝鲜：KP
吉尔吉斯斯坦：KG
中国香港：HK
文莱：BN
孟加拉：BD
阿联酋：AE
也门：YE
越南：VN
乌兹别克斯坦：UZ
中国台湾：TW
土库曼斯坦：TM
塔吉克斯坦：TJ
泰国：TH
新加坡：SG
卡塔尔：QA
巴基斯坦：PK
菲律宾：PH
阿曼：OM
尼泊尔：NP
马来西亚：MY
马尔代夫：MV
中国澳门：MO
蒙古：MN
缅甸：MM
黎巴嫩：LB
科威特：KW
韩国：KR
柬埔寨：KH
日本：JP
约旦：JO
伊朗：IR
伊拉克：IQ
印度：IN
以色列：IL
印度尼西亚：ID
中国：CN
不丹：BT
巴林：BH
阿富汗：AF
利比亚：LY
刚果金：CG
留尼汪岛：RE
斯威士兰：SZ
津巴布韦：ZW
赞比亚：ZM
马约特：YT
乌干达：UG
坦桑尼亚：TZ
突尼斯：TN
多哥：TG
乍得：TD
索马里：SO
塞内加尔：SN
苏丹：SD
塞舌尔：SC
卢旺达：RW
尼日利亚：NG
尼日尔：NE
纳米比亚：NA
莫桑比克：MZ
马拉维：MW
毛里求斯：MU
毛里塔尼亚：MR
马里：ML
马达加斯加：MG
摩洛哥：MA
莱索托：LS
利比里亚：LR
科摩罗：KM
肯尼亚：KE
几内亚：GN
冈比亚：GM
加纳：GH
加蓬：GA
埃塞俄比亚：ET
厄立特里亚：ER
埃及：EG
阿尔及利亚：DZ
吉布提：DJ
喀麦隆：CM
刚果：CG
博茨瓦纳：BW
贝宁：BJ
布隆迪：BI
安哥拉：AO
当MatchKey为ipArea时，取值为：
其他：OTHER
亚洲：AS
欧洲：EU
南极洲：AN
非洲：AF
大洋洲：OC
北美洲：NA
南美洲：SA
当MatchKey为index时
取值为：/;/index.html
*/
MatchValue: Array<string>;
/**
* 是否区分大小写 true：区分 false：不区分
*/
CaseSensitive?: boolean;
/**
* 当MatchKey为param时必填：表示请求参数Key 当MatchKey为cookie时必填：表示请求头Cookie中参数的
*/
MatchKeyParam?: string;
}
/**
* DescribeEdgePackTaskStatus请求参数结构体
*/
export interface DescribeEdgePackTaskStatusRequest {
/**
* 开始时间
*/
StartTime: string;
/**
* 结束时间
*/
EndTime: string;
/**
* 分页查询限制数目，默认为 100，最大可设置为 1000
*/
Limit?: number;
/**
* 分页查询偏移量，默认为 0
*/
Offset?: number;
/**
* 查询条件过滤器
*/
Filters?: Array<EdgePackTaskFilter>;
}
/**
* GetDisableRecords请求参数结构体
*/
export interface GetDisableRecordsRequest {
/**
* 指定 URL 查询
*/
Url?: string;
/**
* 开始时间，如：2018-12-12 10:24:00。
*/
StartTime?: string;
/**
* 结束时间，如：2018-12-14 10:24:00。
*/
EndTime?: string;
/**
* URL 当前状态
disable：当前仍为禁用状态，访问返回 403
enable：当前为可用状态，已解禁，可正常访问
*/
Status?: string;
/**
* 分页查询偏移量，默认为 0
*/
Offset?: number;
/**
* 分页查询限制数目，默认为20。
*/
Limit?: number;
/**
* 任务ID，任务ID和起始时间需要至少填写一项。
*/
TaskId?: string;
}
/**
* PurgeUrlsCache返回参数结构体
*/
export interface PurgeUrlsCacheResponse {
/**
* 刷新任务 ID，同一批次提交的 URL 共用一个任务 ID
*/
TaskId?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeImageConfig请求参数结构体
*/
export interface DescribeImageConfigRequest {
/**
* 域名
*/
Domain: string;
}
/**
* SCDN攻击数据Top展示
*/
export interface ScdnTopData {
/**
* 时间
*/
Time: string;
/**
* 数值
*/
Value: number;
/**
* 运营商
*/
Isp: string;
/**
* IP地址
*/
Ip: string;
/**
* 区域
*/
District: string;
}
/**
* oss回源鉴权
*/
export interface OssPrivateAccess {
/**
* oss回源鉴权配置开关，取值有：
on：开启
off：关闭
*/
Switch: string;
/**
* 访问ID。
注意：此字段可能返回 null，表示取不到有效值。
*/
AccessKey?: string;
/**
* 密钥。
注意：此字段可能返回 null，表示取不到有效值。
*/
SecretKey?: string;
/**
* 地域
注意：此字段可能返回 null，表示取不到有效值。
*/
Region?: string;
/**
* Bucketname
注意：此字段可能返回 null，表示取不到有效值。
*/
Bucket?: string;
}
/**
* ListScdnLogTasks返回参数结构体
*/
export interface ListScdnLogTasksResponse {
/**
* 日志下载任务详情
*/
TaskList: Array<ScdnLogTaskDetail>;
/**
* 查询到的下载任务的总数
*/
TotalCount: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 访问URL重写配置
*/
export interface UrlRedirect {
/**
* 访问URL重写配置开关，取值有：
on：开启
off：关闭
*/
Switch: string;
/**
* 访问URL重写规则，当Switch为on时必填，规则数量最大为10个。
注意：此字段可能返回 null，表示取不到有效值。
*/
PathRules?: Array<UrlRedirectRule>;
}
/**
* 组成CacheKey的一部分
*/
export interface CookieKey {
/**
* 使用Cookie作为Cache的一部分配置开关，取值有：
on：开启，使用Cookie作为Cache的一部分
off：关闭，不使用Cookie作为Cache的一部分
注意：此字段可能返回 null，表示取不到有效值。
*/
Switch: string;
/**
* 使用的cookie，';' 分割
注意：此字段可能返回 null，表示取不到有效值。
*/
Value?: string;
}
/**
* 带宽封顶配置，默认为关闭状态
*/
export interface BandwidthAlert {
/**
* 用量封顶配置开关，取值有：
on：开启
off：关闭
*/
Switch: string;
/**
* 用量封顶阈值，带宽单位为bps，流量单位byte
注意：此字段可能返回 null，表示取不到有效值。
*/
BpsThreshold?: number;
/**
* 达到阈值后的操作
RETURN_404：全部请求返回 404
注意：此字段可能返回 null，表示取不到有效值。
*/
CounterMeasure?: string;
/**
* 境内区域上次触发用量封顶阈值的时间
注意：此字段可能返回 null，表示取不到有效值。
*/
LastTriggerTime?: string;
/**
* 用量封顶提醒配置开关，取值有：
on：开启
off：关闭
注意：此字段可能返回 null，表示取不到有效值。
*/
AlertSwitch?: string;
/**
* 用量封顶阈值提醒百分比
注意：此字段可能返回 null，表示取不到有效值。
*/
AlertPercentage?: number;
/**
* 海外区域上次触发用量封顶阈值的时间
注意：此字段可能返回 null，表示取不到有效值。
*/
LastTriggerTimeOverseas?: string;
/**
* 用量阈值触发的维度
带宽：bandwidth
流量：flux
注意：此字段可能返回 null，表示取不到有效值。
*/
Metric?: string;
/**
* 累计用量配置
注意：此字段可能返回 null，表示取不到有效值。
*/
StatisticItems?: Array<StatisticItem>;
}
/**
* CLS日志搜索对象
*/
export interface ClsLogObject {
/**
* 主题ID
*/
TopicId: string;
/**
* 主题名字
*/
TopicName: string;
/**
* 日志时间
*/
Timestamp: string;
/**
* 日志内容
*/
Content: string;
/**
* 采集路径
*/
Filename: string;
/**
* 日志来源设备
*/
Source: string;
}
/**
* DescribeWafData返回参数结构体
*/
export interface DescribeWafDataResponse {
/**
* 粒度数据
*/
Data: Array<TimestampData>;
/**
* 粒度
*/
Interval: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 区域映射id和子区域id的关联信息。
*/
export interface RegionMapRelation {
/**
* 区域ID。
*/
RegionId: number;
/**
* 子区域ID列表
*/
SubRegionIdList: Array<number | bigint>;
}
/**
* DescribeDiagnoseReport返回参数结构体
*/
export interface DescribeDiagnoseReportResponse {
/**
* 诊断报告基础信息
*/
BaskInfo?: DiagnoseData;
/**
* CNAME检测信息
*/
CnameInfo?: DiagnoseData;
/**
* 客户端检测信息
*/
ClientInfo?: DiagnoseData;
/**
* DNS检测信息
*/
DnsInfo?: DiagnoseData;
/**
* 网络检测信息
*/
NetworkInfo?: DiagnoseData;
/**
* 边缘节点检测信息
*/
OcNodeInfo?: DiagnoseData;
/**
* 中间源节点检测信息
*/
MidNodeInfo?: DiagnoseData;
/**
* 源站检测信息
*/
OriginInfo?: DiagnoseData;
/**
* 刷新检测信息
注意：此字段可能返回 null，表示取不到有效值。
*/
PurgeInfo?: DiagnoseData;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 缓存配置基础版本
默认情况下所有文件缓存过期时间为 30 天
默认情况下静态加速类型的域名 .php;.jsp;.asp;.aspx 不缓存
注意：该版本不支持设置源站未返回 max-age 情况下的缓存过期规则设置
*/
export interface SimpleCache {
/**
* 缓存过期时间规则
注意：此字段可能返回 null，表示取不到有效值。
*/
CacheRules: Array<SimpleCacheRule>;
/**
* 遵循源站 Cache-Control: max-age 配置
on：开启
off：关闭
开启后，未能匹配 CacheRules 规则的资源将根据源站返回的 max-age 值进行节点缓存；匹配了 CacheRules 规则的资源将按照 CacheRules 中设置的缓存过期时间在节点进行缓存
与 CompareMaxAge 冲突，不能同时开启
注意：此字段可能返回 null，表示取不到有效值。
*/
FollowOrigin: string;
/**
* 强制缓存
on：开启
off：关闭
默认为关闭状态，开启后，源站返回的 no-store、no-cache 资源，也将按照 CacheRules 规则进行缓存
注意：此字段可能返回 null，表示取不到有效值。
*/
IgnoreCacheControl: string;
/**
* 忽略源站的Set-Cookie头部
on：开启
off：关闭
默认为关闭状态
注意：此字段可能返回 null，表示取不到有效值。
*/
IgnoreSetCookie: string;
/**
* 高级缓存过期配置，开启时会对比源站返回的 max-age 值与 CacheRules 中设置的缓存过期时间，取最小值在节点进行缓存
on：开启
off：关闭
默认为关闭状态
注意：此字段可能返回 null，表示取不到有效值。
*/
CompareMaxAge: string;
/**
* 总是回源站校验
注意：此字段可能返回 null，表示取不到有效值。
*/
Revalidate?: Revalidate;
}
/**
* BOT统计结果数据详细数据
*/
export interface BotStatsDetailData {
/**
* 时间
*/
Time: string;
/**
* 数据值
*/
Value: number;
}
/**
* 查询结果排序条件
*/
export interface Sort {
/**
* 排序字段，当前支持：
createTime，域名创建时间
certExpireTime，证书过期时间
默认createTime。
*/
Key?: string;
/**
* asc/desc，默认desc。
*/
Sequence?: string;
}
/**
* DescribeEventLogData返回参数结构体
*/
export interface DescribeEventLogDataResponse {
/**
* 统计曲线结果
*/
Results: Array<EventLogStatsData>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SCDN日志事件详细信息
*/
export interface ScdnLogTaskDetail {
/**
* scdn域名
*/
Domain: string;
/**
* 防护类型
*/
Mode: string;
/**
* 查询任务开始时间
*/
StartTime: string;
/**
* 查询任务结束时间
*/
EndTime: string;
/**
* 任务创建时间
*/
CreateTime: string;
/**
* 日志包下载链接
成功返回下载链接，其他情况返回'-'
注意：此字段可能返回 null，表示取不到有效值。
*/
DownloadUrl: string;
/**
* 任务状态
created->任务已经创建
processing->任务正在执行
done->任务执行成功
failed->任务执行失败
no-log->没有日志产生
*/
Status: string;
/**
* 日志任务唯一id
*/
TaskID: string;
/**
* 攻击类型, 可以为"all"
AttackType映射如下:
other = '未知类型'
malicious_scan = "恶意扫描"
sql_inject = "SQL注入攻击"
xss = "XSS攻击"
cmd_inject = "命令注入攻击"
ldap_inject = "LDAP注入攻击"
ssi_inject = "SSI注入攻击"
xml_inject = "XML注入攻击"
web_service = "WEB服务漏洞攻击"
web_app = "WEB应用漏洞攻击"
path_traversal = "路径跨越攻击"
illegal_access_core_file = "核心文件非法访问"
file_upload = "文件上传攻击"
trojan_horse = "木马后门攻击"
csrf = "CSRF攻击"
custom_policy = "自定义策略"
ai_engine= 'AI引擎检出'
malicious_file_upload= '恶意文件上传'
*/
AttackType: string;
/**
* 防御模式,可以为"all"
DefenceMode映射如下：
observe = '观察模式'
intercept = '防御模式'
*/
DefenceMode: string;
/**
* 查询条件
注意：此字段可能返回 null，表示取不到有效值。
*/
Conditions: Array<ScdnEventLogConditions>;
/**
* mainland或overseas
注意：此字段可能返回 null，表示取不到有效值。
*/
Area: string;
}
/**
* 计费数据明细
*/
export interface ResourceBillingData {
/**
* 资源名称，根据查询条件不同分为以下几类：
某一个具体域名：表示该域名明细数据
multiDomains：表示多域名汇总明细数据
某一个项目 ID：指定项目查询时，显示为项目 ID
all：账号维度数据明细
*/
Resource: string;
/**
* 计费数据详情
*/
BillingData: Array<CdnData>;
}
/**
* SearchClsLog请求参数结构体
*/
export interface SearchClsLogRequest {
/**
* 需要查询的日志集ID
*/
LogsetId: string;
/**
* 需要查询的日志主题ID组合，以逗号分隔
*/
TopicIds: string;
/**
* 需要查询的日志的起始时间，格式 YYYY-mm-dd HH:MM:SS
*/
StartTime: string;
/**
* 需要查询的日志的结束时间，格式 YYYY-mm-dd HH:MM:SS
*/
EndTime: string;
/**
* 单次要返回的日志条数，单次返回的最大条数为100
*/
Limit: number;
/**
* 接入渠道，cdn或者ecdn，默认值为cdn
*/
Channel?: string;
/**
* 需要查询的内容，详情请参考https://cloud.tencent.com/document/product/614/16982
*/
Query?: string;
/**
* 加载更多使用，透传上次返回的 context 值，获取后续的日志内容，通过游标最多可获取10000条，请尽可能缩小时间范围
*/
Context?: string;
/**
* 按日志时间排序， asc（升序）或者 desc（降序），默认为 desc
*/
Sort?: string;
}
/**
* UpdateDomainConfig请求参数结构体
*/
export interface UpdateDomainConfigRequest {
/**
* 域名
*/
Domain: string;
/**
* 项目 ID
*/
ProjectId?: number;
/**
* 源站配置
*/
Origin?: Origin;
/**
* IP 黑白名单配置
*/
IpFilter?: IpFilter;
/**
* IP 限频配置
*/
IpFreqLimit?: IpFreqLimit;
/**
* 状态码缓存配置
*/
StatusCodeCache?: StatusCodeCache;
/**
* 智能压缩配置
*/
Compression?: Compression;
/**
* 带宽封顶配置
*/
BandwidthAlert?: BandwidthAlert;
/**
* Range 回源配置
*/
RangeOriginPull?: RangeOriginPull;
/**
* 301/302 回源跟随配置
*/
FollowRedirect?: FollowRedirect;
/**
* 错误码重定向配置（功能灰度中，尚未全量）
*/
ErrorPage?: ErrorPage;
/**
* 回源请求头部配置
*/
RequestHeader?: RequestHeader;
/**
* 响应头部配置
*/
ResponseHeader?: ResponseHeader;
/**
* 下载速度配置
*/
DownstreamCapping?: DownstreamCapping;
/**
* 节点缓存键配置
*/
CacheKey?: CacheKey;
/**
* 头部缓存配置
*/
ResponseHeaderCache?: ResponseHeaderCache;
/**
* 视频拖拽配置
*/
VideoSeek?: VideoSeek;
/**
* 缓存过期时间配置
*/
Cache?: Cache;
/**
* 跨国链路优化配置（已下线）
*/
OriginPullOptimization?: OriginPullOptimization;
/**
* Https 加速配置
*/
Https?: Https;
/**
* 时间戳防盗链配置
*/
Authentication?: Authentication;
/**
* SEO 优化配置
*/
Seo?: Seo;
/**
* 访问协议强制跳转配置
*/
ForceRedirect?: ForceRedirect;
/**
* Referer 防盗链配置
*/
Referer?: Referer;
/**
* 浏览器缓存配置（功能灰度中，尚未全量）
*/
MaxAge?: MaxAge;
/**
* 地域属性特殊配置
适用于域名境内加速、境外加速配置不一致场景
*/
SpecificConfig?: SpecificConfig;
/**
* 域名业务类型
web：静态加速
download：下载加速
media：流媒体点播加速
*/
ServiceType?: string;
/**
* 域名加速区域
mainland：中国境内加速
overseas：中国境外加速
global：全球加速
从mainland/overseas修改至global时，域名的配置将被同步至overseas/mainland。若域名含有后端特殊配置，此类配置的同步过程有一定延时，请耐心等待
*/
Area?: string;
/**
* 回源超时配置
*/
OriginPullTimeout?: OriginPullTimeout;
/**
* 回源S3私有鉴权
*/
AwsPrivateAccess?: AwsPrivateAccess;
/**
* UA黑白名单配置
*/
UserAgentFilter?: UserAgentFilter;
/**
* 访问控制
*/
AccessControl?: AccessControl;
/**
* 访问URL重写配置
*/
UrlRedirect?: UrlRedirect;
/**
* 访问端口配置
*/
AccessPort?: Array<number | bigint>;
/**
* 时间戳防盗链高级版配置，白名单功能
*/
AdvancedAuthentication?: AdvancedAuthentication;
/**
* 回源鉴权高级版配置，白名单功能
*/
OriginAuthentication?: OriginAuthentication;
/**
* Ipv6 访问配置
*/
Ipv6Access?: Ipv6Access;
/**
* 离线缓存
*/
OfflineCache?: OfflineCache;
/**
* 合并回源
*/
OriginCombine?: OriginCombine;
/**
* POST请求传输配置
*/
PostMaxSize?: PostSize;
/**
* Quic访问（收费服务，详见计费说明和产品文档）
*/
Quic?: Quic;
/**
* 回源OSS私有鉴权
*/
OssPrivateAccess?: OssPrivateAccess;
/**
* WebSocket配置
*/
WebSocket?: WebSocket;
/**
* 远程鉴权配置
*/
RemoteAuthentication?: RemoteAuthentication;
/**
* 共享CNAME配置，白名单功能
*/
ShareCname?: ShareCname;
/**
* 华为云对象存储回源鉴权
*/
HwPrivateAccess?: HwPrivateAccess;
/**
* 七牛云对象存储回源鉴权
*/
QnPrivateAccess?: QnPrivateAccess;
/**
* 其他厂商对象存储回源鉴权
*/
OthersPrivateAccess?: OthersPrivateAccess;
/**
* HTTPS服务（收费服务，详见计费说明和产品文档）
*/
HttpsBilling?: HttpsBilling;
}
/**
* SCDN精准访问控制配置
*/
export interface AdvancedScdnAclGroup {
/**
* 规则名称
*/
RuleName: string;
/**
* 具体配置
*/
Configure: Array<AdvancedScdnAclRule>;
/**
* 执行动作，intercept|redirect
*/
Result: string;
/**
* 规则是否生效，active|inactive
*/
Status?: string;
/**
* 错误页面配置
*/
ErrorPage?: ScdnErrorPage;
}
/**
* SCDN精准访问控制配置
*/
export interface ScdnAclGroup {
/**
* 规则名称
*/
RuleName: string;
/**
* 具体配置
*/
Configure: Array<ScdnAclRule>;
/**
* 执行动作，intercept|redirect
*/
Result: string;
/**
* 规则是否生效，active|inactive
*/
Status?: string;
/**
* 错误页面配置
注意：此字段可能返回 null，表示取不到有效值。
*/
ErrorPage?: ScdnErrorPage;
}
/**
* Waf子规则开关状态
*/
export interface WafSubRuleStatus {
/**
* Waf子规则开关状态配置开关，取值有：
on：开启
off：关闭
*/
Switch: string;
/**
* 规则id列表
*/
SubIds: Array<number | bigint>;
}
/**
* SCDN访问控制
*/
export interface ScdnAclConfig {
/**
* SCDN访问控制配置开关，取值有：
on：开启
off：关闭
*/
Switch: string;
/**
* 新版本请使用AdvancedScriptData
注意：此字段可能返回 null，表示取不到有效值。
*/
ScriptData?: Array<ScdnAclGroup>;
/**
* 错误页面配置
注意：此字段可能返回 null，表示取不到有效值。
*/
ErrorPage?: ScdnErrorPage;
/**
* Acl规则组，switch为on时必填
注意：此字段可能返回 null，表示取不到有效值。
*/
AdvancedScriptData?: Array<AdvancedScdnAclGroup>;
}
/**
* 回源鉴权高级配置
*/
export interface OriginAuthentication {
/**
* 回源鉴权高级配置开关，取值有：
on：开启
off：关闭
注意：此字段可能返回 null，表示取不到有效值。
*/
Switch: string;
/**
* 鉴权类型A配置
注意：此字段可能返回 null，表示取不到有效值。
*/
TypeA?: OriginAuthenticationTypeA;
}
/**
* 刷新任务详情
*/
export interface PurgeTask {
/**
* 刷新任务 ID
*/
TaskId: string;
/**
* 刷新 URL
*/
Url: string;
/**
* 刷新任务状态
fail：刷新失败
done：刷新成功
process：刷新中
*/
Status: string;
/**
* 刷新类型
url：URL 刷新
path：目录刷新
*/
PurgeType: string;
/**
* 刷新方式
flush：刷新更新资源（仅目录刷新时有此类型）
delete：刷新全部资源
*/
FlushType: string;
/**
* 刷新任务提交时间
*/
CreateTime: string;
}
/**
* 作为CacheKey的一部分
*/
export interface SchemeKey {
/**
* scheme作为cache key配置开关，取值有：
on：开启
off：关闭
注意：此字段可能返回 null，表示取不到有效值。
*/
Switch: string;
}
/**
* DescribeCcData请求参数结构体
*/
export interface DescribeCcDataRequest {
/**
* 查询起始时间，如：2018-09-04 10:40:00，返回结果大于等于指定时间
*/
StartTime: string;
/**
* 查询结束时间，如：2018-09-04 10:40:00，返回结果小于等于指定时间
*/
EndTime: string;
/**
* 时间粒度，支持以下几种模式：
min：1 分钟粒度，指定查询区间 24 小时内（含 24 小时），可返回 1 分钟粒度明细数据
5min：5 分钟粒度，指定查询区间 31 天内（含 31 天），可返回 5 分钟粒度明细数据
hour：1 小时粒度，指定查询区间 31 天内（含 31 天），可返回 1 小时粒度明细数据
day：天粒度，指定查询区间大于 31 天，可返回天粒度明细数据
*/
Interval?: string;
/**
* 指定域名查询，为空时，表示查询账号级别数据
*/
Domain?: string;
/**
* 执行动作，取值为：intercept/redirect/observe
分别表示：拦截/重定向/观察
为空时，表示所有执行动作
*/
ActionName?: string;
/**
* 指定域名列表查询，为空时，表示查询账号级别数据
*/
Domains?: Array<string>;
/**
* cdn表示CDN数据，默认值
ecdn表示ECDN数据
*/
Source?: string;
/**
* 地域：mainland或overseas，表示国内或海外，不填写默认表示国内
*/
Area?: string;
}
/**
* 组成CacheKey的一部分
*/
export interface CacheTagKey {
/**
* 使用CacheTag作为CacheKey的一部分配置开关，取值有
on：开启，使用CacheTag作为CacheKey的一部分
off：关闭，不使用CacheTag作为CacheKey的一部分
注意：此字段可能返回 null，表示取不到有效值。
*/
Switch: string;
/**
* 自定义CacheTag的值
注意：此字段可能返回 null，表示取不到有效值。
*/
Value?: string;
}
/**
* Scdn饼图数据，waf仅有
*/
export interface ScdnTypeData {
/**
* 攻击类型
*/
AttackType: string;
/**
* 攻击值
*/
Value: number;
}
/**
* DescribeDomains请求参数结构体
*/
export interface DescribeDomainsRequest {
/**
* 分页查询偏移量，默认为 0
*/
Offset?: number;
/**
* 分页查询限制数目，默认为 100，最大可设置为 1000
*/
Limit?: number;
/**
* 查询条件过滤器，复杂类型
*/
Filters?: Array<DomainFilter>;
}
/**
* 查询对象及其对应的访问明细数据
*/
export interface ResourceData {
/**
* 资源名称，根据查询条件不同分为以下几类：
单域名：指定单域名查询，表示该域名明细数据，当传入参数 detail 指定为 true 时，显示该域名（ detail 参数默认为 false ）
多域名：指定多个域名查询，表示多域名汇总明细数据，显示 multiDomains
项目 ID：指定项目查询时，表示该项目下的域名汇总明细数据，显示该项目 ID
all：账号维度明细数据，即账号下所有域名的汇总明细数据
*/
Resource: string;
/**
* 资源对应的数据明细
*/
CdnData: Array<CdnData>;
}
/**
* Scdn的七层限频配置
*/
export interface ScdnSevenLayerRules {
/**
* 区分大小写
*/
CaseSensitive: boolean;
/**
* 规则类型：
protocol：协议，填写 HTTP/HTTPS
method：请求方法，支持 HEAD、GET、POST、PUT、OPTIONS、TRACE、DELETE、PATCH、CONNECT
all：域名 匹配内容固定为"*",不可编辑修改
ip：IP 填写 CIDR 表达式
directory：路径，以/开头，支持目录和具体路径，128字符以内
index：首页 默认固定值：/;/index.html,不可编辑修改
path：文件全路径，资源地址，如/acb/test.png，支持通配符，如/abc/*.jpg
file：文件扩展名，填写具体扩展名，如 jpg;png;css
param：请求参数，填写具体 value 值，512字符以内
referer：Referer，填写具体 value 值，512字符以内
cookie：Cookie，填写具体 value 值，512字符以内
user-agent：User-Agent，填写具体 value 值，512字符以内
head：自定义请求头，填写具体value值，512字符以内；内容为空或者不存在时，无匹配内容输入框，填写匹配参数即可
*/
RuleType: string;
/**
* 逻辑操作符，取值 ：
不包含：exclude,
包含：include,
不等于：notequal,
等于：equal,
前缀匹配：matching
内容为空或不存在：null
*/
LogicOperator: string;
/**
* 规则值
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleValue?: Array<string>;
/**
* 匹配参数，只有请求参数、Cookie、自定义请求头 有值
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleParam?: string;
}
/**
* 域名 https 加速配置，默认为关闭状态
*/
export interface Https {
/**
* https 配置开关，取值有：
on：开启
off：关闭
注意：此字段可能返回 null，表示取不到有效值。
*/
Switch: string;
/**
* http2 配置开关
on：开启
off：关闭
注意：此字段可能返回 null，表示取不到有效值。
*/
Http2?: string;
/**
* OCSP 配置开关
on：开启
off：关闭
默认为关闭状态
注意：此字段可能返回 null，表示取不到有效值。
*/
OcspStapling?: string;
/**
* 客户端证书校验功能
on：开启
off：关闭
默认为关闭状态，开启时需要上传客户端证书信息，该配置项目前在灰度中，尚未全量
注意：此字段可能返回 null，表示取不到有效值。
*/
VerifyClient?: string;
/**
* 服务端证书配置信息
注意：此字段可能返回 null，表示取不到有效值。
*/
CertInfo?: ServerCert;
/**
* 客户端证书配置信息
注意：此字段可能返回 null，表示取不到有效值。
*/
ClientCertInfo?: ClientCert;
/**
* Spdy 配置开关
on：开启
off：关闭
默认为关闭状态
注意：此字段可能返回 null，表示取不到有效值。
*/
Spdy?: string;
/**
* https 证书部署状态
closed：已关闭
deploying：部署中
deployed：部署成功
failed：部署失败
注意：此字段可能返回 null，表示取不到有效值。
*/
SslStatus?: string;
/**
* Hsts配置
注意：此字段可能返回 null，表示取不到有效值。
*/
Hsts?: Hsts;
/**
* Tls版本设置，仅支持部分Advance域名，支持设置 TLSv1, TLSv1.1, TLSv1.2, TLSv1.3，修改时必须开启连续的版本
注意：此字段可能返回 null，表示取不到有效值。
*/
TlsVersion?: Array<string>;
}
/**
* SCDN 事件日志查询条件
*/
export interface ScdnEventLogConditions {
/**
* 匹配关键字，ip, attack_location
*/
Key: string;
/**
* 逻辑操作符，取值 exclude, include
*/
Operator: string;
/**
* 匹配值，允许使用通配符(*)查询，匹配零个、单个、多个字符，例如 1.2.*
*/
Value: string;
}
/**
* 回源 301/302 状态码自动跟随配置，默认为关闭状态
*/
export interface FollowRedirect {
/**
* 回源跟随配置开关，取值有：
on：开启
off：关闭
*/
Switch: string;
/**
* 自定义回源302 follow请求host配置，该功能为白名单功能，需要开启请联系腾讯云工程师。
注意：此字段可能返回 null，表示取不到有效值。
*/
RedirectConfig?: RedirectConfig;
}
/**
* DescribeScdnBotData返回参数结构体
*/
export interface DescribeScdnBotDataResponse {
/**
* 统计信息详细数据
*/
Data: Array<BotStats>;
/**
* 当前返回数据的粒度，取值："2min"或者"hour"，分别表示2分钟或者1小时粒度
*/
Interval: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* StartScdnDomain请求参数结构体
*/
export interface StartScdnDomainRequest {
/**
* 域名
*/
Domain: string;
}
/**
* ListTopWafData请求参数结构体
*/
export interface ListTopWafDataRequest {
/**
* 查询起始时间，如：2018-09-04 10:40:00，返回结果大于等于指定时间
*/
StartTime: string;
/**
* 查询结束时间，如：2018-09-04 10:40:00，返回结果小于等于指定时间
*/
EndTime: string;
/**
* 指定域名查询，不填写查询整个AppID下数据
*/
Domain?: string;
/**
* 指定攻击类型
不填则查询所有攻击类型的数据总和
AttackType 映射如下:
"webshell" : Webshell检测防护
"oa" : 常见OA漏洞防护
"xss" : XSS跨站脚本攻击防护
"xxe" : XXE攻击防护
"webscan" : 扫描器攻击漏洞防护
"cms" : 常见CMS漏洞防护
"upload" : 恶意文件上传攻击防护
"sql" : SQL注入攻击防护
"cmd_inject": 命令/代码注入攻击防护
"osc" : 开源组件漏洞防护
"file_read" : 任意文件读取
"ldap" : LDAP注入攻击防护
"other" : 其它漏洞防护
*/
AttackType?: string;
/**
* 指定防御模式
不填则查询所有防御模式的数据总和
DefenceMode 映射如下：
observe = '观察模式'
intercept = '拦截模式'
*/
DefenceMode?: string;
/**
* 排序对象，支持以下几种形式：
url：攻击目标 url 排序
ip：攻击源 IP 排序
attackType：攻击类型排序
domain：当查询整个AppID下数据时，按照域名请求量排序
*/
Metric?: string;
/**
* 地域：mainland 或 overseas
*/
Area?: string;
/**
* 指定攻击类型列表，取值参考AttackType
*/
AttackTypes?: Array<string>;
/**
* 指定域名列表查询，不填写查询整个AppID下数据
*/
Domains?: Array<string>;
}
/**
* DescribeCdnData返回参数结构体
*/
export interface DescribeCdnDataResponse {
/**
* 返回数据的时间粒度，查询时指定：
min：1 分钟粒度
5min：5 分钟粒度
hour：1 小时粒度
day：天粒度
*/
Interval: string;
/**
* 指定条件查询得到的数据明细
*/
Data: Array<ResourceData>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpdateImageConfig返回参数结构体
*/
export interface UpdateImageConfigResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeOriginData请求参数结构体
*/
export interface DescribeOriginDataRequest {
/**
* 查询起始时间，如：2018-09-04 10:40:00，返回结果大于等于指定时间
根据指定时间粒度不同，会进行向前归整，如 2018-09-04 10:40:00 在按 1 小时的时间粒度查询时，返回的第一个数据对应时间点为 2018-09-04 10:00:00
起始时间与结束时间间隔小于等于 90 天
*/
StartTime: string;
/**
* 查询结束时间，如：2018-09-04 10:40:00，返回结果小于等于指定时间
根据指定时间粒度不同，会进行向前归整，如 2018-09-04 10:40:00 在按 1 小时的时间粒度查询时，返回的最后一个数据对应时间点为 2018-09-04 10:00:00
起始时间与结束时间间隔小于等于 90 天
*/
EndTime: string;
/**
* 指定查询指标，支持的类型有：
flux：回源流量，单位为 byte
bandwidth：回源带宽，单位为 bps
request：回源请求数，单位为 次
failRequest：回源失败请求数，单位为 次
failRate：回源失败率，单位为 %
statusCode：回源状态码，返回 2xx、3xx、4xx、5xx 汇总数据，单位为 个
2xx：返回 2xx 回源状态码汇总及各 2 开头回源状态码数据，单位为 个
3xx：返回 3xx 回源状态码汇总及各 3 开头回源状态码数据，单位为 个
4xx：返回 4xx 回源状态码汇总及各 4 开头回源状态码数据，单位为 个
5xx：返回 5xx 回源状态码汇总及各 5 开头回源状态码数据，单位为 个
支持指定具体状态码查询，若未产生过，则返回为空
*/
Metric: string;
/**
* 指定查询域名列表，最多可一次性查询 30 个加速域名明细
*/
Domains?: Array<string>;
/**
* 指定要查询的项目 ID，[前往查看项目 ID](https://console.cloud.tencent.com/project)
未填充域名情况下，指定项目查询，最多可一次性查询 30 个加速域名明细
若填充了具体域名信息，以域名为主
*/
Project?: number;
/**
* 时间粒度，支持以下几种模式：
min：1 分钟粒度，指定查询区间 24 小时内（含 24 小时），可返回 1 分钟粒度明细数据（指定查询服务地域为中国境外时不支持 1 分钟粒度）
5min：5 分钟粒度，指定查询区间 31 天内（含 31 天），可返回 5 分钟粒度明细数据
hour：1 小时粒度，指定查询区间 31 天内（含 31 天），可返回 1 小时粒度明细数据
day：天粒度，指定查询区间大于 31 天，可返回天粒度明细数据
*/
Interval?: string;
/**
* Domains 传入多个时，默认（false)返回多个域名的汇总数据
可按需指定为 true，返回每一个 Domain 的明细数据（statusCode 指标暂不支持）
*/
Detail?: boolean;
/**
* 指定服务地域查询，不填充表示查询中国境内 CDN 数据
mainland：指定查询中国境内 CDN 数据
overseas：指定查询中国境外 CDN 数据
*/
Area?: string;
/**
* 指定查询时间的时区，默认UTC+08:00
*/
TimeZone?: string;
}
/**
* IP策略查询过滤参数
*/
export interface ScdnIpStrategyFilter {
/**
* 过滤字段名，支持domain, ip
*/
Name: string;
/**
* 过滤字段值
*/
Value: Array<string>;
/**
* 是否启用模糊查询，仅支持过滤字段名为domain。
模糊查询时，Value长度最大为1
*/
Fuzzy?: boolean;
}
/**
* CreateScdnDomain请求参数结构体
*/
export interface CreateScdnDomainRequest {
/**
* 域名
*/
Domain: string;
/**
* Web 攻击防护（WAF）配置
*/
Waf?: ScdnWafConfig;
/**
* 自定义防护策略配置
*/
Acl?: ScdnAclConfig;
/**
* CC 防护配置，目前 CC 防护默认开启
*/
CC?: ScdnConfig;
/**
* DDOS 防护配置，目前 DDoS 防护默认开启
*/
Ddos?: ScdnDdosConfig;
/**
* BOT 防护配置
*/
Bot?: ScdnBotConfig;
}
/**
* 排序类型的数据结构
*/
export interface TopDetailData {
/**
* 数据类型的名称
*/
Name: string;
/**
* 数据值
*/
Value: number;
}
/**
* DescribeDistrictIspData返回参数结构体
*/
export interface DescribeDistrictIspDataResponse {
/**
* 地区运营商数据明细
注意：此字段可能返回 null，表示取不到有效值。
*/
Data?: Array<DistrictIspInfo>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 规则引擎配置
*/
export interface RuleEngine {
/**
* 规则引擎配置开关，取值有：
on：开启
off：关闭
*/
Switch: string;
/**
* 规则
注意：此字段可能返回 null，表示取不到有效值。
*/
Content?: string;
}
/**
* DescribeDomainsConfig返回参数结构体
*/
export interface DescribeDomainsConfigResponse {
/**
* 域名列表
*/
Domains: Array<DetailDomain>;
/**
* 符合查询条件的域名总数
用于分页查询
*/
TotalNumber: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* HTTPS服务，若关闭，下发配置拦截https请求，开启时会产生计费
*/
export interface HttpsBilling {
/**
* HTTPS服务配置开关，取值有：
on：开启，缺省时默认开启，会产生计费
off：关闭，拦截https请求
*/
Switch: string;
}
/**
* DescribeCdnIp请求参数结构体
*/
export interface DescribeCdnIpRequest {
/**
* 需要查询的 IP 列表
*/
Ips: Array<string>;
}
/**
* DescribeIpVisit返回参数结构体
*/
export interface DescribeIpVisitResponse {
/**
* 数据统计的时间粒度，支持5min, day，分别表示5分钟，1天的时间粒度。
*/
Interval: string;
/**
* 各个资源的回源数据详情。
*/
Data: Array<ResourceData>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UserAgent黑白名单规则配置
*/
export interface UserAgentFilterRule {
/**
* 访问路径生效类型
all: 所有访问路径生效
file: 根据文件后缀类型生效
directory: 根据目录生效
path: 根据完整访问路径生效
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleType: string;
/**
* 访问路径生效内容
注意：此字段可能返回 null，表示取不到有效值。
*/
RulePaths: Array<string>;
/**
* UserAgent列表
注意：此字段可能返回 null，表示取不到有效值。
*/
UserAgents: Array<string>;
/**
* 黑名单或白名单，blacklist或whitelist
注意：此字段可能返回 null，表示取不到有效值。
*/
FilterType: string;
}
/**
* 状态码重定向配置，默认为关闭状态
*/
export interface ErrorPage {
/**
* 状态码重定向配置开关，取值有：
on：开启
off：关闭
注意：此字段可能返回 null，表示取不到有效值。
*/
Switch: string;
/**
* 状态码重定向规则配置
注意：此字段可能返回 null，表示取不到有效值。
*/
PageRules?: Array<ErrorPageRule>;
}
/**
* MagAge 规则配置
*/
export interface MaxAgeRule {
/**
* 规则类型：
all：所有文件生效
file：指定文件后缀生效
directory：指定路径生效
path：指定绝对路径生效
index: 指定主页生效
*/
MaxAgeType: string;
/**
* MaxAgeType 对应类型下的匹配内容：
all 时填充 *
file 时填充后缀名，如 jpg、txt
directory 时填充路径，如 /xxx/test/
path 时填充绝对路径，如 /xxx/test.html
index 时填充 /
注意：all规则不可删除，默认遵循源站，可修改。
*/
MaxAgeContents: Array<string>;
/**
* MaxAge 时间设置，单位秒
注意：时间为0，即不缓存。
*/
MaxAgeTime: number;
/**
* 是否遵循源站，on或off，开启时忽略时间设置。
注意：此字段可能返回 null，表示取不到有效值。
*/
FollowOrigin?: string;
}
/**
* DescribeCertDomains请求参数结构体
*/
export interface DescribeCertDomainsRequest {
/**
* PEM格式证书Base64编码后的字符串
*/
Cert?: string;
/**
* 托管证书ID，Cert和CertId不能均未空，都填写时以CerId为准。
*/
CertId?: string;
/**
* 域名所属产品，cdn或ecdn，默认cdn。
*/
Product?: string;
}
/**
* DescribeDomainsConfig请求参数结构体
*/
export interface DescribeDomainsConfigRequest {
/**
* 分页查询偏移量，默认为 0
*/
Offset?: number;
/**
* 分页查询限制数目，默认为 100，最大可设置为 1000
*/
Limit?: number;
/**
* 查询条件过滤器，复杂类型
*/
Filters?: Array<DomainFilter>;
/**
* 排序规则
*/
Sort?: Sort;
}
/**
* ListTopDDoSData返回参数结构体
*/
export interface ListTopDDoSDataResponse {
/**
* DDoS 攻击类型的top数据，当Metric=AttackType的时候返回攻击类型的统计数据，IPData为空
*/
Data: Array<DDoSTopData>;
/**
* ddos攻击ip的top数据，Metric=AttackIP的时候返回IPData，Data为空
*/
IPData: Array<DDoSAttackIPTopData>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 图片优化-WebpAdapter配置
*/
export interface WebpAdapter {
/**
* 图片优化-WebpAdapter配置开关，取值有：
on：开启
off：关闭
注意：此字段可能返回 null，表示取不到有效值。
*/
Switch?: string;
}
/**
* WebSocket配置
WebSocket 为ECDN产品功能，如需使用请通过ECDN域名配置.
*/
export interface WebSocket {
/**
* WebSocket 超时配置开关，取值有：
on：开启，可以调整超时时间
off：关闭，平台仍支持WebSocket连接，此时超时时间默认为15秒
*/
Switch: string;
/**
* 设置超时时间，单位为秒，最大超时时间300秒。
注意：此字段可能返回 null，表示取不到有效值。
*/
Timeout?: number;
}
/**
* 时间戳防盗链模式 D 配置
时间戳防盗链模式 D 的访问 URL 格式为：http://DomainName/FileName?sign=md5hash&t=timestamp
其中 timestamp 为十进制或十六进制 UNIX 时间戳；
md5hash：MD5（自定义密钥 + 文件路径 + timestamp）
*/
export interface AuthenticationTypeD {
/**
* 计算签名的密钥
仅允许大小写字母与数字，长度 6~32 位
注意：此字段可能返回 null，表示取不到有效值。
*/
SecretKey: string;
/**
* 签名过期时间设置
单位为秒，最大可设置为 630720000
*/
ExpireTime: number;
/**
* 鉴权/不做鉴权的文件扩展名列表设置
如果包含字符 * 则表示所有文件
*/
FileExtensions: Array<string>;
/**
* whitelist：白名单，表示对除了 FileExtensions 列表之外的所有类型进行鉴权
blacklist：黑名单，表示仅对 FileExtensions 中的类型进行鉴权
*/
FilterType: string;
/**
* 签名参数名设置
仅允许大小写字母、数字或下划线，长度 1~100 位，不能以数字开头
*/
SignParam: string;
/**
* 时间戳参数名设置
仅允许大小写字母、数字或下划线，长度 1~100 位，不能以数字开头
*/
TimeParam: string;
/**
* 时间戳进制设置
dec：十进制
hex：十六进制
*/
TimeFormat: string;
/**
* 计算签名的备用密钥
仅允许大小写字母与数字，长度 6~32 位
注意：此字段可能返回 null，表示取不到有效值。
*/
BackupSecretKey?: string;
}
/**
* DuplicateDomainConfig请求参数结构体
*/
export interface DuplicateDomainConfigRequest {
/**
* 新增域名
*/
Domain: string;
/**
* 被拷贝配置的域名
*/
ReferenceDomain: string;
}
/**
* 时间戳防盗链模式 B 配置（B 模式正在进行平台升级，暂不支持配置）
*/
export interface AuthenticationTypeB {
/**
* 计算签名的密钥
仅允许大小写字母与数字，长度 6~32 位
注意：此字段可能返回 null，表示取不到有效值。
*/
SecretKey: string;
/**
* 签名过期时间设置
单位为秒，最大可设置为 630720000
*/
ExpireTime: number;
/**
* 鉴权/不做鉴权的文件扩展名列表设置
如果包含字符 * 则表示所有文件
*/
FileExtensions: Array<string>;
/**
* whitelist：白名单，表示对除了 FileExtensions 列表之外的所有类型进行鉴权
blacklist：黑名单，表示仅对 FileExtensions 中的类型进行鉴权
*/
FilterType: string;
/**
* 计算签名的备用密钥
仅允许大小写字母与数字，长度 6~32 位
注意：此字段可能返回 null，表示取不到有效值。
*/
BackupSecretKey?: string;
}
/**
* 时间戳防盗链模式 A 配置
时间戳防盗链模式 A 的访问 URL 格式为：http://DomainName/Filename?sign=timestamp-rand-uid-md5hash
其中 timestamp 为十进制 UNIX 时间戳；
rand 为随机字符串，0 ~ 100 位大小写字母与数字组成；
uid 为 0；
md5hash：MD5（文件路径-timestamp-rand-uid-自定义密钥）
*/
export interface AuthenticationTypeA {
/**
* 计算签名的密钥
仅允许大小写字母与数字，长度 6~32 位
注意：此字段可能返回 null，表示取不到有效值。
*/
SecretKey: string;
/**
* 签名参数名设置
仅允许大小写字母、数字或下划线，长度 1~100 位，不能以数字开头
*/
SignParam: string;
/**
* 签名过期时间设置
单位为秒，最大可设置为 630720000
*/
ExpireTime: number;
/**
* 鉴权/不做鉴权的文件扩展名列表设置
如果包含字符 * 则表示所有文件
*/
FileExtensions: Array<string>;
/**
* whitelist：白名单，表示对除了 FileExtensions 列表之外的所有类型进行鉴权
blacklist：黑名单，表示仅对 FileExtensions 中的类型进行鉴权
*/
FilterType: string;
/**
* 计算签名的备用密钥
仅允许大小写字母与数字，长度 6~32 位
注意：此字段可能返回 null，表示取不到有效值。
*/
BackupSecretKey?: string;
}
/**
* 节点 IP 信息
*/
export interface IpStatus {
/**
* 节点 IP
*/
Ip: string;
/**
* 节点所属区域
*/
District: string;
/**
* 节点所属运营商
*/
Isp: string;
/**
* 节点所在城市
*/
City: string;
/**
* 节点状态
online：上线状态，正常调度服务中
offline：下线状态
*/
Status: string;
/**
* 节点 IPV6
注意：此字段可能返回 null，表示取不到有效值。
*/
Ipv6: string;
}
/**
* https 加速服务端证书配置：
+ 支持使用托管至 SSL 证书管理的证书进行部署
+ 支持上传 PEM 格式的证书进行部署
*/
export interface ServerCert {
/**
* 服务器证书 ID 在 SSL 证书管理进行证书托管时自动生成
注意：此字段可能返回 null，表示取不到有效值。
*/
CertId?: string;
/**
* 服务器证书名称
在 SSL 证书管理进行证书托管时自动生成
注意：此字段可能返回 null，表示取不到有效值。
*/
CertName?: string;
/**
* 服务器证书信息
上传自有证书时必填，需要包含完整的证书链
注意：此字段可能返回 null，表示取不到有效值。
*/
Certificate?: string;
/**
* 服务器密钥信息
上传自有证书时必填
注意：此字段可能返回 null，表示取不到有效值。
*/
PrivateKey?: string;
/**
* 证书过期时间
作为入参配置时无需填充
注意：此字段可能返回 null，表示取不到有效值。
*/
ExpireTime?: string;
/**
* 证书颁发时间
作为入参配置时无需填充
注意：此字段可能返回 null，表示取不到有效值。
*/
DeployTime?: string;
/**
* 证书备注信息
注意：此字段可能返回 null，表示取不到有效值。
*/
Message?: string;
/**
* 证书来源
注意：此字段可能返回 null，表示取不到有效值。
*/
From?: string;
}
/**
* CDN 节点上下线历史记录
*/
export interface CdnIpHistory {
/**
* 操作类型
online：节点上线
offline：节点下线
*/
Status: string;
/**
* 操作类型对应的操作时间
当该值为 null 时表示无历史状态变更记录
注意：此字段可能返回 null，表示取不到有效值。
*/
Datetime: string;
}
/**
* UpdateScdnDomain请求参数结构体
*/
export interface UpdateScdnDomainRequest {
/**
* 域名
*/
Domain: string;
/**
* Web 攻击防护（WAF）配置
*/
Waf?: ScdnWafConfig;
/**
* 自定义防护策略配置
*/
Acl?: ScdnAclConfig;
/**
* CC 防护配置，目前 CC 防护默认开启
*/
CC?: ScdnConfig;
/**
* DDOS 防护配置，目前 DDoS 防护默认开启
*/
Ddos?: ScdnDdosConfig;
/**
* BOT 防护配置
*/
Bot?: ScdnBotConfig;
}
/**
* UpdatePayType请求参数结构体
*/
export interface UpdatePayTypeRequest {
/**
* 计费区域，mainland或overseas。
*/
Area: string;
/**
* 计费类型，flux或bandwidth。
*/
PayType: string;
}
/**
* ListDiagnoseReport请求参数结构体
*/
export interface ListDiagnoseReportRequest {
/**
* 用于搜索诊断URL的关键字，不填时返回用户所有的诊断任务。
*/
KeyWords?: string;
/**
* 用于搜索诊断系统返回的诊断链接，形如：http://cdn.cloud.tencent.com/self_diagnose/xxxxx
*/
DiagnoseLink?: string;
/**
* 请求源带协议头，形如：https://console.cloud.tencent.com
*/
Origin?: string;
}
/**
* waf配置类型
*/
export interface ScdnWafConfig {
/**
* Scdn waf配置开关，取值有：
on：开启
off：关闭
*/
Switch: string;
/**
* intercept|observe，默认intercept
注意：此字段可能返回 null，表示取不到有效值。
*/
Mode?: string;
/**
* 重定向的错误页面
注意：此字段可能返回 null，表示取不到有效值。
*/
ErrorPage?: ScdnErrorPage;
/**
* webshell拦截配置开关，取值有：
on：开启
off：关闭
注意：此字段可能返回 null，表示取不到有效值。
*/
WebShellSwitch?: string;
/**
* 类型拦截规则
注意：此字段可能返回 null，表示取不到有效值。
*/
Rules?: Array<ScdnWafRule>;
/**
* waf规则等级，可取100|200|300
注意：此字段可能返回 null，表示取不到有效值。
*/
Level?: number;
/**
* waf子规则配置开关，取值有：
on：开启
off：关闭
注意：此字段可能返回 null，表示取不到有效值。
*/
SubRuleSwitch?: Array<WafSubRuleStatus>;
}
/**
* 诊断报告内容数据
*/
export interface DiagnoseData {
/**
* 诊断报告内容
注意：此字段可能返回 null，表示取不到有效值。
*/
Data: Array<DiagnoseUnit>;
/**
* 当前诊断项是否正常。
"ok"：正常
"error"：异常
"warning"："警告"
注意：此字段可能返回 null，表示取不到有效值。
*/
Status: string;
}
/**
* DescribeScdnBotRecords请求参数结构体
*/
export interface DescribeScdnBotRecordsRequest {
/**
* BOT类型，取值为"UB","UCB","TCB"，分别表示：未知类型，自定义类型，公开类型
*/
BotType: string;
/**
* 域名
*/
Domain: string;
/**
* 开始时间
*/
StartTime: string;
/**
* 结束时间
*/
EndTime: string;
/**
* 分页参数
*/
Offset: number;
/**
* 分页参数
*/
Limit: number;
/**
* mainland 大陆地区 overseas境外地区
*/
Area: string;
/**
* 排序参数
*/
SortBy?: Array<BotSortBy>;
/**
* BotType=UB时，表示需要过滤的预测标签，取值如下：
"crawler_unregular",
"crawler_regular",
"request_repeat",
"credential_miss_user",
"credential_without_user",
"credential_only_action",
"credential_user_password",
"credential_cracking",
"credential_stuffing",
"brush_sms",
"brush_captcha",
"reg_malicious"
BotType=TCB时，表示需要过滤的Bot分类，取值如下：
"Uncategorised",
"Search engine bot",
"Site monitor",
"Screenshot creator",
"Link checker",
"Web scraper",
"Vulnerability scanner",
"Virus scanner",
"Speed tester",
"Feed Fetcher",
"Tool",
"Marketing"
BotType=UCB时，取值如下：
User-Agent为空或不存在
User-Agent类型为BOT
User-Agent类型为HTTP Library
User-Agent类型为Framework
User-Agent类型为Tools
User-Agent类型为Unkonwn BOT
User-Agent类型为Scanner
Referer空或不存在
Referer滥用(多个UA使用相同Referer)
Cookie滥用(多个UA使用相同Cookie)
Cookie空或不存在
Connection空或不存在
Accept空或不存在
Accept-Language空或不存在
Accept-Enconding空或不存在
使用HTTP HEAD方法
HTTP协议为1.0或者更低
IDC-IP 腾讯云
IDC-IP 阿里云
IDC-IP 华为云
IDC-IP 金山云
IDC-IP UCloud
IDC-IP 百度云
IDC-IP 京东云
IDC-IP 青云
IDC-IP Aws
IDC-IP Azure
IDC-IP Google
以上所有类型，FilterName为空时，表示不过滤，获取所有内容
*/
FilterName?: string;
/**
* 目前支持的Action
"intercept" 拦截
"monitor"，监控
"permit" 放行
"redirect" 重定向
尚未支持的Action
"captcha" 验证码
*/
FilterAction?: string;
/**
* 过滤的IP
*/
FilterIp?: string;
/**
* 域名列表，为空表示查询AppID维度数据
*/
Domains?: Array<string>;
}
/**
* ListScdnLogTasks请求参数结构体
*/
export interface ListScdnLogTasksRequest {
/**
* 产品来源 cdn/ecdn
*/
Source?: string;
/**
* 地域：mainland 或 overseas 为空表示查询所有地域
*/
Area?: string;
}
/**
* ListTopCcData返回参数结构体
*/
export interface ListTopCcDataResponse {
/**
* Top数据
注意：此字段可能返回 null，表示取不到有效值。
*/
Data: Array<CcTopData>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribePushTasks请求参数结构体
*/
export interface DescribePushTasksRequest {
/**
* 开始时间，如2018-08-08 00:00:00。
*/
StartTime?: string;
/**
* 结束时间，如2018-08-08 23:59:59。
*/
EndTime?: string;
/**
* 指定任务 ID 查询
TaskId 和起始时间必须指定一项
*/
TaskId?: string;
/**
* 查询关键字，请输入域名或 http(s):// 开头完整 URL
*/
Keyword?: string;
/**
* 分页查询偏移量，默认为 0
*/
Offset?: number;
/**
* 分页查询限制数目，默认为 20
*/
Limit?: number;
/**
* 指定地区查询预热记录
mainland：境内
overseas：境外
global：全球
*/
Area?: string;
/**
* 指定任务状态查询
fail：预热失败
done：预热成功
process：预热中
invalid: 预热无效(源站返回4xx或5xx状态码)
*/
Status?: string;
}
/**
* DescribeOriginData返回参数结构体
*/
export interface DescribeOriginDataResponse {
/**
* 数据统计的时间粒度，支持min, 5min, hour, day，分别表示1分钟，5分钟，1小时和1天的时间粒度。
*/
Interval: string;
/**
* 各个资源的回源数据详情。
*/
Data: Array<ResourceOriginData>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 域名地区配置
*/
export interface DomainAreaConfig {
/**
* 域名
*/
Domain: string;
/**
* 地区列表，其中元素可为mainland/overseas
*/
Area: Array<string>;
}
/**
* DescribeMapInfo返回参数结构体
*/
export interface DescribeMapInfoResponse {
/**
* 映射关系数组。
*/
MapInfoList: Array<MapInfo>;
/**
* 服务端区域id和子区域id的映射关系。
注意：此字段可能返回 null，表示取不到有效值。
*/
ServerRegionRelation: Array<RegionMapRelation>;
/**
* 客户端区域id和子区域id的映射关系。
注意：此字段可能返回 null，表示取不到有效值。
*/
ClientRegionRelation: Array<RegionMapRelation>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateScdnDomain返回参数结构体
*/
export interface CreateScdnDomainResponse {
/**
* 创建结果，Success表示成功
*/
Result: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 日志包下载链接详情
*/
export interface DomainLog {
/**
* 日志包起始时间
*/
StartTime: string;
/**
* 日志包结束时间
*/
EndTime: string;
/**
* 日志包下载链接
*/
LogPath: string;
/**
* 日志包对应加速区域
mainland：境内
overseas：境外
*/
Area: string;
/**
* 日志包文件名
*/
LogName: string;
/**
* 文件大小，单位: Byte
注意：此字段可能返回 null，表示取不到有效值。
*/
FileSize?: number;
}
/**
* ListTopBotData请求参数结构体
*/
export interface ListTopBotDataRequest {
/**
* 获取Top量，取值范围[1-10]
*/
TopCount: number;
/**
* 开始时间
*/
StartTime: string;
/**
* 结束时间
*/
EndTime: string;
/**
* session表示查询BOT会话的Top信息
ip表示查询BOT客户端IP的Top信息
不填代表获取会话信息
*/
Metric?: string;
/**
* 域名，仅当Metric=ip时有效，不填写表示使用Domains参数
*/
Domain?: string;
/**
* 域名，仅当Metric=ip，并且Domain为空时有效，不填写表示获取AppID信息
*/
Domains?: Array<string>;
}
/**
* Bot js策略
*/
export interface BotJavaScript {
/**
* Bot js策略配置开关，取值有：
on：开启
off：关闭
*/
Switch: string;
/**
* 规则类型，当前只有file
*/
RuleType: string;
/**
* 规则值，['html', 'htm']
*/
RuleValue: Array<string>;
/**
* 执行动作，monitor|intercept|redirect|captcha
*/
Action: string;
/**
* 重定向时设置的重定向页面
注意：此字段可能返回 null，表示取不到有效值。
*/
RedirectUrl?: string;
/**
* 更新时间
注意：此字段可能返回 null，表示取不到有效值。
*/
UpdateTime?: string;
}
/**
* DescribeBillingData返回参数结构体
*/
export interface DescribeBillingDataResponse {
/**
* 时间粒度，根据查询时传递参数指定：
min：1 分钟粒度
5min：5 分钟粒度
hour：1 小时粒度
day：天粒度
*/
Interval: string;
/**
* 数据明细
*/
Data: Array<ResourceBillingData>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 源站头部缓存配置，默认为开启状态，缓存所有头部信息
*/
export interface ResponseHeaderCache {
/**
* 源站头部缓存配置开关，取值有：
on：开启
off：关闭
*/
Switch: string;
}
/**
* EnableClsLogTopic请求参数结构体
*/
export interface EnableClsLogTopicRequest {
/**
* 日志集ID
*/
LogsetId: string;
/**
* 日志主题ID
*/
TopicId: string;
/**
* 接入渠道，cdn或者ecdn，默认值为cdn
*/
Channel?: string;
}
/**
* 请求头部及请求url访问控制
*/
export interface AccessControl {
/**
* 启用请求头部及请求url访问控制开关，取值有：
on：开启
off：关闭
*/
Switch: string;
/**
* 请求头部及请求url访问规则
注意：此字段可能返回 null，表示取不到有效值。
*/
AccessControlRules?: Array<AccessControlRule>;
/**
* 返回状态码
注意：此字段可能返回 null，表示取不到有效值。
*/
ReturnCode?: number;
}
/**
* 远程鉴权规则配置，可以包含多种规则配置。
RemoteAuthenticationRules和Server 互斥，只需要配置其中一个。
若只配置Server ，RemoteAuthenticationRules中详细规则参数将采用默认参数；默认参数值见各个配置项中说明；
*/
export interface RemoteAuthentication {
/**
* 远程鉴权配置开关，取值有：
on：开启
off：关闭
注意：此字段可能返回 null，表示取不到有效值。
*/
Switch: string;
/**
* 远程鉴权规则配置
注意：此字段可能返回 null，表示取不到有效值。
*/
RemoteAuthenticationRules?: Array<RemoteAuthenticationRule>;
/**
* 远程鉴权Server
注意：此字段可能返回 null，表示取不到有效值。
*/
Server?: string;
}
/**
* 缓存键分路径配置
*/
export interface KeyRule {
/**
* CacheType 对应类型下的匹配内容：
file 时填充后缀名，如 jpg、txt
directory 时填充路径，如 /xxx/test
path 时填充绝对路径，如 /xxx/test.html
index 时填充 /
注意：此字段可能返回 null，表示取不到有效值。
*/
RulePaths: Array<string>;
/**
* 规则类型：
file：指定文件后缀生效
directory：指定路径生效
path：指定绝对路径生效
index：首页
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleType: string;
/**
* 是否开启全路径缓存
on：开启全路径缓存（即关闭参数忽略）
off：关闭全路径缓存（即开启参数忽略）
注意：此字段可能返回 null，表示取不到有效值。
*/
FullUrlCache: string;
/**
* 是否忽略大小写缓存
注意：此字段可能返回 null，表示取不到有效值。
*/
IgnoreCase: string;
/**
* CacheKey中包含请求参数
注意：此字段可能返回 null，表示取不到有效值。
*/
QueryString: RuleQueryString;
/**
* 路径缓存键标签，传 user
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleTag: string;
}
/**
* 下行限速配置规则，最多可配置 100 条
*/
export interface CappingRule {
/**
* 规则类型：
all：所有文件生效
file：指定文件后缀生效
directory：指定路径生效
path：指定绝对路径生效
*/
RuleType: string;
/**
* RuleType 对应类型下的匹配内容：
all 时填充 *
file 时填充后缀名，如 jpg、txt
directory 时填充路径，如 /xxx/test/
path 时填充绝对路径，如 /xxx/test.html
*/
RulePaths: Array<string>;
/**
* 下行速度值设置，单位为 KB/s
*/
KBpsThreshold: number;
}
/**
* ModifyDomainConfig返回参数结构体
*/
export interface ModifyDomainConfigResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* Quic配置项
*/
export interface Quic {
/**
* Quic功能配置开关，取值有：
on：开启
off：关闭
*/
Switch: string;
}
/**
* 访问明细数据类型
*/
export interface CdnData {
/**
* 查询指定的指标名称：
flux：流量，单位为 byte
bandwidth：带宽，单位为 bps
request：请求数，单位为 次
fluxHitRate：流量命中率，单位为 %
statusCode：状态码，返回 2XX、3XX、4XX、5XX 汇总数据，单位为 个
2XX：返回 2XX 状态码汇总及各 2 开头状态码数据，单位为 个
3XX：返回 3XX 状态码汇总及各 3 开头状态码数据，单位为 个
4XX：返回 4XX 状态码汇总及各 4 开头状态码数据，单位为 个
5XX：返回 5XX 状态码汇总及各 5 开头状态码数据，单位为 个
或指定查询的某一具体状态码
*/
Metric: string;
/**
* 明细数据组合
*/
DetailData: Array<TimestampData>;
/**
* 汇总数据组合
*/
SummarizedData: SummarizedData;
}
/**
* CreateEdgePackTask返回参数结构体
*/
export interface CreateEdgePackTaskResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 时间戳与其对应的数值
*/
export interface TimestampData {
/**
* 数据统计时间点，采用向前汇总模式
以 5 分钟粒度为例，13:35:00 时间点代表的统计数据区间为 13:35:00 至 13:39:59
*/
Time: string;
/**
* 数据值
*/
Value: number;
}
/**
* StartCdnDomain返回参数结构体
*/
export interface StartCdnDomainResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ListTopWafData返回参数结构体
*/
export interface ListTopWafDataResponse {
/**
* 攻击类型统计
*/
TopTypeData: Array<ScdnTypeData>;
/**
* IP统计
*/
TopIpData: Array<ScdnTopData>;
/**
* URL统计
*/
TopUrlData: Array<ScdnTopUrlData>;
/**
* 域名统计
*/
TopDomainData: Array<ScdnTopDomainData>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 客户端信息
*/
export interface ClientInfo {
/**
* 省份。
注意：此字段可能返回 null，表示取不到有效值。
*/
ProvName: string;
/**
* 国家。
注意：此字段可能返回 null，表示取不到有效值。
*/
Country: string;
/**
* 运营商。
注意：此字段可能返回 null，表示取不到有效值。
*/
IspName: string;
/**
* 客户端IP
注意：此字段可能返回 null，表示取不到有效值。
*/
Ip: string;
}
/**
* 状态码重定向规则配置
*/
export interface ErrorPageRule {
/**
* 状态码
支持 400、403、404、500
*/
StatusCode: number;
/**
* 重定向状态码设置
支持 301 或 302
*/
RedirectCode: number;
/**
* 重定向 URL
需要为完整跳转路径，如 https://www.test.com/error.html
*/
RedirectUrl: string;
}
/**
* 华为云对象存储回源鉴权
*/
export interface HwPrivateAccess {
/**
* 华为云对象存储回源鉴权配置开关，取值有：
on：开启
off：关闭
*/
Switch: string;
/**
* 访问 ID
注意：此字段可能返回 null，表示取不到有效值。
*/
AccessKey?: string;
/**
* 密钥
注意：此字段可能返回 null，表示取不到有效值。
*/
SecretKey?: string;
/**
* bucketname
注意：此字段可能返回 null，表示取不到有效值。
*/
Bucket?: string;
}
/**
* PushUrlsCache返回参数结构体
*/
export interface PushUrlsCacheResponse {
/**
* 此批提交的任务 ID
*/
TaskId: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* StopCdnDomain返回参数结构体
*/
export interface StopCdnDomainResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 刷新/预热 可用量及配额
*/
export interface Quota {
/**
* 单次批量提交配额上限。
*/
Batch: number;
/**
* 每日提交配额上限。
*/
Total: number;
/**
* 每日剩余的可提交配额。
*/
Available: number;
/**
* 配额的区域。
*/
Area: string;
}
/**
* BOT统计结果数据
*/
export interface BotStats {
/**
* 指标名称
*/
Metric: string;
/**
* 指标详细数据
*/
DetailData: Array<BotStatsDetailData>;
}
/**
* DescribeUrlViolations返回参数结构体
*/
export interface DescribeUrlViolationsResponse {
/**
* 违规 URL 详情
注意：此字段可能返回 null，表示取不到有效值。
*/
UrlRecordList: Array<ViolationUrl>;
/**
* 记录总数，用于分页
*/
TotalCount: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribePurgeTasks返回参数结构体
*/
export interface DescribePurgeTasksResponse {
/**
* 详细刷新记录
注意：此字段可能返回 null，表示取不到有效值。
*/
PurgeLogs: Array<PurgeTask>;
/**
* 任务总数，用于分页
注意：此字段可能返回 null，表示取不到有效值。
*/
TotalCount: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ddos配置类型
*/
export interface ScdnDdosConfig {
/**
* Scdn ddos配置开关，取值有：
on：开启
off：关闭
*/
Switch: string;
}
/**
* DDoS攻击Top数据
*/
export interface DDoSTopData {
/**
* 攻击类型
*/
AttackType: string;
/**
* 攻击带宽，单位：bps
*/
Value: number;
}
/**
* 回源超时配置
*/
export interface OriginPullTimeout {
/**
* 回源建连超时时间，单位为秒，要求5~60之间
注意：此字段可能返回 null，表示取不到有效值。
*/
ConnectTimeout: number;
/**
* 回源接收超时时间，单位为秒，要求10 ~ 300之间
注意：此字段可能返回 null，表示取不到有效值。
*/
ReceiveTimeout: number;
}
/**
* DescribeScdnTopData请求参数结构体
*/
export interface DescribeScdnTopDataRequest {
/**
* 查询起始时间，如：2018-09-04 10:40:00，返回结果大于等于指定时间
*/
StartTime: string;
/**
* 查询结束时间，如：2018-09-04 10:40:00，返回结果小于等于指定时间
*/
EndTime: string;
/**
* 查询的SCDN TOP攻击数据类型：
waf：Web 攻击防护TOP数据
*/
Mode: string;
/**
* 排序对象，支持以下几种形式：
url：攻击目标 url 排序
ip：攻击源 IP 排序
attackType：攻击类型排序
*/
Metric: string;
/**
* 排序使用的指标名称：
request：请求次数
*/
Filter: string;
/**
* 指定域名查询
*/
Domain?: string;
/**
* 指定攻击类型, 仅 Mode=waf 时有效
不填则查询所有攻击类型的数据总和
AttackType 映射如下:
other = '未知类型'
malicious_scan = "恶意扫描"
sql_inject = "SQL注入攻击"
xss = "XSS攻击"
cmd_inject = "命令注入攻击"
ldap_inject = "LDAP注入攻击"
ssi_inject = "SSI注入攻击"
xml_inject = "XML注入攻击"
web_service = "WEB服务漏洞攻击"
web_app = "WEB应用漏洞攻击"
path_traversal = "路径跨越攻击"
illegal_access_core_file = "核心文件非法访问"
trojan_horse = "木马后门攻击"
csrf = "CSRF攻击"
malicious_file_upload= '恶意文件上传'
*/
AttackType?: string;
/**
* 指定防御模式,仅 Mode=waf 时有效
不填则查询所有防御模式的数据总和
DefenceMode 映射如下：
observe = '观察模式'
intercept = '拦截模式'
*/
DefenceMode?: string;
}
/**
* scdn的IP白名单策略
*/
export interface ScdnIpStrategy {
/**
* 域名|global表示全部域名
*/
Domain: string;
/**
* 策略ID
*/
StrategyId: string;
/**
* IP白名单列表
*/
IpList: Array<string>;
/**
* 更新时间
*/
UpdateTime: string;
/**
* 备注
*/
Remark: string;
/**
* 规则类型
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleType: string;
/**
* 规则值
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleValue: Array<string>;
}
/**
* DescribeDDoSData返回参数结构体
*/
export interface DescribeDDoSDataResponse {
/**
* DDoS统计数据数组
*/
Data: Array<DDoSStatsData>;
/**
* 时间粒度：
min：1 分钟粒度
5min：5 分钟粒度
hour：1 小时粒度
day：天粒度
*/
Interval: string;
/**
* DDoS统计攻击带宽峰值数组
*/
AttackBandwidthData: Array<DDoSAttackBandwidthData>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeTopData返回参数结构体
*/
export interface DescribeTopDataResponse {
/**
* 各个资源的Top 访问数据详情。
*/
Data: Array<TopDataMore>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* Url重定向规则配置
*/
export interface UrlRedirectRule {
/**
* 重定向状态码，301 | 302
*/
RedirectStatusCode: number;
/**
* 待匹配的Url，仅支持Url路径，不支持参数。默认完全匹配，支持通配符 *，最多支持5个通配符，最大长度1024字符。
*/
Pattern: string;
/**
* 目标URL，必须以“/”开头，不包含参数部分。最大长度1024字符。可使用$1, $2, $3, $4, $5分别捕获匹配路径中的通配符号，最多支持10个捕获值。
*/
RedirectUrl: string;
/**
* 目标host，必须以http://或https://开头，并填写标准格式域名，如果不填写，默认为http:// + 当前域名
注意：此字段可能返回 null，表示取不到有效值。
*/
RedirectHost?: string;
/**
* 指定是全路径配置还是任意匹配
注意：此字段可能返回 null，表示取不到有效值。
*/
FullMatch?: boolean;
}