UNPKG

tencentcloud-sdk-nodejs

Version:
2,065 lines (2,060 loc) 642 kB
/** * DeployConfigGroupVersion请求参数结构体 */ export interface DeployConfigGroupVersionRequest { /** * 站点 ID。 */ ZoneId: string; /** * 环境 ID。请填写版本需要发布到的环境 ID。 */ EnvId: string; /** * 需要发布的版本信息。可以同时变更多个不同配置组的版本,每个配置组一次仅支持变更一个版本。 */ ConfigGroupVersionInfos: Array<ConfigGroupVersionInfo>; /** * 变更说明。用于描述此次变更的内容、原因,最大支持 100 个字符。 */ Description: string; } /** * DescribeSecurityAPIResource返回参数结构体 */ export interface DescribeSecurityAPIResourceResponse { /** * API 资源总数量。 */ TotalCount?: number; /** * API 资源列表。 */ APIResources?: Array<APIResource>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * TopN数据Entry */ export interface TopEntryValue { /** * 排序实体名。 */ Name: string; /** * 排序实体数量。 */ Count: number; } /** * ModifyZoneWorkMode请求参数结构体 */ export interface ModifyZoneWorkModeRequest { /** * 站点 ID。 */ ZoneId: string; /** * 版本管理配置组工作模式。站点各配置模块可按照配置组维度开启「版本管理模式」或「即时生效模式」,详情请参考 [版本管理](https://cloud.tencent.com/document/product/1552/113690)。 */ WorkModeInfos?: Array<ConfigGroupWorkModeInfo>; } /** * 智能压缩配置。 */ export interface Compression { /** * 智能压缩配置开关,取值有: <li>on:开启;</li> <li>off:关闭。</li> */ Switch: string; /** * 支持的压缩算法列表,取值有: <li>brotli:brotli算法;</li> <li>gzip:gzip算法。</li> */ Algorithms?: Array<string>; } /** * DescribeFunctions返回参数结构体 */ export interface DescribeFunctionsResponse { /** * 符合查询条件的函数总数。 */ TotalCount?: number; /** * 符合查询条件的所有函数信息。 */ Functions?: Array<Function>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 例外规则中的跳过字段配置 */ export interface RequestFieldsForException { /** * 跳过的具体字段。取值支持:<br/> <li>body.json:JSON 请求内容;此时 Condition 支持 key、value, TargetField 支持 key、value,例如 { "Scope": "body.json", "Condition": "", "TargetField": "key" },表示 JSON 请求内容所有参数跳过 WAF 扫描;</li> <li style="margin-top:5px">cookie:Cookie;此时 Condition 支持 key、value, TargetField 支持 key、value,例如 { "Scope": "cookie", "Condition": "${key} in ['account-id'] and ${value} like ['prefix-*']", "TargetField": "value" },表示 Cookie 参数名称等于account-id 并且参数值通配符匹配 prefix-* 跳过 WAF 扫描;</li> <li style="margin-top:5px">header:HTTP 头部参数;此时 Condition 支持 key、value, TargetField 支持 key、value,例如 { "Scope": "header", "Condition": "${key} like ['x-auth-*']", "TargetField": "value" },表示 header 参数名称通配符匹配 x-auth-* 跳过 WAF 扫描;</li> <li style="margin-top:5px">uri.query:URL 编码内容/查询参数;此时 Condition 支持 key、value, TargetField 支持 key、value,例如 { "Scope": "uri.query", "Condition": "${key} in ['action'] and ${value} in ['upload', 'delete']", "TargetField": "value" },表示 URL 编码内容/查询参数的参数名称等于 action 并且参数值等于 upload 或 delete 跳过 WAF 扫描;</li> <li style="margin-top:5px">uri:请求路径URI;此时 Condition 必须为空, TargetField 支持 query、path、fullpath,例如 { "Scope": "uri", "Condition": "", "TargetField": "query" },表示请求路径 URI 仅查询参数跳过 WAF 扫描;</li> <li style="margin-top:5px">body:请求正文内容。此时 Condition 必须为空, TargetField 支持 fullbody、multipart,例如 { "Scope": "body", "Condition": "", "TargetField": "fullbody" },表示请求正文内容为完整请求正文跳过 WAF 扫描;</li> */ Scope: string; /** * 跳过的具体字段的表达式,需要符合表达式语法。<br /> Condition 支持表达式配置语法:<li> 按规则的匹配条件表达式语法编写,支持引用 key、value。</li><li> 支持 in、like 操作符,以及 and 逻辑组合。</li> 例如:<li>${key} in ['x-trace-id']:参数名称等于x-trace-id。</li><li>${key} in ['x-trace-id'] and ${value} like ['Bearer *']:参数名称等于x-trace-id并且参数值通配符匹配Bearer *。</li> */ Condition: string; /** * Scope 参数使用不同取值时,TargetField 表达式中支持的值如下: <li> body.json:支持 key、value</li> <li> cookie:支持 key、value</li> <li> header:支持 key、value</li> <li> uri.query:支持 key、value</li> <li> uri:支持 path、query、fullpath</li> <li> body:支持 fullbody、multipart</li> */ TargetField: 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; } /** * ModifySecurityJSInjectionRule请求参数结构体 */ export interface ModifySecurityJSInjectionRuleRequest { /** * 站点 ID。 */ ZoneId: string; /** * JavaScript 注入规则列表。 */ JSInjectionRules?: Array<JSInjectionRule>; } /** * CreateLogAnalysisDownloadTask返回参数结构体 */ export interface CreateLogAnalysisDownloadTaskResponse { /** * <p>日志分析下载任务 ID。</p> */ TaskId?: string; /** * 唯一请求 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 AdaptiveFrequencyControl { /** * 自适应频控是否开启。取值有:<li>on:开启;</li><li>off:关闭。</li> */ Enabled: string; /** * 自适应频控的规则 ID,仅作为出参返回。 */ Id?: string; /** * 自适应频控的限制等级,当 Enabled 为 on 时,此字段必填。取值有:<li>Loose:宽松;</li><li>Moderate:适中;</li><li>Strict:严格。</li> */ Sensitivity?: string; /** * 自适应频控的处置方式,当 Enabled 为 on 时,此字段必填。SecurityAction 的 Name 取值支持:<li>Monitor:观察;</li><li>Deny:拦截;</li><li>Challenge:挑战,其中ChallengeActionParameters.Name仅支持JSChallenge。</li> */ Action?: SecurityAction; } /** * 预付费套餐自动续费配置项。 */ export interface RenewFlag { /** * 预付费套餐的自动续费标志,取值有: <li> on:开启自动续费;</li> <li> off:不开启自动续费。</li> */ Switch: string; } /** * DescribeWebSecurityTemplates请求参数结构体 */ export interface DescribeWebSecurityTemplatesRequest { /** * 站点 ID 列表。单次查询最多传入 100 个站点。 */ ZoneIds: Array<string>; } /** * 安全的执行动作 */ export interface SecurityAction { /** * 安全执行的具体动作。取值有: <li>Deny:拦截,阻止请求访问站点资源;</li> <li>Monitor:观察,仅记录日志;</li> <li>Redirect:重定向至 URL;</li> <li>Disabled:未启用,不启用指定规则;</li> <li>Allow:允许访问,但延迟处理请求;</li> <li>Challenge:挑战,响应挑战内容;</li> <li>Trans:放行,允许请求直接访问站点资源;</li> <li>BlockIP:待废弃,IP 封禁;</li> <li>ReturnCustomPage:待废弃,使用指定页面拦截;</li> <li>JSChallenge:待废弃,JavaScript 挑战;</li> <li>ManagedChallenge:待废弃,托管挑战。</li> */ Name: string; /** * 当 Name 为 Deny 时的附加参数。 */ DenyActionParameters?: DenyActionParameters; /** * 当 Name 为 Redirect 时的附加参数。 */ RedirectActionParameters?: RedirectActionParameters; /** * 当 Name 为 Allow 时的附加参数。 */ AllowActionParameters?: AllowActionParameters; /** * 当 Name 为 Challenge 时的附加参数。 */ ChallengeActionParameters?: ChallengeActionParameters; /** * 待废弃,当 Name 为 BlockIP 时的附加参数。 */ BlockIPActionParameters?: BlockIPActionParameters; /** * 待废弃,当 Name 为 ReturnCustomPage 时的附加参数。 */ ReturnCustomPageActionParameters?: ReturnCustomPageActionParameters; } /** * IP 情报库(原客户端画像分析)配置。 */ export interface IPReputation { /** * IP 情报库(原客户端画像分析)。取值有:<li>on:开启;</li><li>off:关闭。</li> */ Enabled?: string; /** * IP 情报库(原客户端画像分析)的具体配置内容。 */ IPReputationGroup?: IPReputationGroup; } /** * CreateSecurityAPIService请求参数结构体 */ export interface CreateSecurityAPIServiceRequest { /** * 站点 ID。 */ ZoneId: string; /** * API 服务列表。 */ APIServices?: Array<APIService>; } /** * 精准速率限制的配置 */ export interface RateLimitingRules { /** * 精准速率限制的定义列表。使用 ModifySecurityPolicy 修改 Web 防护配置时: <br> <li> 若未指定 Rules 参数,或 Rules 参数长度为零:清空所有精准速率限制配置。</li> <li> 若 SecurityPolicy 参数中,未指定 RateLimitingRules 参数值:保持已有自定义规则配置,不做修改。</li> */ Rules?: Array<RateLimitingRule>; } /** * DescribeMultiPathGatewayLine请求参数结构体 */ export interface DescribeMultiPathGatewayLineRequest { /** * 站点 ID。 */ ZoneId: string; /** * 网关 ID。 */ GatewayId: string; /** * 线路 ID。 */ LineId: string; } /** * 需要配置特定回源 IP 网段回源的实例。 */ export interface OriginACLEntity { /** * 实例类型,取值有: - l7:七层加速域名; - l4:四层代理实例。 */ Type: string; /** * 实例详情,取值有: - 当 Type = l7 时,请填写七层加速域名; - 当 Type = l4 时,请填写四层代理实例 ID。 */ Instances: Array<string>; /** * 操作模式,取值有: <li>enable:启用;</li> <li>disable:停用。</li> */ OperationMode: string; } /** * IDC 规则配置的具体内容。 */ export interface SourceIDC { /** * 来自指定 IDC 请求的处置方式。 SecurityAction 的 Name 取值支持:<li>Deny:拦截;</li><li>Monitor:观察;</li><li>Disabled:未启用,不启用指定规则;</li><li>Challenge:挑战,其中 ChallengeActionParameters 中的 ChallengeOption 支持 JSChallenge 和 ManagedChallenge;</li><li>Allow:放行(待废弃)。</li> */ BaseAction?: SecurityAction; /** * 指定 IDC 请求的处置方式。 */ BotManagementActionOverrides?: Array<BotManagementActionOverrides>; } /** * 智能压缩配置。 */ 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>; /** * 当前配置的回源 HOST 头。 */ HostHeader?: string; /** * 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; } /** * 推理硬件规格信息。 */ export interface InferenceHardwareSpecification { /** * 规格标识。 */ Spec?: string; /** * 规格名称。 */ Name?: string; /** * CPU 核数。 */ CPUNum?: number; /** * 内存大小。单位为 MB。 */ MemSize?: number; /** * GPU 卡数。 */ GPUNum?: number; /** * 显存大小。单位为 MB。 */ GPUMemSize?: number; } /** * DescribeSecurityClientAttester返回参数结构体 */ export interface DescribeSecurityClientAttesterResponse { /** * 认证选项总数量。 */ TotalCount?: number; /** * 认证选项列表。 */ ClientAttesters?: Array<ClientAttester>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 多通道网关示例实例与回源 IP 网段的绑定关系,以及回源 IP 网段详情。 */ export interface MultiPathGatewayOriginACLInfo { /** * 当前生效的回源 IP 网段。 */ MultiPathGatewayCurrentOriginACL?: MultiPathGatewayCurrentOriginACL; /** * 当回源 IP 网段发生更新时,该字段会返回下一个版本将要生效的回源 IP 网段,包含与当前回源 IP 网段的对比。无更新时该字段为空。 */ MultiPathGatewayNextOriginACL?: MultiPathGatewayNextOriginACL; } /** * 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; } /** * ModifyEdgeKVNamespace请求参数结构体 */ export interface ModifyEdgeKVNamespaceRequest { /** * 站点 ID。 */ ZoneId: string; /** * 命名空间名称。 */ Namespace: string; /** * 命名空间描述。用于说明命名空间的用途或业务含义。最大支持 256 个字符。 */ Remark?: 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; } /** * 正文传输最小速率阈值的具体配置。 */ export interface MinimalRequestBodyTransferRate { /** * 正文传输最小速率阈值,单位仅支持bps。 */ MinimalAvgTransferRateThreshold: string; /** * 正文传输最小速率统计时间范围,取值有:<li>10s:10秒;</li><li>30s:30秒;</li><li>60s:60秒;</li><li>120s:120秒。</li> */ CountingPeriod: string; /** * 正文传输最小速率阈值是否开启。取值有:<li>on:开启;</li><li>off:关闭。</li> */ Enabled: string; } /** * 访问 URL 重定向 配置参数。 */ export interface AccessURLRedirectQueryString { /** * 执行动作,取值有: <li>full:全部保留;</li> <li>ignore:全部忽略。</li> */ Action?: string; } /** * 浏览器伪造识别规则(原主动特征识别规则)。 */ export interface BrowserImpersonationDetectionRule { /** * 浏览器伪造识别规则的 ID。<br>通过规则 ID 可支持不同的规则配置操作:<br> <li> <b>增加</b>新规则:ID 为空或不指定 ID 参数;</li><li><b>修改</b>已有规则:指定需要更新/修改的规则 ID;</li><li><b>删除</b>已有规则:BrowserImpersonationDetection 参数中,Rules 列表中未包含的已有规则将被删除。</li> */ Id?: string; /** * 浏览器伪造识别规则的名称。 */ Name?: string; /** * 浏览器伪造识别规则是否开启。取值有:<li>on:开启;</li><li>off:关闭。</li> */ Enabled?: string; /** * 浏览器伪造识别规则的具体内容,其中仅支持请求方式(Method)、请求路径(Path)和请求 URL 的配置,需符合表达式语法,详细规范参见产品文档。 */ Condition?: string; /** * 浏览器伪造识别规则的处置方式,包括 Cookie 校验和会话跟踪配置以及客户端行为校验配置。 */ Action?: BrowserImpersonationDetectionAction; } /** * DescribeInferenceAPITokens请求参数结构体 */ export interface DescribeInferenceAPITokensRequest { /** * <p>站点 ID。</p> */ ZoneId: string; /** * <p>分页查询偏移量。默认值:0。</p> */ Offset?: number; /** * <p>分页查询限制数目。默认值:20,最大值:100。</p> */ Limit?: number; } /** * ModifyFunctionRulePriority请求参数结构体 */ export interface ModifyFunctionRulePriorityRequest { /** * 站点 ID。 */ ZoneId: string; /** * 规则 ID 列表,必须填入调整优先级后的所有规则 ID,多条规则执行顺序依次从上往下,不填写保持原优先级顺序。 */ RuleIds: Array<string>; } /** * ModifyAccelerationDomain返回参数结构体 */ export interface ModifyAccelerationDomainResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteSecurityAPIResource请求参数结构体 */ export interface DeleteSecurityAPIResourceRequest { /** * 站点 ID。 */ ZoneId: string; /** * 需要删除的 API 资源 ID 列表。 */ APIResourceIds?: Array<string>; } /** * 源站卸载配置参数。 */ export interface ShieldParameters { /** * 源站卸载空间 ID。 */ ShieldSpaceId: string; } /** * 地区策略配置。 */ export interface FunctionRegionSelection { /** * 函数 ID 。 */ FunctionId: string; /** * 国家/地区列表。示例值:CN:中国,CN.GD:中国广东。取值请参考:[国家/地区及对应代码枚举](https://cloud.tencent.com/document/product/1552/112542)。 */ Regions: Array<string>; } /** * DescribeInferenceServiceMonitorData返回参数结构体 */ export interface DescribeInferenceServiceMonitorDataResponse { /** * <p>查询结果的总条数。</p> */ TotalCount?: number; /** * <p>推理服务监控数据。</p> */ InferenceServiceMonitorRecords?: Array<InferenceServiceMonitorRecord>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeHostsSetting返回参数结构体 */ export interface DescribeHostsSettingResponse { /** * 域名列表。 */ DetailHosts?: Array<DetailHost>; /** * 域名数量。 */ TotalNumber?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * OperateInferenceService请求参数结构体 */ export interface OperateInferenceServiceRequest { /** * 站点ID。 */ ZoneId: string; /** * 推理服务 ID。 */ ServiceId: string; /** * 操作类型,包含以下几种:<li>Stop:停止;</li><li>Resume:启动;</li><li>Delete:删除。</li> */ Operation: string; } /** * DescribeWebSecurityTemplate返回参数结构体 */ export interface DescribeWebSecurityTemplateResponse { /** * 安全策略模板配置内容,Bot 配置暂不支持,正在开发中。 */ SecurityPolicy?: SecurityPolicy; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 源站配置。 */ export interface Origin { /** * 主源站列表。 */ Origins?: Array<string>; /** * 备源站列表。 */ BackupOrigins?: Array<string>; /** * 回源协议配置,取值有: <li>http:强制 http 回源;</li> <li>follow:协议跟随回源;</li> <li>https:强制 https 回源。</li> */ OriginPullProtocol?: string; /** * 源站为腾讯云 COS 时,是否为私有访问 bucket,取值有: <li>on:私有访问;</li> <li>off:公共访问。</li> */ CosPrivateAccess?: string; } /** * DescribeRules返回参数结构体 */ export interface DescribeRulesResponse { /** * 站点 ID。 */ ZoneId?: string; /** * 规则列表,按规则执行顺序从先往后排序。 */ RuleItems?: Array<RuleItem>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 时序数据信息 */ export interface TimingDataRecord { /** * 查询维度值。 */ TypeKey?: string; /** * <code>Integer</code> 类型的详细时序数据,查询指标值类型为 <code>Integer</code> 指标会由本字段返回对应时序数据。<br> **注意**:若查询指标未明确说明指标值类型,默认由本字段返回数据。 */ TypeValue?: Array<TimingTypeValue>; /** * <code>Float</code> 类型的详细时序数据,查询指标值类型为 <code>Float</code> 指标会由本字段返回对应时序数据。 */ FloatTypeValue?: Array<FloatTimingTypeValue>; } /** * 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 兼容存储桶地址;<br>   log_analysis:推送到 EdgeOne 日志分析。</li> */ Filters?: Array<AdvancedFilter>; } /** * DescribeOriginProtection返回参数结构体 */ export interface DescribeOriginProtectionResponse { /** * 源站防护信息。 注意:此字段可能返回 null,表示取不到有效值。 */ OriginProtectionInfo?: Array<OriginProtectionInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * EdgeOne 人机校验认证实例信息。 */ export interface TCEOCaptchaOption { /** * EdgeOne 人机校验模式,取值有:<li> Invisible:无感验证;</li><li>Adaptive:自适应交互验证。</li> */ CaptchaMode?: string; } /** * DescribeBillingData请求参数结构体 */ export interface DescribeBillingDataRequest { /** * 起始时间。 */ StartTime: string; /** * 结束时间。查询时间范围(`EndTime` - `StartTime`)需小于等于 31 天。 */ EndTime: string; /** * 站点 ID 集合,此参数必填。最多传入 100 个站点 ID。若需查询腾讯云主账号下所有站点数据,请用 `*` 代替,查询账号级别数据需具备本接口全部站点资源权限。 */ ZoneIds: Array<string>; /** * 指标列表,取值如下: <b>四/七层加速流量:</b><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><br><b>四/七层加速带宽:</b><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><br><b>HTTP/HTTPS 安全请求数:</b><li>sec_request_clean: HTTP/HTTPS 请求,单位为次。</li><b><br>增值服务用量:</b><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><br><b>边缘计算用量:</b><li>edgefunction_request:边缘函数请求数,单位为次;</li><li>edgefunction_cpu_time:边缘函数CPU处理时间,单位为毫秒。</li> <b>媒体处理用量:</b><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> 说明:相同 `Type` 的 `BillingDataFilter` 之间为“或”关系,不同 `Type` 的 `BillingDataFilter` 之间为“且”关系。 */ Filters?: Array<BillingDataFilter>; /** * 分组聚合维度。最多允许同时按照两种维度进行分组。取值如下: <li>zone-id:按照站点 ID 进行分组,若使用了内容标识符功能,则优先按照内容标识符分组;<br></li><li>host:按照域名进行分组;<br></li> <li>proxy-id:按照四层代理实例 ID 进行分组;<br></li> <li>region-id:按照计费大区进行分组。</li> */ GroupBy?: Array<string>; } /** * 实时日志投递的输出格式。您可以直接通过 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; } /** * CreateInferenceService请求参数结构体 */ export interface CreateInferenceServiceRequest { /** * <p>站点 ID。</p> */ ZoneId: string; /** * <p>推理服务的名称。长度限制不超过 30 个字符,仅支持小写字母、数字、连字符,以字母开头,数字或字母结尾,不支持重复。</p> */ Name: string; /** * <p>模型服务需要监听的端口。仅支持 1-65535 之间的整数。</p> */ ListenPort: number; /** * <p>推理服务的容器配置。当前仅支持设置 1 个容器。</p> */ Containers: Array<InferenceContainerConfig>; /** * <p>推理服务的资源配置。</p> */ ResourceConfig: InferenceResourceConfig; /** * <p>推理服务的请求路径列表。最多支持 20 个路径。</p> */ RequestPaths?: Array<string>; /** * <p>描述信息。长度限制不超过 60 个字符。</p> */ Description?: string; } /** * 多通道安全网关详情 */ export interface MultiPathGateway { /** * 网关 ID。 */ GatewayId?: string; /** * 网关名。 */ GatewayName?: string; /** * 网关类型,取值有: <li> cloud:云上网关,腾讯云创建和管理的网关。</li> <li> private:自有网关,用户部署的私有网关。</li> */ GatewayType?: string; /** * 网关端口,范围 1~65535(除去 8888 )。 */ GatewayPort?: number; /** * 网关状态,取值有: <li> creating : 创建中;</li> <li> online : 在线;</li> <li> offline : 离线;</li> <li> disable : 已停用。</li> */ Status?: string; /** * 网关 IP, 格式为 IPv4。 */ GatewayIP?: string; /** * 网关地域 Id,可以从接口 DescribeMultiPathGatewayRegions 获取 RegionId 列表。 */ RegionId?: string; /** * 线路信息,当查询网关信息详情 DescribeMultiPathGateway 的时候会返回,当查询网关列表 DescribeMultiPathGateways 的时候不会返回。 */ Lines?: Array<MultiPathGatewayLine>; /** * 网关回源 IP 列表发生了变化是否需要重新确认,取值有:<li>true:回源 IP 列表发生了变化,需要确认;</li><li>false:回源 IP 列表未发生变化,无需确认。</li> */ NeedConfirm?: 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,默认使用历史配置。 */ RateLimitTemplate?: RateLimitTemplate; /** * 智能客户端过滤。如果为null,默认使用历史配置。 */ RateLimitIntelligence?: RateLimitIntelligence; /** * 速率限制-托管定制规则。如果为null,默认使用历史配置。 */ RateLimitCustomizes?: Array<RateLimitUserRule>; } /** * DescribeInferenceServiceDeploymentLogs返回参数结构体 */ export interface DescribeInferenceServiceDeploymentLogsResponse { /** * 符合条件的部署日志总数。 */ TotalCount?: number; /** * 部署日志列表。 */ DeploymentLogInfoSet?: Array<InferenceServiceDeploymentLogInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateRealtimeLogDeliveryTask请求参数结构体 */ export interface CreateRealtimeLogDeliveryTaskRequest { /** * <p>站点 ID。</p> */ ZoneId: string; /** * <p>数据投递区域,可选值:<ul><li>mainland:中国大陆境内;</li><li>overseas:全球(不含中国大陆)。</li></ul></p> */ Area: string; /** * <p>数据投递类型,可选值:<ul><li>l7-access-logs:七层访问日志;</li><li>application:四层代理日志;</li><li>function:边缘函数运行日志;</li><li>web-attack:托管规则日志;</li></ul>以下类型日志合并入 l7-access-logs,不再支持新增:</p><ul><li>domain:站点加速日志;</li><li>web-rateLiming:速率限制和 CC 攻击防护日志;</li><li>web-rule:自定义规则日志;</li><li>web-bot:Bot 管理日志。</li></ul> */ LogType: string; /** * <p>实时日志投递任务的名称,格式为数字、英文、-和_组合,最多 200 个字符。</p> */ TaskName: string; /** * <p>实时日志投递任务类型,取值有:<ul><li>cls: 推送到腾讯云 CLS;</li><li>custom_endpoint:推送到自定义 HTTP(S) 地址;</li><li>s3:推送到 AWS S3 兼容存储桶地址;</li><li>log_analysis:推送到 EdgeOne 日志分析,仅当 LogType = l7-access-logs 或 web-attack 时支持。</li></ul></p> */ TaskType: string; /** * <p>实时日志投递任务对应的实体列表。取值示例如下:<ul><li>七层域名:domain.example.com</li><li>四层代理实例:sid-2s69eb5wcms7</li><li>边缘函数实例:test-zone-2mxigizoh9l9-1257626257</li></ul></p><p>取值参考:<a href="https://cloud.tencent.com/document/api/1552/103413">DescribeL4Proxy</a></p> */ EntityList: Array<string>; /** * <p>投递的预设字段列表。取值参考:<ul><li><a href="https://cloud.tencent.com/document/product/1552/105791">七层访问日志(站点加速日志)</a></li><li><a href="https://cloud.tencent.com/document/product/1552/105792">四层代理日志</a></li><li><a href="https://cloud.tencent.com/document/product/1552/115585">边缘函数运行日志</a></li></ul></p><p>取值参考:DescribeLogFields</p> */ Fields: Array<string>; /** * <p>投递的自定义字段列表,支持在 HTTP 请求头、响应头、Cookie、请求正文中提取指定内容。<br>自定义字段名称不能重复,仅七层访问日志(LogType= l7-access-logs 或 domain)支持添加自定义字段。<br>允许配置的自定义字段个数有配额限制,如遇配额不足请 [联系我们](https://cloud.tencent.com/online-service?from=sales&amp;source=PRESALE)。</p> */ CustomFields?: Array<CustomField>; /** * <p>日志投递的过滤条件,不填表示投递全量日志。</p> */ DeliveryConditions?: Array<DeliveryCondition>; /** * <p>采样比例,采用千分制,取值范围为1-1000,例如:填写 605 表示采样比例为 60.5%。不填表示采样比例为 100%。</p> */ Sample?: number; /** * <p>日志投递的输出格式,使用详情见 <a href="https://cloud.tencent.com/document/product/1552/110448">自定义日志输出格式</a>。不填表示为默认格式,默认格式逻辑如下:<ul><li>当 TaskType 取值为 custom_endpoint 时,默认格式为多个 JSON 对象组成的数组,每个 JSON 对象为一条日志;</li><li>当 TaskType 取值为 s3 时,默认格式为 JSON Lines;</li></ul>特别地,当 TaskType 取值为 cls 或 log_analysis 时,LogFormat.FormatType 的值只能为 json,且 LogFormat 中其他参数将被忽略,建议不传 LogFormat。</p> */ LogFormat?: LogFormat; /** * <p>CLS 的配置信息。当 TaskType 取值为 cls 时,该参数必填。</p> */ CLS?: CLSTopic; /** * <p>自定义 HTTP 服务的配置信息。当 TaskType 取值为 custom_endpoint 时,该参数必填。</p> */ CustomEndpoint?: CustomEndpoint; /** * <p>AWS S3 兼容存储桶的配置信息。当 TaskType 取值为 s3 时,该参数必填。</p> */ 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。 */ 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>; } /** * EdgeKVList请求参数结构体 */ export interface EdgeKVListRequest { /** * 站点 ID。 */ ZoneId: string; /** * 命名空间名称。 */ Namespace: string; /** * 键名前缀过滤。只返回以指定前缀开头的键名,长度为 1-512 个字符。不填写表示返回所有键名;不允许传入空字符串。 */ Prefix?: string; /** * 游标位置。标识当前查询的起始位置,用于遍历大量数据。首次查询时不填写,从头开始遍历;后续查询时填写上一次返回的 Cursor 值,从该位置继续向后遍历。 */ Cursor?: string; /** * 返回的键名数量。默认值:20,最大值:1000。 */ Limit?: number; } /** * 慢速攻击配置。 */ export interface SlowPostConfig { /** * 开关,取值有: <li>on:开启;</li> <li>off:关闭。</li> */ Switch: string; /** * 首包配置。 */ FirstPartConfig?: FirstPartConfig; /** * 基础配置。 */ SlowRateConfig?: SlowRateConfig; /** * 慢速攻击的处置动作,取值有: <li>monitor:观察;</li> <li>drop:拦截。</li> */ Action?: string; /** * 本规则的Id。 */ RuleId?: number; } /** * 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; } /** * EdgeKVGet请求参数结构体 */ export interface EdgeKVGetRequest { /** * 站点 ID。 */ ZoneId: string; /** * 命名空间名称。可通过 DescribeEdgeKVNamespaces 接口获取站点下的命名空间列表。 */ Namespace: string; /** * 键名列表。数组长度上限为 20。每个键名不能为空,长度为 1-512 个字符,支持合法 UTF-8 字符。查询单个键时传入包含一个元素的数组。 */ Keys: Array<string>; } /** * ModifyContentIdentifier返回参数结构体 */ export interface ModifyContentIdentifierResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteEdgeKVNamespace返回参数结构体 */ export interface DeleteEdgeKVNamespaceResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteSecurityAPIService返回参数结构体 */ export interface DeleteSecurityAPIServiceResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 规则引擎条件且关系条件列表 */ export interface RuleAndConditions { /** * 规则引擎条件,该数组内所有项全部满足即判断该条件满足。 */ Conditions: Array<RuleCondition>; } /** * 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>; } /** * 边缘推理定时伸缩动作配置,用于描述一条具体的定时伸缩动作。 */ export interface InferenceScheduledScalingAction { /** * Cron 表达式,用于描述定时伸缩动作的触发时间。采用 5 字段标准 Cron 格式:分钟 小时 日期 月份 星期。不支持秒字段和年份字段。 */ CronExpression: string; /** * 命中该定时伸缩动作后,推理服务需要调整到的最小实例数。若同一评估窗口内多个定时伸缩动作同时命中,则使用其中最大的 MinInstanceCount。 */ MinInstanceCount: number; } /** * 实时日志投递到腾讯云 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>; /** * 预热模式,取值有: <li>default:默认模式,即预热到中间层;</li> <li>edge:边缘预热模式,即预热到边缘和中间层。</li>不填写时,默认值为 default。 注意事项: 1.预热至边缘产生的边缘层流量,会计入计费流量; 2.边缘预热默认分配单独的预热额度 1000 条/天,不消费常规预热额度。 说明: 该参数为白名单功能,如有需要,请联系腾讯云工程师处理。 */ Mode?: string; /** * 是否对url进行encode,若内容含有非 ASCII 字符集的字符,请开启此开关进行编码转换(编码规则遵循 RFC3986)。 * @deprecated */ EncodeUrl?: boolean; /** * 若需要携带 HTTP 头部信息预热,可入参该参数,否则放空即可。 */ Headers?: Array<Header>; /** * 媒体分片预热控制,取值有: <li>on:开启分片预热,预热描述文件,并递归解析描述文件分片进行预热;</li> <li>off:仅预热提交的描述文件;</li>不填写时,默认值为 off。 注意事项: 1. 支持的描述文件为 M3U8,对应分片为 TS; 2. 要求描述文件能正常请求,并按行业标准描述分片路径; 3. 递归解析深度不超过 3 层; 4. 解析获取的分片会正常累加每日预热用量,当用量超出配额时,会静默处理,不再执行预热。 说明: 该参数为白名单功能,如有需要,请联系腾讯云工程师处理。 */ PrefetchMediaSegments?: string; } /** * 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` - `StartTime`)需小于等于 31 天。 */ 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_referers:按 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 集合,此参数将于2024年05月30日后由可选改为必填,详见公告:[【腾讯云 EdgeOne】云 API 变更通知](https://cloud.tencent.com/document/product/1552/104902)。最多传入 100 个站点 ID。若需查询腾讯云主账号下所有站点数据,请用 `*` 代替,查询账号级别数据需具备本接口全部站点资源权限。 */ ZoneIds: Array<string>; /** * 查询前多少个 top 数据,最大值为1000。不填默认为10,表示查询 top10 的数据。 */ Limit?: number; /** * 筛选数据时使用的过滤条件,取值参考 [指标分析筛选条件说明](https://cloud.tencent.com/document/product/1552/98219#1aaf1150-55a4-4b4d-b103-3a8317ac7945) 中针对 L7 访问流量、带宽、请求数的可用筛选项。 如需限定站点或内容标识符,请在 `ZoneIds.N` 参数中另行传入对应的值。 */ Filters?: Array<QueryCondition>; /** * 查询时间粒度,该参数无效,待废弃。 */ Interval?: string; /** * 数据归属地区。该参数已废弃。请在 `Filters.country` 中按客户端地域过滤数据。 */ Area?: string; } /** * CreateMultiPathGatewaySecretKey返回参数结构体 */ export interface CreateMultiPathGatewaySecretKeyResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: 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; } /** * DescribeSecurityAPIService请求参数结构体 */ export interface DescribeSecurityAPIServiceRequest { /** * 站点 ID。 */ ZoneId: string; /** * 分页查询限制数目。默认值:20,最大值:100。 */ Limit?: number; /** * 分页查询偏移量。默认值:0。 */ Offset?: number; } /** * 回源请求参数查询字符串配置。 */ 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>; } /** * 统计曲线数据项 */ export interface FloatTimingDataItem { /** * 返回数据对应时间点,采用 unix 秒级时间戳。 */ Timestamp?: number; /** * 具体数值。 */ Value?: number; } /** * DeleteJustInTimeTranscodeTemplates请求参数结构体 */ export interface DeleteJustInTimeTranscodeTemplatesRequest { /** * 站点ID。 */ ZoneId: string; /** * 需删除的即时转码模板唯一标识数组,长度限制:100。 */ TemplateIds: Array<string>; } /** * 多通道安全网关线路信息 */ export interface MultiPathGatewayLine { /** * 线路 ID , 其中 line-0 和 line-1 为系统内置线路 ID,取值有: <li> line-0:直连线路,不支持添加、编辑和删除;</li> <li> line-1: EdgeOne 四层代理线路,支持修改实例和规则,不支持删除;</li> <li> line-2 及以上:EdgeOne 四层代理线路或者自定义线路,支持修改、删除实例和规则。</li> */ LineId?: string; /** * 线路类型,取值有: <li>direct :直连线路,不支持编辑、不支持删除;</li> <li>proxy :EdgeOne 四层代理线路,支持编辑修改实例和规则,不支持删除;</li> <li>custom :自定义线路,支持编辑、支持删除。</li> */ LineType?: string; /** * 线路地址,格式为 host:port 。 */ LineAddress?: string; /** * 四层代理实例 ID ,当线路类型 LineType 取值为 proxy(EdgeOne 四层代理)返回。 */ ProxyId?: string; /** * 转发规则 ID ,当线路类型 LineType 取值为 proxy(EdgeOne 四层代理)返回。 */ RuleId?: string; } /** * ModifyLoadBalancer返回参数结构体 */ export interface ModifyLoadBalancerResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyL4Proxy返回参数结构体 */ export interface ModifyL4ProxyResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 推理服务自动伸缩配置。 */ export interface InferenceAutoScalingConfig { /** * <p>最小实例数量。当配置了伸缩策略并且策略处于有效期时,将不会生效。</p> */ MinInstanceCount: number; /** * <p>伸缩策略列表。最多支持 5 个策略。</p> */ ScalingPolicies?: Array<InferenceScalingPolicy>; } /** * 负载均衡实例健康检查策略。 */ 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; /** * 检查频率,表示多久发起一次健康检查任务,单位为秒。可配置 10-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>; /** * 函数选择配置类型: <li> direct:直接指定执行函数;</li> <li> weight:基于权重比选择函数;</li> <li> region:基于客户端 IP 的国家/地区选择函数。</li> 不填时默认为 direct 。 */ TriggerType?: string; /** * 指定执行的函数 ID。当 TriggerType 为 direct 或 TriggerType 不填时生效。 */ FunctionId?: string; /** * 基于客户端 IP 国家/地区的函数选择配置,当 TriggerType 为 region 时生效且 RegionMappingSelections 必填。RegionMappingSelections 中至少包含一项 Regions 为 Default 的配置。 */ RegionMappingSelections?: Array<FunctionRegionSelection>; /** * 基于权重的函数选择配置,当 TriggerType 为 weight 时生效且 WeightedSelections 必填。WeightedSelections 中的所有权重之和需要为100。 */ WeightedSelections?: Array<FunctionWeightedSelection>; /** * 规则描述,最大支持 60 个字符。 */ Remark?: string; } /** * 推理服务监控数据项。 */ export interface InferenceServiceMonitorItem { /** * 监控数据对应时间点。 */ Timestamp?: string; /** * 具体数值。 */ Value?: number; } /** * 推理的 TCR 镜像仓库配置。 */ export interface InferenceTCRRepositoryConfig { /** * <p>TCR 服务类型。取值有:<li>Personal:个人版;</li><li>Enterprise:企业版。</li></p> */ TCRType: string; /** * <p>镜像地址。</p> */ Image: string; /** * <p>镜像仓库实例 ID。当 TCRType = Enterprise 时必填。</p> */ RegistryId?: string; /** * <p>地域名称。</p> */ RegionName?: 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>; } /** * 组件被引用的实例信息,用于展示该组件与边缘函数等资源的绑定关系。当边缘函数需要访问组件(如 KV 命名空间)时,会建立引用关系,通过此结构体可查看引用的具体实例详情及所属站点信息。 */ export interface ComponentReference { /** * 引用的实例类型。取值有: <li>edge-function:边缘函数。</li> */ ReferenceType?: string; /** * 引用的实例 ID。根据 ReferenceType 的取值不同,返回对应的实例 ID: <li>当 ReferenceType 为 edge-function 时:返回边缘函数 ID,格式形如:ef-2vc5oe9mzqhm。</li> */ ReferenceId?: string; /** * 引用的实例名称。根据 ReferenceType 的取值不同,返回对应的实例名称: <li>当 ReferenceType 为 edge-function 时:返回边缘函数名称。</li> */ ReferenceName?: string; /** * 站点 ID。引用该命名空间的实例所属的站点标识。 */ ZoneId?: string; /** * 站点名称。引用该命名空间的实例所属的站点名称。 */ ZoneName?: string; /** * 引用该命名空间的实例所属站点的别名。若未设置站点别名,则返回空字符串。 */ AliasZoneName?: string; } /** * ConfirmOriginACLUpdate返回参数结构体 */ export interface ConfirmOriginACLUpdateResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Modif