UNPKG

tencentcloud-sdk-nodejs

Version:
2,077 lines (2,072 loc) 422 kB
/** * DeployConfigGroupVersion请求参数结构体 */ export interface DeployConfigGroupVersionRequest { /** * 站点 ID。 */ ZoneId: string; /** * 环境 ID。请填写版本需要发布到的环境 ID。 */ EnvId: string; /** * 需要发布的版本信息。可以同时变更多个不同配置组的版本,每个配置组一次仅支持变更一个版本。 */ ConfigGroupVersionInfos: Array<ConfigGroupVersionInfo>; /** * 变更说明。用于描述此次变更的内容、原因,最大支持 100 个字符。 */ Description: string; } /** * 预付费套餐自动续费配置项。 */ export interface RenewFlag { /** * 预付费套餐的自动续费标志,取值有: <li> on:开启自动续费;</li> <li> off:不开启自动续费。</li> */ Switch: string; } /** * 智能压缩配置。 */ export interface Compression { /** * 智能压缩配置开关,取值有: <li>on:开启;</li> <li>off:关闭。</li> */ Switch: string; /** * 支持的压缩算法列表,取值有: <li>brotli:brotli算法;</li> <li>gzip:gzip算法。</li> 注意:此字段可能返回 null,表示取不到有效值。 */ Algorithms?: Array<string>; } /** * DescribeFunctions返回参数结构体 */ export interface DescribeFunctionsResponse { /** * 符合查询条件的函数总数。 */ TotalCount?: number; /** * 符合查询条件的所有函数信息。 */ Functions?: Array<Function>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteL4ProxyRules请求参数结构体 */ export interface DeleteL4ProxyRulesRequest { /** * 站点 ID。 */ ZoneId: string; /** * 四层代理实例 ID。 */ ProxyId: string; /** * 转发规则 ID 列表。单次最多支持 200 条转发规则。 */ RuleIds: Array<string>; } /** * DescribeOriginGroup返回参数结构体 */ export interface DescribeOriginGroupResponse { /** * 记录总数。 */ TotalCount?: number; /** * 源站组信息。 */ OriginGroups?: Array<OriginGroup>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeSecurityIPGroupInfo返回参数结构体 */ export interface DescribeSecurityIPGroupInfoResponse { /** * 返回的满足条件的 IP 组数量。 */ TotalCount?: number; /** * IP 组的详细配置信息。包含每个 IP 组的 ID 、名称和 IP /网段列表信息。 */ IPGroups?: Array<IPGroup>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 慢速攻击配置。 */ export interface SlowPostConfig { /** * 开关,取值有: <li>on:开启;</li> <li>off:关闭。</li> */ Switch: string; /** * 首包配置。 注意:此字段可能返回 null,表示取不到有效值。 */ FirstPartConfig?: FirstPartConfig; /** * 基础配置。 注意:此字段可能返回 null,表示取不到有效值。 */ SlowRateConfig?: SlowRateConfig; /** * 慢速攻击的处置动作,取值有: <li>monitor:观察;</li> <li>drop:拦截。</li> 注意:此字段可能返回 null,表示取不到有效值。 */ Action?: string; /** * 本规则的Id。 注意:此字段可能返回 null,表示取不到有效值。 */ RuleId?: number; } /** * 源站组记录 */ export interface OriginRecord { /** * 源站记录值,不包含端口信息,可以为:IPv4,IPv6,域名格式。 */ Record: string; /** * 源站类型,取值有: <li>IP_DOMAIN:IPV4、IPV6、域名类型源站;</li> <li>COS:COS源。</li> <li>AWS_S3:AWS S3对象存储源站。</li> */ Type?: string; /** * 源站记录ID。 */ RecordId?: string; /** * 源站权重,取值为0-100, 不填表示不设置权重,由系统自由调度,填0表示权重为0, 流量将不会调度到此源站。 注意:此字段可能返回 null,表示取不到有效值。 */ Weight?: number; /** * 是否私有鉴权,当源站类型 RecordType=COS/AWS_S3 时生效,取值有: <li>true:使用私有鉴权;</li> <li>false:不使用私有鉴权。</li>不填写,默认值为:false。 */ Private?: boolean; /** * 私有鉴权参数,当源站类型Private=true时有效。 */ PrivateParameters?: Array<PrivateParameter>; } /** * 智能压缩配置。 */ export interface CompressionParameters { /** * 智能压缩配置开关,取值有: <li>on:开启;</li> <li>off:关闭。</li> */ Switch?: string; /** * 支持的压缩算法列表。当 Switch 为 on 时,此字段必填,否则此字段不生效。取值有: <li>brotli:brotli 算法;</li> <li>gzip:gzip 算法。</li> */ Algorithms?: Array<string>; } /** * DescribeConfigGroupVersionDetail返回参数结构体 */ export interface DescribeConfigGroupVersionDetailResponse { /** * 版本信息。 */ ConfigGroupVersionInfo?: ConfigGroupVersionInfo; /** * 版本文件的内容。以 JSON 格式返回。 */ Content?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 加速域名源站信息。 */ export interface OriginDetail { /** * 源站类型,取值有: <li>IP_DOMAIN:IPV4、IPV6 或域名类型源站;</li> <li>COS:腾讯云 COS 对象存储源站;</li> <li>AWS_S3:AWS S3 对象存储源站;</li> <li>ORIGIN_GROUP:源站组类型源站;</li> <li>VOD:云点播;</li> <li>SPACE:源站卸载,当前仅白名单开放;</li> <li>LB:负载均衡,当前仅白名单开放。</li> */ OriginType?: string; /** * 源站地址,根据 OriginType 的取值分为以下情况: <li>当 OriginType = IP_DOMAIN 时,该参数为 IPv4、IPv6 地址或域名;</li> <li>当 OriginType = COS 时,该参数为 COS 桶的访问域名;</li> <li>当 OriginType = AWS_S3,该参数为 S3 桶的访问域名;</li> <li>当 OriginType = ORIGIN_GROUP 时,该参数为源站组 ID;</li> <li>当 OriginType = VOD 时,该参数请填写云点播应用 ID ;</li> */ Origin?: string; /** * 备用源站组 ID,该参数仅在 OriginType = ORIGIN_GROUP 且配置了备源站组时会生效。 */ BackupOrigin?: string; /** * 主源源站组名称,当 OriginType = ORIGIN_GROUP 时该参数会返回值。 */ OriginGroupName?: string; /** * 备用源站组名称,该参数仅当 OriginType = ORIGIN_GROUP 且配置了备用源站组时会生效。 */ BackOriginGroupName?: string; /** * 指定是否允许访问私有对象存储源站,该参数仅当源站类型OriginType = COS 或 AWS_S3 时会生效,取值有: <li>on:使用私有鉴权;</li> <li>off:不使用私有鉴权。</li> 不填写,默认值为 off。 */ PrivateAccess?: string; /** * 私有鉴权使用参数,该参数仅当源站类型 PrivateAccess = on 时会生效。 注意:此字段可能返回 null,表示取不到有效值。 */ PrivateParameters?: Array<PrivateParameter>; /** * MO 子应用 ID * @deprecated */ VodeoSubAppId?: number; /** * MO 分发范围,取值有: <li>All:全部</li> <li>Bucket:存储桶</li> * @deprecated */ VodeoDistributionRange?: string; /** * MO 存储桶 ID,分发范围(DistributionRange)为存储桶(Bucket)时必填 * @deprecated */ VodeoBucketId?: string; /** * 云点播回源范围,当 OriginType = VOD 时该参数会返回值。取值有:<li>all:当前源站对应的云点播应用内所有文件,默认值为 all;</li> <li>bucket:当前源站对应的云点播应用下指定某一个存储桶内的文件。通过参数 VodBucketId 来指定存储桶。 </li> */ VodOriginScope?: string; /** * 云点播存储桶 ID,该参数当 OriginType = VOD 且 VodOriginScope = bucket 时必填。数据来源:云点播专业版应用下存储桶的存储 ID 。 */ VodBucketId?: string; } /** * HTTP 头部设置规则。 */ export interface HeaderAction { /** * HTTP 头部设置方式。取值有: <li>set:设置。变更指定头部参数的取值为设置后的值;</li> <li>del:删除。删除指定的头部参数;</li> <li>add:增加。增加指定的头部参数。</li> */ Action: string; /** * HTTP 头部名称。 */ Name: string; /** * HTTP 头部值。当 Action 取值为 set 或者 add 时,该参数必填;当 Action 取值为 del 时,该参数无需填写。 */ Value?: string; } /** * 实时日志投递任务。 */ export interface RealtimeLogDeliveryTask { /** * 实时日志投递任务 ID。 */ TaskId?: string; /** * 实时日志投递任务的名称。 */ TaskName?: string; /** * 实时日志投递任务的状态,取值有: <li>enabled: 已启用;</li> <li>disabled: 已停用;</li><li>deleted: 异常删除状态,请检查目的地腾讯云 CLS 日志集/日志主题是否已被删除。</li> */ DeliveryStatus?: string; /** * 实时日志投递任务类型,取值有: <li>cls: 推送到腾讯云 CLS;</li> <li>custom_endpoint:推送到自定义 HTTP(S) 地址;</li> <li>s3:推送到 AWS S3 兼容存储桶地址。</li> */ TaskType?: string; /** * 实时日志投递任务对应的实体(七层域名或者四层代理实例)列表。取值示例如下: <li>七层域名:domain.example.com;</li> <li>四层代理实例:sid-2s69eb5wcms7。</li> */ EntityList?: Array<string>; /** * 数据投递类型,取值有: <li>domain:站点加速日志;</li> <li>application:四层代理日志;</li> <li>web-rateLiming:速率限制和 CC 攻击防护日志;</li> <li>web-attack:托管规则日志;</li> <li>web-rule:自定义规则日志;</li> <li>web-bot:Bot管理日志。</li> */ LogType?: string; /** * 数据投递区域,取值有: <li>mainland:中国大陆境内;</li> <li>overseas:全球(不含中国大陆)。</li> */ Area?: string; /** * 投递的预设字段列表。 */ Fields?: Array<string>; /** * 投递的自定义字段列表。 */ CustomFields?: Array<CustomField>; /** * 日志投递的过滤条件。 */ DeliveryConditions?: Array<DeliveryCondition>; /** * 采样比例,采用千分制,取值范围为1-1000,例如:605 表示采样比例为 60.5%。 */ Sample?: number; /** * 日志投递的输出格式。出参为 null 时表示为默认格式,默认格式逻辑如下: <li>当 TaskType 取值为 custom_endpoint 时,默认格式为多个 JSON 对象组成的数组,每个 JSON 对象为一条日志;</li> <li>当 TaskType 取值为 s3 时,默认格式为 JSON Lines。</li> 注意:此字段可能返回 null,表示取不到有效值。 */ LogFormat?: LogFormat; /** * CLS 的配置信息。 注意:此字段可能返回 null,表示取不到有效值。 */ CLS?: CLSTopic; /** * 自定义 HTTP 服务的配置信息。 注意:此字段可能返回 null,表示取不到有效值。 */ CustomEndpoint?: CustomEndpoint; /** * AWS S3 兼容存储桶的配置信息。 注意:此字段可能返回 null,表示取不到有效值。 */ S3?: S3; /** * 创建时间。 */ CreateTime?: string; /** * 更新时间。 */ UpdateTime?: string; } /** * 预付费套餐计费参数 */ export interface PrepaidPlanParam { /** * 订阅预付费套餐的周期,单位:月,取值有:1,2,3,4,5,6,7,8,9,10,11,12,24,36。 不填写使用默认值 1。 */ Period?: number; /** * 预付费套餐的自动续费标志,取值有: <li> on:开启自动续费;</li> <li> off:不开启自动续费。</li> 不填写使用默认值 off,自动续费时,默认续费1个月。 */ RenewFlag?: string; } /** * 访问 URL 重定向 配置参数。 */ export interface AccessURLRedirectQueryString { /** * 执行动作,取值有: <li>full:全部保留;</li> <li>ignore:全部忽略。</li> */ Action?: string; } /** * ModifyFunctionRulePriority请求参数结构体 */ export interface ModifyFunctionRulePriorityRequest { /** * 站点 ID。 */ ZoneId: string; /** * 规则 ID 列表,必须填入调整优先级后的所有规则 ID,多条规则执行顺序依次从上往下,不填写保持原优先级顺序。 */ RuleIds: Array<string>; } /** * ModifyAccelerationDomain返回参数结构体 */ export interface ModifyAccelerationDomainResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * TopN数据Entry */ export interface TopEntryValue { /** * 排序实体名。 */ Name: string; /** * 排序实体数量。 */ Count: number; } /** * DescribeHostsSetting返回参数结构体 */ export interface DescribeHostsSettingResponse { /** * 域名列表。 */ DetailHosts?: Array<DetailHost>; /** * 域名数量。 */ TotalNumber?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 源站配置。 */ export interface Origin { /** * 主源站列表。 注意:此字段可能返回 null,表示取不到有效值。 */ Origins?: Array<string>; /** * 备源站列表。 注意:此字段可能返回 null,表示取不到有效值。 */ BackupOrigins?: Array<string>; /** * 回源协议配置,取值有: <li>http:强制 http 回源;</li> <li>follow:协议跟随回源;</li> <li>https:强制 https 回源。</li> 注意:此字段可能返回 null,表示取不到有效值。 */ OriginPullProtocol?: string; /** * 源站为腾讯云 COS 时,是否为私有访问 bucket,取值有: <li>on:私有访问;</li> <li>off:公共访问。</li> 注意:此字段可能返回 null,表示取不到有效值。 */ CosPrivateAccess?: string; } /** * DescribeRules返回参数结构体 */ export interface DescribeRulesResponse { /** * 站点 ID。 */ ZoneId?: string; /** * 规则列表,按规则执行顺序从先往后排序。 */ RuleItems?: Array<RuleItem>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 时序数据信息 */ export interface TimingDataRecord { /** * 查询维度值。 */ TypeKey: string; /** * 详细时序数据。 */ TypeValue: Array<TimingTypeValue>; } /** * CreateCLSIndex返回参数结构体 */ export interface CreateCLSIndexResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeRealtimeLogDeliveryTasks请求参数结构体 */ export interface DescribeRealtimeLogDeliveryTasksRequest { /** * 站点 ID。 */ ZoneId: string; /** * 分页查询偏移量。默认值:0。 */ Offset?: number; /** * 分页查询限制数目。默认值:20,最大值:1000。 */ Limit?: number; /** * 过滤条件,Filters.Values 的上限为 20。该参数不填写时,返回当前 zone-id 下所有实时日志投递任务信息。详细的过滤条件如下: <li>task-id:按照实时日志投递任务 ID进行过滤。不支持模糊查询。</li> <li>task-name:按照实时日志投递任务名称进行过滤。支持模糊查询,使用模糊查询时,仅支持填写一个实时日志投递任务名称。</li> <li>entity-list:按照实时日志投递任务对应的实体进行过滤。不支持模糊查询。示例值:domain.example.com 或者 sid-2s69eb5wcms7。</li> <li>task-type:按照实时日志投递任务类型进行过滤。不支持模糊查询。可选项如下:<br>   cls: 推送到腾讯云 CLS;<br>   custom_endpoint:推送到自定义 HTTP(S) 地址;<br>   s3:推送到 AWS S3 兼容存储桶地址。</li> */ Filters?: Array<AdvancedFilter>; } /** * DescribeOriginProtection返回参数结构体 */ export interface DescribeOriginProtectionResponse { /** * 源站防护信息。 注意:此字段可能返回 null,表示取不到有效值。 */ OriginProtectionInfo?: Array<OriginProtectionInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeBillingData请求参数结构体 */ export interface DescribeBillingDataRequest { /** * 起始时间。 */ StartTime: string; /** * 结束时间。 */ EndTime: string; /** * 站点 ID 集合,此参数必填。 */ ZoneIds: Array<string>; /** * 指标列表,取值有: <li>acc_flux: 内容加速流量,单位为 Byte;</li> <li>smt_flux: 智能加速流量,单位为 Byte;</li> <li>l4_flux: 四层加速流量,单位为 Byte;</li> <li>sec_flux: 独立防护流量,单位为 Byte;</li> <li>zxctg_flux: 中国大陆网络优化流量,单位为 Byte;</li> <li>acc_bandwidth: 内容加速带宽,单位为 bps;</li> <li>smt_bandwidth: 智能加速带宽,单位为 bps;</li> <li>l4_bandwidth: 四层加速带宽,单位为 bps;</li> <li>sec_bandwidth: 独立防护带宽,单位为 bps;</li> <li>zxctg_bandwidth: 中国大陆网络优化带宽,单位为 bps;</li> <li>sec_request_clean: HTTP/HTTPS 请求,单位为次;</li> <li>smt_request_clean: 智能加速请求,单位为次;</li> <li>quic_request: QUIC 请求,单位为次;</li> <li>bot_request_clean: Bot 请求,单位为次;</li> <li>cls_count: 实时日志推送条数,单位为条;</li> <li>ddos_bandwidth: 弹性 DDoS 防护带宽,单位为 bps;</li> <li>total_transcode:所有规格音频,视频即时转码,转封装时长,单位为秒;</li> <li>remux:转封装时长,单位为秒;</li> <li>transcode_audio:音频转码时长,单位为秒;</li> <li>transcode_H264_SD:H.264 编码方式的标清视频(短边 <= 480 px)时长,单位为秒;</li> <li>transcode_H264_HD:H.264 编码方式的高清视频(短边 <= 720 px)时长,单位为秒;</li> <li>transcode_H264_FHD:H.264 编码方式的全高清视频(短边 <= 1080 px)时长,单位为秒;</li> <li>transcode_H264_2K:H.264 编码方式的 2K 视频(短边 <= 1440 px)时长,单位为秒。</li> */ MetricName: string; /** * 查询时间粒度,取值有: <li>5min:5 分钟粒度;</li> <li>hour:1 小时粒度;</li> <li>day:1 天粒度。</li> */ Interval: string; /** * 过滤条件,详细的过滤条件取值如下: <li>host:按照域名进行过滤。示例值:test.example.com。<br></li> <li>proxy-id:按照四层代理实例 ID 进行过滤。示例值:sid-2rugn89bkla9。<br></li> <li>region-id:按照计费大区进行过滤。可选项如下:<br>  CH:中国大陆境内<br>  AF:非洲<br>  AS1:亚太一区<br>  AS2:亚太二区<br>  AS3:亚太三区<br>  EU:欧洲<br>  MidEast:中东<br>  NA:北美<br>  SA:南美</li> */ Filters?: Array<BillingDataFilter>; } /** * 实时日志投递的输出格式。您可以直接通过 FormatType 参数使用指定预设日志输出格式(JSON Lines / csv),也可以在预设日志输出格式基础上,通过其他参数来自定义变体输出格式。 */ export interface LogFormat { /** * 日志投递的预设输出格式类型,取值有: <li>json:使用预设日志输出格式 JSON Lines,单条日志中的字段以键值对方式呈现;</li> <li>csv:使用预设日志输出格式 csv,单条日志中仅呈现字段值,不呈现字段名称。</li> */ FormatType: string; /** * 在每个日志投递批次之前添加的字符串。每个日志投递批次可能包含多条日志记录。 */ BatchPrefix?: string; /** * 在每个日志投递批次后附加的字符串。 */ BatchSuffix?: string; /** * 在每条日志记录之前添加的字符串。 */ RecordPrefix?: string; /** * 在每条日志记录后附加的字符串。 */ RecordSuffix?: string; /** * 插入日志记录之间作为分隔符的字符串,取值有: <li>\n:换行符;</li> <li>\t:制表符;</li> <li>,:半角逗号。</li> */ RecordDelimiter?: string; /** * 单条日志记录内,插入字段之间作为分隔符的字符串,取值有: <li>\t:制表符;</li> <li>,:半角逗号;</li> <li>;:半角分号。</li> */ FieldDelimiter?: string; } /** * DescribeEnvironments请求参数结构体 */ export interface DescribeEnvironmentsRequest { /** * 站点 ID。 */ ZoneId: string; } /** * DescribeAliasDomains请求参数结构体 */ export interface DescribeAliasDomainsRequest { /** * 站点 ID。 */ ZoneId: string; /** * 分页查询偏移量。默认值:0。 */ Offset?: number; /** * 分页查询限制数目。默认值:20,最大值:1000。 */ Limit?: number; /** * 过滤条件,Filters.Values的上限为20。详细的过滤条件如下: <li>target-name:目标域名名称进行过滤;</li> <li>alias-name:按照别称域名名称进行过滤。</li>模糊查询时仅支持过滤字段名为 alias-name。 */ Filters?: Array<AdvancedFilter>; } /** * QUIC 配置项。 */ export interface QUICParameters { /** * QUIC 配置开关,取值有: <li>on:开启;</li> <li>off:关闭。</li> */ Switch?: string; } /** * 托管规则组信息 */ export interface ManagedRuleGroupMeta { /** * 托管规则组描述,仅出参。 */ GroupDetail?: string; /** * 托管规则组名称,仅出参。 */ GroupName?: string; /** * 当前托管规则组下的所有子规则信息,仅出参。 */ RuleDetails?: Array<ManagedRuleDetail>; } /** * 速率限制规则 */ export interface RateLimitConfig { /** * 开关,取值有: <li>on:开启;</li> <li>off:关闭。</li> */ Switch: string; /** * 速率限制-用户规则列表。如果为null,默认使用历史配置。 */ RateLimitUserRules?: Array<RateLimitUserRule>; /** * 速率限制模板功能。如果为null,默认使用历史配置。 注意:此字段可能返回 null,表示取不到有效值。 */ RateLimitTemplate?: RateLimitTemplate; /** * 智能客户端过滤。如果为null,默认使用历史配置。 注意:此字段可能返回 null,表示取不到有效值。 */ RateLimitIntelligence?: RateLimitIntelligence; /** * 速率限制-托管定制规则。如果为null,默认使用历史配置。 注意:此字段可能返回 null,表示取不到有效值。 */ RateLimitCustomizes?: Array<RateLimitUserRule>; } /** * CreateRealtimeLogDeliveryTask请求参数结构体 */ export interface CreateRealtimeLogDeliveryTaskRequest { /** * 站点 ID。 */ ZoneId: string; /** * 实时日志投递任务的名称,格式为数字、英文、-和_组合,最多 200 个字符。 */ TaskName: string; /** * 实时日志投递任务类型,取值有: <li>cls: 推送到腾讯云 CLS;</li> <li>custom_endpoint:推送到自定义 HTTP(S) 地址;</li> <li>s3:推送到 AWS S3 兼容存储桶地址。</li> */ TaskType: string; /** * 实时日志投递任务对应的实体(七层域名或者四层代理实例)列表。取值示例如下: <li>七层域名:domain.example.com;</li> <li>四层代理实例:sid-2s69eb5wcms7。</li> */ EntityList: Array<string>; /** * 数据投递类型,取值有: <li>domain:站点加速日志;</li> <li>application:四层代理日志;</li> <li>web-rateLiming:速率限制和 CC 攻击防护日志;</li> <li>web-attack:托管规则日志;</li> <li>web-rule:自定义规则日志;</li> <li>web-bot:Bot管理日志。</li> */ LogType: string; /** * 数据投递区域,取值有: <li>mainland:中国大陆境内;</li> <li>overseas:全球(不含中国大陆)。</li> */ Area: string; /** * 投递的预设字段列表。 */ Fields: Array<string>; /** * 投递的自定义字段列表,支持在 HTTP 请求头、响应头、Cookie、请求正文中提取指定内容。自定义字段名称不能重复,且最多不能超过 200 个字段。单个实时日志推送任务最多添加 5 个请求正文类型的自定义字段。目前仅站点加速日志(LogType=domain)支持添加自定义字段。 */ CustomFields?: Array<CustomField>; /** * 日志投递的过滤条件,不填表示投递全量日志。 */ DeliveryConditions?: Array<DeliveryCondition>; /** * 采样比例,采用千分制,取值范围为1-1000,例如:填写 605 表示采样比例为 60.5%。不填表示采样比例为 100%。 */ Sample?: number; /** * 日志投递的输出格式。不填表示为默认格式,默认格式逻辑如下: <li>当 TaskType 取值为 custom_endpoint 时,默认格式为多个 JSON 对象组成的数组,每个 JSON 对象为一条日志;</li> <li>当 TaskType 取值为 s3 时,默认格式为 JSON Lines;</li>特别地,当 TaskType 取值为 cls 时,LogFormat.FormatType 的值只能为 json,且 LogFormat 中其他参数将被忽略,建议不传 LogFormat。 */ LogFormat?: LogFormat; /** * CLS 的配置信息。当 TaskType 取值为 cls 时,该参数必填。 */ CLS?: CLSTopic; /** * 自定义 HTTP 服务的配置信息。当 TaskType 取值为 custom_endpoint 时,该参数必填。 */ CustomEndpoint?: CustomEndpoint; /** * AWS S3 兼容存储桶的配置信息。当 TaskType 取值为 s3 时,该参数必填。 */ S3?: S3; } /** * ModifyAccelerationDomainStatuses返回参数结构体 */ export interface ModifyAccelerationDomainStatusesResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 配置组版本发布记录详情。 */ export interface DeployRecord { /** * 发布版本的详细信息。 */ ConfigGroupVersionInfos?: Array<ConfigGroupVersionInfo>; /** * 发布时间。时间为世界标准时间(UTC), 遵循 ISO 8601 标准的日期和时间格式。 */ DeployTime?: string; /** * 发布状态,取值有: <li> deploying :发布中;</li> <li>failure :发布失败;</li> <li>success: 发布成功。</li> */ Status?: string; /** * 发布结果信息。 */ Message?: string; /** * 发布记录 ID。 注意:此字段可能返回 null,表示取不到有效值。 */ RecordId?: string; /** * 变更说明。 */ Description?: string; } /** * 规则引擎参数详情信息,特殊参数类型。 */ export interface RuleExtraParameter { /** * 参数名,取值有: <li> Action:修改 HTTP 头部所需参数,RuleAction 选择 RewirteAction;</li> <li> StatusCode:状态码相关功能所需参数,RuleAction 选择 CodeAction。</li> */ Id: string; /** * 参数值类型。 <li> CHOICE:参数值只能在 Values 中选择; </li> <li> CUSTOM_NUM:参数值用户自定义,整型类型;</li> <li> CUSTOM_STRING:参数值用户自定义,字符串类型。</li> */ Type: string; /** * 可选参数值。 注意:当 Id 的值为 StatusCode 时数组中的值为整型,填写参数值时请填写字符串的整型数值。 */ Choices: Array<string>; } /** * ModifyL7AccRulePriority请求参数结构体 */ export interface ModifyL7AccRulePriorityRequest { /** * 站点 ID。 */ ZoneId: string; /** * 站点 ID 下完整的规则 ID 列表,规则 ID 列表可以通过 [查询七层加速规则](https://cloud.tencent.com/document/product/1552/115820) 获取,最终优先级顺序将调整成规则 ID 列表的顺序,从前往后依次执行。 */ RuleIds: Array<string>; } /** * WebSocket配置 */ export interface WebSocket { /** * WebSocket 超时时间配置开关,取值有: <li>on:使用Timeout作为WebSocket超时时间;</li> <li>off:平台仍支持WebSocket连接,此时使用系统默认的15秒为超时时间。</li> */ Switch: string; /** * 超时时间,单位为秒,最大超时时间120秒。 */ Timeout?: number; } /** * ModifyAccelerationDomain请求参数结构体 */ export interface ModifyAccelerationDomainRequest { /** * 加速域名所属站点ID。 */ ZoneId: string; /** * 加速域名名称。 */ DomainName: string; /** * 源站信息。 */ OriginInfo?: OriginInfo; /** * 回源协议,取值有: <li>FOLLOW: 协议跟随;</li> <li>HTTP: HTTP协议回源;</li> <li>HTTPS: HTTPS协议回源。</li> <li>不填保持原有配置。</li> */ OriginProtocol?: string; /** * HTTP回源端口,取值为1-65535,当OriginProtocol=FOLLOW/HTTP时生效, 不填保持原有配置。 */ HttpOriginPort?: number; /** * HTTPS回源端口,取值为1-65535,当OriginProtocol=FOLLOW/HTTPS时生效,不填保持原有配置。 */ HttpsOriginPort?: number; /** * IPv6状态,取值有: <li>follow:遵循站点IPv6配置;</li> <li>on:开启状态;</li> <li>off:关闭状态。</li> <li>不填保持原有配置。</li> */ IPv6Status?: string; } /** * ModifyContentIdentifier返回参数结构体 */ export interface ModifyContentIdentifierResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Waf配置。 */ export interface WafConfig { /** * WafConfig开关,取值有: <li> on:开启;</li> <li> off:关闭。</li>开关仅与配置是否生效有关,即使为off(关闭),也可以正常修改配置的内容。 */ Switch: string; /** * 上一次设置的防护级别,取值有: <li> loose:宽松;</li> <li> normal:正常;</li> <li> strict:严格;</li> <li> stricter:超严格;</li> <li> custom:自定义。</li> */ Level: string; /** * 全局WAF模式,取值有: <li> block:阻断(全局阻断,但可对详细规则配置观察);</li> <li> observe:观察(无论详细规则配置什么,都为观察)。</li> */ Mode: string; /** * 托管规则详细配置。如果为null,默认使用历史配置。 */ WafRule?: WafRule; /** * AI规则引擎防护配置。如果为null,默认使用历史配置。 */ AiRule?: AiRule; } /** * CreateAliasDomain请求参数结构体 */ export interface CreateAliasDomainRequest { /** * 站点 ID。 */ ZoneId: string; /** * 别称域名名称。 */ AliasName: string; /** * 目标域名名称。 */ TargetName: string; /** * 证书配置,取值有: <li> none:不配置;</li> <li> hosting:SSL托管证书。</li>默认取值为 none。 */ CertType?: string; /** * 当 CertType 取值为 hosting 时需填入相应证书 ID。 */ CertId?: Array<string>; } /** * 实时日志投递到腾讯云 CLS 的配置信息。 */ export interface CLSTopic { /** * 腾讯云 CLS 日志集 ID。 */ LogSetId: string; /** * 腾讯云 CLS 日志主题 ID。 */ TopicId: string; /** * 腾讯云 CLS 日志集所在的地域。 */ LogSetRegion: string; } /** * CreatePrefetchTask请求参数结构体 */ export interface CreatePrefetchTaskRequest { /** * 站点 ID。 若您希望快速提交不同站点下的 Targets Url,可以将其填写为 *,但前提是调用该 API 的账号必须具备主账号下全部站点资源的权限。 */ ZoneId: string; /** * 要预热的资源列表,每个元素格式类似如下: http://www.example.com/example.txt。参数值当前必填。 注意:提交任务数受计费套餐配额限制,请查看 [EO计费套餐](https://cloud.tencent.com/document/product/1552/77380)。 */ Targets?: Array<string>; /** * 是否对url进行encode,若内容含有非 ASCII 字符集的字符,请开启此开关进行编码转换(编码规则遵循 RFC3986)。 * @deprecated */ EncodeUrl?: boolean; /** * 附带的http头部信息。 */ Headers?: Array<Header>; } /** * DescribeApplicationProxies返回参数结构体 */ export interface DescribeApplicationProxiesResponse { /** * 应用代理列表。 */ ApplicationProxies?: Array<ApplicationProxy>; /** * 记录总数。 */ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 自定义 nameservers */ export interface VanityNameServers { /** * 自定义 ns 开关,取值有: <li> on:开启;</li> <li> off:关闭。</li> */ Switch: string; /** * 自定义 ns 列表。 */ Servers?: Array<string>; } /** * DescribeTopL7AnalysisData请求参数结构体 */ export interface DescribeTopL7AnalysisDataRequest { /** * 开始时间。 */ StartTime: string; /** * 结束时间。 */ EndTime: string; /** * 查询的指标,取值有: <li> l7Flow_outFlux_country:按国家/地区维度统计 L7 EdgeOne 响应流量指标;</li> <li> l7Flow_outFlux_province:按中国大陆境内省份维度统计 L7 EdgeOne 响应流量指标;</li> <li> l7Flow_outFlux_statusCode:按状态码维度统计 L7 EdgeOne 响应流量指标;</li> <li> l7Flow_outFlux_domain:按域名维度统计 L7 EdgeOne 响应流量指标;</li> <li> l7Flow_outFlux_url:按 URL Path 维度统计 L7 EdgeOne 响应流量指标; </li> <li> l7Flow_outFlux_resourceType:按资源类型维度统计 L7 EdgeOne 响应流量指标;</li> <li> l7Flow_outFlux_sip:按客户端 IP 维度统计 L7 EdgeOne 响应流量指标;</li> <li> l7Flow_outFlux_referers:按 Referer 维度统计 L7 EdgeOne 响应流量指标;</li> <li> l7Flow_outFlux_ua_device:按设备类型维度统计 L7 EdgeOne 响应流量指标; </li> <li> l7Flow_outFlux_ua_browser:按浏览器类型维度统计 L7 EdgeOne 响应流量指标;</li> <li> l7Flow_outFlux_ua_os:按操作系统类型维度统计 L7 EdgeOne 响应流量指标;</li> <li> l7Flow_outFlux_ua:按 User-Agent 维度统计 L7 EdgeOne 响应流量指标;</li> <li> l7Flow_request_country:按国家/地区维度统计 L7 访问请求数指标;</li> <li> l7Flow_request_province:按中国大陆境内省份维度统计 L7 访问请求数指标;</li> <li> l7Flow_request_statusCode:按状态码维度统计 L7 访问请求数指标;</li> <li> l7Flow_request_domain:按域名维度统计 L7 访问请求数指标;</li> <li> l7Flow_request_url:按 URL Path 维度统计 L7 访问请求数指标; </li> <li> l7Flow_request_resourceType:按资源类型维度统计 L7 访问请求数指标;</li> <li> l7Flow_request_sip:按客户端 IP 维度统计 L7 访问请求数指标;</li> <li> l7Flow_request_referer:按 Referer 维度统计 L7 访问请求数指标;</li> <li> l7Flow_request_ua_device:按设备类型维度统计 L7 访问请求数指标; </li> <li> l7Flow_request_ua_browser:按浏览器类型维度统计 L7 访问请求数指标;</li> <li> l7Flow_request_ua_os:按操作系统类型维度统计 L7 访问请求数指标;</li> <li> l7Flow_request_ua:按 User-Agent 维度统计 L7 访问请求数指标。</li> */ MetricName: string; /** * 站点 ID 集合,此参数必填。 */ ZoneIds?: Array<string>; /** * 查询前多少个 top 数据,最大值为1000。不填默认为10,表示查询 top10 的数据。 */ Limit?: number; /** * 过滤条件,详细的过滤条件 Key 值如下: <li>country:按照国家/地区进行过滤,国家/地区遵循 <a href="https://baike.baidu.com/item/ISO%203166-1/5269555">ISO 3166-1 alpha-2</a> 规范。示例值:CN。</li> <li>province:按照省份进行过滤,此参数只支持服务区域为中国大陆。省份代码参考<a href="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">境内省份映射表</a>,示例值:22。</li> <li>isp:按照运营商进行过滤,此参数只支持服务区域为中国大陆。对应的 Value 可选项如下:<br>   2:中国电信;<br>   26:中国联通;<br>   1046:中国移动;<br>   3947:中国铁通;<br>   38:教育网;<br>   43:长城宽带;<br>   0:其他运营商。</li> <li>domain:按照子域名进行过滤,示例值: www.example.com。</li> <li>url:按照 URL Path 进行过滤,示例值:/content 或 /content/test.jpg。若填写 url 参数,则最多可查询近 30 天的数据。</li> <li>referer:按照 Referer 请求头部进行过滤,示例值:http://www.example.com/。若填写 referer 参数,则最多可查询近 30 天的数据;</li> <li>resourceType:按照资源类型进行过滤,资源类型一般是文件后缀,示例值:.jpg。若填写 resourceType 参数,则最多可查询近 30 天的数据;</li> <li>protocol:按照 HTTP 协议版本进行过滤。对应的 Value 可选项如下:<br>   HTTP/1.0;<br>   HTTP/1.1;<br>   HTTP/2.0;<br>   HTTP/3;<br>   WebSocket。</li> <li>socket:按照 HTTP协议类型进行过滤。对应的 Value 可选项如下:<br>   HTTP:HTTP 协议;<br>   HTTPS:HTTPS 协议;<br>   QUIC:QUIC 协议。</li> <li>statusCode:按照边缘状态码进行过滤。若填写 statusCode 参数,则最多可查询近 30 天的数据。对应的 Value 可选项如下:<br>   1XX:1xx类型的状态码;<br>   2XX:2xx类型的状态码;<br>   3XX:3xx类型的状态码;<br>   4XX:4xx类型的状态码;<br>   5XX:5xx类型的状态码;<br>   在 [0,600) 范围内的整数。</li> <li>browserType:按照浏览器类型进行过滤。若填写 browserType 参数,则最多可查询近 30 天的数据。对应 Value 的可选项如下:<br>   Firefox:Firefox浏览器;<br>   Chrome:Chrome浏览器;<br>   Safari:Safari浏览器;<br>   Other:其他浏览器类型;<br>   Empty:浏览器类型为空;<br>   Bot:搜索引擎爬虫;<br>   MicrosoftEdge:MicrosoftEdge浏览器;<br>   IE:IE浏览器;<br>   Opera:Opera浏览器;<br>   QQBrowser:QQ浏览器;<br>   LBBrowser:LB浏览器;<br>   MaxthonBrowser:Maxthon浏览器;<br>   SouGouBrowser:搜狗浏览器;<br>   BIDUBrowser:百度浏览器;<br>   TaoBrowser:淘浏览器;<br>   UBrowser:UC浏览器。</li> <li>deviceType:按照设备类型进行过滤。若填写 deviceType 参数,则最多可查询近 30 天的数据。对应 Value 的可选项如下:<br>   TV:TV设备;<br>   Tablet:Tablet设备;<br>   Mobile:Mobile设备;<br>   Desktop:Desktop设备;<br>   Other:其他设备类型;<br>   Empty:设备类型为空。</li> <li>operatingSystemType:按照操作系统类型进行过滤。若填写 operatingSystemType 参数,则最多可查询近 30 天的数据。对应 Value 的可选项如下:<br>   Linux:Linux操作系统;<br>   MacOS:MacOs操作系统;<br>   Android:Android操作系统;<br>   IOS:IOS操作系统;<br>   Windows:Windows操作系统;<br>   NetBSD:NetBSD;<br>   ChromiumOS:ChromiumOS;<br>   Bot:搜索引擎爬虫;<br>   Other:其他类型的操作系统;<br>   Empty:操作系统为空。</li> <li>tlsVersion:按照 TLS 版本进行过滤。若填写 tlsVersion 参数,则最多可查询近 30 天的数据。对应 Value 的可选项如下:<br>   TLS1.0;<br>   TLS1.1;<br>   TLS1.2;<br>   TLS1.3。</li> <li>ipVersion:按照 IP 版本进行过滤。对应 Value 的可选项如下:<br>   4:IPv4;<br>   6:IPv6。</li> <li>cacheType:按照缓存状态进行过滤。对应 Value 的可选项如下:<br>   hit:请求命中 EdgeOne 节点缓存,资源由节点缓存提供。资源部分命中缓存也会记录为 hit。<br>   miss:请求未命中 EdgeOne 节点缓存,资源由源站提供。<br>   dynamic:请求的资源无法缓存/未配置被节点缓存,资源由源站提供。<br>   other:无法被识别的缓存状态。边缘函数响应的请求会记录为 other。</li> <li>clientIp:按照客户端 IP 进行过滤。若填写 clientIp 参数,则最多可查询近 30 天的数据。</li> <li>userAgent:按照 User-Agent 请求头部进行过滤。若填写 userAgent 参数,则最多可查询近 30 天的数据。</li> */ Filters?: Array<QueryCondition>; /** * 查询时间粒度,取值有: <li>min: 1分钟;</li> <li>5min: 5分钟;</li> <li>hour: 1小时;</li> <li>day: 1天。</li>不填将根据开始时间跟结束时间的间距自动推算粒度,具体为:2 小时范围内以 min 粒度查询,2 天范围内以 5min 粒度查询,7 天范围内以 hour 粒度查询,超过 7 天以 day 粒度查询。 */ Interval?: string; /** * 数据归属地区。该参数已废弃。请在 Filters.country 中按客户端地域过滤数据。 */ Area?: string; } /** * DescribeAccelerationDomains返回参数结构体 */ export interface DescribeAccelerationDomainsResponse { /** * 符合查询条件的加速域名个数。 */ TotalCount?: number; /** * 符合查询条件的所有加速域名的信息。 */ AccelerationDomains?: Array<AccelerationDomain>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 功能总开关 */ export interface SwitchConfig { /** * Web类型的安全总开关,取值有: <li>on:开启;</li> <li>off:关闭。</li>不影响DDoS与Bot的开关。 */ WebSwitch: string; } /** * IdentifyZone返回参数结构体 */ export interface IdentifyZoneResponse { /** * 站点归属校验:Dns校验信息。 */ Ascription?: AscriptionInfo; /** * 站点归属权校验:文件校验信息。 */ FileAscription?: FileAscriptionInfo; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 回源请求参数查询字符串配置。 */ export interface UpstreamRequestQueryString { /** * 回源请求参数查询字符串配置开关,取值有: <li>on:开启;</li> <li>off:关闭。</li> */ Switch?: string; /** * 查询字符串模式。当 Switch 为 on 时,该参数必填。取值有: <li>full:全部保留;</li> <li>ignore:全部忽略;</li> <li>includeCustom:保留部分参数;</li> <li>excludeCustom:忽略部分参数。</li> */ Action?: string; /** * 指定参数值。仅当查询字符串模式 Action 为 includeCustom 或者 excludeCustom 时该参数生效,用于指定需要保留或者忽略的参数。最大支持 10 个参数。 */ Values?: Array<string>; } /** * ModifyLoadBalancer返回参数结构体 */ export interface ModifyLoadBalancerResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyL4Proxy返回参数结构体 */ export interface ModifyL4ProxyResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 负载均衡实例健康检查策略。 */ export interface HealthChecker { /** * 健康检查策略,取值有: <li>HTTP;</li> <li>HTTPS;</li> <li>TCP;</li> <li>UDP;</li> <li>ICMP Ping;</li> <li>NoCheck。</li> 注意:NoCheck 表示不启用健康检查策略。 */ Type: string; /** * 检查端口。当 Type=HTTP 或 Type=HTTPS 或 Type=TCP 或 Type=UDP 时为必填。 */ Port?: number; /** * 检查频率,表示多久发起一次健康检查任务,单位为秒。可取值有:30,60,180,300 或 600。 */ Interval?: number; /** * 每一次健康检查的超时时间,若健康检查消耗时间大于此值,则检查结果判定为”不健康“, 单位为秒,默认值为 5s,取值必须小于 Interval。 */ Timeout?: number; /** * 健康阈值,表示连续几次健康检查结果为"健康",则判断源站为"健康",单位为次,默认 3 次,最小取值 1 次。 */ HealthThreshold?: number; /** * 不健康阈值,表示连续几次健康检查结果为"不健康",则判断源站为"不健康",单位为次,默认 2 次。 */ CriticalThreshold?: number; /** * 该参数仅当 Type=HTTP 或 Type=HTTPS 时有效,表示探测路径,需要填写完整的 host/path,不包含协议部分,例如:www.example.com/test。 */ Path?: string; /** * 该参数仅当 Type=HTTP 或 Type=HTTPS 时有效,表示请求方法,取值有: <li>GET;</li> <li>HEAD。</li> */ Method?: string; /** * 该参数仅当 Type=HTTP 或 Type=HTTPS 时有效,表示探测节点向源站发起健康检查时,响应哪些状态码可用于认定探测结果为健康。 */ ExpectedCodes?: Array<string>; /** * 该参数仅当 Type=HTTP 或 Type=HTTPS 时有效,表示探测请求携带的自定义 HTTP 请求头,至多可配置 10 个。 */ Headers?: Array<CustomizedHeader>; /** * 该参数仅当 Type=HTTP 或 Type=HTTPS 时有效,表示是否启用遵循 301/302 重定向。启用后,301/302 默认为"健康"的状态码,默认跳转 3 次。 */ FollowRedirect?: string; /** * 该参数仅当 Type=UDP 时有效,表示健康检查发送的内容。只允许 ASCII 可见字符,最大长度限制 500 个字符。 */ SendContext?: string; /** * 该参数仅当 Type=UDP 时有效,表示健康检查期望源站返回结果。只允许 ASCII 可见字符,最大长度限制 500 个字符。 */ RecvContext?: string; } /** * CreateFunctionRule请求参数结构体 */ export interface CreateFunctionRuleRequest { /** * 站点 ID。 */ ZoneId: string; /** * 规则条件列表,相同触发规则的不同条件匹配项之间为或关系。 */ FunctionRuleConditions: Array<FunctionRuleCondition>; /** * 函数 ID,命中触发规则条件后执行的函数。 */ FunctionId: string; /** * 规则描述,最大支持 60 个字符。 */ Remark?: string; } /** * 子规则分支。 */ export interface RuleBranch { /** * [匹配条件](https://cloud.tencent.com/document/product/1552/90438#33f65828-c6c6-4b66-a011-25a20b548d5d)。 */ Condition?: string; /** * [操作](https://cloud.tencent.com/document/product/1552/90438#c7bd7e02-9247-4a72-b0e4-11c27cadb198)。<br>注意:Actions 和 SubRules 不可同时为空。 注意:此字段可能返回 null,表示取不到有效值。 */ Actions?: Array<RuleEngineAction>; /** * 子规则列表。此列表中时存在多条规则,按照从上往下的顺序依次执行。<br>注意:SubRules 和 Actions 不可同时为空。且当前只支持填写一层 SubRules。 注意:此字段可能返回 null,表示取不到有效值。 */ SubRules?: Array<RuleEngineSubRule>; } /** * DescribeAliasDomains返回参数结构体 */ export interface DescribeAliasDomainsResponse { /** * 符合条件的别称域名个数。 */ TotalCount?: number; /** * 别称域名详细信息列表。 */ AliasDomains?: Array<AliasDomain>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 环境信息。 */ export interface EnvInfo { /** * 环境 ID。 */ EnvId?: string; /** * 环境类型,取值有: <li>production: 生产环境;</li><li>staging: 测试环境。</li> */ EnvType?: string; /** * 环境状态,取值有: <li>creating:创建中;</li> <li>running:稳定运行中,可进行版本变更;</li> <li>version_deploying:版本部署中,不能进行新的变更。</li> */ Status?: string; /** * 当前环境的配置生效范围: <li>当 EnvType 取值为 production 时,该参数值为 ["ALL"],代表全网生效;</li> <li>当 EnvType 取值为 staging 时,会返回测试节点 IP,可用于绑定 host 测试。</li> */ Scope?: Array<string>; /** * 当前环境中各配置组实际生效的版本,根据 Status 的取值有以下两种情况: <li>当 Status 取值为 version_deploying 时,本字段返回的值为执行变更动作之前生效的版本,即新版本部署期间,实际生效的版本为执行变更动作之前的版本;</li> <li>当 Status 取值为 running 时,本字段返回的值即为当前实际生效的版本。</li> */ CurrentConfigGroupVersionInfos?: Array<ConfigGroupVersionInfo>; /** * 创建时间。时间为世界标准时间(UTC), 遵循 ISO 8601 标准的日期和时间格式。 */ CreateTime?: string; /** * 更新时间。时间为世界标准时间(UTC), 遵循 ISO 8601 标准的日期和时间格式。 */ UpdateTime?: string; } /** * ModifyLoadBalancer请求参数结构体 */ export interface ModifyLoadBalancerRequest { /** * 站点 ID。 */ ZoneId: string; /** * 负载均衡实例 ID。 */ InstanceId: string; /** * 实例名称,可输入 1-200 个字符,允许字符为 a-z,A-Z,0-9,_,-。不填写表示维持原有配置。 */ Name?: string; /** * 源站组列表及其对应的容灾调度优先级。详情请参考 [快速创建负载均衡实例](https://cloud.tencent.com/document/product/1552/104223) 中的示例场景。不填写表示维持原有配置。 */ OriginGroups?: Array<OriginGroupInLoadBalancer>; /** * 健康检查策略。详情请参考 [健康检查策略介绍](https://cloud.tencent.com/document/product/1552/104228)。不填写表示维持原有配置。 */ HealthChecker?: HealthChecker; /** * 源站组间的流量调度策略,取值有: <li>Pritory:按优先级顺序进行故障转移 。</li>不填写表示维持原有配置。 */ SteeringPolicy?: string; /** * 实际访问某源站失败时的请求重试策略,详情请参考 [请求重试策略介绍](https://cloud.tencent.com/document/product/1552/104227),取值有: <li>OtherOriginGroup:单次请求失败后,请求优先重试下一优先级源站组;</li> <li>OtherRecordInOriginGroup:单次请求失败后,请求优先重试同源站组内的其他源站。</li>不填写表示维持原有配置。 */ FailoverPolicy?: string; } /** * edgeone套餐信息 */ export interface PlanInfo { /** * 结算货币类型,取值有: <li> CNY :人民币结算; </li> <li> USD :美元结算。</li> */ Currency: string; /** * 套餐所含流量,该流量数值为安全加速流量,内容加速流量和智能加速流量的总和(单位:字节)。 */ Flux: number; /** * 结算周期,取值有: <li> y :按年结算; </li> <li> m :按月结算;</li> <li> h :按小时结算; </li> <li> M :按分钟结算;</li> <li> s :按秒结算。 </li> */ Frequency: string; /** * 套餐类型,取值有: <li> sta :全球内容分发网络(不包括中国大陆)标准版套餐; </li> <li> sta_with_bot :全球内容分发网络(不包括中国大陆)标准版套餐附带bot管理;</li> <li> sta_cm :中国大陆内容分发网络标准版套餐; </li> <li> sta_cm_with_bot :中国大陆内容分发网络标准版套餐附带bot管理;</li> <li> sta_global :全球内容分发网络(包括中国大陆)标准版套餐; </li> <li> sta_global_with_bot :全球内容分发网络(包括中国大陆)标准版套餐附带bot管理;</li> <li> ent :全球内容分发网络(不包括中国大陆)企业版套餐; </li> <li> ent_with_bot : 全球内容分发网络(不包括中国大陆)企业版套餐附带bot管理;</li> <li> ent_cm :中国大陆内容分发网络企业版套餐; </li> <li> ent_cm_with_bot :中国大陆内容分发网络企业版套餐附带bot管理;</li> <li> ent_global :全球内容分发网络(包括中国大陆)企业版套餐; </li> <li> ent_global_with_bot :全球内容分发网络(包括中国大陆)企业版套餐附带bot管理。</li> */ PlanType: string; /** * 套餐价格(单位:分)。 */ Price: number; /** * 套餐所含请求次数,该请求次数为安全加速请求次数。(单位:次)。 */ Request: number; /** * 套餐所能绑定的站点个数。 */ SiteNumber: number; /** * 套餐加速区域类型,取值有: <li> mainland :中国大陆; </li> <li> overseas :全球(不包括中国大陆);</li> <li> global :全球(包括中国大陆)。 </li> */ Area: string; } /** * DescribeTimingL7CacheData请求参数结构体 */ export interface DescribeTimingL7CacheDataRequest { /** * 开始时间。 */ StartTime: string; /** * 结束时间。 */ EndTime: string; /** * 查询的指标,取值有: <li>l7Cache_outFlux:响应流量;</li> <li>l7Cache_request:响应请求数;</li> <li> l7Cache_outBandwidth:响应带宽。</li> */ MetricNames: Array<string>; /** * 站点 ID 集合,此参数必填。 */ ZoneIds?: Array<string>; /** * 过滤条件,详细的过滤条件如下: <li>domain<br>   按照【<strong>子域名</strong>】进行过滤,子域名形如: test.example.com。<br>   类型:String<br>   必选:否</li> <li>url<br>   按照【<strong>URL</strong>】进行过滤,此参数只支持30天的时间范围,URL形如:/content。<br>   类型:String<br>   必选:否</li> <li>resourceType<br>   按照【<strong>资源类型</strong>】进行过滤,此参数只支持30天的时间范围,资源类型形如:jpg,png。<br>   类型:String<br>   必选:否</li> <li>cacheType<br>   按照【<strong>缓存类型</strong>】进行过滤。<br>   类型:String<br>   必选:否<br>   可选项:<br>   hit:命中缓存;<br>   dynamic:资源不可缓存;<br>   miss:未命中缓存。</li> <li>statusCode<br>   按照【<strong>状态码</strong>】进行过滤,此参数只支持30天的时间范围。<br>   类型:String<br>   必选:否<br>   可选项:<br>   1XX:1xx类型的状态码;<br>   100:100状态码;<br>   101:101状态码;<br>   102:102状态码;<br>   2XX:2xx类型的状态码;<br>   200:200状态码;<br>   201:201状态码;<br>   202:202状态码;<br>   203:203状态码;<br>   204:204状态码;<br>   100:100状态码;<br>   206:206状态码;<br>   207:207状态码;<br>   3XX:3xx类型的状态码;<br>   300:300状态码;<br>   301:301状态码;<br>   302:302状态码;<br>   303:303状态码;<br>   304:304状态码;<br>   305:305状态码;<br>   307:307状态码;<br>   4XX:4xx类型的状态码;<br>   400:400状态码;<br>   401:401状态码;<br>   402:402状态码;<br>   403:403状态码;<br>   404:404状态码;<br>   405:405状态码;<br>   406:406状态码;<br>   407:407状态码;<br>   408:408状态码;<br>   409:409状态码;<br>   410:410状态码;<br>   411:411状态码;<br>   412:412状态码;<br>   412:413状态码;<br>   414:414状态码;<br>   415:415状态码;<br>   416:416状态码;<br>   417:417状态码;<br>   422:422状态码;<br>   423:423状态码;<br>   424:424状态码;<br>   426:426状态码;<br>   451:451状态码;<br>   5XX:5xx类型的状态码;<br>   500:500状态码;<br>   501:501状态码;<br>   502:502状态码;<br>   503:503状态码;<br>   504:504状态码;<br>   505:505状态码;<br>   506:506状态码;<br>   507:507状态码;<br>   510:510状态码;<br>   514:514状态码;<br>   544:544状态码。</li> <li>tagKey<br>   按照【<strong>标签Key</strong>】进行过滤。<br>   类型:String<br>   必选:否</li> <li>tagValue<br>   按照【<strong>标签Value</strong>】进行过滤。<br>   类型:String<br>   必选:否</li> */ Filters?: Array<QueryCondition>; /** * 查询时间粒度,可选的值有: <li>min:1分钟的时间粒度;</li> <li>5min:5分钟的时间粒度;</li> <li>hour:1小时的时间粒度;</li> <li>day:1天的时间粒度。</li>不填将根据开始时间跟结束时间的间距自动推算粒度,具体为:一小时范围内以min粒度查询,两天范围内以5min粒度查询,七天范围内以hour粒度查询,超过七天以day粒度查询。 */ Interval?: string; /** * 数据归属地区,取值有: <li>overseas:全球(除中国大陆地区)数据;</li> <li>mainland:中国大陆地区数据;</li> <li>global:全球数据。</li>不填默认取值为global。 */ Area?: string; } /** * IPv6 访问配置。 */ export interface IPv6Parameters { /** * IPv6 访问功能配置,取值有: <li>on:开启 IPv6 访问功能;</li> <li>off:关闭 IPv6 访问功能。</li> */ Switch?: string; } /** * CreateFunction请求参数结构体 */ export interface CreateFunctionRequest { /** * 站点 ID。 */ ZoneId: string; /** * 函数名称,只能包含小写字母、数字、连字符,以数字或字母开头,以数字或字母结尾,最大支持 30 个字符。 */ Name: string; /** * 函数内容,当前仅支持 JavaScript 代码,最大支持 5MB 大小。 */ Content: string; /** * 函数描述,最大支持 60 个字符。 */ Remark?: string; } /** * POST 请求上传文件流式传输最大限制。 */ export interface PostMaxSizeParameters { /** * 是否开启 POST 请求上传文件限制,单位为 Byte,平台默认为限制为 32 * 2<sup>20</sup> Byte,取值有:<li>on:开启限制;</li><li>off:关闭限制。</li> */ Switch?: string; /** * POST 请求上传文件流式传输最大限制,单位为 Byte,取值:1 * 2<sup>20</sup> Byte~500 * 2<sup>20</sup> Byte。 */ MaxSize?: number; } /** * 实时日志投递到 AWS S3 兼容存储桶的配置信息。 */ export interface S3 { /** * 不包含存储桶名称或路径的 URL,例如:`https://storage.googleapis.com`、`https://s3.ap-northeast-2.amazonaws.com`、`https://cos.ap-nanjing.myqcloud.com`。 */ Endpoint: string; /** * 存储桶所在的地域,例如:`ap-northeast-2`。 */ Region: string; /** * 存储桶名称和日志存储目录,例如:`your_bucket_name/EO-logs/`。如果存储桶中无此目录则会自动创建。 */ Bucket: string; /** * 访问存储桶使用的 Access Key ID。 */ AccessId: string; /** * 访问存储桶使用的 secret key。 */ AccessKey: string; /** * 数据压缩类型,取值有: <li> gzip:gzip压缩。</li>不填表示不启用压缩。 */ CompressType?: string; } /** * DescribeDDoSAttackEvent返回参数结构体 */ export interface DescribeDDoSAttackEventResponse { /** * DDOS攻击事件数据列表。 注意:此字段可能返回 null,表示取不到有效值。 */ Data?: Array<DDoSAttackEvent>; /** * 查询结果的总条数。 */ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteL4ProxyRules返回参数结构体 */ export interface DeleteL4ProxyRulesResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 访问协议强制 HTTPS 跳转配置。 */ export interface ForceRedirect { /** * 访问强制跳转配置开关,取值有: <li>on:开启;</li> <li>off:关闭。</li> */ Switch: string; /** * 重定向状态码,取值有: <li>301:301跳转;</li> <li>302:302跳转。</li> 注意:此字段可能返回 null,表示取不到有效值。 */ RedirectStatusCode?: number; } /** * 规则引擎带有状态码的动作 */ export interface CodeAction { /** * 功能名称,功能名称填写规范可调用接口 [查询规则引擎的设置参数](https://cloud.tencent.com/document/product/1552/80618) 查看。 */ Action: string; /** * 操作参数。 */ Parameters: Array<RuleCodeActionParams>; } /** * CreateL7AccRules返回参数结构体 */ export interface CreateL7AccRulesResponse { /** * 规则 ID 列表。 */ RuleIds?: Array<string>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 缓存预刷新 */ export interface CachePrefresh { /** * 缓存预刷新配置开关,取值有: <li>on:开启;</li> <li>off:关闭。</li> */ Switch: string; /** * 缓存预刷新百分比,取值范围:1-99。 注意:此字段可能返回 null,表示取不到有效值。 */ Percent?: number; } /** * DescribeTimingL7AnalysisData返回参数结构体 */ export interface DescribeTimingL7AnalysisDataResponse { /** * 查询结果的总条数。 */ TotalCount?: number; /** * 时序流量数据列表。 注意:此字段可能返回 null,表示取不到有效值。 */ Data?: Array<TimingDataRecord>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 图片优化配置。 */ export interface ImageOptimize { /** * 开关,取值有: <li>on:开启;</li> <li>off:关闭。</li> */ Switch: string; } /** * CreateL7AccRules请求参数结构体 */ export interface CreateL7AccRulesRequest { /** * 站点 ID。 */ ZoneId: string; /** * 规则内容。 */ Rules: Array<RuleEngineItem>; } /** * bot 用户画像规则 */ export interface BotPortraitRule { /** * 本功能的开关,取值有: <li>on:开启;</li> <li>off:关闭。</li> */ Switch: string; /** * 本规则的ID。仅出参使用。 */ RuleID?: number; /** * JS挑战的规则ID。默认所有规则不配置JS挑战。 注意:此字段可能返回 null,表示取不到有效值。 */ AlgManagedIds?: Array<number | bigint>; /** * 数字验证码的规则ID。默认所有规则不配置数字验证码。 注意:此字段可能返回 null,表示取不到有效值。 */ CapManagedIds?: Array<number | bigint>; /** * 观察的规则ID。默认所有规则不配置观察。 注意:此字段可能返回 null,表示取不到有效值。 */ MonManagedIds?: Array<number | bigint>; /** * 拦截的规则ID。默认所有规则不配置拦截。 注意:此字段可能返回 null,表示取不到有效值。 */ DropManagedIds?: Array<number | bigint>; } /** * 规则引擎可应用于匹配请求的设置详细信息。 */ export interface RulesProperties { /** * 值为参数名称。 */ Name?: string; /** * 数值参数的最小值,非数值参数或 Min 和 Max 值都为 0 则此项无意义。 */ Min?: number; /** * 参数值的可选值。 注意:若参数值为用户自定义则该数组为空数组。 */ ChoicesValue?: Array<string>; /** * 参数值类型。 <li> CHOICE:参数值只能在 ChoicesValue 中选择; </li> <li> TOGGLE:参数值为开关类型,可在 ChoicesValue 中选择;</li> <li> OBJECT:参数值为对象类型,ChoiceProperties 为改对象类型关联的属性;</li> <li> CUSTOM_NUM:参数值用户自定义,整型类型;</li> <li> CUSTOM_STRING:参数值用户自定义,字符串类型。</li>注意:当参数类型为 OBJECT 类型时,请注意参考 [示例2 参数为 OBJECT 类型的创建](https://cloud.tencent.com/document/product/1552/80622#.E7.A4.BA.E4.BE.8B2-.E4.BF.AE.E6.94.B9.E6.BA.90.E7.AB.99.E4.B8.BAIP.E5.9F.9F.E5.90.8D) */ Type?: string; /** * 数值参数的最大值,非数值参数或 Min 和 Max 值都为 0 则此项无意义。 */ Max?: number; /** * 参数值是否支持多选或者填写多个。 */ IsMultiple?: boolean; /** * 是否允许为空。 */ IsAllowEmpty?: boolean; /** * 该参数对应的关联配置参数,属于调用接口的必填参数。 注意:如果可选参数无特殊新增参数则该数组为空数组。 */ ChoiceProperties?: Array<RuleChoicePropertiesItem>; /** * <li> 为 NULL:无特殊参数,RuleAction 选择 NormalAction;</li> 注意:此字段可能返回 null,表示取不到有效值。 */ ExtraParameter?: RuleExtraParameter; } /** * 规则引擎条件使用StatusCode字段动作参数 */ export interface RuleCodeActionParams { /** * 状态 Code。 */ StatusCode: number; /** * 参数名称,参数填写规范可调用接口 [查询规则引擎的设置参数](https://cloud.tencent.com/document/product/1552/80618) 查看。 */ Name: string; /** * 参数值。 */ Values: Array<string>; } /** * 源站组引用服务。 */ export interface OriginGroupReference { /** * 引用服务类型,取值有: <li>AccelerationDomain: 加速域名;</li> <li>RuleEngine: 规则引擎;</li> <li>Loadbalance: 负载均衡;</li> <li>ApplicationProxy: 四层代理。</li> */ InstanceType?: string; /** * 引用类型的实例ID。 */ InstanceId?: string; /** * 应用类型的实例名称。 */ InstanceName?: string; } /** * DeleteLoadBalancer请求参数结构体 */ export interface DeleteLoadBalancerRequest { /** * 站点 ID。 */ ZoneId: string; /** * 负载均衡实例 ID。 */ InstanceId: string; } /** * 自定义 Cache Key Cookie 配置参数。 */ export interface CacheKeyCookie { /** * 功能开关,取值有: <li>on:开启;</li> <li>off:关闭。</li> */ Switch?: string; /** * 缓存动作,取值有: <li>full:全部保留;</li> <li> ignore:全部忽略;</li> <li> includeCustom:保留指定参数;</li> <li>excludeCustom:忽略指定参数。</li>注意:当 Switch 为 on 时,此字段必填;当 Switch 为 off 时,无需填写此字段,若填写则不生效。 */ Action?: string; /** * 自定义 Cache Key Cookie 名称列表。<br>注意:当 Action 为 includeCustom 或 excludeCustom 时,此字段必填;当 Action 为 full 或 ignore 时,无需填写此字段,若填写则不生效。 */ Values?: Array<string>; } /** * 例外规则的配置,包含生效的条件,生效的范围。 */ export interface ExceptUserRule { /** * 规则名称,不可使用中文。 */ RuleName: string; /** * 规则的处置方式,当前仅支持skip:跳过全部托管规则。 */ Action: string; /** * 规则生效状态,取值有: <li>on:生效;</li> <li>off:失效。</li> */ RuleStatus: string; /** * 规则ID。仅出参使用。默认由底层生成。 */ RuleID?: number; /** * 更新时间,如果为null,默认由底层按当前时间生成。 注意:此字段可能返回 null,表示取不到有效值。 */ UpdateTime?: string; /** * 匹配条件。 注意:此字段可能返回 null,表示取不到有效值。 */ ExceptUserRuleConditions?: Array<ExceptUserRuleCondition>; /** * 规则生效的范围。 注意:此字段可能返回 null,表示取不到有效值。 */ ExceptUserRuleScope?: ExceptUserRuleScope; /** * 优先级,取值范围0-100。如果为null,默认由底层设置为0。 */ RulePriority?: number; } /** * 安全数据Entry返回值 */ export interface SecEntry { /** * 查询维度值。 */ Key: string; /** * 查询维度下详细数据。 */ Value: Array<SecEntryValue>; } /** * ModifyCustomErrorPage返回参数结构体 */ export interface ModifyCustomErrorPageResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 嵌套规则信息。 */ export interface SubRule { /** * 执行功能判断条件。 注意:满足该数组内任意一项条件,功能即可执行。 */ Conditions: Array<RuleAndConditions>; /** * 执行的功能。 */ Actions: Array<Action>; } /** * Debug 调试结构体。 */ export interface StandardDebugParameters { /** * Debug 功能开关,取值有: <li>on:开启;</li> <li>off:关闭。</li> */ Switch?: string; /** * 允许的客户端来源。支持填写 IPv4 以及 IPv6 的 IP 网段。0.0.0.0/0 表示允许所有 IPv4 客户端进行调试;::/0 表示允许所有 IPv6 客户端进行调试;不能填写 127.0.0.1。<br>注意:当 Switch 字段为 on 时,此字段必填,且填写个数为 1~100;当 Switch 为 off 时,无需填写此字段,若填写则不生效。 */ AllowClientIPList?: Array<string>; /** * Debug 功能到期时间。超出设置的时间,则功能失效。<br>注意:当 Switch 为 on 时,此字段必填;当 Switch 为 off 时,无需填写此字段,若填写则不生效。 */ Expires?: string; } /** * 配置组版本信息。 */ export interface ConfigGroupVersionInfo { /** * 版本 ID。 */ VersionId: string; /** * 版本号。 */ VersionNumber?: string; /*