tencentcloud-sdk-nodejs
Version:
2,772 lines (2,766 loc) • 276 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后缀的压缩包，解压后是无扩展名的文本文件。链接有效期1天。
*/
DomainLogs?: Array<DomainLog>;
/**
* 查询到的总条数
*/
TotalCount?: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 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。
*/
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。
*/
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。
*/
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 回源
注意：此字段可能返回 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。
*/
RequestId?: string;
}
/**
* ListClsLogTopics返回参数结构体
*/
export interface ListClsLogTopicsResponse {
/**
* 上海区域日志集信息
*/
Logset: LogSetInfo;
/**
* 上海区域日志主题信息列表
注意：此字段可能返回 null，表示取不到有效值。
*/
Topics: Array<TopicInfo>;
/**
* 其他区域日志集信息列表
注意：此字段可能返回 null，表示取不到有效值。
*/
ExtraLogset: Array<ExtraLogset>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* VerifyDomainRecord返回参数结构体
*/
export interface VerifyDomainRecordResponse {
/**
* 是否验证成功
*/
Result?: boolean;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 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。
*/
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。
*/
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。
*/
RequestId?: string;
}
/**
* ListScdnDomains返回参数结构体
*/
export interface ListScdnDomainsResponse {
/**
* 域名列表信息
注意：此字段可能返回 null，表示取不到有效值。
*/
DomainList?: Array<ScdnDomain>;
/**
* 域名的总条数。
注意：此字段可能返回 null，表示取不到有效值。
*/
TotalCount?: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 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。
*/
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、307、308
注意：此字段可能返回 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 {
/**
* 结果列表
*/
CacheOptResult?: CacheOptResult;
/**
* 任务ID
*/
TaskId?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SCDN攻击数据Top展示
*/
export interface ScdnTopDomainData {
/**
* 域名
*/
Domain: string;
/**
* 请求量
*/
Value: number;
/**
* 百分比
*/
Percent: number;
}
/**
* StartScdnDomain返回参数结构体
*/
export interface StartScdnDomainResponse {
/**
* 开启结果，Success表示成功
*/
Result: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 自定义响应头配置，默认为关闭状态
*/
export interface ResponseHeader {
/**
* 自定义响应头配置开关，取值有：
on：开启
off：关闭
*/
Switch: string;
/**
* 自定义响应头规则
注意：此字段可能返回 null，表示取不到有效值。
*/
HeaderRules?: Array<HttpHeaderPathRule>;
}
/**
* DisableCaches返回参数结构体
*/
export interface DisableCachesResponse {
/**
* 提交结果
*/
CacheOptResult?: CacheOptResult;
/**
* 任务ID
*/
TaskId?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 事件日志统计数据结果
*/
export interface EventLogStatsData {
/**
* 时间
*/
Datetime: string;
/**
* 请求数
*/
Request: number;
}
/**
* DescribeIpStatus返回参数结构体
*/
export interface DescribeIpStatusResponse {
/**
* 节点列表
*/
Ips?: Array<IpStatus>;
/**
* 节点总个数
*/
TotalCount?: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 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。
*/
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 格式IPV4地址 或X:X:X:X:X:X:X:X 格式IPV6地址， 或网段格式/X（IPV4:1≤X≤32；IPV6:1≤X≤128）
最多可填充 200 个白名单或 500 个黑名单；
注意：此字段可能返回 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>;
/**
* 备注信息, 最多支持50个字符
*/
Remark?: 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。
*/
RequestId?: string;
}
/**
* 图片优化-AvifAdapter配置
*/
export interface AvifAdapter {
/**
* 图片优化AvifAdapter配置项开关，取值有：
on：开启
off：关闭
注意：此字段可能返回 null，表示取不到有效值。
*/
Switch?: string;
/**
* 当原图是 avif 且客户端 Accept 头包含 image/avif 时，直接返回原图。
当原图是 avif 且客户端 Accept 头不包含 image/avif 时但包含 image/webp，将 avif 转 webp 格式返回。如果 Accept 头不包含 image/webp, 则转 jpeg 返回。
可用的枚举值：
- []
- ["webp"]
- ["jpeg"]
- ["webp", "jpeg"]
"webp"：是否开启 avif 转 webp，"jpeg": 是否开启 avif 转 jpeg。如果 webp 和 jpeg 都开启的情况下，webp 必须在 jpeg 前面。
注意：此字段可能返回 null，表示取不到有效值。
*/
FallbackFormats?: Array<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。
*/
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，表