UNPKG

tencentcloud-sdk-nodejs

Version:
2,647 lines (2,643 loc) 208 kB
/** * DescribeCdnDomainLogs返回参数结构体 */ export interface DescribeCdnDomainLogsResponse { /** * 日志包下载链接。 下载内容是gz后缀的压缩包,解压后是无扩展名的文本文件。链接有效期1天。 */ DomainLogs?: Array<DomainLog>; /** * 查询到的总条数 */ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: 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; } /** * 回源的自定义Https配置 */ export interface AdvanceHttps { /** * <p>自定义Tls数据开关<br>on - 开<br>off - 关</p> 注意:此字段可能返回 null,表示取不到有效值。 */ CustomTlsStatus?: string; /** * <p>Tls版本列表,支持设置 TLSv1, TLSV1.1, TLSV1.2, TLSv1.3,修改时必须开启连续的版本</p> 注意:此字段可能返回 null,表示取不到有效值。 */ TlsVersion?: Array<string>; /** * <p>自定义加密套件</p> 注意:此字段可能返回 null,表示取不到有效值。 */ Cipher?: string; /** * <p>回源双向校验开启状态<br>off - 关闭校验<br>oneWay - 校验源站<br>twoWay - 双向校验</p> 注意:此字段可能返回 null,表示取不到有效值。 */ VerifyOriginType?: string; /** * <p>回源层证书配置信息</p> 注意:此字段可能返回 null,表示取不到有效值。 */ CertInfo?: ServerCert; /** * <p>源站证书配置信息</p> 注意:此字段可能返回 null,表示取不到有效值。 */ OriginCertInfo?: ClientCert; } /** * 是否回源站校验 */ export interface Revalidate { /** * 总是回源校验配置开关,取值有: on:开启 off:关闭 注意:此字段可能返回 null,表示取不到有效值。 */ Switch: string; /** * 只在特定请求路径回源站校验 注意:此字段可能返回 null,表示取不到有效值。 */ Path?: string; } /** * 查询对象及其对应的访问明细数据 */ export interface ResourceData { /** * 资源名称,根据查询条件不同分为以下几类: 单域名:指定单域名查询,表示该域名明细数据,当传入参数 detail 指定为 true 时,显示该域名( detail 参数默认为 false ) 多域名:指定多个域名查询,表示多域名汇总明细数据,显示 multiDomains 项目 ID:指定项目查询时,表示该项目下的域名汇总明细数据,显示该项目 ID all:账号维度明细数据,即账号下所有域名的汇总明细数据 */ Resource: string; /** * 资源对应的数据明细 */ CdnData: Array<CdnData>; } /** * UserAgent黑白名单配置 */ export interface UserAgentFilter { /** * UserAgent黑白名单配置开关,取值有: on:开启 off:关闭 注意:此字段可能返回 null,表示取不到有效值。 */ Switch: string; /** * UA黑白名单生效规则列表,不能超过10条规则 注意:此字段可能返回 null,表示取不到有效值。 */ FilterRules?: Array<UserAgentFilterRule>; } /** * 其他厂商对象存储回源鉴权 */ 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。 */ RequestId?: string; } /** * DescribePurgeQuota返回参数结构体 */ export interface DescribePurgeQuotaResponse { /** * URL刷新用量及配额。 */ UrlPurge?: Array<Quota>; /** * 目录刷新用量及配额。 */ PathPurge?: Array<Quota>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 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; } /** * ImageOptimization配置 */ export interface ImageOptimization { /** * WebpAdapter配置 注意:此字段可能返回 null,表示取不到有效值。 */ WebpAdapter: WebpAdapter; /** * TpgAdapter配置 注意:此字段可能返回 null,表示取不到有效值。 */ TpgAdapter: TpgAdapter; /** * GuetzliAdapter配置 注意:此字段可能返回 null,表示取不到有效值。 */ GuetzliAdapter: GuetzliAdapter; /** * AvifAdapter配置 注意:此字段可能返回 null,表示取不到有效值。 */ AvifAdapter: AvifAdapter; } /** * 域名 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>; } /** * 分路径分片回源配置 */ 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>; } /** * 缓存配置分路径版本。 默认情况下所有文件缓存过期时间为 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; } /** * 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; } /** * 图片优化-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>; } /** * CreateClsLogTopic返回参数结构体 */ export interface CreateClsLogTopicResponse { /** * 主题ID */ TopicId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * MaxAge 状态码相关规则配置 */ export interface MaxAgeCodeRule { /** * 处理动作 clear:清除 cache-control 头部 */ Action: string; /** * 指定HTTP状态码生效,当前仅支持填写"400-599" */ StatusCodes: Array<string>; } /** * 智能压缩配置,默认对 js、html、css、xml、json、shtml、htm 后缀且大小为 256 ~ 2097152 字节的文件进行 GZIP 压缩 */ export interface Compression { /** * 智能压缩配置开关,取值有: on:开启 off:关闭 */ Switch: string; /** * 压缩规则数组 注意:此字段可能返回 null,表示取不到有效值。 */ CompressionRules?: Array<CompressionRule>; } /** * PurgePathCache返回参数结构体 */ export interface PurgePathCacheResponse { /** * 刷新任务 ID,同一批次提交的目录共用一个任务 ID */ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 分片回源配置,默认为开启状态 */ export interface RangeOriginPull { /** * 分片回源配置开关,取值有: on:开启 off:关闭 */ Switch: string; /** * 分路径分片回源配置 注意:此字段可能返回 null,表示取不到有效值。 */ RangeRules?: Array<RangeOriginPullRule>; } /** * 域名查询时过滤条件。 */ 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; /** * 过滤字段值,默认最多传 5 个。当 Name 是 origin/domain 且 Fuzzy 传 true,最多传 1 个。 */ Value: Array<string>; /** * 是否启用模糊查询,仅支持过滤字段名为origin,domain。 模糊查询时,Value长度最大为1,否则Value长度最大为5。 */ Fuzzy?: boolean; } /** * 参数黑名单 */ export interface ParamFilter { /** * 参数黑名单开关 注意:此字段可能返回 null,表示取不到有效值。 */ Switch: string; /** * 参数黑名单规则 注意:此字段可能返回 null,表示取不到有效值。 */ FilterRules?: Array<ParamFilterRule>; } /** * 域名国内海外分地区特殊配置。 */ export interface SpecificConfig { /** * 国内特殊配置。 注意:此字段可能返回 null,表示取不到有效值。 */ Mainland?: MainlandConfig; /** * 海外特殊配置。 注意:此字段可能返回 null,表示取不到有效值。 */ Overseas?: OverseaConfig; } /** * DescribeTopData请求参数结构体 */ export interface DescribeTopDataRequest { /** * <p>查询起始日期:yyyy-MM-dd<br>仅支持按天粒度的数据查询,取入参中的天信息作为起始日期<br>返回大于等于起始日期当天 00:00:00 点产生的数据,如 StartTime为2018-09-04,返回数据的起始时间为2018-09-04 00:00:00<br>仅支持 90 天内数据查询</p> */ StartTime: string; /** * <p>查询结束日期:yyyy-MM-dd<br>仅支持按天粒度的数据查询,取入参中的天信息作为结束日期<br>返回小于等于结束日期当天 23:59:59 产生的数据,如EndTime为2018-09-05,返回数据的结束时间为2018-09-05 23:59:59<br>EndTime 需要大于等于 StartTime</p> */ EndTime: string; /** * <p>排序对象,支持以下几种形式:<br>ip、ua_device、ua_browser、ua_os、referer</p> */ Metric: string; /** * <p>排序使用的指标名称:<br>flux:Metric 为 host 时指代访问流量<br>request:Metric 为 host 时指代访问请求数</p> */ Filter: string; /** * <p>指定查询域名列表,最多可一次性查询 30 个加速域名明细</p> */ Domains?: Array<string>; /** * <p>未填充域名情况下,指定项目查询,若填充了具体域名信息,以域名为主</p> */ Project?: number; /** * <p>是否详细显示每个域名的的具体数值</p> */ Detail?: boolean; /** * <p>指定服务地域查询,不填充表示查询中国境内 CDN 数据<br>mainland:指定查询中国境内 CDN 数据<br>overseas:指定查询中国境外 CDN 数据</p> */ Area?: string; /** * <p>指定查询的产品数据,目前仅可使用cdn</p> */ 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; } /** * DescribePurgeQuota请求参数结构体 */ export type DescribePurgeQuotaRequest = null; /** * 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>; } /** * DescribeCdnData返回参数结构体 */ export interface DescribeCdnDataResponse { /** * 返回数据的时间粒度,查询时指定: min:1 分钟粒度 5min:5 分钟粒度 hour:1 小时粒度 day:天粒度 */ Interval?: string; /** * 指定条件查询得到的数据明细 */ Data?: Array<ResourceData>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * EnableClsLogTopic请求参数结构体 */ export interface EnableClsLogTopicRequest { /** * 日志集ID */ LogsetId: string; /** * 日志主题ID */ TopicId: string; /** * 接入渠道,cdn或者ecdn,默认值为cdn */ Channel?: string; } /** * UpdateImageConfig返回参数结构体 */ export interface UpdateImageConfigResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 路径缓存不缓存配置 */ export interface CacheConfigNoCache { /** * 路径缓存不缓存配置配置开关,取值有: on:开启 off:关闭 注意:此字段可能返回 null,表示取不到有效值。 */ Switch: string; /** * 总是回源站校验 on:开启 off:关闭 默认为关闭状态 注意:此字段可能返回 null,表示取不到有效值。 */ Revalidate: string; } /** * 请求头部及请求url访问控制 */ export interface AccessControl { /** * 启用请求头部及请求url访问控制开关,取值有: on:开启 off:关闭 */ Switch: string; /** * 请求头部及请求url访问规则 注意:此字段可能返回 null,表示取不到有效值。 */ AccessControlRules?: Array<AccessControlRule>; /** * 返回状态码 注意:此字段可能返回 null,表示取不到有效值。 */ ReturnCode?: number; } /** * DescribeCdnOriginIp返回参数结构体 */ export interface DescribeCdnOriginIpResponse { /** * 回源节点IP详情。 */ Ips?: Array<OriginIp>; /** * 回源节点IP总个数。 */ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 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。 */ RequestId?: 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; } /** * 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; } /** * ListClsTopicDomains请求参数结构体 */ export interface ListClsTopicDomainsRequest { /** * 日志集ID */ LogsetId: string; /** * 日志主题ID */ TopicId: string; /** * 接入渠道,cdn或者ecdn,默认值为cdn */ Channel?: string; } /** * DescribeDomains返回参数结构体 */ export interface DescribeDomainsResponse { /** * 域名列表 */ Domains: Array<BriefDomain>; /** * 符合查询条件的域名总数 用于分页查询 */ TotalNumber: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribePayType请求参数结构体 */ export interface DescribePayTypeRequest { /** * 指定服务地域查询 mainland:境内计费方式查询 overseas:境外计费方式查询 global:全球计费方式查询 未填充时,默认为 mainland */ Area?: string; /** * 指定查询的产品数据,可选为cdn或者ecdn,默认为cdn */ Product?: string; /** * 指定资源包查询 flux:流量包 https:HTTPS请求包 未填充时,默认为 flux */ Type?: string; } /** * UpdateImageConfig请求参数结构体 */ export interface UpdateImageConfigRequest { /** * 域名 */ Domain: string; /** * WebpAdapter配置项 */ WebpAdapter?: WebpAdapter; /** * TpgAdapter配置项 */ TpgAdapter?: TpgAdapter; /** * GuetzliAdapter配置项 */ GuetzliAdapter?: GuetzliAdapter; /** * AvifAdapter配置项 */ AvifAdapter?: AvifAdapter; } /** * 时间戳防盗链高级版模式D配置。 */ export interface AdvancedAuthenticationTypeD { /** * 用于计算签名的密钥,只允许字母和数字,长度6-32字节。 */ SecretKey: string; /** * 备份密钥,当使用SecretKey鉴权失败时会使用该密钥重新鉴权。 */ BackupSecretKey: string; /** * uri串中签名的字段名,字母,数字或下划线构成,同时必须以字母开头。 */ SignParam: string; /** * uri串中时间的字段名,字母,数字或下划线构成,同时必须以字母开头。 */ TimeParam: string; /** * 过期时间,单位秒。 */ ExpireTime: number; /** * 时间格式,dec,hex分别表示十进制,十六进制。 */ TimeFormat: 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>; } /** * 自定义回源302 follow请求host配置 */ export interface RedirectConfig { /** * 自定义回源302 follow请求host配置开关,取值有: on:开启 off:关闭 */ Switch: string; /** * 主源站follow302请求时带的自定义的host头部 */ FollowRedirectHost: string; /** * 备份源站follow302请求时带的自定义的host头部 */ FollowRedirectBackupHost?: string; } /** * 图片优化-GuetzliAdapter配置 */ export interface GuetzliAdapter { /** * 图片优化-GuetzliAdapter配置开关,取值有: on:开启 off:关闭 注意:此字段可能返回 null,表示取不到有效值。 */ Switch?: 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 地址 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; } /** * 时间戳防盗链高级鉴权模式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; } /** * 排序类型数据结构 */ export interface TopData { /** * 资源名称,根据查询条件不同分为以下几类: 具体域名:表示该域名明细数据 multiDomains:表示多域名汇总明细数据 项目 ID:指定项目查询时,显示为项目 ID all:账号维度明细数据 */ Resource?: string; /** * 排序结果详情 */ DetailData?: Array<TopDetailData>; } /** * 通过Cls日志,计算出来的IP每秒访问数量 */ export interface ClsLogIpData { /** * IP */ ClientIp: string; /** * 在给定的时间段中,1秒内的最大请求量 */ Request: number; /** * 在获取的Top信息中,IP出现的次数 */ Count: number; /** * 在给定的时间段中,1秒内的最大请求量对应的时间 */ Time: string; } /** * 组成CacheKey */ export interface HeaderKey { /** * 组成Cachekey配置开关,取值有: on:开启 off:关闭 注意:此字段可能返回 null,表示取不到有效值。 */ Switch?: string; /** * 组成CacheKey的header数组,';' 分割 注意:此字段可能返回 null,表示取不到有效值。 */ Value?: string; } /** * DescribeBillingData请求参数结构体 */ export interface DescribeBillingDataRequest { /** * <p>查询起始时间,如:2018-09-04 10:40:00,返回结果大于等于指定时间<br>根据指定时间粒度参数不同,会进行向前取整,如指定起始时间为 2018-09-04 10:40:00 按小时粒度查询,返回的第一个数据对应时间点为 2018-09-04 10:00:00<br>起始时间与结束时间间隔小于等于 90 天</p> */ StartTime: string; /** * <p>查询结束时间,如:2018-09-04 10:40:00,返回结果小于等于指定时间<br>根据指定时间粒度参数不同,会进行向前取整,如指定结束时间为 2018-09-04 10:40:00 按小时粒度查询时,返回的最后一个数据对应时间点为 2018-09-04 10:00:00<br>起始时间与结束时间间隔小于等于 90 天</p> */ EndTime: string; /** * <p>时间粒度,支持模式如下:<br>min:1 分钟粒度,查询区间需要小于等于 24 小时<br>5min:5 分钟粒度,查询区间需要小于等于 31 天(计费数据粒度)<br>hour:1 小时粒度,查询区间需要小于等于 31 天内<br>day:天粒度,查询区间需要大于 31 天</p><p>Area 字段为 overseas 时暂不支持1分钟粒度数据查询</p> */ Interval?: string; /** * <p>指定域名查询计费数据</p> */ Domain?: string; /** * <p>指定项目 ID 查询,<a href="https://console.cloud.tencent.com/project">前往查看项目 ID</a><br>若 Domain 参数填充了具体域名信息,则返回该域名的计费数据,而非指定项目计费数据</p> */ Project?: number; /** * <p>指定加速区域查询计费数据:<br>mainland:中国境内<br>overseas:中国境外<br>不填充时,默认为 mainland</p> */ Area?: string; /** * <p>Area 为 overseas 时,仅支持地区查询<br>省份、国家/地区编码可以查看 <a href="https://cloud.tencent.com/document/product/228/6316#.E7.9C.81.E4.BB.BD.E6.98.A0.E5.B0.84">省份编码映射</a><br>不填充时,查询所有国家/地区</p> */ District?: number; /** * <p>计费统计类型<br>flux:计费流量<br>bandwidth:计费带宽<br>https:https请求数<br>默认为 bandwidth</p> */ Metric?: string; /** * <p>指定查询的产品数据,可选为cdn或者ecdn,默认为cdn</p> */ Product?: string; /** * <p>指定查询时间的时区,默认UTC+08:00</p> */ TimeZone?: 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; } /** * DeleteClsLogTopic请求参数结构体 */ export interface DeleteClsLogTopicRequest { /** * 日志主题ID */ TopicId: string; /** * 日志集ID */ LogsetId: string; /** * 接入渠道,cdn或者ecdn,默认值为cdn */ Channel?: string; } /** * DescribeDistrictIspData返回参数结构体 */ export interface DescribeDistrictIspDataResponse { /** * <p>地区运营商数据明细</p> */ Data?: Array<DistrictIspInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeCdnOriginIp请求参数结构体 */ export type DescribeCdnOriginIpRequest = null; /** * 排序类型的数据结构,同时附带上该项的在总值的占比 */ export interface TopDetailDataMore { /** * 数据类型的名称 */ Name: string; /** * 数据值 */ Value: number; /** * 数据值在总值中的百分比 注意:此字段可能返回 null,表示取不到有效值。 */ Percent: number; } /** * CLS主题信息 */ export interface TopicInfo { /** * 主题ID */ TopicId?: string; /** * 主题名字 */ TopicName?: string; /** * 是否启用投递 */ Enabled?: number; /** * 创建时间 注意:此字段可能返回 null,表示取不到有效值。 */ CreateTime?: string; /** * 归属于cdn或ecdn 注意:此字段可能返回 null,表示取不到有效值。 */ Channel?: string; /** * cls侧是否已经被删除 注意:此字段可能返回 null,表示取不到有效值。 */ Deleted?: string; } /** * DescribeDomainsConfig返回参数结构体 */ export interface DescribeDomainsConfigResponse { /** * 域名列表 */ Domains?: Array<DetailDomain>; /** * 符合查询条件的域名总数 用于分页查询 */ TotalNumber?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: 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 TimestampData { /** * 数据统计时间点,采用向前汇总模式 以 5 分钟粒度为例,13:35:00 时间点代表的统计数据区间为 13:35:00 至 13:39:59 */ Time?: string; /** * 数据值 */ Value?: number; } /** * 图片优化-TpgAdapter配置 */ export interface TpgAdapter { /** * 图片优化-TpgAdapter配置开关,取值有: 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; /** * 当缓存过期后,是否开启源站 mtime 校验,配置值为equal、since、none 和 null。默认配置值为equal,会校验源站文件的mtime与长度。2024-09-12 18:00 之前创建的域名默认值 null,行为保持不变。 equal:源站响应mtime必须和缓存mtime一致,若mtime值不一致,清除缓存。 since:若源站响应mtime大于缓存mtime,清除缓存。 none: 缓存过期回源重新获取文件mtime和长度后,不会校验源站响应mtime,若源站响应携带Content-Length头部,只有文件大小改变时才会更新缓存;若源站响应不携带Content-Length头部,会更新缓存。 注意:此字段可能返回 null,表示取不到有效值。 */ OriginMtimeCheckType?: string; } /** * DescribeReportData返回参数结构体 */ export interface DescribeReportDataResponse { /** * 域名维度数据详情 */ DomainReport?: Array<ReportData>; /** * 项目维度数据详情 */ ProjectReport?: Array<ReportData>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DisableClsLogTopic请求参数结构体 */ export interface DisableClsLogTopicRequest { /** * 日志集ID */ LogsetId: string; /** * 日志主题ID */ TopicId: string; /** * 接入渠道,cdn或者ecdn,默认值为cdn */ Channel?: string; } /** * 路径缓存缓存配置(三种缓存模式中选取一种) */ export interface RuleCacheConfig { /** * 缓存配置 注意:此字段可能返回 null,表示取不到有效值。 */ Cache: CacheConfigCache; /** * 不缓存配置 注意:此字段可能返回 null,表示取不到有效值。 */ NoCache: CacheConfigNoCache; /** * 遵循源站配置 注意:此字段可能返回 null,表示取不到有效值。 */ FollowOrigin: CacheConfigFollowOrigin; } /** * ListClsTopicDomains返回参数结构体 */ export interface ListClsTopicDomainsResponse { /** * 开发者ID */ AppId?: number; /** * 渠道 */ Channel?: string; /** * 日志集ID */ LogsetId?: string; /** * 日志主题ID */ TopicId?: string; /** * 域名区域配置,其中可能含有已删除的域名,如果要再传回ManageClsTopicDomains接口,需要结合ListCdnDomains接口排除掉已删除的域名 */ DomainAreaConfigs?: Array<DomainAreaConfig>; /** * 日志主题名称 */ TopicName?: string; /** * 日志主题最近更新时间 */ UpdateTime?: string; /** * 是否继承域名标签 */ InheritDomainTags?: boolean; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: 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; } /** * HTTPS服务,若关闭,下发配置拦截https请求,开启时会产生计费 */ export interface HttpsBilling { /** * HTTPS服务配置开关,取值有: on:开启,缺省时默认开启,会产生计费 off:关闭,拦截https请求 */ Switch: string; } /** * DescribeCdnIp请求参数结构体 */ export interface DescribeCdnIpRequest { /** * 需要查询的 IP 列表,单次可支持1-20个IP查询。 */ Ips: Array<string>; } /** * Ipv6源站启用配置,不可更改 */ export interface Ipv6 { /** * 域名开启源站ipv6配置开关,取值有: on:开启 off:关闭 注意:此字段可能返回 null,表示取不到有效值。 */ Switch: string; } /** * DescribeHttpsPackages请求参数结构体 */ export interface DescribeHttpsPackagesRequest { /** * 分页查询起始地址,默认 0 */ Offset?: number; /** * 分页查询记录个数,默认100,最大1000 */ Limit?: number; } /** * 防盗刷配置规则 */ export interface FilterRules { /** * <p>封禁类型<br>forbidden - 封禁</p> 注意:此字段可能返回 null,表示取不到有效值。 */ FilterType: string; /** * <p>封禁规则类型<br>all - 全部请求<br>file - 指定后缀的文件请求</p> 注意:此字段可能返回 null,表示取不到有效值。 */ RuleType: string; /** * <p>封禁规则路径</p> 注意:此字段可能返回 null,表示取不到有效值。 */ RulePaths: Array<string>; } /** * DescribeTrafficPackages请求参数结构体 */ export interface DescribeTrafficPackagesRequest { /** * 分页查询起始地址,默认 0 */ Offset?: number; /** * 分页查询记录个数,默认100,最大1000 */ Limit?: number; /** * 流量包排序方式,支持以下值: expireTimeDesc:默认值,按过期时间倒序 expireTimeAsc:按过期时间正序 createTimeDesc:按创建时间倒序 createTimeAsc:按创建时间正序 status:按状态排序,正常抵扣>未生效>已用尽>已过期 channel:按来源排序,主动购买>自动续订>CDN赠送 */ SortBy?: string; } /** * 状态码缓存过期配置,默认情况下会对 404 状态码缓存 10 秒 */ export interface StatusCodeCache { /** * 状态码缓存过期配置开关,取值有: on:开启 off:关闭 注意:此字段可能返回 null,表示取不到有效值。 */ Switch: string; /** * 状态码缓存过期规则明细 注意:此字段可能返回 null,表示取不到有效值。 */ CacheRules?: Array<StatusCodeCacheRule>; } /** * DescribeIpVisit返回参数结构体 */ export interface DescribeIpVisitResponse { /** * 数据统计的时间粒度,支持5min, day,分别表示5分钟,1天的时间粒度。 */ Interval?: string; /** * 各个资源的回源数据详情。 */ Data?: Array<ResourceData>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 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; } /** * 远程鉴权规则。 */ 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; } /** * 域名海外地区特殊配置。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; } /** * 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; } /** * UserAgent黑白名单规则配置 */ export interface UserAgentFilterRule { /** * 访问路径生效类型 all: 所有访问路径生效 file: 根据文件后缀类型生效 directory: 根据目录生效 path: 根据完整访问路径生效 注意:此字段可能返回 null,表示取不到有效值。 */ RuleType: string; /** * 访问路径生效内容 注意:此字段可能返回 null,表示取不到有效值。 */ RulePaths: Array<string>; /** * UserAgent列表,UserAgent 个数不能超过 10个 注意:此字段可能返回 null,表示取不到有效值。 */ UserAgents: Array<string>; /** * 黑名单或白名单,blacklist或whitelist 注意:此字段可能返回 null,表示取不到有效值。 */ FilterType: 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; /** * 响应头部配