/** * DeployConfigGroupVersion请求参数结构体 */ export interface DeployConfigGroupVersionRequest { /** * 站点 ID。 */ ZoneId: string; /** * 环境 ID。请填写版本需要发布到的环境 ID。 */ EnvId: string; /** * 需要发布的版本信息。可以同时变更多个不同配置组的版本，每个配置组一次仅支持变更一个版本。 */ ConfigGroupVersionInfos: Array; /** * 变更说明。用于描述此次变更的内容、原因，最大支持 100 个字符。 */ Description: string; } /** * DescribeSecurityAPIResource返回参数结构体 */ export interface DescribeSecurityAPIResourceResponse { /** * API 资源总数量。 */ TotalCount?: number; /** * API 资源列表。 */ APIResources?: Array; /** * 唯一请求 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; } /** * 智能压缩配置。 */ export interface Compression { /** * 智能压缩配置开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch: string; /** * 支持的压缩算法列表，取值有：
  • brotli：brotli算法；
  • gzip：gzip算法。
    • */ Algorithms?: Array; } /** * DescribeFunctions返回参数结构体 */ export interface DescribeFunctionsResponse { /** * 符合查询条件的函数总数。 */ TotalCount?: number; /** * 符合查询条件的所有函数信息。 */ Functions?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 例外规则中的跳过字段配置 */ export interface RequestFieldsForException { /** * 跳过的具体字段。取值支持：
  • body.json：JSON 请求内容；此时 Condition 支持 key、value, TargetField 支持 key、value，例如 { "Scope": "body.json", "Condition": "", "TargetField": "key" }，表示 JSON 请求内容所有参数跳过 WAF 扫描；
  • 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 扫描；
  • header：HTTP 头部参数；此时 Condition 支持 key、value, TargetField 支持 key、value，例如 { "Scope": "header", "Condition": "${key} like ['x-auth-*']", "TargetField": "value" }，表示 header 参数名称通配符匹配 x-auth-* 跳过 WAF 扫描；
  • 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 扫描；
  • uri：请求路径URI；此时 Condition 必须为空， TargetField 支持 query、path、fullpath，例如 { "Scope": "uri", "Condition": "", "TargetField": "query" }，表示请求路径 URI 仅查询参数跳过 WAF 扫描；
  • body：请求正文内容。此时 Condition 必须为空， TargetField 支持 fullbody、multipart，例如 { "Scope": "body", "Condition": "", "TargetField": "fullbody" }，表示请求正文内容为完整请求正文跳过 WAF 扫描；
    • */ Scope: string; /** * 跳过的具体字段的表达式，需要符合表达式语法。
    Condition 支持表达式配置语法：
  • 按规则的匹配条件表达式语法编写，支持引用 key、value。
  • 支持 in、like 操作符，以及 and 逻辑组合。
    • 例如：
  • ${key} in ['x-trace-id']：参数名称等于x-trace-id。
  • ${key} in ['x-trace-id'] and ${value} like ['Bearer *']：参数名称等于x-trace-id并且参数值通配符匹配Bearer *。
    • */ Condition: string; /** * Scope 参数使用不同取值时，TargetField 表达式中支持的值如下：
  • body.json：支持 key、value
  • cookie：支持 key、value
  • header：支持 key、value
  • uri.query：支持 key、value
  • uri：支持 path、query、fullpath
  • body：支持 fullbody、multipart
    • */ TargetField: string; } /** * DeleteL4ProxyRules请求参数结构体 */ export interface DeleteL4ProxyRulesRequest { /** * 站点 ID。 */ ZoneId: string; /** * 四层代理实例 ID。 */ ProxyId: string; /** * 转发规则 ID 列表。单次最多支持 200 条转发规则。 */ RuleIds: Array; } /** * DescribeOriginGroup返回参数结构体 */ export interface DescribeOriginGroupResponse { /** * 记录总数。 */ TotalCount?: number; /** * 源站组信息。 */ OriginGroups?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifySecurityJSInjectionRule请求参数结构体 */ export interface ModifySecurityJSInjectionRuleRequest { /** * 站点 ID。 */ ZoneId: string; /** * JavaScript 注入规则列表。 */ JSInjectionRules?: Array; } /** * CreateLogAnalysisDownloadTask返回参数结构体 */ export interface CreateLogAnalysisDownloadTaskResponse { /** *

    日志分析下载任务 ID。

    */ TaskId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeSecurityIPGroupInfo返回参数结构体 */ export interface DescribeSecurityIPGroupInfoResponse { /** * 返回的满足条件的 IP 组数量。 */ TotalCount?: number; /** * IP 组的详细配置信息。包含每个 IP 组的 ID 、名称和 IP /网段列表信息。 */ IPGroups?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 自适应频控 */ export interface AdaptiveFrequencyControl { /** * 自适应频控是否开启。取值有：
  • on：开启；
  • off：关闭。
    • */ Enabled: string; /** * 自适应频控的规则 ID，仅作为出参返回。 */ Id?: string; /** * 自适应频控的限制等级，当 Enabled 为 on 时，此字段必填。取值有：
  • Loose：宽松；
  • Moderate：适中；
  • Strict：严格。
    • */ Sensitivity?: string; /** * 自适应频控的处置方式，当 Enabled 为 on 时，此字段必填。SecurityAction 的 Name 取值支持：
  • Monitor：观察；
  • Deny：拦截；
  • Challenge：挑战，其中ChallengeActionParameters.Name仅支持JSChallenge。
    • */ Action?: SecurityAction; } /** * DescribeAvailableCustomActionsForRuleEngine请求参数结构体 */ export interface DescribeAvailableCustomActionsForRuleEngineRequest { /** *

    站点 ID。

    */ ZoneId: string; /** *

    过滤条件，多个条件为且关系，Filters.Values 的上限为 20。该参数不填写时，返回当前站点下所有可用的规则引擎定制配置。详细的过滤条件如下：

  • action-id：按照定制配置唯一标识 ID 进行过滤；
  • name：按照定制配置名称进行过滤。
    • 模糊查询时仅支持过滤字段名为 name。

    */ Filters?: Array; /** *

    分页查询限制数目。

    取值范围：[0, 1000]

    默认值：20

    */ Limit?: number; /** *

    分页偏移量。

    默认值：0

    */ Offset?: number; /** *

    排序字段，取值有：

  • action-id：按照定制配置唯一标识 ID 排序；
  • create-time：按照定制配置创建时间排序。
    • 默认值：action-id。

    */ SortBy?: string; /** *

    排序方式，取值有：

  • asc：升序排序；
  • desc：降序排序。
    • 默认值：desc。

    */ SortOrder?: string; } /** * 预付费套餐自动续费配置项。 */ export interface RenewFlag { /** * 预付费套餐的自动续费标志，取值有：
  • on：开启自动续费；
  • off：不开启自动续费。
    • */ Switch: string; } /** * DescribeWebSecurityTemplates请求参数结构体 */ export interface DescribeWebSecurityTemplatesRequest { /** * 站点 ID 列表。单次查询最多传入 100 个站点。 */ ZoneIds: Array; } /** * 安全的执行动作 */ export interface SecurityAction { /** * 安全执行的具体动作。取值有：
  • Deny：拦截，阻止请求访问站点资源；
  • Monitor：观察，仅记录日志；
  • Redirect：重定向至 URL；
  • Disabled：未启用，不启用指定规则；
  • Allow：允许访问，但延迟处理请求；
  • Challenge：挑战，响应挑战内容；
  • Trans：放行，允许请求直接访问站点资源；
  • BlockIP：待废弃，IP 封禁；
  • ReturnCustomPage：待废弃，使用指定页面拦截；
  • JSChallenge：待废弃，JavaScript 挑战；
  • ManagedChallenge：待废弃，托管挑战。
    • */ 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 情报库（原客户端画像分析）。取值有：
  • on：开启；
  • off：关闭。
    • */ Enabled?: string; /** * IP 情报库（原客户端画像分析）的具体配置内容。 */ IPReputationGroup?: IPReputationGroup; } /** * CreateSecurityAPIService请求参数结构体 */ export interface CreateSecurityAPIServiceRequest { /** * 站点 ID。 */ ZoneId: string; /** * API 服务列表。 */ APIServices?: Array; } /** * 精准速率限制的配置 */ export interface RateLimitingRules { /** * 精准速率限制的定义列表。使用 ModifySecurityPolicy 修改 Web 防护配置时:
  • 若未指定 Rules 参数，或 Rules 参数长度为零：清空所有精准速率限制配置。
  • 若 SecurityPolicy 参数中，未指定 RateLimitingRules 参数值：保持已有自定义规则配置，不做修改。
    • */ Rules?: Array; } /** * 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; /** * 操作模式，取值有：
  • enable：启用；
  • disable：停用。
    • */ OperationMode: string; } /** * IDC 规则配置的具体内容。 */ export interface SourceIDC { /** * 来自指定 IDC 请求的处置方式。 SecurityAction 的 Name 取值支持：
  • Deny：拦截；
  • Monitor：观察；
  • Disabled：未启用，不启用指定规则；
  • Challenge：挑战，其中 ChallengeActionParameters 中的 ChallengeOption 支持 JSChallenge 和 ManagedChallenge；
  • Allow：放行（待废弃）。
    • */ BaseAction?: SecurityAction; /** * 指定 IDC 请求的处置方式。 */ BotManagementActionOverrides?: Array; } /** * 智能压缩配置。 */ export interface CompressionParameters { /** * 智能压缩配置开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch?: string; /** * 支持的压缩算法列表。当 Switch 为 on 时，此字段必填，否则此字段不生效。取值有：
  • brotli：brotli 算法；
  • gzip：gzip 算法。
    • */ Algorithms?: Array; } /** * DescribeConfigGroupVersionDetail返回参数结构体 */ export interface DescribeConfigGroupVersionDetailResponse { /** * 版本信息。 */ ConfigGroupVersionInfo?: ConfigGroupVersionInfo; /** * 版本文件的内容。以 JSON 格式返回。 */ Content?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 加速域名源站信息。 */ export interface OriginDetail { /** * 源站类型，取值有：
  • IP_DOMAIN：IPV4、IPV6 或域名类型源站；
  • COS：腾讯云 COS 对象存储源站；
  • AWS_S3：AWS S3 对象存储源站；
  • ORIGIN_GROUP：源站组类型源站；
  • VOD：云点播；
  • SPACE：源站卸载，当前仅白名单开放；
  • LB：负载均衡，当前仅白名单开放。
    • */ OriginType?: string; /** * 源站地址，根据 OriginType 的取值分为以下情况：
  • 当 OriginType = IP_DOMAIN 时，该参数为 IPv4、IPv6 地址或域名；
  • 当 OriginType = COS 时，该参数为 COS 桶的访问域名；
  • 当 OriginType = AWS_S3，该参数为 S3 桶的访问域名；
  • 当 OriginType = ORIGIN_GROUP 时，该参数为源站组 ID；如果引用了其它站点的源站组，格式为{源站组 ID}@{ZoneID}。例如：og-testorigin@zone-38moq1z10wwwy
  • 当 OriginType = VOD 时，该参数请填写云点播应用 ID ；
  • 当 OriginType = LB 时，该参数请填写负载均衡实例 ID，该功能当前仅白名单开放；如果引用了其它站点的负载均衡，格式为{负载均衡 ID}@{ZoneID}。例如：lb-2rxpamcyqfzg@zone-38moq1z10wwwy
  • 当 OriginType = SPACE 时，该参数请填写源站卸载空间 ID，该功能当前仅白名单开放。
    • */ Origin?: string; /** * 备用源站组 ID，该参数仅在 OriginType = ORIGIN_GROUP 且配置了备源站组时会生效。 */ BackupOrigin?: string; /** * 主源源站组名称，当 OriginType = ORIGIN_GROUP 时该参数会返回值。 */ OriginGroupName?: string; /** * 备用源站组名称，该参数仅当 OriginType = ORIGIN_GROUP 且配置了备用源站组时会生效。 */ BackOriginGroupName?: string; /** * 指定是否允许访问私有对象存储源站，该参数仅当源站类型OriginType = COS 或 AWS_S3 时会生效，取值有：
  • on：使用私有鉴权；
  • off：不使用私有鉴权。
    • 不填写，默认值为 off。 */ PrivateAccess?: string; /** * 私有鉴权使用参数，该参数仅当源站类型 PrivateAccess = on 时会生效。 注意：此字段可能返回 null，表示取不到有效值。 */ PrivateParameters?: Array; /** * 当前配置的回源 HOST 头。 */ HostHeader?: string; /** * MO 子应用 ID * @deprecated */ VodeoSubAppId?: number; /** * MO 分发范围，取值有：
  • All：全部
  • Bucket：存储桶
    • * @deprecated */ VodeoDistributionRange?: string; /** * MO 存储桶 ID，分发范围(DistributionRange)为存储桶(Bucket)时必填 * @deprecated */ VodeoBucketId?: string; /** * 云点播回源范围，当 OriginType = VOD 时该参数会返回值。取值有:
  • all：当前源站对应的云点播应用内所有文件，默认值为 all；
  • bucket：当前源站对应的云点播应用下指定某一个存储桶内的文件。通过参数 VodBucketId 来指定存储桶。
    • */ VodOriginScope?: string; /** * 云点播存储桶 ID，该参数当 OriginType = VOD 且 VodOriginScope = bucket 时必填。数据来源：云点播专业版应用下存储桶的存储 ID 。 */ VodBucketId?: string; } /** * 推理硬件规格信息。 */ export interface InferenceHardwareSpecification { /** *

    规格标识。已废弃，参考使用字段 HardwareSpecId。

    * @deprecated */ Spec?: string; /** *

    规格唯一标识 ID。

    */ HardwareSpecId?: string; /** *

    规格名称。

    */ Name?: string; /** *

    规格默认分配的 GPU 卡数。

    */ GPUNum?: number; /** *

    规格默认分配的 CPU 核数。

    */ CPUNum?: number; /** *

    规格默认分配的内存大小。

    单位：MB

    */ MemSize?: number; /** *

    规格默认分配的显存大小。

    单位：MB

    */ GPUMemSize?: number; /** *

    规格默认分配的磁盘大小。

    单位：MB

    */ DiskSize?: number; /** *

    规格当前支持的 GPU 卡数列表。

    若不填充或填充空数组，则仅支持规格默认分配的 GPU 卡数。

    */ AllowedGPUNums?: Array; } /** * DescribeSecurityClientAttester返回参数结构体 */ export interface DescribeSecurityClientAttesterResponse { /** * 认证选项总数量。 */ TotalCount?: number; /** * 认证选项列表。 */ ClientAttesters?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 自定义变量详情。 */ export interface CustomVariable { /** *

    变量名称。需填写完整前缀：user.zone.* 表示站点级自定义变量，user.rule.* 表示规则级自定义变量。前缀后的自定义部分仅支持大小写字母、数字和下划线。变量名称区分大小写，长度不能超过 50 个字符。变量创建成功后，名称不可修改。

    */ Name: string; /** *

    变量初始值。支持使用常量字符串、变量以及公式。长度不能超过 255 个字符。

    */ InitialValue?: string; /** *

    变量描述。长度限制不超过 60 个字符。

    */ Description?: string; } /** * 多通道网关示例实例与回源 IP 网段的绑定关系，以及回源 IP 网段详情。 */ export interface MultiPathGatewayOriginACLInfo { /** * 当前生效的回源 IP 网段。 */ MultiPathGatewayCurrentOriginACL?: MultiPathGatewayCurrentOriginACL; /** * 当回源 IP 网段发生更新时，该字段会返回下一个版本将要生效的回源 IP 网段，包含与当前回源 IP 网段的对比。无更新时该字段为空。 */ MultiPathGatewayNextOriginACL?: MultiPathGatewayNextOriginACL; } /** * HTTP 头部设置规则。 */ export interface HeaderAction { /** * HTTP 头部设置方式。取值有：
  • set：设置。变更指定头部参数的取值为设置后的值；
  • del：删除。删除指定的头部参数；
  • add：增加。增加指定的头部参数。
    • */ 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; /** * 预付费套餐的自动续费标志，取值有：
  • on：开启自动续费；
  • off：不开启自动续费。
    • 不填写使用默认值 off，自动续费时，默认续费1个月。 */ RenewFlag?: string; } /** * 正文传输最小速率阈值的具体配置。 */ export interface MinimalRequestBodyTransferRate { /** * 正文传输最小速率阈值，单位仅支持bps。 */ MinimalAvgTransferRateThreshold: string; /** * 正文传输最小速率统计时间范围，取值有：
  • 10s：10秒；
  • 30s：30秒；
  • 60s：60秒；
  • 120s：120秒。
    • */ CountingPeriod: string; /** * 正文传输最小速率阈值是否开启。取值有：
  • on：开启；
  • off：关闭。
    • */ Enabled: string; } /** * 访问 URL 重定向 配置参数。 */ export interface AccessURLRedirectQueryString { /** * 执行动作，取值有：
  • full：全部保留；
  • ignore：全部忽略。
    • */ Action?: string; } /** * 浏览器伪造识别规则（原主动特征识别规则）。 */ export interface BrowserImpersonationDetectionRule { /** * 浏览器伪造识别规则的 ID。
    通过规则 ID 可支持不同的规则配置操作：
  • 增加新规则：ID 为空或不指定 ID 参数；
  • 修改已有规则：指定需要更新/修改的规则 ID；
  • 删除已有规则：BrowserImpersonationDetection 参数中，Rules 列表中未包含的已有规则将被删除。
    • */ Id?: string; /** * 浏览器伪造识别规则的名称。 */ Name?: string; /** * 浏览器伪造识别规则是否开启。取值有：
  • on：开启；
  • off：关闭。
    • */ Enabled?: string; /** * 浏览器伪造识别规则的具体内容，其中仅支持请求方式（Method）、请求路径（Path）和请求 URL 的配置，需符合表达式语法，详细规范参见产品文档。 */ Condition?: string; /** * 浏览器伪造识别规则的处置方式，包括 Cookie 校验和会话跟踪配置以及客户端行为校验配置。 */ Action?: BrowserImpersonationDetectionAction; } /** * DescribeInferenceAPITokens请求参数结构体 */ export interface DescribeInferenceAPITokensRequest { /** *

    站点 ID。

    */ ZoneId: string; /** *

    分页查询偏移量。默认值：0。

    */ Offset?: number; /** *

    分页查询限制数目。默认值：20，最大值：100。

    */ Limit?: number; } /** * ModifyFunctionRulePriority请求参数结构体 */ export interface ModifyFunctionRulePriorityRequest { /** * 站点 ID。 */ ZoneId: string; /** * 规则 ID 列表，必须填入调整优先级后的所有规则 ID，多条规则执行顺序依次从上往下，不填写保持原优先级顺序。 */ RuleIds: Array; } /** * ModifyAccelerationDomain返回参数结构体 */ export interface ModifyAccelerationDomainResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteSecurityAPIResource请求参数结构体 */ export interface DeleteSecurityAPIResourceRequest { /** * 站点 ID。 */ ZoneId: string; /** * 需要删除的 API 资源 ID 列表。 */ APIResourceIds?: Array; } /** * 源站卸载配置参数。 */ 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; } /** * DescribeInferenceServiceMonitorData返回参数结构体 */ export interface DescribeInferenceServiceMonitorDataResponse { /** *

    查询结果的总条数。

    */ TotalCount?: number; /** *

    推理服务监控数据。

    */ InferenceServiceMonitorRecords?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeHostsSetting返回参数结构体 */ export interface DescribeHostsSettingResponse { /** * 域名列表。 */ DetailHosts?: Array; /** * 域名数量。 */ TotalNumber?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * OperateInferenceService请求参数结构体 */ export interface OperateInferenceServiceRequest { /** * 站点ID。 */ ZoneId: string; /** * 推理服务 ID。 */ ServiceId: string; /** * 操作类型，包含以下几种：
  • Stop：停止；
  • Resume：启动；
  • Delete：删除。
    • */ Operation: string; } /** * DescribeWebSecurityTemplate返回参数结构体 */ export interface DescribeWebSecurityTemplateResponse { /** * 安全策略模板配置内容，Bot 配置暂不支持，正在开发中。 */ SecurityPolicy?: SecurityPolicy; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 源站配置。 */ export interface Origin { /** * 主源站列表。 */ Origins?: Array; /** * 备源站列表。 */ BackupOrigins?: Array; /** * 回源协议配置，取值有：
  • http：强制 http 回源；
  • follow：协议跟随回源；
  • https：强制 https 回源。
    • */ OriginPullProtocol?: string; /** * 源站为腾讯云 COS 时，是否为私有访问 bucket，取值有：
  • on：私有访问；
  • off：公共访问。
    • */ CosPrivateAccess?: string; } /** * DescribeRules返回参数结构体 */ export interface DescribeRulesResponse { /** * 站点 ID。 */ ZoneId?: string; /** * 规则列表，按规则执行顺序从先往后排序。 */ RuleItems?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 时序数据信息 */ export interface TimingDataRecord { /** * 查询维度值。 */ TypeKey?: string; /** * Integer 类型的详细时序数据，查询指标值类型为 Integer 指标会由本字段返回对应时序数据。
    **注意**：若查询指标未明确说明指标值类型，默认由本字段返回数据。 */ TypeValue?: Array; /** * Float 类型的详细时序数据，查询指标值类型为 Float 指标会由本字段返回对应时序数据。 */ FloatTypeValue?: Array; } /** * 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 下所有实时日志投递任务信息。详细的过滤条件如下：
  • task-id：按照实时日志投递任务 ID进行过滤。不支持模糊查询。
  • task-name：按照实时日志投递任务名称进行过滤。支持模糊查询，使用模糊查询时，仅支持填写一个实时日志投递任务名称。
  • entity-list：按照实时日志投递任务对应的实体进行过滤。不支持模糊查询。示例值：domain.example.com 或者 sid-2s69eb5wcms7。
  • task-type：按照实时日志投递任务类型进行过滤。不支持模糊查询。可选项如下：
       cls: 推送到腾讯云 CLS；
       custom_endpoint：推送到自定义 HTTP(S) 地址；
       s3：推送到 AWS S3 兼容存储桶地址；
       log_analysis：推送到 EdgeOne 日志分析。
    • */ Filters?: Array; } /** * DescribeOriginProtection返回参数结构体 */ export interface DescribeOriginProtectionResponse { /** * 源站防护信息。 注意：此字段可能返回 null，表示取不到有效值。 */ OriginProtectionInfo?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * EdgeOne 人机校验认证实例信息。 */ export interface TCEOCaptchaOption { /** * EdgeOne 人机校验模式，取值有：
  • Invisible：无感验证；
  • Adaptive：自适应交互验证。
    • */ CaptchaMode?: string; } /** * DescribeBillingData请求参数结构体 */ export interface DescribeBillingDataRequest { /** * 起始时间。 */ StartTime: string; /** * 结束时间。查询时间范围（`EndTime` - `StartTime`）需小于等于 31 天。 */ EndTime: string; /** * 站点 ID 集合，此参数必填。最多传入 100 个站点 ID。若需查询腾讯云主账号下所有站点数据，请用 `*` 代替，查询账号级别数据需具备本接口全部站点资源权限。 */ ZoneIds: Array; /** * 指标列表，取值如下： 四/七层加速流量：
  • acc_flux: 内容加速流量，单位为 Byte；
  • smt_flux: 智能加速流量，单位为 Byte；
  • l4_flux: 四层加速流量，单位为 Byte；
  • sec_flux: 独立防护流量，单位为 Byte；
  • zxctg_flux: 中国大陆网络优化流量，单位为 Byte。

    • 四/七层加速带宽:
  • acc_bandwidth: 内容加速带宽，单位为 bps；
  • smt_bandwidth: 智能加速带宽，单位为 bps；
  • l4_bandwidth: 四层加速带宽，单位为 bps；
  • sec_bandwidth: 独立防护带宽，单位为 bps；
  • zxctg_bandwidth: 中国大陆网络优化带宽，单位为 bps。

    • HTTP/HTTPS 安全请求数：
  • sec_request_clean: HTTP/HTTPS 请求，单位为次。

    • 增值服务用量：
  • smt_request_clean: 智能加速请求，单位为次；
  • quic_request: QUIC 请求，单位为次；
  • bot_request_clean: Bot 请求，单位为次；
  • cls_count: 实时日志推送条数，单位为条；
  • ddos_bandwidth: 弹性 DDoS 防护带宽，单位为 bps。

    • 边缘计算用量：
  • edgefunction_request：边缘函数请求数，单位为次；
  • edgefunction_cpu_time：边缘函数CPU处理时间，单位为毫秒。
    • 媒体处理用量：
  • total_transcode：所有规格音频，视频即时转码，转封装时长，单位为秒；
  • remux：转封装时长，单位为秒；
  • transcode_audio：音频转码时长，单位为秒；
  • transcode_H264_SD：H.264 编码方式的标清视频（短边 <= 480 px）时长，单位为秒；
  • transcode_H264_HD：H.264 编码方式的高清视频（短边 <= 720 px）时长，单位为秒；
  • transcode_H264_FHD：H.264 编码方式的全高清视频（短边 <= 1080 px）时长，单位为秒；
  • transcode_H264_2K：H.264 编码方式的 2K 视频（短边 <= 1440 px）时长，单位为秒。
    • */ MetricName: string; /** * 查询时间粒度，取值有：
  • 5min：5 分钟粒度；
  • hour：1 小时粒度；
  • day：1 天粒度。
    • */ Interval: string; /** * 过滤条件，详细的过滤条件取值如下：
  • host：按照域名进行过滤。示例值：test.example.com。
  • proxy-id：按照四层代理实例 ID 进行过滤。示例值：sid-2rugn89bkla9。
  • region-id：按照计费大区进行过滤。可选项如下：
      CH：中国大陆境内
      AF：非洲
      AS1：亚太一区
      AS2：亚太二区
      AS3：亚太三区
      EU：欧洲
      MidEast：中东
      NA：北美
      SA：南美
    • 说明：相同 `Type` 的 `BillingDataFilter` 之间为“或”关系，不同 `Type` 的 `BillingDataFilter` 之间为“且”关系。 */ Filters?: Array; /** * 分组聚合维度。最多允许同时按照两种维度进行分组。取值如下：
  • zone-id：按照站点 ID 进行分组，若使用了内容标识符功能，则优先按照内容标识符分组；
  • host：按照域名进行分组；
  • proxy-id：按照四层代理实例 ID 进行分组；
  • region-id：按照计费大区进行分组。
    • */ GroupBy?: Array; } /** * 实时日志投递的输出格式。您可以直接通过 FormatType 参数使用指定预设日志输出格式（JSON Lines / csv），也可以在预设日志输出格式基础上，通过其他参数来自定义变体输出格式，使用详情见 [自定义日志输出格式](https://cloud.tencent.com/document/product/1552/110448)。 */ export interface LogFormat { /** *

    日志输出格式，取值有：

    • json：使用预设日志输出格式 JSON Lines，单条日志中的字段以键值对方式呈现；
    • csv：使用预设日志输出格式 csv，单条日志中仅呈现字段值，不呈现字段名称。
    • template：使用用户自定义输出模板，单条日志中支持按照自定义模板进行自定义排版和拼接，需配合 RecordTemplate 字段使用。
    */ FormatType: string; /** *

    在每个日志投递批次之前添加的字符串。每个日志投递批次可能包含多条日志记录。

    */ BatchPrefix?: string; /** *

    在每个日志投递批次后附加的字符串。

    */ BatchSuffix?: string; /** *

    单条日志前缀，在每条日志记录之前添加的字符串。

    */ RecordPrefix?: string; /** *

    单条日志后缀，在每条日志记录后附加的字符串。

    */ RecordSuffix?: string; /** *

    日志分隔符，插入日志记录之间作为分隔的字符串，取值有：

    • \n：换行符；
    • \t：制表符；
    • ，：半角逗号。
    */ RecordDelimiter?: string; /** *

    日志模板，单条日志的输出模板，长度限制 4KB，仅当 FormatType = template 生效。支持对配置的推送字段按照模板进行自定义排版和拼接。

    */ RecordTemplate?: string; /** *

    字段分隔符，单条日志记录内，插入字段之间作为分隔符的字符串，仅当 FormatType = csv 生效。取值有：

    • \t：制表符；
    • ，：半角逗号；
    • ;：半角分号。

    */ FieldDelimiter?: string; } /** * DescribeEnvironments请求参数结构体 */ export interface DescribeEnvironmentsRequest { /** * 站点 ID。 */ ZoneId: string; } /** * CreateInferenceService请求参数结构体 */ export interface CreateInferenceServiceRequest { /** *

    站点 ID。

    */ ZoneId: string; /** *

    推理服务的名称。长度限制不超过 30 个字符，仅支持小写字母、数字、连字符，以字母开头，数字或字母结尾，不支持重复。

    */ Name: string; /** *

    模型服务需要监听的端口。仅支持 1-65535 之间的整数。

    */ ListenPort: number; /** *

    推理服务的容器配置。当前仅支持设置 1 个容器。

    */ Containers: Array; /** *

    推理服务的资源配置。

    */ ResourceConfig: InferenceResourceConfig; /** *

    推理服务亲和性配置。

    */ AffinityConfig?: InferenceAffinityConfig; /** *

    推理服务的请求路径列表。最多支持 20 个路径。

    */ RequestPaths?: Array; /** *

    描述信息。长度限制不超过 60 个字符。

    */ Description?: string; } /** * 多通道安全网关详情 */ export interface MultiPathGateway { /** * 网关 ID。 */ GatewayId?: string; /** * 网关名。 */ GatewayName?: string; /** * 网关类型，取值有：
  • cloud：云上网关，腾讯云创建和管理的网关。
  • private：自有网关，用户部署的私有网关。
    • */ GatewayType?: string; /** * 网关端口，范围 1～65535（除去 8888 ）。 */ GatewayPort?: number; /** * 网关状态，取值有：
  • creating : 创建中；
  • online : 在线；
  • offline : 离线；
  • disable : 已停用。
    • */ Status?: string; /** * 网关 IP， 格式为 IPv4。 */ GatewayIP?: string; /** * 网关地域 Id，可以从接口 DescribeMultiPathGatewayRegions 获取 RegionId 列表。 */ RegionId?: string; /** * 线路信息，当查询网关信息详情 DescribeMultiPathGateway 的时候会返回，当查询网关列表 DescribeMultiPathGateways 的时候不会返回。 */ Lines?: Array; /** * 网关回源 IP 列表发生了变化是否需要重新确认，取值有：
  • true：回源 IP 列表发生了变化，需要确认；
  • false：回源 IP 列表未发生变化，无需确认。
    • */ NeedConfirm?: string; } /** * DescribeAliasDomains请求参数结构体 */ export interface DescribeAliasDomainsRequest { /** * 站点 ID。 */ ZoneId: string; /** * 分页查询偏移量。默认值：0。 */ Offset?: number; /** * 分页查询限制数目。默认值：20，最大值：1000。 */ Limit?: number; /** * 过滤条件，Filters.Values的上限为20。详细的过滤条件如下：
  • target-name：目标域名名称进行过滤；
  • alias-name：按照别称域名名称进行过滤。
    • 模糊查询时仅支持过滤字段名为 alias-name。 */ Filters?: Array; } /** * QUIC 配置项。 */ export interface QUICParameters { /** * QUIC 配置开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch?: string; } /** * 托管规则组信息 */ export interface ManagedRuleGroupMeta { /** * 托管规则组描述，仅出参。 */ GroupDetail?: string; /** * 托管规则组名称，仅出参。 */ GroupName?: string; /** * 当前托管规则组下的所有子规则信息，仅出参。 */ RuleDetails?: Array; } /** * 速率限制规则 */ export interface RateLimitConfig { /** * 开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch: string; /** * 速率限制-用户规则列表。如果为null，默认使用历史配置。 */ RateLimitUserRules?: Array; /** * 速率限制模板功能。如果为null，默认使用历史配置。 */ RateLimitTemplate?: RateLimitTemplate; /** * 智能客户端过滤。如果为null，默认使用历史配置。 */ RateLimitIntelligence?: RateLimitIntelligence; /** * 速率限制-托管定制规则。如果为null，默认使用历史配置。 */ RateLimitCustomizes?: Array; } /** * DescribeInferenceServiceDeploymentLogs返回参数结构体 */ export interface DescribeInferenceServiceDeploymentLogsResponse { /** * 符合条件的部署日志总数。 */ TotalCount?: number; /** * 部署日志列表。 */ DeploymentLogInfoSet?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateRealtimeLogDeliveryTask请求参数结构体 */ export interface CreateRealtimeLogDeliveryTaskRequest { /** *

    站点 ID。

    */ ZoneId: string; /** *

    数据投递区域，可选值：

    • mainland：中国大陆境内；
    • overseas：全球（不含中国大陆）。

    */ Area: string; /** *

    数据投递类型，可选值：

    • l7-access-logs：七层访问日志；
    • application：四层代理日志；
    • function：边缘函数运行日志；
    • web-attack：托管规则日志；
    以下类型日志合并入 l7-access-logs，不再支持新增：

    • domain：站点加速日志；
    • web-rateLiming：速率限制和 CC 攻击防护日志；
    • web-rule：自定义规则日志；
    • web-bot：Bot 管理日志。
    */ LogType: string; /** *

    实时日志投递任务的名称，格式为数字、英文、-和_组合，最多 200 个字符。

    */ TaskName: string; /** *

    实时日志投递任务类型，取值有：

    • cls: 推送到腾讯云 CLS；
    • custom_endpoint：推送到自定义 HTTP(S) 地址；
    • s3：推送到 AWS S3 兼容存储桶地址；
    • log_analysis：推送到 EdgeOne 日志分析，仅当 LogType = l7-access-logs 或 web-attack 时支持。

    */ TaskType: string; /** *

    实时日志投递任务对应的实体列表。取值示例如下：

    • 七层域名：domain.example.com
    • 四层代理实例：sid-2s69eb5wcms7
    • 边缘函数实例：test-zone-2mxigizoh9l9-1257626257

    取值参考：DescribeL4Proxy

    */ EntityList: Array; /** *

    投递的预设字段列表。取值参考：

    取值参考：DescribeLogFields

    */ Fields: Array; /** *

    投递的自定义字段列表，支持在 HTTP 请求头、响应头、Cookie、请求正文中提取指定内容。
    自定义字段名称不能重复，仅七层访问日志（LogType= l7-access-logs 或 domain）支持添加自定义字段。
    允许配置的自定义字段个数有配额限制，如遇配额不足请 [联系我们](https://cloud.tencent.com/online-service?from=sales&source=PRESALE)。

    */ CustomFields?: Array; /** *

    投递的自定义表达式字段列表，可以通过自定义日志推送字段名称和取值表达式，实现个性化的实时日志内容推送，使用详情见 [自定义日志字段表达式]()。
    仅七层访问日志（LogType= l7-access-logs 或 domain）支持添加自定义字段。
    允许配置的自定义字段个数有配额限制，如遇配额不足请 [联系我们](https://cloud.tencent.com/online-service?from=sales&source=PRESALE) 。
    **注意**：若 CustomExpressionFields 中存在命名 与 Fields 和 CustomFields 中同名的字段，以 CustomExpressionFields 中的取值为准。

    */ CustomExpressionFields?: Array; /** *

    日志投递的过滤条件，不填表示投递全量日志。

    */ DeliveryConditions?: Array; /** *

    采样比例，采用千分制，取值范围为1-1000，例如：填写 605 表示采样比例为 60.5%。不填表示采样比例为 100%。

    */ Sample?: number; /** *

    日志投递的输出格式，使用详情见 自定义日志输出格式。不填表示为默认格式，默认格式逻辑如下：

    • 当 TaskType 取值为 custom_endpoint 时，默认格式为多个 JSON 对象组成的数组，每个 JSON 对象为一条日志；
    • 当 TaskType 取值为 s3 时，默认格式为 JSON Lines；
    特别地，当 TaskType 取值为 cls 或 log_analysis 时，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; /** * 发布时间。时间为世界标准时间（UTC）， 遵循 ISO 8601 标准的日期和时间格式。 */ DeployTime?: string; /** * 发布状态，取值有：
  • deploying ：发布中；
  • failure ：发布失败；
  • success： 发布成功。
    • */ Status?: string; /** * 发布结果信息。 */ Message?: string; /** * 发布记录 ID。 */ RecordId?: string; /** * 变更说明。 */ Description?: string; } /** * 规则引擎参数详情信息，特殊参数类型。 */ export interface RuleExtraParameter { /** * 参数名，取值有：
  • Action：修改 HTTP 头部所需参数，RuleAction 选择 RewirteAction；
  • StatusCode：状态码相关功能所需参数，RuleAction 选择 CodeAction。
    • */ Id: string; /** * 参数值类型。
  • CHOICE：参数值只能在 Values 中选择；
  • CUSTOM_NUM：参数值用户自定义，整型类型；
  • CUSTOM_STRING：参数值用户自定义，字符串类型。
    • */ Type: string; /** * 可选参数值。 注意：当 Id 的值为 StatusCode 时数组中的值为整型，填写参数值时请填写字符串的整型数值。 */ Choices: Array; } /** * ModifyL7AccRulePriority请求参数结构体 */ export interface ModifyL7AccRulePriorityRequest { /** * 站点 ID。 */ ZoneId: string; /** * 站点 ID 下完整的规则 ID 列表，规则 ID 列表可以通过 [查询七层加速规则](https://cloud.tencent.com/document/product/1552/115820) 获取，最终优先级顺序将调整成规则 ID 列表的顺序，从前往后依次执行。 */ RuleIds: Array; } /** * EdgeKVList请求参数结构体 */ export interface EdgeKVListRequest { /** * 站点 ID。 */ ZoneId: string; /** * 命名空间名称。 */ Namespace: string; /** * 键名前缀过滤。只返回以指定前缀开头的键名，长度为 1-512 个字符。不填写表示返回所有键名；不允许传入空字符串。 */ Prefix?: string; /** * 游标位置。标识当前查询的起始位置，用于遍历大量数据。首次查询时不填写，从头开始遍历；后续查询时填写上一次返回的 Cursor 值，从该位置继续向后遍历。 */ Cursor?: string; /** * 返回的键名数量。默认值：20，最大值：1000。 */ Limit?: number; } /** * 慢速攻击配置。 */ export interface SlowPostConfig { /** * 开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch: string; /** * 首包配置。 */ FirstPartConfig?: FirstPartConfig; /** * 基础配置。 */ SlowRateConfig?: SlowRateConfig; /** * 慢速攻击的处置动作，取值有：
  • monitor：观察；
  • drop：拦截。
    • */ Action?: string; /** * 本规则的Id。 */ RuleId?: number; } /** * WebSocket配置 */ export interface WebSocket { /** * WebSocket 超时时间配置开关，取值有：
  • on：使用Timeout作为WebSocket超时时间；
  • off：平台仍支持WebSocket连接，此时使用系统默认的15秒为超时时间。
    • */ Switch: string; /** * 超时时间，单位为秒，最大超时时间120秒。 */ Timeout?: number; } /** * ModifyAccelerationDomain请求参数结构体 */ export interface ModifyAccelerationDomainRequest { /** * 加速域名所属站点ID。 */ ZoneId: string; /** * 加速域名名称。 */ DomainName: string; /** * 源站信息。 */ OriginInfo?: OriginInfo; /** * 回源协议，取值有：
  • FOLLOW: 协议跟随；
  • HTTP: HTTP协议回源；
  • HTTPS: HTTPS协议回源。
  • 不填保持原有配置。
    • */ OriginProtocol?: string; /** * HTTP回源端口，取值为1-65535，当OriginProtocol=FOLLOW/HTTP时生效, 不填保持原有配置。 */ HttpOriginPort?: number; /** * HTTPS回源端口，取值为1-65535，当OriginProtocol=FOLLOW/HTTPS时生效，不填保持原有配置。 */ HttpsOriginPort?: number; /** * IPv6状态，取值有：
  • follow：遵循站点IPv6配置；
  • on：开启状态；
  • off：关闭状态。
  • 不填保持原有配置。
    • */ IPv6Status?: string; } /** * EdgeKVGet请求参数结构体 */ export interface EdgeKVGetRequest { /** * 站点 ID。 */ ZoneId: string; /** * 命名空间名称。可通过 DescribeEdgeKVNamespaces 接口获取站点下的命名空间列表。 */ Namespace: string; /** * 键名列表。数组长度上限为 20。每个键名不能为空，长度为 1-512 个字符，支持合法 UTF-8 字符。查询单个键时传入包含一个元素的数组。 */ Keys: Array; } /** * 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; } /** * CreateAliasDomain请求参数结构体 */ export interface CreateAliasDomainRequest { /** * 站点 ID。 */ ZoneId: string; /** * 别称域名名称。 */ AliasName: string; /** * 目标域名名称。 */ TargetName: string; /** * 证书配置，取值有：
  • none：不配置；
  • hosting：SSL托管证书。
    • 默认取值为 none。 */ CertType?: string; /** * 当 CertType 取值为 hosting 时需填入相应证书 ID。 */ CertId?: Array; } /** * 边缘推理定时伸缩动作配置，用于描述一条具体的定时伸缩动作。 */ 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; /** * 预热模式，取值有：
  • default：默认模式，即预热到中间层；
  • edge：边缘预热模式，即预热到边缘和中间层。
    • 不填写时，默认值为 default。 注意事项： 1.预热至边缘产生的边缘层流量，会计入计费流量； 2.边缘预热默认分配单独的预热额度 1000 条/天，不消费常规预热额度。 说明： 该参数为白名单功能，如有需要，请联系腾讯云工程师处理。 */ Mode?: string; /** * 是否对url进行encode，若内容含有非 ASCII 字符集的字符，请开启此开关进行编码转换（编码规则遵循 RFC3986）。 * @deprecated */ EncodeUrl?: boolean; /** * 若需要携带 HTTP 头部信息预热，可入参该参数，否则放空即可。 */ Headers?: Array
    ; /** * 媒体分片预热控制，取值有：
  • on：开启分片预热，预热描述文件，并递归解析描述文件分片进行预热；
  • off：仅预热提交的描述文件；
    • 不填写时，默认值为 off。 注意事项： 1. 支持的描述文件为 M3U8，对应分片为 TS； 2. 要求描述文件能正常请求，并按行业标准描述分片路径； 3. 递归解析深度不超过 3 层； 4. 解析获取的分片会正常累加每日预热用量，当用量超出配额时，会静默处理，不再执行预热。 说明： 该参数为白名单功能，如有需要，请联系腾讯云工程师处理。 */ PrefetchMediaSegments?: string; } /** * DescribeApplicationProxies返回参数结构体 */ export interface DescribeApplicationProxiesResponse { /** * 应用代理列表。 */ ApplicationProxies?: Array; /** * 记录总数。 */ TotalCount?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 自定义 nameservers */ export interface VanityNameServers { /** * 自定义 ns 开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch: string; /** * 自定义 ns 列表。 */ Servers?: Array; } /** * DescribeTopL7AnalysisData请求参数结构体 */ export interface DescribeTopL7AnalysisDataRequest { /** * 开始时间。 */ StartTime: string; /** * 结束时间。查询时间范围（`EndTime` - `StartTime`）需小于等于 31 天。 */ EndTime: string; /** * 查询的指标，取值有：
  • l7Flow_outFlux_country：按国家/地区维度统计 L7 EdgeOne 响应流量指标；
  • l7Flow_outFlux_province：按中国大陆境内省份维度统计 L7 EdgeOne 响应流量指标；
  • l7Flow_outFlux_statusCode：按状态码维度统计 L7 EdgeOne 响应流量指标；
  • l7Flow_outFlux_domain：按域名维度统计 L7 EdgeOne 响应流量指标；
  • l7Flow_outFlux_url：按 URL Path 维度统计 L7 EdgeOne 响应流量指标;
  • l7Flow_outFlux_resourceType：按资源类型维度统计 L7 EdgeOne 响应流量指标；
  • l7Flow_outFlux_sip：按客户端 IP 维度统计 L7 EdgeOne 响应流量指标；
  • l7Flow_outFlux_referers：按 Referer 维度统计 L7 EdgeOne 响应流量指标；
  • l7Flow_outFlux_ua_device：按设备类型维度统计 L7 EdgeOne 响应流量指标;
  • l7Flow_outFlux_ua_browser：按浏览器类型维度统计 L7 EdgeOne 响应流量指标；
  • l7Flow_outFlux_ua_os：按操作系统类型维度统计 L7 EdgeOne 响应流量指标；
  • l7Flow_outFlux_ua：按 User-Agent 维度统计 L7 EdgeOne 响应流量指标；
  • l7Flow_request_country：按国家/地区维度统计 L7 访问请求数指标；
  • l7Flow_request_province：按中国大陆境内省份维度统计 L7 访问请求数指标；
  • l7Flow_request_statusCode：按状态码维度统计 L7 访问请求数指标；
  • l7Flow_request_domain：按域名维度统计 L7 访问请求数指标；
  • l7Flow_request_url：按 URL Path 维度统计 L7 访问请求数指标;
  • l7Flow_request_resourceType：按资源类型维度统计 L7 访问请求数指标；
  • l7Flow_request_sip：按客户端 IP 维度统计 L7 访问请求数指标；
  • l7Flow_request_referers：按 Referer 维度统计 L7 访问请求数指标；
  • l7Flow_request_ua_device：按设备类型维度统计 L7 访问请求数指标;
  • l7Flow_request_ua_browser：按浏览器类型维度统计 L7 访问请求数指标；
  • l7Flow_request_ua_os：按操作系统类型维度统计 L7 访问请求数指标；
  • l7Flow_request_ua：按 User-Agent 维度统计 L7 访问请求数指标。
    • */ MetricName: string; /** * 站点 ID 集合，此参数将于2024年05月30日后由可选改为必填，详见公告：[【腾讯云 EdgeOne】云 API 变更通知](https://cloud.tencent.com/document/product/1552/104902)。最多传入 100 个站点 ID。若需查询腾讯云主账号下所有站点数据，请用 `*` 代替，查询账号级别数据需具备本接口全部站点资源权限。 */ ZoneIds: Array; /** * 查询前多少个 top 数据，最大值为1000。不填默认为10，表示查询 top10 的数据。 */ Limit?: number; /** * 筛选数据时使用的过滤条件，取值参考 [指标分析筛选条件说明](https://cloud.tencent.com/document/product/1552/98219#1aaf1150-55a4-4b4d-b103-3a8317ac7945) 中针对 L7 访问流量、带宽、请求数的可用筛选项。 如需限定站点或内容标识符，请在 `ZoneIds.N` 参数中另行传入对应的值。 */ Filters?: Array; /** * 查询时间粒度，该参数无效，待废弃。 */ Interval?: string; /** * 数据归属地区。该参数已废弃。请在 `Filters.country` 中按客户端地域过滤数据。 */ Area?: string; } /** * CreateMultiPathGatewaySecretKey返回参数结构体 */ export interface CreateMultiPathGatewaySecretKeyResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAccelerationDomains返回参数结构体 */ export interface DescribeAccelerationDomainsResponse { /** * 符合查询条件的加速域名个数。 */ TotalCount?: number; /** * 符合查询条件的所有加速域名的信息。 */ AccelerationDomains?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 功能总开关 */ export interface SwitchConfig { /** * Web类型的安全总开关，取值有：
  • on：开启；
  • off：关闭。
    • 不影响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 { /** * 回源请求参数查询字符串配置开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch?: string; /** * 查询字符串模式。当 Switch 为 on 时，该参数必填。取值有：
  • full：全部保留；
  • ignore：全部忽略；
  • includeCustom：保留部分参数；
  • excludeCustom：忽略部分参数。
    • */ Action?: string; /** * 指定参数值。仅当查询字符串模式 Action 为 includeCustom 或者 excludeCustom 时该参数生效，用于指定需要保留或者忽略的参数。最大支持 10 个参数。 */ Values?: Array; } /** * 统计曲线数据项 */ export interface FloatTimingDataItem { /** * 返回数据对应时间点，采用 unix 秒级时间戳。 */ Timestamp?: number; /** * 具体数值。 */ Value?: number; } /** * DeleteJustInTimeTranscodeTemplates请求参数结构体 */ export interface DeleteJustInTimeTranscodeTemplatesRequest { /** * 站点ID。 */ ZoneId: string; /** * 需删除的即时转码模板唯一标识数组，长度限制：100。 */ TemplateIds: Array; } /** * 地区策略配置。 */ export interface ConfigGroupFunctionRegionSelection { /** *

    指定执行的函数，取值为函数在站点内的唯一标识。当 TriggerType 为 direct 时生效。

    */ Function: string; /** *

    国家/地区列表。示例值：CN：中国，CN.GD：中国广东。取值请参考：国家/地区及对应代码枚举。

    */ Regions: Array; } /** * ModifyLoadBalancer返回参数结构体 */ export interface ModifyLoadBalancerResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyL4Proxy返回参数结构体 */ export interface ModifyL4ProxyResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 推理服务自动伸缩配置。 */ export interface InferenceAutoScalingConfig { /** *

    最小实例数量。当配置了伸缩策略并且策略处于有效期时，将不会生效。

    */ MinInstanceCount: number; /** *

    伸缩策略列表。最多支持 5 个策略。

    */ ScalingPolicies?: Array; } /** * 负载均衡实例健康检查策略。 */ export interface HealthChecker { /** *

    健康检查策略，取值有：

  • HTTP；
  • HTTPS；
  • TCP；
  • UDP；
  • ICMP Ping；
  • NoCheck。
    • 注意：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 时有效，表示请求方法，取值有：

  • GET；
  • HEAD。
    • */ Method?: string; /** *

    该参数仅当 Type=HTTP 或 Type=HTTPS 时有效，表示探测节点向源站发起健康检查时，响应哪些状态码可用于认定探测结果为健康。

    */ ExpectedCodes?: Array; /** *

    该参数仅当 Type=HTTP 或 Type=HTTPS 时有效，表示探测请求携带的自定义 HTTP 请求头，至多可配置 10 个。

    */ Headers?: Array; /** *

    该参数仅当 Type=HTTP 或 Type=HTTPS 时有效，表示是否启用遵循 301/302 重定向。启用后，301/302 默认为"健康"的状态码，默认跳转 3 次。

    */ FollowRedirect?: string; /** *

    该参数仅当 Type=UDP 时有效，表示健康检查发送的内容。只允许 ASCII 可见字符，最大长度限制 500 个字符。

    */ SendContext?: string; /** *

    该参数仅当 Type=UDP 时有效，表示健康检查期望源站返回结果。只允许 ASCII 可见字符，最大长度限制 500 个字符。

    */ RecvContext?: string; /** *

    健康检查探测集群。指定本负载均衡实例发起健康探测的集群区域范围，探测集群地区分布详见健康检查策略介绍，仅 HTTP 专用型（V2）版本负载均衡实例支持设置。取值有：
    global：由全球所有区域的探测集群发起探测，包括中国大陆区域以及非中国大陆区域，各个区域的集群独立维护各自的探测结果；
    mainland_china：仅由中国大陆区域的探测集群发起探测，当前中国大陆区域共用一个探测集群，探测结果由中国大陆区域的探测集群维护，其他区域跟随中国大陆区域的集群的探测结果；
    overseas：仅由非中国大陆区域的探测集群发起探测，当前非中国大陆区域包含多个地区的探测集群，探测结果由各个地区的探测集群独立维护，中国大陆区域的探测结果由所有其他地区的探测集群的探测结果汇总生成。
    默认为 global。

    */ ProbeCluster?: string; } /** * CreateFunctionRule请求参数结构体 */ export interface CreateFunctionRuleRequest { /** * 站点 ID。 */ ZoneId: string; /** * 规则条件列表，相同触发规则的不同条件匹配项之间为或关系。 */ FunctionRuleConditions: Array; /** * 函数选择配置类型：
  • direct：直接指定执行函数；
  • weight：基于权重比选择函数；
  • region：基于客户端 IP 的国家/地区选择函数。
    • 不填时默认为 direct 。 */ TriggerType?: string; /** * 指定执行的函数 ID。当 TriggerType 为 direct 或 TriggerType 不填时生效。 */ FunctionId?: string; /** * 基于客户端 IP 国家/地区的函数选择配置，当 TriggerType 为 region 时生效且 RegionMappingSelections 必填。RegionMappingSelections 中至少包含一项 Regions 为 Default 的配置。 */ RegionMappingSelections?: Array; /** * 基于权重的函数选择配置，当 TriggerType 为 weight 时生效且 WeightedSelections 必填。WeightedSelections 中的所有权重之和需要为100。 */ WeightedSelections?: Array; /** * 规则描述，最大支持 60 个字符。 */ Remark?: string; } /** * 推理服务监控数据项。 */ export interface InferenceServiceMonitorItem { /** * 监控数据对应时间点。 */ Timestamp?: string; /** * 具体数值。 */ Value?: number; } /** * 推理的 TCR 镜像仓库配置。 */ export interface InferenceTCRRepositoryConfig { /** *

    TCR 服务类型。取值有：

  • Personal：个人版；
  • Enterprise：企业版。

    • */ TCRType: string; /** *

    镜像地址。

    */ Image: string; /** *

    镜像仓库实例 ID。当 TCRType = Enterprise 时必填。

    */ RegistryId?: string; /** *

    地域名称。

    */ 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)。
    注意：Actions 和 SubRules 不可同时为空。 注意：此字段可能返回 null，表示取不到有效值。 */ Actions?: Array; /** * 子规则列表。此列表中时存在多条规则，按照从上往下的顺序依次执行。
    注意：SubRules 和 Actions 不可同时为空。且当前只支持填写一层 SubRules。 注意：此字段可能返回 null，表示取不到有效值。 */ SubRules?: Array; } /** * 组件被引用的实例信息，用于展示该组件与边缘函数等资源的绑定关系。当边缘函数需要访问组件（如 KV 命名空间）时，会建立引用关系，通过此结构体可查看引用的具体实例详情及所属站点信息。 */ export interface ComponentReference { /** * 引用的实例类型。取值有：
  • edge-function：边缘函数。
    • */ ReferenceType?: string; /** * 引用的实例 ID。根据 ReferenceType 的取值不同，返回对应的实例 ID：
  • 当 ReferenceType 为 edge-function 时：返回边缘函数 ID，格式形如：ef-2vc5oe9mzqhm。
    • */ ReferenceId?: string; /** * 引用的实例名称。根据 ReferenceType 的取值不同，返回对应的实例名称：
  • 当 ReferenceType 为 edge-function 时：返回边缘函数名称。
    • */ ReferenceName?: string; /** * 站点 ID。引用该命名空间的实例所属的站点标识。 */ ZoneId?: string; /** * 站点名称。引用该命名空间的实例所属的站点名称。 */ ZoneName?: string; /** * 引用该命名空间的实例所属站点的别名。若未设置站点别名，则返回空字符串。 */ AliasZoneName?: string; } /** * ConfirmOriginACLUpdate返回参数结构体 */ export interface ConfirmOriginACLUpdateResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyEdgeKVNamespace返回参数结构体 */ export interface ModifyEdgeKVNamespaceResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAliasDomains返回参数结构体 */ export interface DescribeAliasDomainsResponse { /** * 符合条件的别称域名个数。 */ TotalCount?: number; /** * 别称域名详细信息列表。 */ AliasDomains?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 环境信息。 */ export interface EnvInfo { /** * 环境 ID。 */ EnvId?: string; /** * 环境类型，取值有：
  • production: 生产环境；
  • staging: 测试环境。
    • */ EnvType?: string; /** * 环境状态，取值有：
  • creating：创建中；
  • running：稳定运行中，可进行版本变更；
  • version_deploying：版本部署中，不能进行新的变更。
    • */ Status?: string; /** * 当前环境的配置生效范围：
  • 当 EnvType 取值为 production 时，该参数值为 ["ALL"]，代表全网生效；
  • 当 EnvType 取值为 staging 时，会返回测试节点 IP，可用于绑定 host 测试。
    • */ Scope?: Array; /** * 当前环境中各配置组实际生效的版本，根据 Status 的取值有以下两种情况：
  • 当 Status 取值为 version_deploying 时，本字段返回的值为执行变更动作之前生效的版本，即新版本部署期间，实际生效的版本为执行变更动作之前的版本；
  • 当 Status 取值为 running 时，本字段返回的值即为当前实际生效的版本。
    • */ CurrentConfigGroupVersionInfos?: Array; /** * 创建时间。时间为世界标准时间（UTC）， 遵循 ISO 8601 标准的日期和时间格式。 */ CreateTime?: string; /** * 更新时间。时间为世界标准时间（UTC）， 遵循 ISO 8601 标准的日期和时间格式。 */ UpdateTime?: string; } /** * 音频流配置参数。 */ export interface AudioTemplateInfo { /** * 音频流的编码格式。可选值为：
  • libfdk_aac。
    • */ Codec: string; /** * 音频通道数，可选值：
  • 2：双通道。
    • 默认值：2。 */ AudioChannel?: number; } /** * 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; /** * 健康检查策略。详情请参考 [健康检查策略介绍](https://cloud.tencent.com/document/product/1552/104228)。不填写表示维持原有配置。 */ HealthChecker?: HealthChecker; /** * 源站组间的流量调度策略，取值有：
  • Pritory：按优先级顺序进行故障转移 。
    • 不填写表示维持原有配置。 */ SteeringPolicy?: string; /** * 实际访问某源站失败时的请求重试策略，详情请参考 [请求重试策略介绍](https://cloud.tencent.com/document/product/1552/104227)，取值有：
  • OtherOriginGroup：单次请求失败后，请求优先重试下一优先级源站组；
  • OtherRecordInOriginGroup：单次请求失败后，请求优先重试同源站组内的其他源站。
    • 不填写表示维持原有配置。 */ FailoverPolicy?: string; } /** * edgeone套餐信息 */ export interface PlanInfo { /** * 结算货币类型，取值有：
  • CNY ：人民币结算；
  • USD ：美元结算。
    • */ Currency: string; /** * 套餐所含流量，该流量数值为安全加速流量，内容加速流量和智能加速流量的总和（单位：字节）。 */ Flux: number; /** * 结算周期，取值有：
  • y ：按年结算；
  • m ：按月结算；
  • h ：按小时结算；
  • M ：按分钟结算；
  • s ：按秒结算。
    • */ Frequency: string; /** * 套餐类型，取值有：
  • sta ：全球内容分发网络（不包括中国大陆）标准版套餐；
  • sta_with_bot ：全球内容分发网络（不包括中国大陆）标准版套餐附带bot管理；
  • sta_cm ：中国大陆内容分发网络标准版套餐；
  • sta_cm_with_bot ：中国大陆内容分发网络标准版套餐附带bot管理；
  • sta_global ：全球内容分发网络（包括中国大陆）标准版套餐；
  • sta_global_with_bot ：全球内容分发网络（包括中国大陆）标准版套餐附带bot管理；
  • ent ：全球内容分发网络（不包括中国大陆）企业版套餐；
  • ent_with_bot ： 全球内容分发网络（不包括中国大陆）企业版套餐附带bot管理；
  • ent_cm ：中国大陆内容分发网络企业版套餐；
  • ent_cm_with_bot ：中国大陆内容分发网络企业版套餐附带bot管理；
  • ent_global ：全球内容分发网络（包括中国大陆）企业版套餐；
  • ent_global_with_bot ：全球内容分发网络（包括中国大陆）企业版套餐附带bot管理。
    • */ PlanType: string; /** * 套餐价格（单位：分）。 */ Price: number; /** * 套餐所含请求次数，该请求次数为安全加速请求次数。（单位：次）。 */ Request: number; /** * 套餐所能绑定的站点个数。 */ SiteNumber: number; /** * 套餐加速区域类型，取值有：
  • mainland ：中国大陆；
  • overseas ：全球（不包括中国大陆）；
  • global ：全球（包括中国大陆）。
    • */ Area: string; } /** * DescribeTimingL7CacheData请求参数结构体 */ export interface DescribeTimingL7CacheDataRequest { /** * 开始时间。 */ StartTime: string; /** * 结束时间。 */ EndTime: string; /** * 查询的指标，取值有：
  • l7Cache_outFlux：响应流量；
  • l7Cache_request：响应请求数；
  • l7Cache_outBandwidth：响应带宽。
    • */ MetricNames: Array; /** * 站点 ID 集合，此参数必填。 */ ZoneIds?: Array; /** * 过滤条件，详细的过滤条件如下：
  • domain
       按照【子域名】进行过滤，子域名形如： test.example.com。
       类型：String
       必选：否
  • url
       按照【URL】进行过滤，此参数只支持30天的时间范围，URL形如：/content。
       类型：String
       必选：否
  • resourceType
       按照【资源类型】进行过滤，此参数只支持30天的时间范围，资源类型形如：jpg，png。
       类型：String
       必选：否
  • cacheType
       按照【缓存类型】进行过滤。
       类型：String
       必选：否
       可选项：
       hit：命中缓存；
       dynamic：资源不可缓存；
       miss：未命中缓存。
  • statusCode
       按照【状态码】进行过滤，此参数只支持30天的时间范围。
       类型：String
       必选：否
       可选项：
       1XX：1xx类型的状态码；
       100：100状态码；
       101：101状态码；
       102：102状态码；
       2XX：2xx类型的状态码；
       200：200状态码；
       201：201状态码；
       202：202状态码；
       203：203状态码；
       204：204状态码；
       100：100状态码；
       206：206状态码；
       207：207状态码；
       3XX：3xx类型的状态码；
       300：300状态码；
       301：301状态码；
       302：302状态码；
       303：303状态码；
       304：304状态码；
       305：305状态码；
       307：307状态码；
       4XX：4xx类型的状态码；
       400：400状态码；
       401：401状态码；
       402：402状态码；
       403：403状态码；
       404：404状态码；
       405：405状态码；
       406：406状态码；
       407：407状态码；
       408：408状态码；
       409：409状态码；
       410：410状态码；
       411：411状态码；
       412：412状态码；
       412：413状态码；
       414：414状态码；
       415：415状态码；
       416：416状态码；
       417：417状态码；
       422：422状态码；
       423：423状态码；
       424：424状态码；
       426：426状态码；
       451：451状态码；
       5XX：5xx类型的状态码；
       500：500状态码；
       501：501状态码；
       502：502状态码；
       503：503状态码；
       504：504状态码；
       505：505状态码；
       506：506状态码；
       507：507状态码；
       510：510状态码；
       514：514状态码；
       544：544状态码。
  • tagKey
       按照【标签Key】进行过滤。
       类型：String
       必选：否
  • tagValue
       按照【标签Value】进行过滤。
       类型：String
       必选：否
    • */ Filters?: Array; /** * 查询时间粒度，可选的值有：
  • min：1分钟的时间粒度；
  • 5min：5分钟的时间粒度；
  • hour：1小时的时间粒度；
  • day：1天的时间粒度。
    • 不填将根据开始时间跟结束时间的间距自动推算粒度，具体为：一小时范围内以min粒度查询，两天范围内以5min粒度查询，七天范围内以hour粒度查询，超过七天以day粒度查询。 */ Interval?: string; /** * 数据归属地区，取值有：
  • overseas：全球（除中国大陆地区）数据；
  • mainland：中国大陆地区数据；
  • global：全球数据。
    • 不填默认取值为global。 */ Area?: string; } /** * ModifySecurityAPIResource请求参数结构体 */ export interface ModifySecurityAPIResourceRequest { /** * 站点 ID。 */ ZoneId: string; /** * API 资源列表。 */ APIResources?: Array; } /** * IPv6 访问配置。 */ export interface IPv6Parameters { /** * IPv6 访问功能配置，取值有：
  • on：开启 IPv6 访问功能；
  • off：关闭 IPv6 访问功能。
    • */ Switch?: string; } /** * CreateFunction请求参数结构体 */ export interface CreateFunctionRequest { /** * 站点 ID。 */ ZoneId: string; /** * 函数名称，只能包含小写字母、数字、连字符，以数字或字母开头，以数字或字母结尾，最大支持 30 个字符。 */ Name: string; /** * 函数内容，当前仅支持 JavaScript 代码，最大支持 5MB 大小。 */ Content: string; /** * 函数描述，最大支持 60 个字符。 */ Remark?: string; } /** * 回源限速限制详情。 */ export interface PrefetchOriginLimit { /** * 站点 ID。 */ ZoneId?: string; /** * 加速域名。 */ DomainName?: string; /** * 回源限速限制的加速区域。 预热时，该加速区域将会受到配置的Bandwidth值限制。取值有：
  • Overseas：全球可用区（不含中国大陆）；
  • MainlandChina：中国大陆可用区。
    • */ Area?: string; /** * 回源限速带宽。 预热时回到源站的带宽上限值，取值范围 100 - 100,000，单位 Mbps。 */ Bandwidth?: number; /** * 回源限速限制创建的时间。 */ CreateTime?: string; /** * 回源限速限制更新的时间。 */ UpdateTime?: string; } /** * POST 请求上传文件流式传输最大限制。 */ export interface PostMaxSizeParameters { /** * 是否开启 POST 请求上传文件限制，单位为 Byte，平台默认为限制为 32 * 220 Byte，取值有：
  • on：开启限制；
  • off：关闭限制。
    • */ Switch?: string; /** * POST 请求上传文件流式传输最大限制，该字段仅在 Switch 为 on 时生效，取值在 1MB 和 800MB 之间，单位字节。 */ 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; /** * 数据压缩类型，取值有:
  • gzip：gzip压缩。
    • 不填表示不启用压缩。 */ CompressType?: string; } /** * DescribeDDoSAttackEvent返回参数结构体 */ export interface DescribeDDoSAttackEventResponse { /** * DDOS攻击事件数据列表。 注意：此字段可能返回 null，表示取不到有效值。 */ Data?: Array; /** * 查询结果的总条数。 */ TotalCount?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTimingL7OriginPullData返回参数结构体 */ export interface DescribeTimingL7OriginPullDataResponse { /** * 查询结果的总条数。 */ TotalCount?: number; /** * 回源时序数据列表。 */ TimingDataRecords?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInferenceServices请求参数结构体 */ export interface DescribeInferenceServicesRequest { /** *

    站点ID。

    */ ZoneId: string; /** *

    过滤条件，上限 20 个，多个条件为且关系，Filters.Values 的上限为 20。详细的过滤条件如下：

  • service-name：按照服务名称进行过滤；
  • service-id：按照服务 ID 过滤；
  • status：按照服务状态过滤。
    • 模糊查询时仅支持过滤字段名为 service-name。

    */ Filters?: Array; /** *

    分页查询偏移量。默认值：0。

    */ Offset?: number; /** *

    分页查询限制数目。默认值：20，最大值：200。

    */ Limit?: number; /** *

    可根据该字段对返回结果进行排序，取值有：

  • create-time：创建时间。
    • 不填写时默认按照 create-time 排序。

    */ Order?: string; /** *

    排序方向，如果是字段值为数字，则根据数字大小排序；如果字段值为文本，则根据 ASCII 码的大小排序。取值有：

  • asc：从小到大排序；
  • desc：从大到小排序。
    • 不填写使用默认值 desc。

    */ Direction?: string; } /** * 访问协议强制 HTTPS 跳转配置。 */ export interface ForceRedirect { /** * 访问强制跳转配置开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch: string; /** * 重定向状态码，取值有：
  • 301：301跳转；
  • 302：302跳转。
    • */ RedirectStatusCode?: number; } /** * 推理服务监控数据记录。 */ export interface InferenceServiceMonitorRecord { /** * 推理服务 ID。 */ ServiceId?: string; /** * 指标名称。 */ MetricName?: string; /** * 详细推理服务监控数据。 */ InferenceServiceMonitorItems?: Array; } /** * 规则引擎带有状态码的动作 */ export interface CodeAction { /** * 功能名称，功能名称填写规范可调用接口 [查询规则引擎的设置参数](https://cloud.tencent.com/document/product/1552/80618) 查看。 */ Action: string; /** * 操作参数。 */ Parameters: Array; } /** * 站点配置相关信息。 */ export interface ZoneConfigParameters { /** * 站点名称。 */ ZoneName?: string; /** * 站点配置信息。 注意：此字段可能返回 null，表示取不到有效值。 */ ZoneConfig?: ZoneConfig; } /** * CreateL7AccRules返回参数结构体 */ export interface CreateL7AccRulesResponse { /** * 规则 ID 列表。 */ RuleIds?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 源站故障转移配置参数。 */ export interface SiteFailoverParameters { /** * 源站故障转移条件状态码。当源站返回的响应状态码命中本字段返回时，才会按照SiteFailoverParams执行源站转移。该参数取值为 4xx、5xx 之一。 */ SiteFailoverStatusCodes: Array; /** * 源站故障转移配置参数列表。最小长度为1，最大长度为2。 */ SiteFailoverParams: Array; } /** * 缓存预刷新 */ export interface CachePrefresh { /** * 缓存预刷新配置开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch: string; /** * 缓存预刷新百分比，取值范围：1-99。 */ Percent?: number; } /** * DescribePurgeTasks请求参数结构体 */ export interface DescribePurgeTasksRequest { /** * 站点 ID。此参数将于2024年05月30日后由可选改为必填，详见公告：[【腾讯云 EdgeOne】云 API 变更通知](https://cloud.tencent.com/document/product/1552/104902)。 */ ZoneId?: string; /** * 查询起始时间，时间与 job-id 必填一个。 */ StartTime?: string; /** * 查询结束时间，时间与 job-id 必填一个。 */ EndTime?: string; /** * 分页查询偏移量，默认为 0。 */ Offset?: number; /** * 分页查询限制数目，默认值：20，最大值：1000。 */ Limit?: number; /** * 过滤条件，Filters.Values的上限为20。详细的过滤条件如下：
  • job-id：按照任务 ID 进行过滤。job-id 形如：1379afjk91u32h，暂不支持多值，不支持模糊查询；
  • target：按照目标资源信息进行过滤，target 形如：http://www.qq.com/1.txt 或者 tag1，暂不支持多值，支持模糊查询；
  • domains：按照域名进行过滤，形如：www.qq.com，不支持模糊查询；
  • statuses：按照任务状态进行过滤，不支持模糊查询。可选项：
       processing：处理中
       success：成功
       failed：失败
       timeout：超时
       canceled：已取消
  • type：按照清除缓存类型进行过滤，暂不支持多值，不支持模糊查询。可选项：
       purge_url：URL
       purge_prefix：前缀
       purge_all：全部缓存内容
       purge_host：Hostname
       purge_cache_tag：CacheTag
    • */ Filters?: Array; } /** * DescribeTimingL7AnalysisData返回参数结构体 */ export interface DescribeTimingL7AnalysisDataResponse { /** *

    查询结果的总条数。

    */ TotalCount?: number; /** *

    七层时序流量数据列表。
    对于不同的查询指标，根据指标值类型的不同，会从不同的参数返回时序数据。
    目前存在的值类型有以下两种：

    • Integer：Integer 值类型的指标将从 Data.N.TypeValue 返回对应时序数据。
      对应的查询指标 MetricName 有：
      • l7Flow_outFlux：L7 EdgeOne 响应流量，单位：Byte；
      • l7Flow_inFlux：L7 客户端请求流量，单位：Byte；
      • l7Flow_flux：L7 访问总流量（EdgeOne 响应+客户端请求），单位：Byte；
      • l7Flow_outBandwidth：L7 EdgeOne 响应带宽，单位：bps；
      • l7Flow_inBandwidth：L7 客户端请求带宽，单位：bps；
      • l7Flow_bandwidth：L7 访问总带宽（EdgeOne 响应+客户端请求），单位：bps；
      • l7Flow_request：L7 访问请求数，单位：次；
      • l7Flow_avgResponseTime：L7 访问平均响应耗时，单位：ms；
      • l7Flow_avgFirstByteResponseTime：L7 访问平均首字节响应耗时，单位：ms。
    • Float：Float 值类型的指标将从 Data.N.FloatTypeValue 返回对应时序数据。
      对应的查询指标 MetricName 有：
      • l7Flow_requestRate：L7 访问请求速率，单位：qps。
    注意：此字段可能返回 null，表示取不到有效值。 */ Data?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 图片优化配置。 */ export interface ImageOptimize { /** * 开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch: string; } /** * CreateL7AccRules请求参数结构体 */ export interface CreateL7AccRulesRequest { /** * 站点 ID。 */ ZoneId: string; /** * 规则内容。 */ Rules: Array; } /** * 实时日志投递任务。 */ export interface RealtimeLogDeliveryTask { /** *

    实时日志投递任务 ID。

    */ TaskId?: string; /** *

    实时日志投递任务的名称。

    */ TaskName?: string; /** *

    实时日志投递任务的状态，取值有：

  • enabled: 已启用；
  • disabled: 已停用；
  • deleted: 异常删除状态，请检查目的地腾讯云 CLS 日志集/日志主题是否已被删除。

    • */ DeliveryStatus?: string; /** *

    实时日志投递任务类型，取值有：

    • cls: 推送到腾讯云 CLS；
    • custom_endpoint：推送到自定义 HTTP(S) 地址；
    • s3：推送到 S3 兼容（兼容 SigV4 鉴权算法）的对象存储的地址；
    • log_analysis：推送到 EdgeOne 日志分析。

    */ TaskType?: string; /** *

    实时日志投递任务对应的实体（七层域名或者四层代理实例）列表。取值示例如下：

  • 七层域名：domain.example.com；
  • 四层代理实例：sid-2s69eb5wcms7。

    • */ EntityList?: Array; /** *

    数据投递类型，取值有：

  • l7-access-logs：七层访问日志；
  • application：四层代理日志；
  • function：边缘函数运行日志；
  • web-attack：托管规则日志；
  • domain：站点加速日志；
  • web-rateLiming：速率限制和 CC 攻击防护日志；
  • web-rule：自定义规则日志；
  • web-bot：Bot 管理日志。

    • */ LogType?: string; /** *

    数据投递区域，取值有：

  • mainland：中国大陆境内；
  • overseas：全球（不含中国大陆）。

    • */ Area?: string; /** *

    投递的预设字段列表。

    */ Fields?: Array; /** *

    投递的自定义字段列表。

    */ CustomFields?: Array; /** *

    投递的自定义表达式字段列表。

    */ CustomExpressionFields?: Array; /** *

    日志投递的过滤条件。

    */ DeliveryConditions?: Array; /** *

    采样比例，采用千分制，取值范围为1-1000，例如：605 表示采样比例为 60.5%。

    */ Sample?: number; /** *

    日志投递的输出格式。出参为 null 时表示为默认格式，默认格式逻辑如下：

  • 当 TaskType 取值为 custom_endpoint 时，默认格式为多个 JSON 对象组成的数组，每个 JSON 对象为一条日志；
  • 当 TaskType 取值为 s3 时，默认格式为 JSON Lines。
    • 注意：此字段可能返回 null，表示取不到有效值。 */ LogFormat?: LogFormat; /** *

    CLS 的配置信息。

    注意：此字段可能返回 null，表示取不到有效值。 */ CLS?: CLSTopic; /** *

    自定义 HTTP 服务的配置信息。

    注意：此字段可能返回 null，表示取不到有效值。 */ CustomEndpoint?: CustomEndpoint; /** *

    S3 兼容（兼容 SigV4 鉴权算法）的对象存储的配置信息。

    注意：此字段可能返回 null，表示取不到有效值。 */ S3?: S3; /** *

    创建时间。

    */ CreateTime?: string; /** *

    更新时间。

    */ UpdateTime?: string; } /** * DeleteFunctionReplica返回参数结构体 */ export interface DeleteFunctionReplicaResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 规则引擎可应用于匹配请求的设置详细信息。 */ export interface RulesProperties { /** * 值为参数名称。 */ Name?: string; /** * 数值参数的最小值，非数值参数或 Min 和 Max 值都为 0 则此项无意义。 */ Min?: number; /** * 参数值的可选值。 注意：若参数值为用户自定义则该数组为空数组。 */ ChoicesValue?: Array; /** * 参数值类型。
  • CHOICE：参数值只能在 ChoicesValue 中选择；
  • TOGGLE：参数值为开关类型，可在 ChoicesValue 中选择；
  • OBJECT：参数值为对象类型，ChoiceProperties 为改对象类型关联的属性；
  • CUSTOM_NUM：参数值用户自定义，整型类型；
  • CUSTOM_STRING：参数值用户自定义，字符串类型。
    • 注意：当参数类型为 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; /** *
  • 为 NULL：无特殊参数，RuleAction 选择 NormalAction；
    • 注意：此字段可能返回 null，表示取不到有效值。 */ ExtraParameter?: RuleExtraParameter; } /** * DescribeSecurityJSInjectionRule返回参数结构体 */ export interface DescribeSecurityJSInjectionRuleResponse { /** * JavaScript 注入规则总数量。 */ TotalCount?: number; /** * JavaScript 注入规则列表。 */ JSInjectionRules?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 七层加速域名/四层代理实例与回源 IP 网段的绑定关系，同时包含回源 IP 网段详情和选择可切换的回源 IP 网段列表。 */ export interface OriginACLInfo { /** * 启用了特定回源 IP 网段回源的七层加速域名列表。源站防护未开启时为空。 */ L7Hosts?: Array; /** * 启用了特定回源 IP 网段回源的四层代理实例列表。源站防护未开启时为空。 */ L4ProxyIds?: Array; /** * 当前生效的回源 IP 网段。源站防护未开启时为空。 注意：此字段可能返回 null，表示取不到有效值。 */ CurrentOriginACL?: CurrentOriginACL; /** * 当回源 IP 网段发生更新时，该字段会返回下一个版本将要生效的回源 IP 网段，包含与当前回源 IP 网段的对比。无更新或者源站防护未开启时该字段为空。 注意：此字段可能返回 null，表示取不到有效值。 */ NextOriginACL?: NextOriginACL; /** * 源站防护状态，取值有：
  • online：已生效；
  • offline：已停用；
  • updating: 配置部署中。
    • */ Status?: string; /** * 源站防护回源ACL控制域。 */ OriginACLFamily?: string; } /** * 源站组引用服务。 */ export interface OriginGroupReference { /** * 引用服务类型，取值有：
  • acceleration-domain: 加速域名；
  • rule-engine: 规则引擎；
  • load-balancer: 负载均衡；
  • application-proxy: 四层代理。
    • */ InstanceType?: string; /** * 引用类型的实例ID。 */ InstanceId?: string; /** * 引用类型的实例名称。 */ InstanceName?: string; /** * 引用站点ID。 */ ZoneId?: string; /** * 引用站点名称。 */ ZoneName?: string; /** * 引用站点别名。 */ AliasZoneName?: string; } /** * DeleteLoadBalancer请求参数结构体 */ export interface DeleteLoadBalancerRequest { /** * 站点 ID。 */ ZoneId: string; /** * 负载均衡实例 ID。 */ InstanceId: string; } /** * 自定义 Cache Key Cookie 配置参数。 */ export interface CacheKeyCookie { /** * 功能开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch?: string; /** * 缓存动作，取值有：
  • full：全部保留；
  • ignore：全部忽略；
  • includeCustom：保留指定参数；
  • excludeCustom：忽略指定参数。
    • 注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。 */ Action?: string; /** * 自定义 Cache Key Cookie 名称列表。
    注意：当 Action 为 includeCustom 或 excludeCustom 时，此字段必填；当 Action 为 full 或 ignore 时，无需填写此字段，若填写则不生效。 */ Values?: Array; } /** * DescribeInferenceServices返回参数结构体 */ export interface DescribeInferenceServicesResponse { /** *

    满足条件的服务总数。

    */ TotalCount?: number; /** *

    推理服务列表。

    */ Services?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 例外规则的配置，包含生效的条件，生效的范围。 */ export interface ExceptUserRule { /** * 规则名称，不可使用中文。 */ RuleName: string; /** * 规则的处置方式，当前仅支持skip：跳过全部托管规则。 */ Action: string; /** * 规则生效状态，取值有：
  • on：生效；
  • off：失效。
    • */ RuleStatus: string; /** * 规则ID。仅出参使用。默认由底层生成。 */ RuleID?: number; /** * 更新时间，如果为null，默认由底层按当前时间生成。 */ UpdateTime?: string; /** * 匹配条件。 */ ExceptUserRuleConditions?: Array; /** * 规则生效的范围。 */ ExceptUserRuleScope?: ExceptUserRuleScope; /** * 优先级，取值范围0-100。如果为null，默认由底层设置为0。 */ RulePriority?: number; } /** * 安全数据Entry返回值 */ export interface SecEntry { /** * 查询维度值。 */ Key: string; /** * 查询维度下详细数据。 */ Value: Array; } /** * ModifyCustomErrorPage返回参数结构体 */ export interface ModifyCustomErrorPageResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifySecurityAPIService请求参数结构体 */ export interface ModifySecurityAPIServiceRequest { /** * 站点 ID。 */ ZoneId: string; /** * API 服务列表。 */ APIServices?: Array; } /** * CreateInferenceAPIToken返回参数结构体 */ export interface CreateInferenceAPITokenResponse { /** * 推理 API Token ID。 */ TokenId?: string; /** * 推理 API Token 内容。 */ Content?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 推理服务部署日志信息。 */ export interface InferenceServiceDeploymentLogInfo { /** * 日志消息内容。 */ LogMessage?: string; /** * 日志产生时间。 */ Timestamp?: string; } /** * Debug 调试结构体。 */ export interface StandardDebugParameters { /** * Debug 功能开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch?: string; /** * 允许的客户端来源。支持填写 IPv4 以及 IPv6 的 IP 网段。0.0.0.0/0 表示允许所有 IPv4 客户端进行调试；::/0 表示允许所有 IPv6 客户端进行调试；不能填写 127.0.0.1。
    注意：当 Switch 字段为 on 时，此字段必填，且填写个数为 1～100；当 Switch 为 off 时，无需填写此字段，若填写则不生效。 */ AllowClientIPList?: Array; /** * Debug 功能到期时间。超出设置的时间，则功能失效。
    注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。 */ Expires?: string; } /** * 配置组版本信息。 */ export interface ConfigGroupVersionInfo { /** *

    配置组版本 ID，创建配置组版本时 EdgeOne 分配的唯一资源 ID。

    参数格式：ver-2kplomhisdcb

    取值参考：

    */ VersionId: string; /** *

    配置组版本号。该参数仅作展示使用，配置组每创建一次新版本，该版本号自增加一，初始版本的版本号为 "0"。

    取值参考：DescribeConfigGroupVersions 返回值 ConfigGroupVersionInfos

    */ VersionNumber?: string; /** *

    配置组版本所基于的来源版本 ID，在创建配置组版本时进行指定来源版本 ID，新版本将在该来源版本的配置基础上派生创建。

    参数格式：ver-2kplomhisdcb

    取值参考：

    */ SourceVersion?: string; /** *

    版本归属的配置组类型。

    枚举值：

    • l7_acceleration： 七层加速配置组
    • edge_functions： 边缘函数配置组
    • web_security： Web 防护配置组
    */ GroupType?: string; /** *

    版本归属的配置组 ID。

    参数格式：cg-2kplomhisdcb

    */ GroupId?: string; /** *

    版本描述。

    */ Description?: string; /** *

    版本生效状态。

    枚举值：

    • creating： 版本创建中
    • inactive： 版本未生效
    • active： 版本已生效
    */ Status?: string; /** *

    版本创建时间。时间为世界标准时间（UTC）， 遵循 ISO 8601 标准的日期和时间格式。

    */ CreateTime?: string; } /** * VerifyOwnership返回参数结构体 */ export interface VerifyOwnershipResponse { /** * 归属权验证结果。
  • success：验证成功；
  • fail：验证失败。
    • */ Status?: string; /** * 当验证结果为不通过时，该字段会返回原因，协助您排查问题。 */ Result?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeSecurityIPGroupContent返回参数结构体 */ export interface DescribeSecurityIPGroupContentResponse { /** * IP 组中正在生效的 IP 或网段个数。 */ IPTotalCount?: number; /** * 满足查询条件的 IP 或网段列表。受 Limit 和 Offset 参数限制。 */ IPList?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 询价参数 */ export interface Sv { /** * 询价参数键。 */ Key: string; /** * 询价参数值。 */ Value: string; /** * 询价参数映射的配额，取值有：
  • zone：站点数；
  • custom-rule：自定义规则数；
  • rate-limiting-rule：速率限制规则数；
  • l4-proxy-instance：四层代理实例数。
    • 注意：此字段可能返回 null，表示取不到有效值。 */ Pack?: string; /** * 询价参数映射的四层代理实例Id。 注意：此字段可能返回 null，表示取不到有效值。 */ InstanceId?: string; /** * 询价参数对应的防护等级。 取值有：
  • cm_30G：中国大陆加速区域保底防护30Gbps；
  • cm_60G：中国大陆加速区域保底防护60Gbps；
  • cm_100G：中国大陆加速区域保底防护100Gbps；
  • anycast_300G：全球加速区域（除中国大陆）Anycast联防300Gbps；
  • anycast_unlimited：全球加速区域（除中国大陆）Anycast无上限全力防护；
  • cm_30G_anycast_300G：中国大陆加速区域保底防护30Gbps，全球加速区域（除中国大陆）Anycast联防300Gbps；
  • cm_30G_anycast_unlimited：中国大陆加速区域保底防护30Gbps，全球加速区域（除中国大陆）Anycast无上限全力防护；
  • cm_60G_anycast_300G：中国大陆加速区域保底防护60Gbps，全球加速区域（除中国大陆）Anycast联防300Gbps；
  • cm_60G_anycast_unlimited：中国大陆加速区域保底防护60Gbps，全球加速区域（除中国大陆）Anycast无上限全力防护；
  • cm_100G_anycast_300G：中国大陆加速区域保底防护100Gbps，全球加速区域（除中国大陆）Anycast联防300Gbps；
  • cm_100G_anycast_unlimited：中国大陆加速区域保底防护100Gbps，全球加速区域（除中国大陆）Anycast无上限全力防护。
    • 注意：此字段可能返回 null，表示取不到有效值。 */ ProtectionSpecs?: string; } /** * 规则引擎规则项，Conditions 数组内多个项的关系为 或，内层 Conditions 列表内多个项的关系为 且。 */ export interface Rule { /** * 执行功能判断条件。 注意：满足该数组内任意一项条件，功能即可执行。 */ Conditions: Array; /** * 执行的功能。注意：Actions 和 SubRules 不可都为空 */ Actions?: Array; /** * 嵌套规则。注意：SubRules 和 Actions 不可都为空 */ SubRules?: Array; } /** * DownloadL4Logs请求参数结构体 */ export interface DownloadL4LogsRequest { /** * 开始时间。 */ StartTime: string; /** * 结束时间。 */ EndTime: string; /** * 站点 ID 集合，此参数将于2024年05月30日后由可选改为必填，详见公告：[【腾讯云 EdgeOne】云 API 变更通知](https://cloud.tencent.com/document/product/1552/104902)。 */ ZoneIds: Array; /** * 四层实例 ID 集合。 */ ProxyIds?: Array; /** * 分页查询的限制数目，默认值为 20，最大查询条目为 300。 */ Limit?: number; /** * 分页的偏移量，默认值为 0。 */ Offset?: number; } /** * 源站故障转移 配置参数内部结构。 */ export interface SiteFailover { /** * 源站故障转移类型。取值有：
  • FailoverToHost:回源到指定 IP/域名；
  • FailoverToCOS:回源到腾讯云 COS；
  • FailoverToS3CompatibleObjectStorage:回源到 S3 兼容；
  • FailoverRedirectToURL :重定向至指定 URL；
  • FailoverCustomResponsePage:使用自定义响应页面。
    • */ Mode: string; /** * 源站地址，根据 Mode 的取值分为以下情况：
  • 当 Mode = FailoverToHost 时，该参数请填写 IPV4、IPV6 地址或域名；
  • 当 Mode = FailoverToCOS 时，该参数请填写 COS 桶的访问域名；
  • 当 Mode = FailoverToS3CompatibleObjectStorage，该参数请填写 S3 桶的访问域名。
    • */ Origin?: string; /** * 回源协议配置。当 Mode 取值为 FailoverToHost 时该参数必填。取值有：
  • http：使用 HTTP 协议；
  • https：使用 HTTPS 协议；
  • follow：协议跟随。
    • */ OriginProtocol?: string; /** * HTTP 回源端口，取值范围 1～65535。当回源协议 OriginProtocol 为 http 或者 follow 时该参数必填。 */ HTTPOriginPort?: number; /** * HTTPS 回源端口，取值范围 1～65535。当回源协议 OriginProtocol 为 https 或者 follow 时该参数必填。 */ HTTPSOriginPort?: number; /** * 回源Host Header 重写配置， */ UpstreamHostHeader?: HostHeaderParameters; /** * 回源 URL 重写配置。 */ UpstreamURLRewrite?: UpstreamURLRewriteParameters; /** * 回源请求参数配置。 */ UpstreamRequestParameters?: UpstreamRequestParameters; /** * HTTP2 回源配置参数。 */ UpstreamHTTP2Parameters?: UpstreamHTTP2Parameters; /** * 指定是否允许访问私有对象存储源站，当源站类型 Mode = FailoverToCOS 或 FailoverToS3CompatibleObjectStorage 时该参数必填，取值有：
  • on：使用私有鉴权；
  • off：不使用私有鉴权。
    • */ PrivateAccess?: string; /** * 私有鉴权使用参数，该参数仅当 Mode = FailoverToS3CompatibleObjectStorage 且 PrivateAccess = on 时会生效。 */ PrivateParameters?: OriginPrivateParameters; /** * 重定向目标 URL。当 Mode 取值为 FailoverRedirectToURL 时该参数必填。 */ RedirectURL?: string; /** * 响应页面 ID。当 Mode 取值为 FailoverCustomResponsePage 时该参数必填。 */ ResponsePageId?: string; /** * 响应状态码。当 Mode 取值为 FailoverRedirectToURL 或 FailoverCustomResponsePage 时该参数必填。取值有：
  • 当 Mode = FailoverRedirectToURL 时，该参数取值为 301、302、303、307、308 之一；
  • 当 Mode = FailoverCustomResponsePage 时，该参数取值为 400、403、404、405、414、416、451、500、501、502、503、504 之一。
    • */ StatusCode?: number; } /** * 返回站点信息 */ export interface ZoneInfo { /** * 站点id。 */ ZoneId?: string; /** * 站点名称。 */ ZoneName?: string; /** * 站点是否停用。取值有：
  • false：非停用；
  • true：停用。
    • */ Paused?: boolean; } /** * EdgeKVGet返回参数结构体 */ export interface EdgeKVGetResponse { /** * 键值对数据列表。按入参 Keys 的顺序依次返回结果，若某键不存在，则对应项的 Value 字段返回空字符串。 */ Data?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 人机校验页的具体配置。 */ export interface CAPTCHAPageChallenge { /** * 人机校验页是否开启，取值有：
  • on：开启；
  • off：关闭。
    • */ Enabled?: string; } /** * ModifyZoneSetting请求参数结构体 */ export interface ModifyZoneSettingRequest { /** * 待变更的站点 ID。 */ ZoneId: string; /** * 缓存过期时间配置。 不填写表示保持原有配置。 */ CacheConfig?: CacheConfig; /** * 节点缓存键配置。 不填写表示保持原有配置。 */ CacheKey?: CacheKey; /** * 浏览器缓存配置。 不填写表示保持原有配置。 */ MaxAge?: MaxAge; /** * 离线缓存配置。 不填写表示保持原有配置。 */ OfflineCache?: OfflineCache; /** * Quic 访问配置。 不填写表示保持原有配置。 */ Quic?: Quic; /** * Post 请求传输配置。 不填写表示保持原有配置。 */ PostMaxSize?: PostMaxSize; /** * 智能压缩配置。 不填写表示保持原有配置。 */ Compression?: Compression; /** * Http2 回源配置。 不填写表示保持原有配置。 */ UpstreamHttp2?: UpstreamHttp2; /** * 访问协议强制 Https 跳转配置。 不填写表示保持原有配置。 */ ForceRedirect?: ForceRedirect; /** * Https 加速配置。 不填写表示保持原有配置。 */ Https?: Https; /** * 源站配置。 不填写表示保持原有配置。 */ Origin?: Origin; /** * 智能加速配置。 不填写表示保持原有配置。 */ SmartRouting?: SmartRouting; /** * WebSocket 配置。 不填写表示保持原有配置。 */ WebSocket?: WebSocket; /** * 客户端 IP 回源请求头配置。 不填写表示保持原有配置。 */ ClientIpHeader?: ClientIpHeader; /** * 缓存预刷新配置。 不填写表示保持原有配置。 */ CachePrefresh?: CachePrefresh; /** * Ipv6 访问配置。 不填写表示保持原有配置。 */ Ipv6?: Ipv6; /** * 回源时是否携带客户端 IP 所属地域信息的配置。 不填写表示保持原有配置。 */ ClientIpCountry?: ClientIpCountry; /** * Grpc 协议支持配置。 不填写表示保持原有配置。 */ Grpc?: Grpc; /** * 网络错误日志记录配置。不填写表示保持原有配置。 */ NetworkErrorLogging?: NetworkErrorLogging; /** * 图片优化配置。 不填写表示关闭。 */ ImageOptimize?: ImageOptimize; /** * 标准 Debug 配置。 */ StandardDebug?: StandardDebug; /** * 视频即时处理配置。不填写表示保持原有配置。 */ JITVideoProcess?: JITVideoProcess; } /** * 检测长度限制规则详情 */ export interface DetectLengthLimitRule { /** * 规则Id。仅出参使用。 */ RuleId: number; /** * 规则名称。仅出参使用。 */ RuleName: string; /** * 规则描述，仅出参使用。 */ Description: string; /** * 规则配置条件。仅出参使用。 */ Conditions: Array; /** * 处置方式，取值有：
  • skip：当请求正文数据超过 Conditions 出参中 body_depth 设置的检测深度时，跳过所有请求正文内容的检测；
  • scan：仅检测 Conditions 出参中 body_depth 设置的检测深度，对超出部分的请求正文内容直接截断处理，超出部分的请求正文不会经过安全检测。
    • 仅出参使用。 */ Action: string; } /** * IP SSL相关信息 */ export interface IPSSLConfig { /** *

    IP SSL 关联域名所属站点ID。如果Status值为 unbound 时，该字段为空值。

    注意：此字段可能返回 null，表示取不到有效值。 */ ZoneId?: string; /** *

    IP SSL关联的域名。如果Status值为 unbound 时，该字段为空值。

    注意：此字段可能返回 null，表示取不到有效值。 */ AssociatedDomain?: string; /** *

    关联状态， 取值如下：

  • bound：IP SSL配置已绑定
  • binding：IP SSL配置绑定中
  • unbinding：IP SSL配置解绑中
  • unbound：IP SSL配置未绑定
    • */ Status?: string; } /** * DescribeL4Proxy返回参数结构体 */ export interface DescribeL4ProxyResponse { /** * 四层代理实例的数量。 */ TotalCount?: number; /** * 四层代理实例列表。 */ L4Proxies?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 源站组健康状态。 */ export interface OriginGroupHealthStatus { /** * 源站组 ID。 */ OriginGroupID?: string; /** * 源站组名。 */ OriginGroupName?: string; /** * 源站组类型，取值有：
  • HTTP：HTTP 专用型；
  • GENERAL：通用型。
    • */ OriginType?: string; /** * 优先级。 */ Priority?: string; /** * 源站组里各源站的健康状态。 */ OriginHealthStatus?: Array; } /** * ModifyDnsRecords返回参数结构体 */ export interface ModifyDnsRecordsResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 计费数据过滤条件。 */ export interface BillingDataFilter { /** * 参数名称。 */ Type: string; /** * 参数值。 */ Value: string; } /** * DeleteCustomErrorPage返回参数结构体 */ export interface DeleteCustomErrorPageResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTimingL7CacheData返回参数结构体 */ export interface DescribeTimingL7CacheDataResponse { /** * 查询结果的总条数。 */ TotalCount?: number; /** * 七层缓存分析时序类流量数据列表。 注意：此字段可能返回 null，表示取不到有效值。 */ Data?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDefaultCertificates请求参数结构体 */ export interface DescribeDefaultCertificatesRequest { /** * 站点 ID。 */ ZoneId?: string; /** * 过滤条件，Filters.Values的上限为5。详细的过滤条件如下：
  • zone-id
       按照【站点ID】进行过滤。站点ID形如：zone-xxx。
       类型：String
       必选：是
    • */ Filters?: Array; /** * 分页查询偏移量。默认值：0。 */ Offset?: number; /** * 分页查询限制数目。默认值：20，最大值：100。 */ Limit?: number; } /** * DescribeZones返回参数结构体 */ export interface DescribeZonesResponse { /** * 符合条件的站点个数。 */ TotalCount?: number; /** * 站点列表详情。 */ Zones?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteMultiPathGateway请求参数结构体 */ export interface DeleteMultiPathGatewayRequest { /** * 站点 ID。 */ ZoneId: string; /** * 网关 ID。 */ GatewayId: string; } /** * DeleteCustomErrorPage请求参数结构体 */ export interface DeleteCustomErrorPageRequest { /** * 站点 ID。 */ ZoneId: string; /** * 自定义响应页面 ID。 */ PageId: string; } /** * 实时日志投递任务中的自定义日志字段。 */ export interface CustomField { /** * 自定义日志字段类型。从 HTTP 请求和响应中的指定位置提取数据，取值有：
  • ReqHeader：从 HTTP 请求头中提取指定字段值；
  • RspHeader：从 HTTP 响应头中提取指定字段值；
  • Cookie: 从 Cookie 中提取指定字段值；
  • ReqBody: 从 HTTP 请求正文中通过 Google RE2 正则表达式提取指定内容。
    • */ Name: string; /** * 根据字段类型（Name）填入字段值的定义。需要区分大小写。
  • 当字段类型为 ReqHeader、RspHeader、Cookie 时，填入需要提取值的参数名称，例如：Accept-Language。可输入 1-100 个字符，允许的字符开头为字母，中间为字母、数字、-，结尾为字母、数字；
  • 当字段类型为 ReqBody 时，填入 Google RE2 正则表达式，正则表达式长度上限为 4KB。
    • */ Value: string; /** * 是否投递该字段，不填表示不投递此字段。 */ Enabled?: boolean; } /** * 模板的安全配置。 */ export interface WebSecurityTemplates { /** *

    策略模板的 ID

    */ TemplateId?: string; /** *

    策略模板名称。由中文、英文、数字和下划线组成，不能以下划线开头，且长度不能超过 32 个字符。

    */ TemplateName?: string; /** *

    策略模板的策略配置，配置对所有关联了该策略模板的域名生效。

    */ Policy?: SecurityPolicy; } /** * ApplyFreeCertificate返回参数结构体 */ export interface ApplyFreeCertificateResponse { /** * 当 VerificationMethod 为 dns_challenge 时，域名申请免费证书的相关验证信息。 */ DnsVerification?: DnsVerification; /** * 当 VerificationMethod 为 http_challenge 时，域名申请免费证书的相关验证信息。 */ FileVerification?: FileVerification; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 时序类型详细数据 */ export interface FloatTimingTypeValue { /** * 数据和。 */ Sum?: number; /** * 最大值。 */ Max?: number; /** * 平均值。 */ Avg?: number; /** * 指标名。 */ MetricName?: string; /** * 详细数据。 */ Detail?: Array; } /** * Bot 浏览器校验规则（原主动特征识别规则）的 Action。 */ export interface BrowserImpersonationDetectionAction { /** * Cookie 校验和会话跟踪配置。 */ BotSessionValidation?: BotSessionValidation; /** * 客户端行为校验配置。 */ ClientBehaviorDetection?: ClientBehaviorDetection; } /** * 自定义 Cache Key HTTP 请求头配置参数。 */ export interface CacheKeyHeader { /** * 功能开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch?: string; /** * 自定义 Cache Key HTTP 请求头列表。
    注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。 */ Values?: Array; } /** * DeleteZone请求参数结构体 */ export interface DeleteZoneRequest { /** * 站点 ID。 */ ZoneId: string; } /** * 分片回源配置参数。 */ export interface RangeOriginPullParameters { /** * 分片回源开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch?: string; } /** * Bot 规则，下列规则ID可参考接口 DescribeBotManagedRules返回的ID信息 */ export interface BotManagedRule { /** * 触发规则后的处置方式，取值有：
  • drop：拦截；
  • trans：放行；
  • alg：Javascript挑战；
  • monitor：观察。
    • */ Action: string; /** * 本规则的ID。仅出参使用。 */ RuleID?: number; /** * 放行的规则ID。默认所有规则不配置放行。 */ TransManagedIds?: Array; /** * JS挑战的规则ID。默认所有规则不配置JS挑战。 */ AlgManagedIds?: Array; /** * 数字验证码的规则ID。默认所有规则不配置数字验证码。 */ CapManagedIds?: Array; /** * 观察的规则ID。默认所有规则不配置观察。 */ MonManagedIds?: Array; /** * 拦截的规则ID。默认所有规则不配置拦截。 */ DropManagedIds?: Array; } /** * 当前生效的回源 IP 网段。 */ export interface CurrentOriginACL { /** * 回源 IP 网段详情。 注意：此字段可能返回 null，表示取不到有效值。 */ EntireAddresses?: Addresses; /** * 版本号。 注意：此字段可能返回 null，表示取不到有效值。 */ Version?: string; /** * 版本生效时间，时间是北京时间 UTC+8， 遵循 ISO 8601 标准的日期和时间格式。 注意：此字段可能返回 null，表示取不到有效值。 */ ActiveTime?: string; /** * 本参数用于记录当前版本生效前是否完成「我已更新至最新回源 IP 网段」的确认。取值有：
  • true：版本生效时，已完成更新至最新回源 IP 的确认；
  • false：版本生效时，仍未完成已更新至最新回源 IP 的确认，回源 IP 网段由后台强制更新至最新版本。
    • 注意：本参数返回 false 时，请及时确认您的源站防火墙配置是否已更新至最新的回源 IP 网段，以避免出现回源失败。 注意：此字段可能返回 null，表示取不到有效值。 */ IsPlaned?: string; } /** * DescribeIPGroupReferences返回参数结构体 */ export interface DescribeIPGroupReferencesResponse { /** *

    引用对应 IP 组的配置信息。

    */ References?: Array; /** *

    查询结果总数。

    */ TotalCount?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateEdgeKVNamespace请求参数结构体 */ export interface CreateEdgeKVNamespaceRequest { /** * 站点 ID。 */ ZoneId: string; /** * 命名空间名称。输入内容有以下限制：支持输入 1-50 个字符，允许的字符为 a-z、A-Z、0-9、-，且 - 不能单独注册或连续使用，不能放在开头或结尾。在同站点下，名称需保证唯一。 */ Namespace: string; /** * 命名空间描述。用于说明命名空间的用途或业务含义。最大支持 256 个字符。 */ Remark?: string; } /** * Web安全配置 */ export interface SecurityConfig { /** * 托管规则。如果入参为空或不填，默认使用历史配置。 */ WafConfig?: WafConfig; /** * 速率限制。如果入参为空或不填，默认使用历史配置。 */ RateLimitConfig?: RateLimitConfig; /** * 自定义规则。如果入参为空或不填，默认使用历史配置。 */ AclConfig?: AclConfig; /** * Bot配置。如果入参为空或不填，默认使用历史配置。 */ BotConfig?: BotConfig; /** * 七层防护总开关。如果入参为空或不填，默认使用历史配置。 */ SwitchConfig?: SwitchConfig; /** * 基础访问管控。如果入参为空或不填，默认使用历史配置。 */ IpTableConfig?: IpTableConfig; /** * 例外规则配置。如果入参为空或不填，默认使用历史配置。 */ ExceptConfig?: ExceptConfig; /** * 自定义拦截页面配置。如果入参为空或不填，默认使用历史配置。 */ DropPageConfig?: DropPageConfig; /** * 模板配置。此处仅出参数使用。 */ TemplateConfig?: TemplateConfig; /** * 慢速攻击配置。如果入参为空或不填，默认使用历史配置。 */ SlowPostConfig?: SlowPostConfig; /** * 检测长度限制配置。仅出参使用。 */ DetectLengthLimitConfig?: DetectLengthLimitConfig; } /** * CreateSecurityIPGroup请求参数结构体 */ export interface CreateSecurityIPGroupRequest { /** * 站点 Id。 */ ZoneId: string; /** * IP 组信息。 */ IPGroup: IPGroup; } /** * ModifyPlan请求参数结构体 */ export interface ModifyPlanRequest { /** * 套餐 ID，形如 edgeone-2unuvzjmmn2q。 */ PlanId: string; /** * 预付费套餐自动续费配置。若开启了自动续费，则会在套餐到期前一天自动续费，仅支持个人版，基础版，标准版套餐。不填写表示保持原有配置。 */ RenewFlag?: RenewFlag; } /** * DescribeOriginACL返回参数结构体 */ export interface DescribeOriginACLResponse { /** * 七层加速域名/四层代理实例与回源 IP 网段的绑定关系详情。 */ OriginACLInfo?: OriginACLInfo; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 共享CNAME明细 */ export interface SharedCNAMEInfo { /** *

    共享CNAME类型：取值范围如下：

  • custom：由用户创建的自定义共享CNAME
  • ip-ssl：IP SSL类型的共享CNAME
  • zero-rating：免流类型的共享CNAME
  • preset：预置资源类型的共享CNAME
    • */ Type?: string; /** *

    共享CNAME名称。

    */ SharedCNAME?: string; /** *

    描述。

    */ Description?: string; /** *

    当type为ip-ssl时，展示该共享CNAME关联的 IP SSL 配置信息。

    */ IPSSLConfig?: IPSSLConfig; /** *

    共享CNAME绑定的加速域名数量。

    */ BindDomainCount?: number; /** *

    加入该共享CNAME的加速域名列表。当加入的域名数量超过100个时，只返回前100个加速域名。

    */ AccelerationDomains?: Array; } /** * 默认拦截动作配置。当安全规则命中并触发拦截处置动作时，若 SecurityAction 仅指定了 Name 为 Deny 且未指定 DenyActionParameters，则按功能模块维度匹配并使用此处定义的默认参数配置：
  • ManagedRules 托管规则默认拦截处置动作配置。
  • OtherModules 除托管规则外的安全防护规则（自定义规则、速率限制 和 Bot 管理功能）默认拦截处置动作配置。
    • */ export interface DefaultDenySecurityActionParameters { /** * 托管规则默认拦截处置动作配置。 DenyActionParameters 支持的配置参数：
  • ReturnCustomPage：是否使用自定义页面。
  • ResponseCode：自定义页面的状态码。
  • ErrorPageId：自定义页面的 PageId。
    • */ ManagedRules?: DenyActionParameters; /** * 除托管规则外的安全防护规则（自定义规则、速率限制 和 Bot 管理功能）默认拦截处置动作配置。 DenyActionParameters 支持的配置参数：
  • ReturnCustomPage：是否使用自定义页面。
  • ResponseCode：自定义页面的状态码。
  • ErrorPageId：自定义页面的 PageId。
    • */ OtherModules?: DenyActionParameters; } /** * DescribePrefetchTasks请求参数结构体 */ export interface DescribePrefetchTasksRequest { /** * 站点ID。此参数将于2024年05月30日后由可选改为必填，详见公告：[【腾讯云 EdgeOne】云 API 变更通知](https://cloud.tencent.com/document/product/1552/104902)。 */ ZoneId?: string; /** * 查询起始时间，时间与 job-id 必填一个。 */ StartTime?: string; /** * 查询结束时间，时间与 job-id 必填一个。 */ EndTime?: string; /** * 分页查询偏移量，默认为 0。 */ Offset?: number; /** * 分页查询限制数目，默认值：20，上限：1000。 */ Limit?: number; /** * 过滤条件，Filters.Values 的上限为 20。详细的过滤条件如下：
  • job-id：按照任务 ID 进行过滤。job-id 形如：1379afjk91u32h，暂不支持多值，不支持模糊查询；
  • target：按照目标资源信息进行过滤。target 形如：http://www.qq.com/1.txt，暂不支持多值，不支持模糊查询；
  • domains：按照域名行过滤。domains 形如：www.qq.com，不支持模糊查询；
  • statuses：按照任务状态进行过滤，不支持模糊查询。可选项：
       processing：处理中
       success：成功
       failed：失败
       timeout：超时
       canceled：已取消
       invalid：无效。即源站响应非 2xx 状态码，请检查源站服务。
    • */ Filters?: Array; } /** * ModifyL4ProxyRules请求参数结构体 */ export interface ModifyL4ProxyRulesRequest { /** * 站点 ID。 */ ZoneId: string; /** * 四层代理实例 ID。 */ ProxyId: string; /** * 转发规则列表。单次最多支持 200 条转发规则。 注意：L4ProxyRule 在此处使用时，RuleId 为必填字段；Protocol、PortRange、OriginType、OriginValue、OriginPortRange、ClientIPPassThroughMode、SessionPersist、SessionPersistTime、RuleTag 均为选填字段，不填写表示不修改；Status 请勿填写。 */ L4ProxyRules: Array; } /** * DescribeRulesSetting请求参数结构体 */ export type DescribeRulesSettingRequest = null; /** * 安全实例状态。 */ export interface EntityStatus { /** * 实例名，现在只有子域名。 */ Entity?: string; /** * 实例配置下发状态，取值有：
  • online：配置已生效；
  • fail：配置失败；
  • process：配置下发中。
    • */ Status?: string; /** * 实例配置下发信息提示。 */ Message?: string; } /** * 智能加速配置。 */ export interface SmartRoutingParameters { /** * 智能加速配置开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch?: string; } /** * DisableOriginACL返回参数结构体 */ export interface DisableOriginACLResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateFunctionRule返回参数结构体 */ export interface CreateFunctionRuleResponse { /** * 规则 ID。 */ RuleId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateMultiPathGatewaySecretKey请求参数结构体 */ export interface CreateMultiPathGatewaySecretKeyRequest { /** * 站点 ID。 */ ZoneId: string; /** * 多通道安全加速网关接入密钥，base64字符串，编码前字符串长度为 32-48 个字符，非必填，不填系统自动生成，可通过接口 DescribeMultiPathGatewaySecretKey 查询。 */ SecretKey?: string; } /** * 七层回源超时配置。 */ export interface HTTPUpstreamTimeoutParameters { /** * HTTP 应答超时时间，单位为秒，取值：5～600。 */ ResponseTimeout?: number; } /** * DescribeMultiPathGateway请求参数结构体 */ export interface DescribeMultiPathGatewayRequest { /** * 站点 ID。 */ ZoneId: string; /** * 网关 ID。 */ GatewayId: string; } /** * 对象存储源站私有鉴权参数 */ export interface PrivateParameter { /** * 私有鉴权参数名称，取值有：
  • AccessKeyId：鉴权参数 Access Key ID；
  • SecretAccessKey：鉴权参数 Secret Access Key；
  • SignatureVersion：鉴权版本，v2 或者 v4；
  • Region：存储桶地域。
    • */ Name: string; /** * 私有鉴权参数值。 */ Value: string; } /** * 缓存键配置。 */ export interface CacheKeyConfigParameters { /** * 是否开启全路径缓存，取值有：
  • on：开启全路径缓存（即关闭参数忽略）；
  • off：关闭全路径缓存（即开启参数忽略）。
    • */ FullURLCache?: string; /** * 是否忽略大小写缓存，取值有：
  • on：忽略；
  • off：不忽略。
    • */ IgnoreCase?: string; /** * 查询字符串保留配置参数。此字段和 FullURLCache 必须同时设置，但不能同为 on。 */ QueryString?: CacheKeyQueryString; } /** * Bot 管理中校验的触发阈值。 */ export interface MaxNewSessionTriggerConfig { /** * 触发阈值统计的时间窗口，取值有：
  • 5s：5 秒内；
  • 10s：10 秒内；
  • 15s：15 秒内；
  • 30s：30 秒内；
  • 60s：60 秒内；
  • 5m：5 分钟内；
  • 10m：10 分钟内；
  • 30m：30 分钟内；
  • 60m：60 分钟内。
    • */ MaxNewSessionCountInterval?: string; /** * 触发阈值统计的累计次数，取值范围 1 ~ 100000000。 */ MaxNewSessionCountThreshold?: number; } /** * CreateOriginGroup请求参数结构体 */ export interface CreateOriginGroupRequest { /** * 站点 ID */ ZoneId: string; /** * 源站记录信息，此参数必填。 */ Records: Array; /** * 源站组名称，可输入1 - 200个字符，允许的字符为 a - z, A - Z, 0 - 9, _, - 。 */ Name?: string; /** * 源站组类型，此参数必填，取值有：
  • GENERAL：通用型源站组，仅支持添加 IP/域名 源站，可以被域名服务、规则引擎、四层代理、通用型负载均衡、HTTP 专用型负载均衡引用；
  • HTTP： HTTP 专用型源站组，支持添加 IP/域名、对象存储源站作为源站，无法被四层代理引用，仅支持被添加加速域名、规则引擎-修改源站、HTTP 专用型负载均衡引用。
    • */ Type?: string; /** * 回源 Host Header，仅 Type = HTTP 时传入生效，规则引擎修改 Host Header 配置优先级高于源站组的 Host Header。 */ HostHeader?: string; } /** * ModifyDDoSProtection请求参数结构体 */ export interface ModifyDDoSProtectionRequest { /** * 站点 ID。 */ ZoneId: string; /** * 独立 DDoS 防护配置。 */ DDoSProtection: DDoSProtection; } /** * DescribeDDoSProtection返回参数结构体 */ export interface DescribeDDoSProtectionResponse { /** * 独立 DDoS 防护配置。用于控制独立 DDoS 防护的生效范围。 */ DDoSProtection?: DDoSProtection; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateSecurityIPGroup返回参数结构体 */ export interface CreateSecurityIPGroupResponse { /** * IP 组 Id。 */ GroupId?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateSharedCNAME返回参数结构体 */ export interface CreateSharedCNAMEResponse { /** * 共享 CNAME。格式为：`<自定义前缀>++share.dnse[0-5].com`。 */ SharedCNAME?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 状态码缓存 TTL 配置参数内部结构。 */ export interface StatusCodeCacheParam { /** * 状态码，取值为 400、 401、403、 404、 405、 407、 414、 500、 501、 502、 503、 504、 509、 514 之一。 */ StatusCode?: number; /** * 缓存时间数值，单位为秒，取值：0～31536000。 */ CacheTime?: number; } /** * DeleteMultiPathGateway返回参数结构体 */ export interface DeleteMultiPathGatewayResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAvailablePlans返回参数结构体 */ export interface DescribeAvailablePlansResponse { /** * 当前账户可购买套餐类型及相关信息。 注意：此字段可能返回 null，表示取不到有效值。 */ PlanInfo?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 速率限制模板 */ export interface RateLimitTemplate { /** * 模板等级名称，取值有：
  • sup_loose：超级宽松；
  • loose：宽松；
  • emergency：紧急；
  • normal：适中；
  • strict：严格；
  • close：关闭，仅精准速率限制生效。
    • */ Mode: string; /** * 模板处置方式，取值有：
  • alg：JavaScript挑战；
  • monitor：观察。
    • 不填写默认取alg。 */ Action?: string; /** * 模板值详情。仅出参返回。 */ RateLimitTemplateDetail?: RateLimitTemplateDetail; } /** * 版本管理配置组工作模式信息。 */ export interface ConfigGroupWorkModeInfo { /** * 配置组类型，可选项如下：
  • l7_acceleration: 七层加速配置组；
  • edge_functions: 边缘函数配置组。
  • web_security: Web 防护配置组。
    • */ ConfigGroupType: string; /** * 工作模式，可选项如下：
  • immediate_effect: 即时生效模式；
  • version_control: 版本管理模式。
    • */ WorkMode: string; } /** * 内容压缩配置。 */ export interface ContentCompressionParameters { /** * 内容压缩配置开关，取值有：
  • on：开启；
  • off：关闭。
    • 当 Switch 为 on 时，将同时支持 brotli 和 gzip 压缩算法。 */ Switch: string; } /** * 加速域名所对应的证书信息。 */ export interface AccelerationDomainCertificate { /** * 配置服务端证书的模式，取值有：
    • disable：不配置服务端证书；
    • eofreecert：通过自动验证申请免费证书并部署。验证方式详见：[申请免费证书支持的验证方式](https://cloud.tencent.com/document/product/1552/90437) - 在 NS 或者 DNSPod 托管接入模式下，仅支持自动验证的方式申请免费证书。 - 当免费证书申请失败时会导致证书部署失败，您可以通过检查免费证书申请结果接口获取申请失败原因。
    • eofreecert_manual：部署 DNS 委派验证或者文件验证申请的免费证书。在部署免费证书前，您需要触发申请免费证书接口申请免费证书。在免费证书申请成功后，你可以通过该枚举值对免费证书进行部署；
      • 注意：在对免费证书部署时，需要保证当前已存在申请成功的免费证书。您可以通过检查免费证书申请结果接口检查当前是否已存在申请成功的免费证书。
    • sslcert：配置 SSL 托管服务端证书。
    */ Mode?: string; /** * 服务端证书列表，相关证书部署在 EO 的入口侧。 注意：此字段可能返回 null，表示取不到有效值。 */ List?: Array; /** * 在边缘双向认证场景下，该字段为客户端的 CA 证书，部署在 EO 节点内，用于 EO 节点认证客户端证书。 */ ClientCertInfo?: MutualTLS; /** * 用于分别开启/关闭回源双向认证和源站证书校验。回源双向认证的证书用于 EO 回源时携带，源站可选择校验该证书用于确保请求来源于受信任的 EO 节点。源站证书校验开启时，证书配置用于 EO 节点校验源站证书是否可信。 */ UpstreamCertInfo?: UpstreamCertInfo; } /** * DescribeFunctionComponentBindings返回参数结构体 */ export interface DescribeFunctionComponentBindingsResponse { /** * 符合条件的函数绑定总数。 */ TotalCount?: number; /** * 函数组件绑定列表。 */ FunctionComponentBindings?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeSecurityTemplateBindings请求参数结构体 */ export interface DescribeSecurityTemplateBindingsRequest { /** * 要查询的站点 ID。 */ ZoneId: string; /** * 要查询的策略模板 ID。 */ TemplateId: Array; } /** * DescribeInferenceAPITokens返回参数结构体 */ export interface DescribeInferenceAPITokensResponse { /** *

    Token 的总数。

    */ TotalCount?: number; /** *

    Token 列表。

    */ Tokens?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Bot主动特征识别校验结果。 */ export interface AlgDetectResult { /** * 校验结果，取值有：
  • invalid：不合法Cookie；
  • cookie_empty：末携带Cookie或Cookie己过期；
  • js_empty：客户端末启用JS（末完成检测）；
  • low：会话速率和周期特征校验低风险；
  • middle：会话速率和周期特征校验中风险；
  • high：会话速率和周期特征校验高风险；
  • timeout：检测超时时长；
  • not_browser：不合法浏览器；
  • is_bot：Bot客户端。
    • */ Result?: string; /** * 处罚动作，取值有：
  • drop：拦截；
  • monitor：观察；
  • silence：静默；
  • shortdelay：（短时间）等待后响应；
  • longdelay：（长时间）等待后响应。
    • */ Action?: string; } /** * EdgeKVList返回参数结构体 */ export interface EdgeKVListResponse { /** * 键名列表。 */ Keys?: Array; /** * 游标位置。标识当前遍历的位置，用于获取下一批数据。将此值填入下次请求的 Cursor 参数中，可继续向后遍历。若为空字符串，表示已遍历完所有数据。 */ Cursor?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifySharedCNAME请求参数结构体 */ export interface ModifySharedCNAMERequest { /** * 共享 CNAME 所属站点 ID。 */ ZoneId: string; /** * 共享 CNAME。 */ SharedCNAME: string; /** * 请输入调整后的描述。 */ Description?: string; /** * 设置IP SSL 类型的共享CNAME 的 IP SSL 信息。 */ IPSSLSetting?: IPSSLSetting; } /** * https 服务端证书配置 */ export interface DefaultServerCertInfo { /** * 服务器证书 ID。 */ CertId: string; /** * 证书备注名。 */ Alias?: string; /** * 证书类型，取值有：
  • default: 默认证书;
  • upload:用户上传;
  • managed:腾讯云托管。
    • */ Type?: string; /** * 证书过期时间。 */ ExpireTime?: string; /** * 证书生效时间。 */ EffectiveTime?: string; /** * 证书公用名。 */ CommonName?: string; /** * 证书SAN域名。 */ SubjectAltName?: Array; /** * 部署状态，取值有：
  • processing: 部署中；
  • deployed: 已部署；
  • failed: 部署失败。
    • */ Status?: string; /** * Status为失败时,此字段返回失败原因。 */ Message?: string; /** * 证书算法。 */ SignAlgo?: string; } /** * 规则引擎规则详情。 */ export interface RuleEngineItem { /** *

    规则状态。取值有：

  • enable: 启用；
  • disable: 未启用。

    • */ Status?: string; /** *

    规则 ID。规则的唯一性标识，当调用 ModifyL7AccRule 时，该参数必填。

    */ RuleId?: string; /** *

    规则名称。名称长度限制不超过 255 个字符。

    */ RuleName?: string; /** *

    规则注释。可以填写多个注释。

    */ Description?: Array; /** *

    规则级自定义变量列表。CustomVariable.Name 需要使用 user.rule. 作为前缀。变量按照数组顺序依次初始化，InitialValue 支持引用站点级自定义变量，以及位于当前变量之前的规则级自定义变量，不支持引用当前变量自身或位于其后的规则级自定义变量。站点级自定义变量可通过 DescribeZoneCustomVariables 接口查询。当 Branches 为空时 CustomVariable 不允许填写，填写无效。

    注意：此字段可能返回 null，表示取不到有效值。 */ CustomVariables?: Array; /** *

    规则级自定义变量运算详情。运算中支持引用站点级自定义变量和当前规则已定义的规则级自定义变量。站点级自定义变量可通过 DescribeZoneCustomVariables 接口查询。此列表当前只支持填写一项规则，多填无效。当 Branches 为空时 CustomVariableOperations 不允许填写，填写无效。

    注意：此字段可能返回 null，表示取不到有效值。 */ CustomVariableOperations?: Array; /** *

    子规则分支。此列表当前只支持填写一项规则，多填无效。

    注意：此字段可能返回 null，表示取不到有效值。 */ Branches?: Array; /** *

    规则优先级。仅作为出参使用。

    */ RulePriority?: number; } /** * ModifySecurityAPIService返回参数结构体 */ export interface ModifySecurityAPIServiceResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * OCSP 装订配置参数。 */ export interface OCSPStaplingParameters { /** * OCSP 装订配置开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch?: string; } /** * CreateL4ProxyRules请求参数结构体 */ export interface CreateL4ProxyRulesRequest { /** * 站点 ID。 */ ZoneId: string; /** * 四层代理实例 ID。 */ ProxyId: string; /** * 转发规则列表。单次最多支持 200 条转发规则。 注意：L4ProxyRule 在此处使用时，Protocol、PortRange、OriginType、OriginValue、OriginPortRange 为必填字段；ClientIPPassThroughMode、SessionPersist、SessionPersistTime、RuleTag 均为选填字段；RuleId、Status 请勿填写。 */ L4ProxyRules: Array; } /** * DescribeDDoSAttackTopData返回参数结构体 */ export interface DescribeDDoSAttackTopDataResponse { /** * DDoS攻击Top数据列表。 注意：此字段可能返回 null，表示取不到有效值。 */ Data?: Array; /** * 查询结果的总条数。 */ TotalCount?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 嵌套规则信息。 */ export interface SubRule { /** * 执行功能判断条件。 注意：满足该数组内任意一项条件，功能即可执行。 */ Conditions: Array; /** * 执行的功能。 */ Actions: Array; } /** * ModifyPrefetchOriginLimit返回参数结构体 */ export interface ModifyPrefetchOriginLimitResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyMultiPathGateway请求参数结构体 */ export interface ModifyMultiPathGatewayRequest { /** * 站点 ID。 */ ZoneId: string; /** * 网关 ID。 */ GatewayId: string; /** * 网关名称，16 个字符以内，可用字符（a-z,A-Z,0-9,-,_）。 */ GatewayName?: string; /** * 网关地址，GatewayType 取值为 private（自有网关）可填入进行修改，使用该地址时，请确保该地址已录入腾讯云多通道安全加速网关系统。如未录入，需要在本接口调用前通过工单或者联系架构师把网关 IP 地址提前录入腾讯云多通道安全加速网关系统。 */ GatewayIP?: string; /** * 网关端口，范围 1～65535（除去 8888 ），只支持修改 GatewayType 取值为 private 的自有网关。 */ GatewayPort?: number; } /** * 负载均衡实例信息。 */ export interface LoadBalancer { /** *

    实例 ID。

    */ InstanceId?: string; /** *

    实例名称，可输入 1-200 个字符，允许字符为 a-z，A-Z，0-9，_，-。

    */ Name?: string; /** *

    实例类型，取值有：

  • HTTP_V2：HTTP 专用型（V2），支持添加 HTTP 专用型和通用型源站组，仅支持被站点加速相关服务引用（如域名服务和规则引擎）。该实例类型支持选择发起探测的区域，可显著降低探测请求量但对源站的健康感知灵敏度更低；
  • HTTP：HTTP 专用型（V1），支持添加 HTTP 专用型和通用型源站组，仅支持被站点加速相关服务引用（如域名服务和规则引擎）。该实例类型不支持选择发起探测的区域，探测请求量较大但对源站的健康感知灵敏度更高；
  • GENERAL：通用型，仅支持添加通用型源站组，能被站点加速服务（如域名服务和规则引擎）和四层代理引用。该实例类型不支持选择发起探测的区域，探测请求量较大但对源站的健康感知灵敏度更高。
    • */ Type?: string; /** *

    健康检查策略。详情请参考 健康检查策略介绍。

    */ HealthChecker?: HealthChecker; /** *

    源站组间的流量调度策略，取值有：

  • Pritory：按优先级顺序进行故障转移 。
    • */ SteeringPolicy?: string; /** *

    实际访问某源站失败时的请求重试策略，详情请参考 请求重试策略介绍，取值有：

  • OtherOriginGroup：单次请求失败后，请求优先重试下一优先级源站组；
  • OtherRecordInOriginGroup：单次请求失败后，请求优先重试同源站组内的其他源站。
    • */ FailoverPolicy?: string; /** *

    源站组健康状态。

    */ OriginGroupHealthStatus?: Array; /** *

    负载均衡状态，取值有：

  • Pending：部署中；
  • Deleting：删除中；
  • Running：已生效。
    • */ Status?: string; /** *

    该负载均衡实例绑的四层代理实例的列表。

    */ L4UsedList?: Array; /** *

    该负载均衡实例绑定的七层域名列表。

    */ L7UsedList?: Array; /** *

    负载均衡被引用实例的列表。

    */ References?: Array; } /** * 实时日志投递任务中的自定义日志字段，字段支持自定义命名和配置取值表达式，使用详情见 [自定义日志字段表达式]()。 */ export interface CustomExpressionField { /** *

    自定义日志字段名称。可输入1-100个字符，允许的字符为字母、数字、_，仅能以字母开头，该名称不能重复。

    */ Name: string; /** *

    自定义日志字段的取值表达式，表达式长度上限 4KB，语法说明详见 自定义日志字段表达式。

    */ Expression: string; /** *

    是否投递该字段，不填表示不投递此字段。

    */ Enabled?: boolean; } /** * DescribeFunctionReplicas返回参数结构体 */ export interface DescribeFunctionReplicasResponse { /** * 边缘函数副本总数。 */ TotalCount?: number; /** * 边缘函数副本列表。 */ FunctionReplicas?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateSecurityAPIService返回参数结构体 */ export interface CreateSecurityAPIServiceResponse { /** * API 服务 ID 列表。 */ APIServiceIds?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 访问 URL 重定向 HostName 配置参数。 */ export interface HostName { /** * 目标 HostName 配置，取值有：
  • follow：跟随请求；
  • custom：自定义。
    • */ Action?: string; /** * 目标 HostName 自定义取值，最大长度 1024。
    注意：当 Action 为 custom 时，此字段必填；当 Action 为 follow 时，此字段不生效。 */ Value?: string; } /** * DeleteRules请求参数结构体 */ export interface DeleteRulesRequest { /** * 站点 ID。 */ ZoneId: string; /** * 指定删除的规则 ID 列表。 */ RuleIds: Array; } /** * 例外规则生效的具体条件。 */ export interface ExceptUserRuleCondition { /** * 匹配项，取值有：
  • host：请求域名；
  • sip：客户端IP；
  • ua：User-Agent；
  • cookie：会话 Cookie；
  • cgi：CGI 脚本；
  • xff：XFF 扩展头部；
  • url：请求 URL；
  • accept：请求内容类型；
  • method：请求方式；
  • header：请求头部；
  • sip_proto：网络层协议。
    • */ MatchFrom?: string; /** * 匹配项的参数。仅当 MatchFrom 为 header 时，可以使用本参数，值可填入 header 的 key 作为参数。 */ MatchParam?: string; /** * 匹配操作符，取值有：
  • equal：字符串等于；
  • not_equal：数值不等于；
  • include：字符包含；
  • not_include：字符不包含；
  • match：ip匹配；
  • not_match：ip不匹配；
  • include_area：地域包含；
  • is_empty：存在字段但值为空；
  • not_exists：不存在关键字段；
  • regexp：正则匹配；
  • len_gt：数值大于；
  • len_lt：数值小于；
  • len_eq：数值等于；
  • match_prefix：前缀匹配；
  • match_suffix：后缀匹配；
  • wildcard：通配符。
    • */ Operator?: string; /** * 匹配值。 */ MatchContent?: string; } /** * DeleteWebSecurityTemplate返回参数结构体 */ export interface DeleteWebSecurityTemplateResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyL7AccRule请求参数结构体 */ export interface ModifyL7AccRuleRequest { /** * 站点 ID。 */ ZoneId: string; /** * 需要修改的规则。您可以先通过 DescribeL7AccRules 接口来获取需要修改的规则的 Ruleid，然后传入修改后的规则内容，原规则内容会被覆盖式更新。 */ Rule: RuleEngineItem; } /** * 浏览器缓存规则配置，用于设置 MaxAge 默认值，默认为关闭状态 */ export interface MaxAge { /** * 是否遵循源站，取值有：
  • on：遵循源站，忽略MaxAge 时间设置；
  • off：不遵循源站，使用MaxAge 时间设置。
    • */ FollowOrigin?: string; /** * MaxAge 时间设置，单位为秒，取值：0～315360000。 注意：时间为0，即不缓存。 */ MaxAgeTime?: number; } /** * DescribeCustomErrorPages返回参数结构体 */ export interface DescribeCustomErrorPagesResponse { /** *

    自定义响应页面总数。

    */ TotalCount?: number; /** *

    自定义响应页面数据列表。

    */ ErrorPages?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteApplicationProxy返回参数结构体 */ export interface DeleteApplicationProxyResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Bot主动特征识别规则。 */ export interface AlgDetectRule { /** * 规则id。 */ RuleID?: number; /** * 规则名。 */ RuleName?: string; /** * 规则开关。 */ Switch?: string; /** * 自定义规则。 */ AlgConditions?: Array; /** * Cookie校验和会话行为分析。 */ AlgDetectSession?: AlgDetectSession; /** * 客户端行为校验。 */ AlgDetectJS?: Array; /** * 更新时间。仅出参使用。 */ UpdateTime?: string; } /** * 安全数据维度值信息 */ export interface SecEntryValue { /** * 指标名称。 */ Metric: string; /** * 时序数据详情。 */ Detail: Array; /** * 最大值。 */ Max: number; /** * 平均值。 */ Avg: number; /** * 数据总和。 */ Sum: number; } /** * DescribeSecurityAPIResource请求参数结构体 */ export interface DescribeSecurityAPIResourceRequest { /** * 站点 ID。 */ ZoneId: string; /** * 分页查询限制数目。默认值：20，最大值：100。 */ Limit?: number; /** * 分页查询偏移量。默认值：0。 */ Offset?: number; } /** * 回源 IP 网段版本信息。 */ export interface OriginACLFamilyInfo { /** * 源站防护版本号。 格式说明： 标准版本：
  • gaz-xxxxx：全球；
  • mlc-xxxxx：中国；
  • emc-xxxxx：海外(全球不含中国)；
    • 精简版(平台级版本)：
  • plat-gaz-xxxxxx：精简全球版；
  • plat-mlc-xxxxxx：精简中国版；
  • plat-emc-xxxxxx：精简海外(全球不含中国)版；
    • 缩写说明：
  • gaz：Global AZ Availability Zone;
  • mlc：mainlandChina;
  • emc：Exclude mainlandChina.
    • */ Version?: string; /** * 版本生效时间，时间是北京时间 UTC+8， 遵循 ISO 8601 标准的日期和时间格式。 */ ActiveTime?: string; /** * 回源 IP 网段详情。 */ EntireAddresses?: Addresses; /** * 源站防护回源ACL控制域。取值说明如下：
  • gaz：标准全球可用区控制域；
  • mlc：标准中国大陆可用区控制域；
  • emc：标准全球(不含中国大陆)可用区控制域；
  • plat-gaz：精简全球可用区控制域；
  • plat-mlc：精简中国大陆可用区控制域；
  • plat-emc：精简全球(不含中国大陆)可用区控制域；
    • */ OriginACLFamily?: string; } /** * 最新IP白名单列表相比于当前IP白名单列表的区别 */ export interface DiffIPWhitelist { /** * 最新IP白名单列表。 */ LatestIPWhitelist: IPWhitelist; /** * 最新IP白名单列表相比于当前IP白名单列表，新增部分。 */ AddedIPWhitelist: IPWhitelist; /** * 最新IP白名单列表相比于当前IP白名单列表，删减部分。 */ RemovedIPWhitelist: IPWhitelist; /** * 最新IP白名单列表相比于当前IP白名单列表，不变部分。 */ NoChangeIPWhitelist: IPWhitelist; } /** * DeleteSecurityIPGroup返回参数结构体 */ export interface DeleteSecurityIPGroupResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyRule请求参数结构体 */ export interface ModifyRuleRequest { /** * 站点 ID。 */ ZoneId: string; /** * 规则名称，字符串名称长度 1~255。 */ RuleName: string; /** * 规则内容。 */ Rules: Array; /** * 规则 ID。 */ RuleId: string; /** * 规则状态，取值有：
  • enable: 启用；
  • disable: 未启用。
    • */ Status: string; /** * 规则标签。 */ Tags?: Array; } /** * DescribeSharedCNAME返回参数结构体 */ export interface DescribeSharedCNAMEResponse { /** * 符合过滤条件的共享CNAME总数。 */ TotalCount?: number; /** * 共享CNAME列表明细。 */ SharedCNAMEInfo?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RenewPlan请求参数结构体 */ export interface RenewPlanRequest { /** * 套餐 ID，形如 edgeone-2unuvzjmmn2q。 */ PlanId: string; /** * 续费套餐的时长，单位：月，取值有：1，2，3，4，5，6，7，8，9，10，11，12，24，36。 */ Period: number; /** * 是否自动使用代金券，取值有：
  • true：是；
  • false：否。
    • 不填写使用默认值 false。 */ AutoUseVoucher?: string; } /** * DescribePrefetchTasks返回参数结构体 */ export interface DescribePrefetchTasksResponse { /** * 该查询条件总共条目数。 */ TotalCount?: number; /** * 任务结果列表。 */ Tasks?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 推理服务的资源配置。 */ export interface InferenceResourceConfig { /** *

    扩容缩容的方式。取值有：

  • Auto：根据请求量自动调整实例数量；
  • Manual：人工设置固定的实例数量。

    • */ ScalingMode: string; /** *

    硬件规格标识。已废弃，请参考使用 HardwareSpecId。

    * @deprecated */ HardwareSpec?: string; /** *

    硬件规格唯一标识 ID，可通过 DescribeInferenceHardwareSpecifications 接口获取当前站点支持的硬件规格。

    系统默认按照所选 HardwareSpecId 对应的硬件规格配置推理服务所需资源；如需调整，可通过 HardwareConfig 自定义硬件资源配置。

    */ HardwareSpecId?: string; /** *

    推理服务硬件配置。

    作为入参时，若未填充则按照所选 HardwareSpecId 规格的默认值配置硬件资源；若填充则优先按照填写值进行配置。

    */ HardwareConfig?: InferenceHardwareConfig; /** *

    推理服务自动伸缩配置。当 ScalingMode 为 Auto 时必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ AutoScalingConfig?: InferenceAutoScalingConfig; /** *

    推理服务人工设置实例配置。当 ScalingMode 为 Manual 时必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ ManualInstanceConfig?: InferenceManualInstanceConfig; /** *

    单实例的并发数。默认值为 1。

    */ Concurrency?: number; } /** * 托管规则详情 */ export interface ManagedRuleDetail { /** * 托管规则Id。 */ RuleId?: string; /** * 托管规则的防护级别。取值有：
  • low：低风险，此规则风险较低，适用于非常严格控制环境下的访问场景，该等级规则可能造成较多的误报；
  • medium：中风险，表示此条规则风险正常，适用较为严格的防护场景；
  • high：高风险，表示此条规则风险较高，大多数场景不会产生误报；
  • extreme：超高风险，表示此条规则风险极高，基本不会产生误报；
    • */ RiskLevel?: string; /** * 规则描述。 */ Description?: string; /** * 规则标签。部分类型的规则不存在标签。 */ Tags?: Array; /** * 规则所属版本。 */ RuleVersion?: string; } /** * 当回源 IP 网段发生更新时，该字段会返回下一个版本将要生效的回源 IP 网段，包含与当前生效的回源 IP 网段的对比。 */ export interface NextOriginACL { /** * 版本号。 */ Version?: string; /** * 版本生效时间，时间是北京时间 UTC+8， 遵循 ISO 8601 标准的日期和时间格式。 */ PlannedActiveTime?: string; /** * 回源 IP 网段详情。 */ EntireAddresses?: Addresses; /** * 最新回源 IP 网段相较于 CurrentOrginACL 中回源 IP 网段新增的部分。 */ AddedAddresses?: Addresses; /** * 最新回源 IP 网段相较于 CurrentOrginACL 中回源 IP 网段删减的部分。 */ RemovedAddresses?: Addresses; /** * 最新回源 IP 网段相较于 CurrentOrginACL 中回源 IP 网段无变化的部分。 */ NoChangeAddresses?: Addresses; } /** * DescribeMultiPathGatewayRegions请求参数结构体 */ export interface DescribeMultiPathGatewayRegionsRequest { /** * 站点 ID。 */ ZoneId: string; } /** * DescribeZoneSetting请求参数结构体 */ export interface DescribeZoneSettingRequest { /** * 站点ID。 */ ZoneId: string; } /** * 高级回源优化配置参数。 */ export interface AdvancedOriginRoutingParameters { /** *

    回源优化方向，取值有：

  • MainlandChinaAndGlobalAdaptive：自适应。域名需同时开启「智能加速」后生效，EdgeOne将根据客户端与源站的实际地理位置，自动匹配最优回源优化方向，无需手动指定。例如 www.example.com 开启「高级回源优化」，但「智能加速」关闭或仅部分匹配条件开启时，「高级回源优化」将不生效。
    • */ Direction: string; } /** * ModifyL4ProxyStatus返回参数结构体 */ export interface ModifyL4ProxyStatusResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 站点 CNAME 模式接入验证归属权或域名申请免费证书时，使用 HTTP 访问验证文件时所需的信息。 */ export interface FileVerification { /** * EdgeOne 后台服务器将通过 http://{Host}{URL Path} 的格式（例如 http://www.example.com/.well-known/teo-verification/z12h416twn.txt）获取文件验证信息。其中，本字段为您需要创建的 URL Path 部分，Host 为当前加速域名。 */ Path?: string; /** * 验证文件的内容。该字段的内容需要您填写至 Path 字段返回的 txt 文件中。 */ Content?: string; } /** * ModifyWebSecurityTemplate返回参数结构体 */ export interface ModifyWebSecurityTemplateResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifySecurityPolicy请求参数结构体 */ export interface ModifySecurityPolicyRequest { /** * 站点 ID。 */ ZoneId: string; /** * 安全策略配置。
  • 当 SecurityPolicy 参数中的 ExceptionRules 被设置时，SecurityConfig 参数中的 ExceptConfig 将被忽略；
  • 当 SecurityPolicy 参数中的 CustomRules 被设置时，SecurityConfig 参数中的 AclConfig、 IpTableConfig 将被忽略；
  • 当 SecurityPolicy 参数中的 HttpDDoSProtection 和 RateLimitingRules 被设置时，SecurityConfig 参数中的 RateLimitConfig 将被忽略；
  • 当 SecurityPolicy 参数中的 ManagedRule 被设置时，SecurityConfig 参数中的 WafConfig 将被忽略；
  • 当 SecurityPolicy 参数中的 BotManagement 被设置时，SecurityConfig 参数中的 BotConfig 将被忽略；
  • 对于例外规则、自定义规则、速率限制、托管规则以及 Bot 管理策略配置建议使用 SecurityPolicy 参数进行设置。
    • */ SecurityConfig: SecurityConfig; /** * 安全策略配置。对 Web 例外规则、防护自定义策略、速率规则、托管规则和 Bot 管理配置建议使用，支持表达式语法对安全策略进行配置。 */ SecurityPolicy?: SecurityPolicy; /** * 安全策略类型，可使用以下参数值：
  • ZoneDefaultPolicy：用于指定站点级策略；
  • Template：用于指定策略模板，需要同时指定 TemplateId 参数；
  • Host：用于指定域名级策略（注意：当使用域名来指定域名服务策略时，仅支持已经应用了域名级策略的域名服务或者策略模板）。
    • */ Entity?: string; /** * 指定域名。当 Entity 参数值为 Host 时，使用本参数指定的域名级策略，例如：使用 www.example.com ，配置该域名的域名级策略。 */ Host?: string; /** * 指定策略模板 ID。当 Entity 参数值为 Template 时，使用本参数指定策略模板的 ID。 */ TemplateId?: string; } /** * CreateFunctionReplica请求参数结构体 */ export interface CreateFunctionReplicaRequest { /** * 站点 ID。 */ ZoneId: string; /** * 函数 ID。 */ FunctionId: string; /** * 边缘函数副本名称。限制可输入 1-50 个字符，允许的字符为a-z、0-9、-，且-不能单独注册或连续使用，不能放在开头或结尾。同一 FunctionId 下副本名称需唯一。 */ ReplicaName: string; /** * 边缘函数副本内容，当前仅支持 JavaScript 代码，最大支持 5MB。 */ Content: string; /** * 边缘函数副本描述。最大支持 50 个字符。 */ Remark?: string; } /** * ModifySharedCNAME返回参数结构体 */ export interface ModifySharedCNAMEResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteL7AccRules请求参数结构体 */ export interface DeleteL7AccRulesRequest { /** * 站点 ID。 */ ZoneId: string; /** * 需要删除的规则 ID 列表。您可以通过 DescribeL7AccRules 获取 Ruleid。 */ RuleIds: Array; } /** * 智能加速配置 */ export interface SmartRouting { /** * 智能加速配置开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch: string; } /** * CreateApplicationProxy返回参数结构体 */ export interface CreateApplicationProxyResponse { /** * 新增的四层代理应用ID。 */ ProxyId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Bot自定义规则 */ export interface BotUserRule { /** * 规则名，只能以英文字符，数字，下划线组合，且不能以下划线开头。 */ RuleName: string; /** * 处置动作，取值有：
  • drop：拦截；
  • monitor：观察；
  • trans：放行；
  • redirect：重定向；
  • page：指定页面；
  • alg：JavaScript 挑战；
  • captcha：托管挑战；
  • random：随机处置；
  • silence：静默；
  • shortdelay：短时响应；
  • longdelay：长时响应。
    • */ Action: string; /** * 规则状态，取值有：
  • on：生效；
  • off：不生效。
    • 默认 on 生效。 */ RuleStatus: string; /** * 规则详情。 */ AclConditions: Array; /** * 规则权重，取值范围0-100。 */ RulePriority: number; /** * 规则 Id。仅出参使用。 */ RuleID?: number; /** * 随机处置的处置方式及占比，非随机处置可不填暂不支持。 */ ExtendActions?: Array; /** * 过滤词，取值有：
  • sip：客户端 ip。
    • 默认为空字符串。 */ FreqFields?: Array; /** * 更新时间。仅出参使用。 */ UpdateTime?: string; /** * 统计范围。取值有：
  • source_to_eo：（响应）源站到 EdgeOne；
  • client_to_eo：（请求）客户端到 EdgeOne。
    • 默认为 source_to_eo。 */ FreqScope?: Array; /** * 自定义返回页面的名称。Action 是 page 时必填，且不能为空。 */ Name?: string; /** * 自定义响应 Id。该 Id 可通过查询自定义错误页列表接口获取。默认值为default，使用系统默认页面。Action 是 page 时必填，且不能为空。 */ CustomResponseId?: string; /** * 自定义返回页面的响应码。Action 是 page 时必填，且不能为空，取值: 100~600，不支持 3xx 响应码。默认值：567。 */ ResponseCode?: number; /** * 重定向时候的地址。Action 是 redirect 时必填，且不能为空。 */ RedirectUrl?: string; } /** * 内容管理任务结果 */ export interface Task { /** * 任务 ID。 */ JobId?: string; /** * 资源。 */ Target?: string; /** * 任务类型。 */ Type?: string; /** * 节点缓存清除方法，取值有：
  • invalidate：标记过期，用户请求时触发回源校验，即发送带有 If-None-Match 和 If-Modified-Since 头部的 HTTP 条件请求。若源站响应 200，则节点会回源拉取新的资源并更新缓存；若源站响应 304，则节点不会更新缓存；
  • delete：直接删除节点缓存，用户请求时触发回源拉取资源。
    • */ Method?: string; /** * 状态。取值有：
  • processing：处理中；
  • success：成功；
  • failed：失败；
  • timeout：超时；
  • canceled：已取消。
    • */ Status?: string; /** * 任务创建时间。 */ CreateTime?: string; /** * 任务完成时间。 */ UpdateTime?: string; /** * 刷新、预热失败类型。取值有：
  • taskFailed：任务失败；
  • quotaExceeded：配额超限；
  • downloadManifestFailed：下载描述文件失败；
  • accessDenied：访问被拒绝。
  • originPullFailed：回源失败。
    • */ FailType?: string; /** * 清除缓存、预热缓存的失败原因描述。 */ FailMessage?: string; } /** * CreateZone请求参数结构体 */ export interface CreateZoneRequest { /** * 站点接入类型。该参数取值如下，不填写时默认为 partial：
  • partial：CNAME 接入；
  • full：NS 接入；
  • noDomainAccess：无域名接入；
  • dnsPodAccess：DNSPod 托管接入，该接入模式要求您的域名已托管在 DNSPod 内；
  • ai：边缘推理接入。
    • */ Type?: string; /** * 站点名称。CNAME/NS 接入的时，请传入二级域名（example.com）作为站点名称；无域名接入时，该值请保留为空。 */ ZoneName?: string; /** * Type 取值为 partial/full 时，七层域名的加速区域。以下为该参数取值，不填写时该值默认为 overseas。Type 取值为 noDomainAccess 时该值请保留为空：
  • global: 全球可用区；
  • mainland: 中国大陆可用区；
  • overseas: 全球可用区（不含中国大陆）。
    • */ Area?: string; /** * 待绑定的目标套餐 ID。当您账号下已存在套餐时，可以填写此参数，直接将站点绑定至该套餐。若您当前没有可绑定的套餐时，可通过 [CreatePlan](https://cloud.tencent.com/document/product/1552/105771) 购买套餐。 注意：如果不填写此参数，将创建一个处于“init”状态的站点，该站点为未激活状态，并不会显示在控制台上。您可以通过访问 [BindZoneToPlan](https://cloud.tencent.com/document/product/1552/83042) 来绑定套餐并激活站点，激活后站点可以正常提供服务。 */ PlanId?: string; /** * 同名站点标识。限制输入数字、英文、"." 、"-" 和 "_"，长度 200 个字符以内。详情参考 [同名站点标识](https://cloud.tencent.com/document/product/1552/70202)，无此使用场景时，该字段保留为空即可。 */ AliasZoneName?: string; /** * 标签。该参数用于对站点进行分权限管控、分账。需要先前往 [标签控制台](https://console.cloud.tencent.com/tag/taglist) 创建对应的标签才可以在此处传入对应的标签键和标签值。 */ Tags?: Array; /** * 是否允许重复接入。
  • true：允许重复接入；
  • false：不允许重复接入。
    • 不填写使用默认值false。 * @deprecated */ AllowDuplicates?: boolean; /** * 是否跳过站点现有的DNS记录扫描。默认值：false。 * @deprecated */ JumpStart?: boolean; } /** * CreateInferenceAPIToken请求参数结构体 */ export interface CreateInferenceAPITokenRequest { /** * 站点 ID。 */ ZoneId: string; /** * 推理 API Token 的名称，长度限制不超过 30 个字符。 */ Name: string; } /** * DescribeSecurityIPGroup请求参数结构体 */ export interface DescribeSecurityIPGroupRequest { /** * 站点 ID ，用于指定查询的站点范围。 */ ZoneId: string; /** * 指定安全 IP 组 ID。
  • 提供该参数时，仅查询指定 ID 的安全 IP 组配置；
  • 不传递参数时，返回站点下所有安全 IP 组信息。
    • */ GroupIds?: Array; } /** * 站点加速配置。 */ export interface ZoneConfig { /** * 智能加速配置。 注意：此字段可能返回 null，表示取不到有效值。 */ SmartRouting?: SmartRoutingParameters; /** * 缓存过期时间配置。 注意：此字段可能返回 null，表示取不到有效值。 */ Cache?: CacheConfigParameters; /** * 浏览器缓存配置。 注意：此字段可能返回 null，表示取不到有效值。 */ MaxAge?: MaxAgeParameters; /** * 节点缓存键配置。 注意：此字段可能返回 null，表示取不到有效值。 */ CacheKey?: CacheKeyConfigParameters; /** * 缓存预刷新配置。 注意：此字段可能返回 null，表示取不到有效值。 */ CachePrefresh?: CachePrefreshParameters; /** * 离线缓存配置。 注意：此字段可能返回 null，表示取不到有效值。 */ OfflineCache?: OfflineCacheParameters; /** * 智能压缩配置。 注意：此字段可能返回 null，表示取不到有效值。 */ Compression?: CompressionParameters; /** * 访问协议强制 HTTPS 跳转配置。 注意：此字段可能返回 null，表示取不到有效值。 */ ForceRedirectHTTPS?: ForceRedirectHTTPSParameters; /** * HSTS 相关配置。 注意：此字段可能返回 null，表示取不到有效值。 */ HSTS?: HSTSParameters; /** * TLS 相关配置。 注意：此字段可能返回 null，表示取不到有效值。 */ TLSConfig?: TLSConfigParameters; /** * OCSP 装订配置。 注意：此字段可能返回 null，表示取不到有效值。 */ OCSPStapling?: OCSPStaplingParameters; /** * HTTP2 相关配置。 注意：此字段可能返回 null，表示取不到有效值。 */ HTTP2?: HTTP2Parameters; /** * QUIC 访问配置。 注意：此字段可能返回 null，表示取不到有效值。 */ QUIC?: QUICParameters; /** * HTTP2 回源配置。 注意：此字段可能返回 null，表示取不到有效值。 */ UpstreamHTTP2?: UpstreamHTTP2Parameters; /** * IPv6 访问配置。 注意：此字段可能返回 null，表示取不到有效值。 */ IPv6?: IPv6Parameters; /** * WebSocket 配置。 注意：此字段可能返回 null，表示取不到有效值。 */ WebSocket?: WebSocketParameters; /** * POST 请求传输配置。 注意：此字段可能返回 null，表示取不到有效值。 */ PostMaxSize?: PostMaxSizeParameters; /** * 客户端 IP 回源请求头配置。 注意：此字段可能返回 null，表示取不到有效值。 */ ClientIPHeader?: ClientIPHeaderParameters; /** * 回源时是否携带客户端 IP 所属地域信息的配置。 注意：此字段可能返回 null，表示取不到有效值。 */ ClientIPCountry?: ClientIPCountryParameters; /** * gRPC 协议支持配置。 注意：此字段可能返回 null，表示取不到有效值。 */ Grpc?: GrpcParameters; /** * 网络错误日志记录配置。 注意：此字段可能返回 null，表示取不到有效值。 */ NetworkErrorLogging?: NetworkErrorLoggingParameters; /** * 中国大陆加速优化配置。 注意：此字段可能返回 null，表示取不到有效值。 */ AccelerateMainland?: AccelerateMainlandParameters; /** * 标准 Debug 配置。 注意：此字段可能返回 null，表示取不到有效值。 */ StandardDebug?: StandardDebugParameters; } /** * DescribeTimingL7OriginPullData请求参数结构体 */ export interface DescribeTimingL7OriginPullDataRequest { /** * 站点 ID 集合，此参数必填。最多传入 100 个站点 ID。若需查询腾讯云主账号下所有站点数据，请用 `*` 代替，查询账号级别数据需具备本接口全部站点资源权限。 */ ZoneIds: Array; /** * 指标列表，取值有:
    • l7Flow_outFlux_hy: EdgeOne 节点至源站方向的请求流量，单位：Byte；
    • l7Flow_outBandwidth_hy: EdgeOne 节点至源站方向的请求带宽，单位：bps；
    • l7Flow_request_hy: EdgeOne 节点至源站方向的请求数，单位：次。
    • l7Flow_inFlux_hy: 源站至 EdgeOne 节点方向的响应流量，单位：Byte；
    • l7Flow_inBandwidth_hy: 源站至 EdgeOne 节点方向的响应带宽，单位：bps。
    */ MetricNames: Array; /** * 开始时间。 */ StartTime: string; /** * 结束时间。查询时间范围（`EndTime` - `StartTime`）需小于等于 31 天。 */ EndTime: string; /** * 查询时间粒度，取值有：
    • min: 1分钟；
    • 5min: 5分钟；
    • hour: 1小时；
    • day: 1天。
    不填将根据开始时间跟结束时间的间距自动推算粒度，具体为：2 小时范围内以 min 粒度查询，2 天范围内以 5min 粒度查询，7 天范围内以 hour 粒度查询，超过 7 天以 day 粒度查询。 */ Interval?: string; /** * 过滤条件，详细的过滤条件如下：
    • domain：客户端请求的域名。若按泛域名接入 EdgeOne，则数据中记录为泛域名，而不是具体域名。
    • originStatusCode：回源状态码，仅当 MetricNames = ["l7Flow_request_hy"] 时支持本过滤项。
      对应的 Value 可选项如下：
      • 1xx：1xx 类型的状态码；
      • 2xx：2xx 类型的状态码；
      • 3xx：3xx 类型的状态码；
      • 4xx：4xx 类型的状态码；
      • 5xx：5xx 类型的状态码；
      • 在 [0, 600) 范围内的整数（不包括 600）。
    **注意**：当 DimensionName 不为空时，仅支持 equals 运算符。 */ Filters?: Array; /** *

    查询维度名称，取值有：

    • domain：客户端请求的域名。若按泛域名接入 EdgeOne，则数据中记录为泛域名。
      使用 domain 维度时必须在 Filters 中包含 domain 过滤项，指定总数不超过 100 个需要查询的域名列表；
    • origin-status-code：回源状态码，如 200、404，
      仅当 MetricNames = ["l7Flow_request_hy"] 时支持本维度；
    • origin-status-code-category：回源状态码类别，如 2xx、4xx，
      仅当 MetricNames =["l7Flow_request_hy"] 时支持本维度。

    若 DimensionName 入参为空，默认按 AppId 维度汇总，只返回一组数据。

    若 DimensionName 入参不为空，则按照传入的查询维度分组返回对应的时序数据。例如：

      当 DimensionName = origin-status-code 时：
      • 返回数据中 TimingDataRecords.TypeKey 为具体回源状态码，例如 200。
      • 返回数据中 TimingDataRecords.TypeValue 是该状态码对应的时序数据。
    注意：当指定 DimensionName 查询时，禁止并发调用。若超出查询频率限制，会返回错误 InvalidParameter.ActionInProgress 。 */ DimensionName?: string; } /** * 负载均衡实例 HTTP/HTTPS 健康检查策略下可配置的自定义头部。 */ export interface CustomizedHeader { /** * 自定义头部 Key。 */ Key: string; /** * 自定义头部 Value。 */ Value: string; } /** * ModifyDDoSProtection返回参数结构体 */ export interface ModifyDDoSProtectionResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeFunctions请求参数结构体 */ export interface DescribeFunctionsRequest { /** * 站点 ID。 */ ZoneId: string; /** * 按照函数 ID 列表过滤。 */ FunctionIds?: Array; /** * 过滤条件列表，多个条件为且关系，Filters.Values 的上限为 20。详细的过滤条件如下：
  • name：按照【函数名称】进行模糊匹配。
  • remark：按照【函数描述】进行模糊匹配。
    • */ Filters?: Array; /** * 分页查询偏移量。默认值：0。 */ Offset?: number; /** * 分页查询限制数目。默认值：20，最大值：200。 */ Limit?: number; } /** * ModifyDnsRecordsStatus请求参数结构体 */ export interface ModifyDnsRecordsStatusRequest { /** * 站点 ID。 */ ZoneId: string; /** * 待启用的 DNS 记录 ID 列表，上限：200。
    注意：同个 DNS 记录 ID 不能同时存在于 RecordsToEnable 和 RecordsToDisable。 */ RecordsToEnable?: Array; /** * 待停用的 DNS 记录 ID 列表，上限：200。
    注意：同个 DNS 记录 ID 不能同时存在于 RecordsToEnable 和 RecordsToDisable。 */ RecordsToDisable?: Array; } /** * 托管规则自动更新选项 */ export interface ManagedRuleAutoUpdate { /** * 是否开启自动更新至最新版本。取值有：
  • on：开启
  • off：关闭
    • */ AutoUpdateToLatestVersion: string; /** * 当前使用的版本，格式符合ISO 8601标准，如2023-12-21T12:00:32Z，默认为空，仅出参。 */ RulesetVersion?: string; } /** * Web 防护功能下的自定义规则。 */ export interface CustomRule { /** * 自定义规则的名称。 */ Name: string; /** * 自定义规则的具体内容，需符合表达式语法，详细规范参见 [产品文档](https://cloud.tencent.com/document/product/1552/125343) 。 */ Condition: string; /** * 自定义规则的处置动作。SecurityAction.Name 取值范围如下：
    • Deny：拦截；
    • Monitor：观察；
    • ReturnCustomPage：使用指定页面拦截；
    • Redirect：重定向至 URL；
    • BlockIP：IP 封禁；
    • JSChallenge：JavaScript 挑战；
    • ManagedChallenge：托管挑战；
    • Allow：放行。
    */ Action: SecurityAction; /** * 自定义规则是否开启。取值有：
    • on：开启
    • off：关闭
    */ Enabled: string; /** * 自定义规则的 ID。通过规则 ID 可支持不同的规则配置操作：
    • 增加新规则：ID 为空或不指定 ID 参数；
    • 修改已有规则：指定需要更新/修改的规则 ID；
    • 删除已有规则：CustomRules 参数中，Rules 列表中未包含的已有规则将被删除。
    */ Id?: string; /** * 自定义规则的类型。取值有：
    • BasicAccessRule：基础访问管控；
    • PreciseMatchRule：精准匹配规则；
    • ManagedAccessRule：专家定制规则，仅出参支持。
    说明：当未指定 RuleType 时，默认为 `PreciseMatchRule`。 */ RuleType?: string; /** * 自定义规则的优先级，范围是 0 ~ 100，默认为 0，仅支持精准匹配规则（`PreciseMatchRule`）。 */ Priority?: number; } /** * Bot扩展处置方式，多处置动作组合。 */ export interface BotExtendAction { /** * 处置动作，取值有：
  • monitor：观察；
  • alg：JavaScript挑战；
  • captcha：托管挑战；
  • random：随机，按照ExtendActions分配处置动作和比例；
  • silence：静默；
  • shortdelay：短时响应；
  • longdelay：长时响应。
    • */ Action: string; /** * 处置方式的触发概率，范围0-100。 */ Percent?: number; } /** * 定制配置 */ export interface CustomAction { /** *

    定制配置的配置项 Id。

    您可以通过 DescribeAvailableCustomActionsForRuleEngine 接口的返回值 CustomActionSet[].ActionId 获取。

    */ ActionId: string; /** *

    该定制配置项下各参数字段的取值。

    您可以通过 DescribeAvailableCustomActionsForRuleEngine 接口返回值 CustomActionSet[].Parameters 获取。

    */ Parameters: Array; } /** * CreatePurgeTask返回参数结构体 */ export interface CreatePurgeTaskResponse { /** * 任务 ID。 */ JobId?: string; /** * 失败的任务列表及原因。 注意：此字段可能返回 null，表示取不到有效值。 */ FailedList?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteApplicationProxyRule返回参数结构体 */ export interface DeleteApplicationProxyRuleResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 访问 URL 重定向路径配置参数。 */ export interface URLPath { /** * 执行动作，取值有：
  • follow：跟随请求；
  • custom：自定义；
  • regex：正则匹配。
    • */ Action?: string; /** * 正则匹配的表达式，长度范围为 1～1024。
    注意：当 Action 为 regex 时，此字段必填；当 Action 为 follow 或 custom 时，无需填写此字段，若填写则不生效。 */ Regex?: string; /** * 重定向的目标URL，长度范围为 1～1024。
    注意：当 Action 为 regex 或 custom 时，此字段必填；当 Action 为 follow 时，无需填写此字段，若填写则不生效。 */ Value?: string; } /** * DeleteAccelerationDomains返回参数结构体 */ export interface DeleteAccelerationDomainsResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Web安全的例外规则 */ export interface ExceptionRules { /** * 例外规则的定义列表。使用 ModifySecurityPolicy 修改 Web 防护配置时:
  • 若未指定 Rules 参数，或 Rules 参数长度为零：清空所有例外规则配置。
  • 若 SecurityPolicy 参数中，未指定 ExceptionRules 参数值：保持已有例外规则配置，不做修改。
    • */ Rules?: Array; } /** * 例外规则，用于配置需要跳过特定场景的规则 */ export interface ExceptConfig { /** * 配置开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch: string; /** * 例外规则详情。如果为null，默认使用历史配置。 */ ExceptUserRules?: Array; } /** * Web安全重定向的附加参数 */ export interface RedirectActionParameters { /** * 重定向的URL。 */ URL: string; } /** * DeleteOriginGroup请求参数结构体 */ export interface DeleteOriginGroupRequest { /** * 站点 ID */ ZoneId: string; /** * 源站组 ID，此参数必填。 */ GroupId: string; } /** * DescribeDDoSProtection请求参数结构体 */ export interface DescribeDDoSProtectionRequest { /** * 站点 ID。 */ ZoneId: string; } /** * 精准防护条件 */ export interface AclCondition { /** * 匹配字段，取值有：
  • host：请求域名；
  • sip：客户端IP；
  • ua：User-Agent；
  • cookie：会话 Cookie；
  • cgi：CGI 脚本；
  • xff：XFF 扩展头部；
  • url：请求 URL；
  • accept：请求内容类型；
  • method：请求方式；
  • header：请求头部；
  • app_proto：应用层协议；
  • sip_proto：网络层协议；
  • uabot：UA 特征规则，仅bot自定义规则可用；
  • idcid：IDC 规则，仅bot自定义规则可用；
  • sipbot：搜索引擎规则，仅bot自定义规则可用；
  • portrait：画像分析，仅bot自定义规则可用；
  • header_seq：请求头顺序，仅bot自定义规则可用；
  • hdr：请求正文，仅Web防护自定义规则可用。
    • */ MatchFrom: string; /** * 匹配字符串。当 MatchFrom 为 header 时，可以填入 header 的 key 作为参数。 */ MatchParam: string; /** * 匹配关系，取值有：
  • equal：字符串等于；
  • not_equal：数值不等于；
  • include：字符包含；
  • not_include：字符不包含；
  • match：ip匹配；
  • not_match：ip不匹配；
  • include_area：地域包含；
  • is_empty：存在字段但值为空；
  • not_exists：不存在关键字段；
  • regexp：正则匹配；
  • len_gt：数值大于；
  • len_lt：数值小于；
  • len_eq：数值等于；
  • match_prefix：前缀匹配；
  • match_suffix：后缀匹配；
  • wildcard：通配符。
    • */ Operator: string; /** * 匹配内容。 */ MatchContent: string; } /** * DescribeJustInTimeTranscodeTemplates返回参数结构体 */ export interface DescribeJustInTimeTranscodeTemplatesResponse { /** * 符合过滤条件的记录总数。 */ TotalCount?: number; /** * 模板详情列表。 */ TemplateSet?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 站点验证信息 */ export interface Identification { /** * 站点名称。 */ ZoneName?: string; /** * 验证子域名。验证站点时，该值为空。验证子域名是为具体子域名。 */ Domain?: string; /** * 验证状态，取值有：
  • pending：验证中；
  • finished：验证完成。
    • */ Status?: string; /** * 站点归属权校验：Dns校验信息。 */ Ascription?: AscriptionInfo; /** * 域名当前的 NS 记录。 */ OriginalNameServers?: Array; /** * 站点归属权校验：文件校验信息。 */ FileAscription?: FileAscriptionInfo; } /** * 正文传输超时时长的具体配置。 */ export interface RequestBodyTransferTimeout { /** * 正文传输超时时长，取值 5 ~ 120，单位仅支持秒（s）。 */ IdleTimeout: string; /** * 正文传输超时时长是否开启。取值有：
  • on：开启；
  • off：关闭。
    • */ Enabled: string; } /** * 七层离线日志详细信息。 */ export interface L7OfflineLog { /** * 离线日志域名。 */ Domain?: string; /** * 日志所属区域，取值有：
  • mainland：中国大陆境内;
  • overseas：全球（不含中国大陆）。
    • */ Area?: string; /** * 离线日志数据包名。 */ LogPacketName?: string; /** * 离线日志下载地址。 */ Url?: string; /** * 日志打包时间，此参数已经废弃。 */ LogTime?: number; /** * 日志打包开始时间。 */ LogStartTime?: string; /** * 日志打包结束时间。 */ LogEndTime?: string; /** * 日志原始大小，单位 Byte。 */ Size?: number; } /** * ModifyRule返回参数结构体 */ export interface ModifyRuleResponse { /** * 规则 ID。 */ RuleId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 应用代理规则 */ export interface ApplicationProxyRule { /** * 协议，取值有：
  • TCP：TCP协议；
  • UDP：UDP协议。
    • */ Proto: string; /** * 端口，支持格式：
  • 单个端口，如：80。
  • 端口段，如：81-82。表示81，82两个端口。
    • 注意：一条规则最多可填写20个端口。 */ Port: Array; /** * 源站类型，取值有：
  • custom：手动添加；
  • loadbalancer：负载均衡；
  • origins：源站组。
    • */ OriginType: string; /** * 源站信息：
  • 当 OriginType 为 custom 时，表示一个或多个源站，如`["8.8.8.8","9.9.9.9"]` 或 `OriginValue=["test.com"]`；
  • 当 OriginType 为 loadbalancer 时，表示一个负载均衡，如`["lb-3pbiw4d9iqz0"]`；
  • 当 OriginType 为 origins 时，要求有且仅有一个元素，表示源站组ID，如`["origin-537f5b41-162a-11ed-abaa-525400c5da15"]`。
    • */ OriginValue: Array; /** * 规则ID。 */ RuleId?: string; /** * 状态，取值有：
  • online：启用；
  • offline：停用；
  • progress：部署中；
  • stopping：停用中；
  • fail：部署失败/停用失败。
    • */ Status?: string; /** * 传递客户端IP，取值有：
  • TOA：TOA（仅Proto=TCP时可选）；
  • PPV1：Proxy Protocol传递，协议版本V1（仅Proto=TCP时可选）；
  • PPV2：Proxy Protocol传递，协议版本V2；
  • OFF：不传递。
    • 默认值：OFF。 */ ForwardClientIp?: string; /** * 是否开启会话保持，取值有：
  • true：开启；
  • false：关闭。
    • 默认值：false。 */ SessionPersist?: boolean; /** * 会话保持的时间，单位为秒，只有当SessionPersist为true时，该值才会生效。 */ SessionPersistTime?: number; /** * 源站端口，支持格式：
  • 单端口，如：80。
  • 端口段：81-82，表示81，82两个端口。
    • */ OriginPort?: string; /** * 规则标签。 */ RuleTag?: string; } /** * 用于分别开启/关闭回源双向认证和源站证书校验。回源双向认证的证书用于 EO 回源时携带，源站可选择校验该证书用于确保请求来源于受信任的 EO 节点。源站证书校验开启时，证书配置用于 EO 节点校验源站证书是否可信。 */ export interface UpstreamCertInfo { /** * 在回源双向认证场景下，该字段为 EO 节点回源时携带的证书（包含公钥、私钥即可），部署在 EO 节点，用于源站对 EO 节点进行认证。在作为入参使用时，不填写表示保持原有配置。 */ UpstreamMutualTLS?: MutualTLS; /** * 在源站证书校验场景下，该字段为 EO 节点回源时用于验证的 CA 证书，部署在 EO 节点，用于 EO 节点对服务端证书进行认证。在作为入参使用时，不填写表示保持原有配置。 */ UpstreamCertificateVerify?: OriginCertificateVerify; } /** * 站点详情。 */ export interface Zone { /** * 站点 ID。 */ ZoneId?: string; /** * 站点名称。 */ ZoneName?: string; /** * 同名站点标识。允许输入数字、英文、"." 、"-" 和 "_" 组合，长度 200 个字符以内。 */ AliasZoneName?: string; /** * 站点加速区域，取值有：
  • global：全球可用区；
  • mainland：中国大陆可用区；
  • overseas：全球可用区（不含中国大陆）。
    • */ Area?: string; /** * 站点接入类型，取值有：
  • full：NS 接入类型；
  • partial：CNAME 接入类型；
  • noDomainAccess：无域名接入类型；
  • dnsPodAccess：DNSPod 托管类型，该类型要求您的域名已托管在腾讯云 DNSPod；
  • pages：Pages 类型；
  • ai：边缘推理接入类型。
    • */ Type?: string; /** * 站点关联的标签。 */ Tags?: Array; /** * 计费资源列表。 */ Resources?: Array; /** * NS 类型站点详情。仅当 Type = full 时返回值。 */ NSDetail?: NSDetail; /** * CNAME 类型站点详情。仅当 Type = partial 时返回值。 */ CNAMEDetail?: CNAMEDetail; /** * DNSPod 托管类型站点详情。仅当 Type = dnsPodAccess 时返回值。 */ DNSPodDetail?: DNSPodDetail; /** * 站点创建时间。 */ CreatedOn?: string; /** * 站点修改时间。 */ ModifiedOn?: string; /** * 站点状态，取值有：
  • active：NS 已切换；
  • pending：NS 未切换；
  • moved：NS 已切走；
  • deactivated：被封禁。
  • initializing：待绑定套餐。
    • */ Status?: string; /** * CNAME 接入状态，取值有：
  • finished：站点已验证；
  • pending：站点验证中。
    • */ CnameStatus?: string; /** * 展示状态，取值有：
  • active：已启用；
  • inactive：未生效；
  • paused：已停用。
    • */ ActiveStatus?: string; /** * 锁定状态，取值有：
  • enable：正常，允许进行修改操作；
  • disable：锁定中，不允许进行修改操作；
  • plan_migrate：套餐迁移中，不允许进行修改操作。
    • */ LockStatus?: string; /** * 站点是否关闭。 */ Paused?: boolean; /** * 是否伪站点（该字段为历史保留字段，已不再维护，请根据站点类型参考对应字段），取值有：
  • 0：非伪站点；
  • 1：伪站点。
    • */ IsFake?: number; /** * 是否开启 CNAME 加速（该字段为历史保留字段，已不再维护，请根据站点类型参考对应字段），取值有：
  • enabled：开启；
  • disabled：关闭。
    • */ CnameSpeedUp?: string; /** * 归属权验证信息。（该字段为历史保留字段，已不再维护，请根据站点类型参考对应字段） 注意：此字段可能返回 null，表示取不到有效值。 */ OwnershipVerification?: OwnershipVerification; /** * 站点当前使用的 NS 列表。（该字段为历史保留字段，已不再维护，请根据站点类型参考对应字段） */ OriginalNameServers?: Array; /** * 腾讯云分配的 NS 列表。（该字段为历史保留字段，已不再维护，请根据站点类型参考对应字段） */ NameServers?: Array; /** * 用户自定义 NS 信息。（该字段为历史保留字段，已不再维护，请根据站点类型参考对应字段） 注意：此字段可能返回 null，表示取不到有效值。 */ VanityNameServers?: VanityNameServers; /** * 用户自定义 NS IP 信息。（该字段为历史保留字段，已不再维护，请根据站点类型参考对应字段） 注意：此字段可能返回 null，表示取不到有效值。 */ VanityNameServersIps?: Array; /** * 版本管理配置组工作模式。站点各配置模块可按照配置组维度开启「版本管理模式」或「即时生效模式」，详情请参考 [版本管理](https://cloud.tencent.com/document/product/1552/113690)。 */ WorkModeInfos?: Array; } /** * 规则引擎条件常规动作参数 */ export interface RuleNormalActionParams { /** * 参数名称，参数填写规范可调用接口 [查询规则引擎的设置参数](https://cloud.tencent.com/document/product/1552/80618) 查看。 */ Name: string; /** * 参数值。 */ Values: Array; } /** * 自定义错误页面配置参数。 */ export interface ErrorPageParameters { /** * 自定义错误页面配置列表。 注意：此字段可能返回 null，表示取不到有效值。 */ ErrorPageParams?: Array; } /** * DescribeRulesSetting返回参数结构体 */ export interface DescribeRulesSettingResponse { /** * 规则引擎可应用匹配请求的设置列表及其详细建议配置信息。 */ Actions?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * BindSecurityTemplateToEntity返回参数结构体 */ export interface BindSecurityTemplateToEntityResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Bot 管理的基础配置，对策略关联的所有域名生效。可以通过 CustomRules 进行精细化定制。 */ export interface BasicBotSettings { /** * 客户端 IP 的来源 IDC 配置，用于处置来自 IDC（数据中心） 的客户端 IP 的访问请求。此类来源请求不是由移动端或浏览器端直接访问。 */ SourceIDC?: SourceIDC; /** * 搜索引擎爬虫配置，用于处置来自搜索引擎爬虫的请求。此类请求的 IP、User-Agent 或 rDNS 结果匹配已知搜索引擎爬虫。 */ SearchEngineBots?: SearchEngineBots; /** * 商业或开源工具 UA 特征配置（原 UA 特征规则），用于处置来自已知商业工具或开源工具的访问请求。此类请求的 User-Agent 头部符合已知商业或开源工具特征。 */ KnownBotCategories?: KnownBotCategories; /** * IP 威胁情报库（原客户端画像分析）配置，用于处置近期访问行为具有特定风险特征的客户端 IP。 */ IPReputation?: IPReputation; /** * Bot 智能分析的具体配置。 */ BotIntelligence?: BotIntelligence; } /** * ModifyL4ProxyRules返回参数结构体 */ export interface ModifyL4ProxyRulesResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DDoS攻击事件对象 */ export interface DDoSAttackEvent { /** *

    事件 ID。

    */ EventId?: string; /** *

    攻击类型。

    */ AttackType?: string; /** *

    攻击状态。

    枚举值：

    • 0： 观察中
    • 1： 攻击中
    • 2： 攻击结束
    */ AttackStatus?: number; /** *

    攻击最大带宽，单位为 bps。

    */ AttackMaxBandWidth?: number; /** *

    攻击包速率峰值，单位为 pps。

    */ AttackPacketMaxRate?: number; /** *

    攻击开始时间戳。

    单位：秒

    */ AttackStartTime?: number; /** *

    攻击结束时间戳。

    单位：秒

    */ AttackEndTime?: number; /** *

    DDoS 策略组 ID。

    注意：此字段可能返回 null，表示取不到有效值。 */ PolicyId?: number; /** *

    站点 ID。

    注意：此字段可能返回 null，表示取不到有效值。 */ ZoneId?: string; /** *

    攻击事件所属地区。

    枚举值：

    • overseas： 全球（除中国大陆地区）数据；
    • mainland： 中国大陆地区数据。
    注意：此字段可能返回 null，表示取不到有效值。 */ Area?: string; /** *

    封禁解封信息。

    注意：此字段可能返回 null，表示取不到有效值。 */ DDoSBlockData?: Array; /** *

    被 DDoS 攻击的目的 IP 列表。

    */ DDoSAttackDips?: Array; } /** * 存储客户端请求IP的头部信息配置 */ export interface ClientIpHeader { /** * 配置开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch: string; /** * 回源时，存放客户端 IP 的请求头名称。当 Switch 为 on 时，该参数必填。该参数不允许填写 X-Forwarded-For。 */ HeaderName?: string; } /** * DummyParseZoneFullConfig请求参数结构体 */ export type DummyParseZoneFullConfigRequest = null; /** * DescribeConfigGroupVersionDetail请求参数结构体 */ export interface DescribeConfigGroupVersionDetailRequest { /** * 站点 ID。 */ ZoneId: string; /** * 版本 ID。 */ VersionId: string; } /** * ModifyPlan返回参数结构体 */ export interface ModifyPlanResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAvailableOriginACLFamily返回参数结构体 */ export interface DescribeAvailableOriginACLFamilyResponse { /** *

    源站防护 IP 段详细信息总数。

    */ TotalCount?: number; /** *

    回源 IP 网段详细信息列表。

    */ OriginACLFamilyInfos?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 接入域名 CNAME 配置状态 */ export interface CnameStatus { /** * 接入域名。 */ RecordName?: string; /** * EdgeOne 分配给接入域名的 CNAME。 */ Cname?: string; /** * CNAME 配置状态校验结果，取值有：
  • active：表示接入域名已正确配置到 EdgeOne 为其分配的指定 CNAME；
  • moved：表示接入域名未配置到 EdgeOne 为其分配的指定 CNAME；
  • invalid：表示接入域名配置的 CNAME 为 EdgeOne 为其他域名分配的 CNAME，会导致服务异常，请修改为 EdgeOne 为该接入域名提供的指定 CNAME，您可通过本结构体的 Cname 字段获取 EdgeOne 为该接入域名提供的 CNAME。
    • */ Status?: string; } /** * DescribeLogAnalysisDownloadTasks返回参数结构体 */ export interface DescribeLogAnalysisDownloadTasksResponse { /** *

    符合日志匹配条件的日志分析下载任务总条数。

    */ TotalCount?: number; /** *

    符合日志匹配条件的日志分析下载任务列表。

    */ Tasks?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Waf配置。 */ export interface WafConfig { /** * WafConfig开关，取值有：
  • on：开启；
  • off：关闭。
    • 开关仅与配置是否生效有关，即使为off（关闭），也可以正常修改配置的内容。 */ Switch: string; /** * 上一次设置的防护级别，取值有：
  • loose：宽松；
  • normal：正常；
  • strict：严格；
  • stricter：超严格；
  • custom：自定义。
    • */ Level: string; /** * 全局WAF模式，取值有：
  • block：阻断（全局阻断，但可对详细规则配置观察）；
  • observe：观察（无论详细规则配置什么，都为观察）。
    • */ Mode: string; /** * 托管规则详细配置。如果为null，默认使用历史配置。 */ WafRule?: WafRule; /** * AI规则引擎防护配置。如果为null，默认使用历史配置。 */ AiRule?: AiRule; } /** * 流量防盗刷（仅适用中国大陆地区）的具体配置。 */ export interface BandwidthAbuseDefense { /** * 流量防盗刷（仅适用中国大陆地区）是否开启。取值有：
  • on：开启；
  • off：关闭。
    • */ Enabled: string; /** * 流量防盗刷的规则 ID，仅作为出参返回。 */ Id?: string; /** * 流量防盗刷（仅适用中国大陆地区）的处置方式，当 Enabled 为 on 时，此字段必填。SecurityAction 的 Name 取值支持：
  • Monitor：观察；
  • Deny：拦截；
  • Challenge：挑战，其中ChallengeActionParameters.Name仅支持JSChallenge。
    • */ Action?: SecurityAction; } /** * https 服务端证书配置 */ export interface ServerCertInfo { /** * 服务器证书 ID。来源于 SSL 侧，您可以前往 [SSL 证书列表](https://console.cloud.tencent.com/ssl) 查看 CertId。 */ CertId: string; /** * 证书备注名。 */ Alias?: string; /** * 证书类型，取值有：
  • default：默认证书；
  • upload：用户上传；
  • managed：腾讯云托管。
    • */ Type?: string; /** * 证书过期时间。 */ ExpireTime?: string; /** * 证书部署时间。 */ DeployTime?: string; /** * 签名算法。 */ SignAlgo?: string; /** * 证书归属域名名称。 */ CommonName?: string; } /** * DescribeZones请求参数结构体 */ export interface DescribeZonesRequest { /** * 分页查询偏移量。默认值：0。 */ Offset?: number; /** * 分页查询限制数目。默认值：20，最大值：100。 */ Limit?: number; /** * 过滤条件，Filters.Values 的上限为 20。该参数不填写时，返回当前 appid 下有权限的所有站点信息。详细的过滤条件如下：
  • zone-name：按照站点名称进行过滤；
  • zone-type：按照站点类型进行过滤。可选项：
       full：NS 接入类型；
       partial：CNAME 接入类型；
       partialComposite：无域名接入类型；
       dnsPodAccess：DNSPod 托管接入类型；
       pages：Pages 接入类型；
       ai：边缘推理接入类型。
  • zone-id：按照站点 ID 进行过滤，站点 ID 形如：zone-2noz78a8ev6k；
  • status：按照站点状态进行过滤。可选项：
       active：NS 已切换；
       pending：NS 待切换；
       deleted：已删除。
  • tag-key：按照标签键进行过滤；
  • tag-value： 按照标签值进行过滤；
  • alias-zone-name： 按照同名站点标识进行过滤。
    • 模糊查询时支持过滤字段名为 zone-name 或 alias-zone-name。 */ Filters?: Array; /** * 可根据该字段对返回结果进行排序，取值有：
  • type：接入类型；
  • area：加速区域；
  • create-time：创建时间；
  • zone-name：站点名称；
  • use-time：最近使用时间；
  • active-status：生效状态。
    • 不填写时对返回结果默认按照 create-time 排序。 */ Order?: string; /** * 排序方向，如果是字段值为数字，则根据数字大小排序；如果字段值为文本，则根据 ascill 码的大小排序。取值有：
  • asc：从小到大排序；
  • desc：从大到小排序。
    • 不填写使用默认值 desc。 */ Direction?: string; } /** * DescribeZoneConfigImportResult返回参数结构体 */ export interface DescribeZoneConfigImportResultResponse { /** * 本次导入任务的导入状态。取值有：
  • success：表示配置项导入成功；
  • failure：表示配置项导入失败；
  • doing：表示配置项正在导入中。
    • */ Status?: string; /** * 本次导入任务的状态的提示信息。当配置项导入失败时，可通过本字段查看失败原因。 */ Message?: string; /** * 本次导入任务的配置内容。 */ Content?: string; /** * 本次导入任务的开始时间。 */ ImportTime?: string; /** * 本次导入任务的结束时间。 */ FinishTime?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyInferenceService请求参数结构体 */ export interface ModifyInferenceServiceRequest { /** *

    站点 ID。

    */ ZoneId: string; /** *

    推理服务 ID。

    */ ServiceId: string; /** *

    模型服务需要监听的端口。仅支持 1-65535 之间的整数。

    */ ListenPort?: number; /** *

    推理服务的请求路径列表。最多支持 20 个路径。

    */ RequestPaths?: Array; /** *

    推理服务的容器配置。当前仅支持设置 1 个容器。

    */ Containers?: Array; /** *

    推理服务的资源配置。

    */ ResourceConfig?: InferenceResourceConfigForModify; /** *

    推理服务亲和性配置

    */ AffinityConfig?: InferenceAffinityConfig; /** *

    描述信息。长度限制不超过 60 个字符。

    */ Description?: string; } /** * ModifyFunctionComponentBindings返回参数结构体 */ export interface ModifyFunctionComponentBindingsResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * BindSharedCNAME返回参数结构体 */ export interface BindSharedCNAMEResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteSharedCNAME请求参数结构体 */ export interface DeleteSharedCNAMERequest { /** * 共享 CNAME 所属站点 ID。 */ ZoneId: string; /** * 需要删除的共享 CNAME。 */ SharedCNAME: string; } /** * Web安全的自定义规则结构 */ export interface CustomRules { /** * 自定义规则的定义列表。
    使用 ModifySecurityPolicy 修改 Web 防护配置时:
    - 若未指定 Rules 参数，或 Rules 参数长度为零：清空所有自定义规则配置。
    - 若 SecurityPolicy 参数中，未指定 CustomRules 参数值：保持已有自定义规则配置，不做修改。 */ Rules?: Array; } /** * ModifyRealtimeLogDeliveryTask请求参数结构体 */ export interface ModifyRealtimeLogDeliveryTaskRequest { /** *

    站点 ID。

    */ ZoneId: string; /** *

    实时日志投递任务 ID。

    */ TaskId: string; /** *

    实时日志投递任务的名称，格式为数字、英文、-和_组合，最多 200 个字符。不填保持原有配置。

    */ TaskName?: string; /** *

    实时日志投递任务的状态，取值有：

  • enabled: 启用；
  • disabled: 停用。
    • 不填保持原有配置。 */ DeliveryStatus?: string; /** *

    实时日志投递任务对应的实体（七层域名或者四层代理实例）列表。取值示例如下：

  • 七层域名：domain.example.com；
  • 四层代理实例：sid-2s69eb5wcms7。
    • 不填保持原有配置。

    取值参考：DescribeApplicationProxies

    */ EntityList?: Array; /** *

    投递的预设字段列表。不填保持原有配置。

    取值参考：DescribeLogFields

    */ Fields?: Array; /** *

    投递的自定义日志字段列表，可以通过自定义日志推送字段名称和取值表达式，实现个性化的实时日志内容推送，详见 自定义日志字段表达式。
    仅七层访问日志（LogType= l7-access-logs 或 domain）支持添加自定义字段，允许配置的自定义字段个数有配额限制，如遇配额不足请 联系我们 。

    */ CustomFields?: Array; /** *

    投递的自定义表达式字段列表，可以通过自定义日志推送字段名称和取值表达式，实现个性化的实时日志内容推送，使用详情见 [自定义日志字段表达式]()。
    仅七层访问日志（LogType= l7-access-logs 或 domain）支持添加自定义字段。允许配置的自定义字段个数有配额限制，如遇配额不足请 [联系我们](https://cloud.tencent.com/online-service?from=sales&source=PRESALE) 。
    **注意**：若 CustomExpressionFields 中存在命名 与 Fields 和 CustomFields 中同名的字段，以 CustomExpressionFields 中的取值为准。

    */ CustomExpressionFields?: Array; /** *

    日志投递的过滤条件。不填表示投递全量日志。

    */ DeliveryConditions?: Array; /** *

    采样比例，采用千分制，取值范围为1-1000，例如：填写 605 表示采样比例为 60.5%。不填保持原有配置。

    */ Sample?: number; /** *

    日志投递的输出格式，使用详情见 自定义日志输出格式。不填表示为默认格式，默认格式逻辑如下：

    • 当 TaskType 取值为 custom_endpoint 时，默认格式为多个 JSON 对象组成的数组，每个 JSON 对象为一条日志；
    • 当 TaskType 取值为 s3 时，默认格式为 JSON Lines；
    特别地，当 TaskType 取值为 cls 或 log_analysis 时，LogFormat.FormatType 的值只能为 json，且 LogFormat 中其他参数将被忽略，建议不传 LogFormat。

    */ LogFormat?: LogFormat; /** *

    自定义 HTTP 服务的配置信息，不填保持原有配置。

    */ CustomEndpoint?: CustomEndpoint; /** *

    AWS S3 兼容存储桶的配置信息，不填保持原有配置。

    */ S3?: S3; } /** * 视频流配置参数。 */ export interface VideoTemplateInfo { /** * 视频流的编码格式，可选值：
  • H.264: 使用 H.264 编码；
  • H.265: 使用 H.265 编码。
    • */ Codec: string; /** * 视频帧率，取值范围：[0, 30]，单位：Hz。 取值为 0，表示帧率和原始视频保持一致，但最大不超过 30。 默认值：0。 */ Fps?: number; /** * 视频流的码率，取值范围：0 和 [128, 10000]，单位：kbps。 取值为 0，表示自动根据视频画面和质量选择视频码率。 默认值：0。 */ Bitrate?: number; /** * 分辨率自适应，可选值：
  • open：开启，此时，Width 代表视频的长边，Height 表示视频的短边；
  • close：关闭，此时，Width 代表视频的宽度，Height 表示视频的高度。
    • 默认值：open。 */ ResolutionAdaptive?: string; /** * 视频流宽度（或长边）的最大值，取值范围：0 和 [128, 1920]，单位：px。
  • 当 Width、Height 均为 0，则分辨率同源；
  • 当 Width 为 0，Height 非 0，则 Width 按比例缩放；
  • 当 Width 非 0，Height 为 0，则 Height 按比例缩放；
  • 当 Width、Height 均非 0，则分辨率按用户指定。
    • 默认值：0。 */ Width?: number; /** * 视频流高度（或短边）的最大值，取值范围：0 和 [128, 1080]，单位：px。
  • 当 Width、Height 均为 0，则分辨率同源；
  • 当 Width 为 0，Height 非 0，则 Width 按比例缩放；
  • 当 Width 非 0，Height 为 0，则 Height 按比例缩放；
  • 当 Width、Height 均非 0，则分辨率按用户指定。
    • 默认值：0。 */ Height?: number; /** * 填充方式，当视频流配置宽高参数与原始视频的宽高比不一致时，对转码的处理方式，即为“填充”。可选填充方式：
  • stretch：拉伸，对每一帧进行拉伸，填满整个画面，可能导致转码后的视频被“压扁”或者“拉长”。
  • black：留黑，保持视频宽高比不变，边缘剩余部分使用黑色填充。
  • white：留白，保持视频宽高比不变，边缘剩余部分使用白色填充。
  • gauss：高斯模糊，保持视频宽高比不变，边缘剩余部分使用高斯模糊填充。
    • 默认值：black 。 */ FillType?: string; } /** * Top类数据记录 */ export interface TopDataRecord { /** * 查询维度值。 */ TypeKey: string; /** * top数据排行。 */ DetailData: Array; } /** * HandleFunctionRuntimeEnvironment返回参数结构体 */ export interface HandleFunctionRuntimeEnvironmentResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DestroyPlan请求参数结构体 */ export interface DestroyPlanRequest { /** * 套餐 ID，形如 edgeone-2wdo315m2y4c。 */ PlanId: string; } /** * Web安全IP封禁的附加参数 */ export interface BlockIPActionParameters { /** * 封禁 IP 的惩罚时长。支持的单位有：
  • s：秒，取值范围1～120；
  • m：分，取值范围1～120；
  • h：小时，取值范围1～48。
    • */ Duration: string; } /** * CreatePlan请求参数结构体 */ export interface CreatePlanRequest { /** * 订阅的套餐类型，取值有：
  • personal：个人版套餐，预付费套餐；
  • basic：基础版套餐，预付费套餐；
  • standard：标准版套餐，预付费套餐；
  • enterprise：企业版套餐，后付费套餐。
    • 订阅预付费套餐时，请确保账号内有足够余额，余额不足会产生一个待支付的订单。 计费概述参考 [Edgeone计费概述](https://cloud.tencent.com/document/product/1552/94156) 不同套餐区别参考 [Edgeone计费套餐选型对比](https://cloud.tencent.com/document/product/1552/94165) */ PlanType: string; /** * 是否自动使用代金券，取值有：
  • true：是；
  • false：否。
    • 该参数仅在 PlanType 为 personal, basic, standard 时有效。 不填写使用默认值 false。 */ AutoUseVoucher?: string; /** * 订阅预付费套餐参数，PlanType 为 personal, basic, standard 时，可以选填该参数，用于传入套餐的订阅时长和是否开启自动续费。 不填该参数时，默认开通套餐时长为 1 个月，不开启自动续费。 */ PrepaidPlanParam?: PrepaidPlanParam; } /** * 检测长度限制 */ export interface DetectLengthLimitConfig { /** * 检测长度限制的规则列表。 */ DetectLengthLimitRules: Array; } /** * DescribeFunctionRuntimeEnvironment请求参数结构体 */ export interface DescribeFunctionRuntimeEnvironmentRequest { /** * 站点 ID。 */ ZoneId: string; /** * 函数 ID。 */ FunctionId: string; } /** * IP 网段组 */ export interface IPGroup { /** *

    IP 组 Id，创建时填 0 即可。

    */ GroupId: number; /** *

    IP 组名称。

    */ Name: string; /** *

    IP 组内容，仅支持 IP 及 IP 网段。

    */ Content: Array; /** *

    IP 组中正在生效的 IP 或网段个数。作为出参时有效，作为入参时无需填写该字段。

    */ IPTotalCount?: number; /** *

    IP 定时过期信息。
    作为入参，用于为指定的 IP 地址或网段配置定时过期时间。
    作为出参，包含以下两类信息：

  • 当前未到期的定时过期信息：尚未触发的过期配置。
  • 一周内已到期的定时过期信息：已触发的过期配置。
    • */ IPExpireInfo?: Array; /** *

    IP 组被引用的数量。

    */ RefCount?: number; } /** * 定制配置的单个字段参数内容。 */ export interface CustomActionParameter { /** *

    定制配置项下各参数字段名称。

    您可以通过 DescribeAvailableCustomActionsForRuleEngine 接口返回值 CustomActionSet[].Parameters[].Name 获取，如 "Seconds"、"Ports"、"StatusCode"。

    */ Name: string; /** *

    定制配置项下各参数字段值的类型。

    枚举值：

    • String： 字符串类型。
    • Integer： 整型类型。
    • Float： 浮点数类型。
    • Boolean： 布尔类型。
    • ArrayOfString： 字符串数组类型。
    • ArrayOfInteger： 整型数组类型。
    • ArrayOfFloat： 浮点数数组类型。

    您可以通过 DescribeAvailableCustomActionsForRuleEngine 接口返回值 CustomActionSet[].Parameters[].Type 获取。

    */ ValueType: string; /** *

    字符串类型参数值。当 ValueType 为 String 时，该参数必填。

    您可以通过 DescribeAvailableCustomActionsForRuleEngine 接口返回值 CustomActionSet[].Parameters 获取参数值的默认值、单位、限制等说明。

    */ StringValue?: string; /** *

    整型类型参数值。当 ValueType 为 Integer 时，该参数必填。

    您可以通过 DescribeAvailableCustomActionsForRuleEngine 接口返回值 CustomActionSet[].Parameters 获取参数值的默认值、单位、限制等说明。

    */ IntegerValue?: number; /** *

    浮点数类型参数值。当 ValueType 为 Float 时，该参数必填。

    您可以通过 DescribeAvailableCustomActionsForRuleEngine 接口返回值 CustomActionSet[].Parameters 获取参数值的默认值、单位、限制等说明。

    */ FloatValue?: number; /** *

    布尔类型参数值。当 ValueType 为 Boolean 时，该参数必填。

    您可以通过 DescribeAvailableCustomActionsForRuleEngine 接口返回值 CustomActionSet[].Parameters 获取参数值的默认值、单位、限制等说明。

    */ BooleanValue?: boolean; /** *

    字符串数组类型参数值。当 ValueType 为 ArrayOfString 时，该参数必填。

    您可以通过 DescribeAvailableCustomActionsForRuleEngine 接口返回值 CustomActionSet[].Parameters 获取参数值的默认值、单位、限制等说明。

    */ StringArrayValue?: Array; /** *

    整型数组类型参数值。当 ValueType 为 ArrayOfInteger 时，该参数必填。

    您可以通过 DescribeAvailableCustomActionsForRuleEngine 接口返回值 CustomActionSet[].Parameters 获取参数值的默认值、单位、限制等说明。

    */ IntegerArrayValue?: Array; /** *

    浮点数数组类型参数值。当 ValueType 为 ArrayOfFloat 时，该参数必填。

    您可以通过 DescribeAvailableCustomActionsForRuleEngine 接口返回值 CustomActionSet[].Parameters 获取参数值的默认值、单位、限制等说明。

    */ FloatArrayValue?: Array; } /** * DescribeDnsRecords请求参数结构体 */ export interface DescribeDnsRecordsRequest { /** * 站点 ID。 */ ZoneId: string; /** * 分页查询偏移量，默认为 0。 */ Offset?: number; /** * 分页查询限制数目，默认值：20，上限：1000。 */ Limit?: number; /** * 过滤条件，Filters.Values 的上限为20。详细的过滤条件如下：
  • id： 按照 DNS 记录 ID 进行过滤，支持模糊查询；
  • name：按照 DNS 记录名称进行过滤，支持模糊查询；
  • content：按照 DNS 记录内容进行过滤，支持模糊查询；
  • type：按照 DNS 记录类型进行过滤，不支持模糊查询。可选项：
       A：将域名指向一个外网 IPv4 地址，如 8.8.8.8；
       AAAA：将域名指向一个外网 IPv6 地址；
       CNAME：将域名指向另一个域名，再由该域名解析出最终 IP 地址；
       TXT：对域名进行标识和说明，常用于域名验证和 SPF 记录（反垃圾邮件）；
       NS：如果需要将子域名交给其他 DNS 服务商解析，则需要添加 NS 记录。根域名无法添加 NS 记录；
       CAA：指定可为本站点颁发证书的 CA；
       SRV：标识某台服务器使用了某个服务，常见于微软系统的目录管理；
       MX：指定收件人邮件服务器。
  • ttl：按照解析生效时间进行过滤，不支持模糊查询。
    • */ Filters?: Array; /** * 排序依据，取值有：
  • content：DNS 记录内容；
  • created-on：DNS 记录创建时间；
  • name：DNS 记录名称；
  • ttl：缓存时间；
  • type：DNS 记录类型。
    • 默认根据 type, name 属性组合排序。 */ SortBy?: string; /** * 列表排序方式，取值有：
  • asc：升序排列；
  • desc：降序排列。
    • 默认值为 asc。 */ SortOrder?: string; /** * 匹配方式，取值有：
  • all：返回匹配所有查询条件的记录；
  • any：返回匹配任意一个查询条件的记录。
    • 默认值为 all。 */ Match?: string; } /** * CreatePrefetchTask返回参数结构体 */ export interface CreatePrefetchTaskResponse { /** * 任务 ID。 */ JobId?: string; /** * 失败的任务列表。 注意：此字段可能返回 null，表示取不到有效值。 */ FailedList?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateSecurityJSInjectionRule请求参数结构体 */ export interface CreateSecurityJSInjectionRuleRequest { /** * 站点 ID。 */ ZoneId: string; /** * JavaScript 注入规则列表。 */ JSInjectionRules?: Array; } /** * DescribeMultiPathGateways返回参数结构体 */ export interface DescribeMultiPathGatewaysResponse { /** * 网关详情。 */ Gateways?: Array; /** * 总条数。 */ TotalCount?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 浏览器缓存 TTL 配置参数。 */ export interface MaxAgeParameters { /** * 遵循源站 Cache-Control 开关，取值有：
  • on：遵循源站，忽略 CacheTime 时间设置；
  • off：不遵循源站，使用 CacheTime 时间设置。
    • */ FollowOrigin?: string; /** * 自定义缓存时间数值，单位为秒，取值：0～315360000。
    注意：当 FollowOrigin 为 off 时，表示不遵循源站，使用 CacheTime 设置缓存时间，否则此字段不生效。 */ CacheTime?: number; } /** * ModifyApplicationProxyRule返回参数结构体 */ export interface ModifyApplicationProxyRuleResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteFunctionReplica请求参数结构体 */ export interface DeleteFunctionReplicaRequest { /** * 站点 ID。 */ ZoneId: string; /** * 函数 ID。 */ FunctionId: string; /** * 需要删除的函数的副本名称。支持以列表的形式传入。 */ ReplicaNames: Array; } /** * 日志分析日志下载任务。 */ export interface LogAnalysisDownloadTask { /** *

    任务 ID。

    */ TaskId?: string; /** *

    站点 ID。

    */ ZoneId?: string; /** *

    数据归属地区，取值有：

    • mainland：中国大陆境内；
    • overseas：全球（不含中国大陆）。

    */ Area?: string; /** *

    开始时间，示例值：2020-04-29T00:00:00Z。

    */ StartTime?: string; /** *

    结束时间，示例值：2020-04-30T00:00:00Z。

    */ EndTime?: string; /** *

    日志类型，取值有：

    • l7-access-logs：七层访问日志；
    • web-attack：托管规则日志。

    */ LogType?: string; /** *

    日志匹配条件，长度上限 12KB。

    */ Condition?: string; /** *

    文件格式，取值有：

    • csv 。
    */ Format?: string; /** *

    原始日志是否按时间排序返回，取值有：

    • asc：升序；
    • desc：降序。

    */ Sort?: string; /** *

    任务状态，取值有：

    • loading：处理中，等待生成下载链接；
    • failed: 处理失败，当前任务无法下载;
    • completed：已完成打包，可以下载。

    */ Status?: string; /** *

    任务创建时间，任务创建成功后将保留3天。

    */ CreateTime?: string; /** *

    下载地址，仅当 Status = completed 时有返回值。

    */ Url?: string; /** *

    下载任务过期时间，过期后下载地址将不可用，请通过本接口获取新的下载地址。

    */ ExpireTime?: string; } /** * DDoS配置 */ export interface DDoS { /** * 开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch: string; } /** * ModifyL7AccRulePriority返回参数结构体 */ export interface ModifyL7AccRulePriorityResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeZoneCustomVariables返回参数结构体 */ export interface DescribeZoneCustomVariablesResponse { /** *

    站点级自定义变量列表。

    */ CustomVariables?: Array; /** *

    站点级自定义变量运算规则。

    */ CustomVariableOperations?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * API 服务配置。 */ export interface APIService { /** * API 服务 ID。 */ Id?: string; /** * API 服务名称。 */ Name?: string; /** * 基础路径。 */ BasePath?: string; } /** * CreateConfigGroupVersion返回参数结构体 */ export interface CreateConfigGroupVersionResponse { /** *

    版本 ID。

    */ VersionId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ConfirmOriginACLUpdate请求参数结构体 */ export interface ConfirmOriginACLUpdateRequest { /** * 站点 ID。 */ ZoneId: string; } /** * CreateJustInTimeTranscodeTemplate返回参数结构体 */ export interface CreateJustInTimeTranscodeTemplateResponse { /** * 即时转码模板唯一标识，用于即时转码 URL 拼接。 */ TemplateId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DownloadL7Logs请求参数结构体 */ export interface DownloadL7LogsRequest { /** * 开始时间。 */ StartTime: string; /** * 结束时间。 */ EndTime: string; /** * 站点ID集合，此参数将于2024年05月30日后由可选改为必填，详见公告：[【腾讯云 EdgeOne】云 API 变更通知](https://cloud.tencent.com/document/product/1552/104902)。 */ ZoneIds: Array; /** * 子域名集合，不填默认选择全部子域名。 */ Domains?: Array; /** * 分页查询的限制数目，默认值为 20，最大查询条目为 300。 */ Limit?: number; /** * 分页的偏移量，默认值为 0。 */ Offset?: number; } /** * DNSPod 托管类型站点参数详情。 */ export interface DNSPodDetail { /** * 是否伪站点，取值有：
  • 0：非伪站点；
  • 1：伪站点。
    • */ IsFake?: number; } /** * 规则引擎条件使用StatusCode字段动作参数 */ export interface RuleCodeActionParams { /** * 状态 Code。 */ StatusCode: number; /** * 参数名称，参数填写规范可调用接口 [查询规则引擎的设置参数](https://cloud.tencent.com/document/product/1552/80618) 查看。 */ Name: string; /** * 参数值。 */ Values: Array; } /** * DescribeSecurityClientAttester请求参数结构体 */ export interface DescribeSecurityClientAttesterRequest { /** * 站点 ID。 */ ZoneId: string; /** * 分页查询限制数目。默认值：20，最大值：100。 */ Limit?: number; /** * 分页查询偏移量。默认值：0。 */ Offset?: number; } /** * DescribeLogAnalysisDetail请求参数结构体 */ export interface DescribeLogAnalysisDetailRequest { /** *

    站点 ID。

    */ ZoneId: string; /** *

    数据归属地区，可选值：

    • mainland：中国大陆境内；
    • overseas：全球（不含中国大陆）。
    注意：若站点服务区域为“全球可用区”，获取全部数据需要分别查询 mainland 和 overseas 的数据。

    */ Area: string; /** *

    开始时间，示例值：2020-04-29T00:00:00Z。套餐版本不同，支持的可查询开始时间至今的最大时间跨度不同，详情请见 套餐选型对比。

    */ StartTime: string; /** *

    结束时间，示例值：2020-04-30T00:00:00Z。单次查询的开始时间到结束时间跨度最大为 31 天。

    */ EndTime: string; /** *

    日志类型，可选值：

    • l7-access-logs：七层访问日志；
    • web-attack：托管规则日志。
    默认为 l7-access-logs 。

    */ LogType?: string; /** *

    日志匹配条件，最大长度 12KB。

    */ Condition?: string; /** *

    分页查询限制数目，默认值：20，最大值 100。

    */ Limit?: number; /** *

    分页查询偏移量，默认为 0。

    */ Offset?: number; /** *

    原始日志是否按时间排序返回；可选值：

    • asc：升序；
    • desc：降序。
    默认为 desc。

    */ Sort?: string; } /** * WebSocket 配置。 */ export interface WebSocketParameters { /** * WebSocket 超时时间配置开关，取值有：
  • on：使用 Timeout 作为 WebSocket 超时时间；
  • off：平台仍支持 WebSocket 连接，此时使用系统默认的 15 秒为超时时间。
    • */ Switch?: string; /** * 超时时间，单位为秒，最大超时时间 120 秒。
    注意：当 Switch 为 on 时，此字段必填，否则此字段不生效。 */ Timeout?: number; } /** * 规则引擎规则详情 */ export interface RuleItem { /** * 规则ID。 */ RuleId?: string; /** * 规则名称，名称字符串长度 1~255。 */ RuleName?: string; /** * 规则状态，取值有:
  • enable: 启用；
  • disable: 未启用。
    • */ Status?: string; /** * 规则内容。 */ Rules?: Array; /** * 规则优先级, 值越大优先级越高，最小为 1。 */ RulePriority?: number; /** * 规则标签。 */ Tags?: Array; } /** * 慢速攻击的基础配置。 */ export interface SlowRateConfig { /** * 开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch: string; /** * 统计的间隔，单位是秒，即在首段包传输结束后，将数据传输轴按照本参数切分，每个分片独立计算慢速攻击。 */ Interval?: number; /** * 统计时应用的速率阈值，单位是bps，即如果本分片中的传输速率没达到本参数的值，则判定为慢速攻击，应用慢速攻击的处置方式。 */ Threshold?: number; } /** * 缓存时间设置 */ export interface Cache { /** * 缓存配置开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch: string; /** * 缓存过期时间设置。 单位为秒，最大可设置为 365 天。 */ CacheTime?: number; /** * 是否开启强制缓存，取值有：
  • on：开启；
  • off：关闭。
    • 注意：此字段可能返回 null，表示取不到有效值。 * @deprecated */ IgnoreCacheControl?: string; } /** * 节点缓存 TTL 自定义缓存时间参数配置。 */ export interface CustomTime { /** * 自定义缓存时间开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch?: string; /** * 忽略源站 CacheControl 开关，取值有：
  • on：开启；
  • off：关闭。
    • 注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。 */ IgnoreCacheControl?: string; /** * 自定义缓存时间数值，单位为秒，取值：0～315360000。
    注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。 */ CacheTime?: number; } /** * CreateInferenceService返回参数结构体 */ export interface CreateInferenceServiceResponse { /** *

    服务 ID。

    */ ServiceId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 权重策略配置。 */ export interface FunctionWeightedSelection { /** * 函数 ID 。 */ FunctionId: string; /** * 选中权重。取值范围0-100，所有的权重之和需要为100。 选中概率计算方式为： weight/100。例如设置了两个函数 A 和 B ，其中 A 的权重为30，那么 B 的权重必须为70，最终选中 A 的概率为30%，选中 B 的概率为70%。 */ Weight: number; } /** * 域名配置信息 */ export interface DetailHost { /** * 站点ID。 */ ZoneId?: string; /** * 加速服务状态，取值为：
  • process：部署中；
  • online：已启动；
  • offline：已关闭。
    • */ Status?: string; /** * 域名。 */ Host?: string; /** * 站点名称。 */ ZoneName?: string; /** * 分配的Cname域名 */ Cname?: string; /** * 资源ID。 */ Id?: string; /** * 实例ID。 */ InstanceId?: string; /** * 锁状态。 */ Lock?: number; /** * 域名状态类型。 */ Mode?: number; /** * 域名加速地域，取值有：
  • global：全球；
  • mainland：中国大陆；
  • overseas：境外区域。
    • */ Area?: string; /** * 加速类型配置项。 注意：此字段可能返回 null，表示取不到有效值。 */ AccelerateType?: AccelerateType; /** * Https配置项。 注意：此字段可能返回 null，表示取不到有效值。 */ Https?: Https; /** * 缓存配置项。 注意：此字段可能返回 null，表示取不到有效值。 */ CacheConfig?: CacheConfig; /** * 源站配置项。 注意：此字段可能返回 null，表示取不到有效值。 */ Origin?: Origin; /** * 安全类型。 注意：此字段可能返回 null，表示取不到有效值。 */ SecurityType?: SecurityType; /** * 缓存键配置项。 注意：此字段可能返回 null，表示取不到有效值。 */ CacheKey?: CacheKey; /** * 智能压缩配置项。 注意：此字段可能返回 null，表示取不到有效值。 */ Compression?: Compression; /** * Waf防护配置项。 注意：此字段可能返回 null，表示取不到有效值。 */ Waf?: Waf; /** * CC防护配置项。 注意：此字段可能返回 null，表示取不到有效值。 */ CC?: CC; /** * DDoS防护配置。 注意：此字段可能返回 null，表示取不到有效值。 */ DDoS?: DDoS; /** * 智能路由配置项。 注意：此字段可能返回 null，表示取不到有效值。 */ SmartRouting?: SmartRouting; /** * Ipv6访问配置项。 注意：此字段可能返回 null，表示取不到有效值。 */ Ipv6?: Ipv6; /** * 回源时是否携带客户端IP所属地域信息的配置。 注意：此字段可能返回 null，表示取不到有效值。 */ ClientIpCountry?: ClientIpCountry; } /** * DescribeInferenceHardwareSpecifications返回参数结构体 */ export interface DescribeInferenceHardwareSpecificationsResponse { /** *

    硬件规格列表。

    */ HardwareSpecifications?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 推理服务单次部署配置。 */ export interface InferenceServiceConfig { /** *

    模型服务需要监听的端口。

    */ ListenPort?: number; /** *

    推理服务的请求路径列表。

    */ RequestPaths?: Array; /** *

    推理服务的容器配置。

    */ Containers?: Array; /** *

    推理服务的资源配置。

    */ ResourceConfig?: InferenceResourceConfig; /** *

    推理服务亲和性配置。

    */ AffinityConfig?: InferenceAffinityConfig; } /** * TopN的Entry数据 */ export interface TopEntry { /** * top查询维度值。 */ Key: string; /** * 查询具体数据。 */ Value: Array; } /** * DescribeConfigGroupVersions返回参数结构体 */ export interface DescribeConfigGroupVersionsResponse { /** * 版本总数。 */ TotalCount?: number; /** * 版本信息列表。 */ ConfigGroupVersionInfos?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 边缘函数环境变量 */ export interface FunctionEnvironmentVariable { /** * 变量的名称，限制只能包含大小写字母、数字，特殊字符仅支持 @ . - _ ，最大 64 个字节，不支持重复。 */ Key: string; /** * 变量的值，限制最大 5000 字节，默认值为空。 */ Value?: string; /** * 变量的类型，取值有：
  • string：字符串类型；
  • json：json 对象类型。
    • 默认值为：string。 */ Type?: string; } /** * DeleteRealtimeLogDeliveryTask返回参数结构体 */ export interface DeleteRealtimeLogDeliveryTaskResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 规则引擎条件参数 */ export interface RuleCondition { /** * 运算符，取值有：
  • equal: 等于；
  • notequal: 不等于；
  • exist: 存在；
  • notexist: 不存在。
    • */ Operator: string; /** * 匹配类型，取值有：
  • filename：文件名；
  • extension：文件后缀；
  • host：HOST；
  • full_url：URL Full，当前站点下完整 URL 路径，必须包含 HTTP 协议，Host 和 路径；
  • url：URL Path，当前站点下 URL 路径的请求；
  • client_country：客户端国家/地区；
  • query_string：查询字符串，当前站点下请求 URL 的查询字符串；
  • request_header：HTTP 请求头部。
  • client_ip：客户端 IP。
  • request_protocol：请求协议。
  • request_method：HTTP 请求方法。
    • */ Target: string; /** * 对应匹配类型的参数值，仅在匹配类型为查询字符串或HTTP请求头并且运算符取值为存在或不存在时允许传空数组，对应匹配类型有：
  • 文件后缀：jpg、txt 等文件后缀；
  • 文件名称：例如 foo.jpg 中的 foo；
  • 全部（站点任意请求）：all；
  • HOST：当前站点下的 host ，例如www.maxx55.com；
  • URL Path：当前站点下 URL 路径的请求，例如：/example；
  • URL Full：当前站点下完整 URL 请求，必须包含 HTTP 协议，Host 和 路径，例如：https://www.maxx55.cn/example；
  • 客户端国家/地区：符合 ISO3166 标准的国家/地区标识；
  • 查询字符串: 当前站点下 URL 请求中查询字符串的参数值，例如 lang=cn&version=1 中的 cn 和 1；
  • HTTP 请求头: HTTP 请求头部字段值，例如 Accept-Language:zh-CN,zh;q=0.9中的zh-CN,zh;q=0.9 ；
  • 客户端 IP: 当前请求携带的客户端请求 IP，支持 IPv4/IPv6, 支持 IP 段；
  • 请求协议: 当前请求的协议，取值范围为：HTTP、HTTPS；
  • HTTP 请求方法: 当前请求的方法，取值范围为：GET、HEAD、POST、PUT、DELETE、TRACE、CONNECT、OPTIONS、PATCH、COPY、LOCK、MKCOL、MOVE、PROPFIND、PROPPATCH、UNLOCK。
    • */ Values?: Array; /** * 是否忽略参数值的大小写，默认值为 false。 */ IgnoreCase?: boolean; /** * 对应匹配类型的参数名称，在 Target 值为以下取值时有效，有效时值不能为空：
  • query_string（查询字符串）: 当前站点下URL请求中查询字符串的参数名称，例如lang=cn&version=1中的lang和version；
  • request_header（HTTP 请求头）: HTTP请求头部字段名，例如Accept-Language:zh-CN,zh;q=0.9中的Accept-Language。
    • */ Name?: string; /** * 是否忽略参数名称的大小写，默认值为 false。 注意：此字段可能返回 null，表示取不到有效值。 * @deprecated */ IgnoreNameCase?: boolean; } /** * DescribeOverviewL7Data返回参数结构体 */ export interface DescribeOverviewL7DataResponse { /** * 查询结果的总条数。 */ TotalCount?: number; /** * 七层监控类时序流量数据列表。 注意：此字段可能返回 null，表示取不到有效值。 */ Data?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeSecurityPolicy请求参数结构体 */ export interface DescribeSecurityPolicyRequest { /** * 站点 ID。 */ ZoneId: string; /** * 安全策略类型，可使用以下参数值进行查询：
  • ZoneDefaultPolicy：用于指定查询站点级策略；
  • Template：用于指定查询策略模板，需要同时指定 TemplateId 参数；
  • Host：用于指定查询域名级策略（注意：当使用域名来指定域名服务策略时，仅支持已经应用了域名级策略的域名服务或者策略模板）。
    • */ Entity?: string; /** * 指定策略模板 ID。当 Entity 参数值为 Template 时，使用本参数指定策略模板的 ID 查询模板配置。 */ TemplateId?: string; /** * 指定域名。当 Entity 参数值为 Host 时，使用本参数指定的域名级策略查询域名配置，例如：使用 www.example.com ，配置该域名的域名级策略。 */ Host?: string; } /** * DescribeEnvironments返回参数结构体 */ export interface DescribeEnvironmentsResponse { /** * 环境总数。 */ TotalCount?: number; /** * 环境列表。 */ EnvInfos?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 节点缓存 TTL 配置参数。 */ export interface CacheParameters { /** * 缓存遵循源站。不填表示不设置该配置，FollowOrigin、NoCache、CustomTime 最多只能配置一个 Switch 为 on。 注意：此字段可能返回 null，表示取不到有效值。 */ FollowOrigin?: FollowOrigin; /** * 不缓存。不填表示不设置该配置，FollowOrigin、NoCache、CustomTime 最多只能配置一个 Switch 为 on。 注意：此字段可能返回 null，表示取不到有效值。 */ NoCache?: NoCache; /** * 自定义缓存时间。不填表示不设置该配置，FollowOrigin、NoCache、CustomTime 最多只能配置一个 Switch 为 on。 注意：此字段可能返回 null，表示取不到有效值。 */ CustomTime?: CustomTime; } /** * 回源鉴权请求属性。 */ export interface OriginAuthenticationRequestProperties { /** * 设置回源鉴权参数类型，取值有：
  • QueryString：表示设置回源鉴权参数类型为查询字符串；
  • Header：表示设置回源鉴权参数类型为请求头。
    • */ Type: string; /** * 设置回源鉴权类型对应的参数名称。 */ Name: string; /** * 设置回源鉴权类型对应的参数值。 */ Value: string; } /** * ModifyRealtimeLogDeliveryTask返回参数结构体 */ export interface ModifyRealtimeLogDeliveryTaskResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RateLimit规则 */ export interface RateLimitUserRule { /** * 速率限制统计阈值，单位是次，取值范围0-4294967294。 */ Threshold: number; /** * 速率限制统计时间，取值范围 10/20/30/40/50/60 单位是秒。 */ Period: number; /** * 规则名，只能以英文字符，数字，下划线组合，且不能以下划线开头。 */ RuleName: string; /** * 处置动作，取值有：
  • monitor：观察；
  • drop：拦截；
  • redirect：重定向；
  • page：指定页面；
  • alg：JavaScript 挑战。
    • */ Action: string; /** * 惩罚时长，0-2天。 */ PunishTime: number; /** * 处罚时长单位，取值有：
  • second：秒；
  • minutes：分钟；
  • hour：小时。
    • */ PunishTimeUnit: string; /** * 规则状态，取值有：
  • on：生效；
  • off：不生效。
    • 默认 on 生效。 */ RuleStatus: string; /** * 规则详情。 */ AclConditions: Array; /** * 规则权重，取值范围0-100。 */ RulePriority: number; /** * 规则 Id。仅出参使用。 */ RuleID?: number; /** * 过滤词，取值有：
  • sip：客户端 ip。
    • 默认为空字符串。 */ FreqFields?: Array; /** * 更新时间。仅出参使用。修改时默认为当前时间。 */ UpdateTime?: string; /** * 统计范围。取值有：
  • source_to_eo：（响应）源站到 EdgeOne；
  • client_to_eo：（请求）客户端到 EdgeOne。
    • 默认为 source_to_eo。 */ FreqScope?: Array; /** * 自定义返回页面的名称。Action 是 page 时必填，且不能为空。 */ Name?: string; /** * 自定义响应 Id。该 Id 可通过查询自定义错误页列表接口获取。默认值为default，使用系统默认页面。Action 是 page 时必填，且不能为空。 */ CustomResponseId?: string; /** * 自定义返回页面的响应码。Action 是 page 时必填，且不能为空，取值: 100~600，不支持 3xx 响应码。默认值：567。 */ ResponseCode?: number; /** * 重定向时候的地址。Action 是 redirect 时必填，且不能为空。 */ RedirectUrl?: string; } /** * DescribeInferenceServiceDeploymentRecords返回参数结构体 */ export interface DescribeInferenceServiceDeploymentRecordsResponse { /** *

    部署历史总数。

    */ TotalCount?: number; /** *

    推理服务部署历史列表。

    */ RecordSet?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeOriginACL请求参数结构体 */ export interface DescribeOriginACLRequest { /** * 站点 ID。 */ ZoneId: string; } /** * CreatePlanForZone请求参数结构体 */ export interface CreatePlanForZoneRequest { /** * 站点ID。 */ ZoneId: string; /** * 所要购买套餐的类型，取值有：
  • sta: 全球内容分发网络（不包括中国大陆）标准版套餐；
  • sta_with_bot: 全球内容分发网络（不包括中国大陆）标准版套餐附带bot管理；
  • sta_cm: 中国大陆内容分发网络标准版套餐；
  • sta_cm_with_bot: 中国大陆内容分发网络标准版套餐附带bot管理；
  • sta_global ：全球内容分发网络（包括中国大陆）标准版套餐；
  • sta_global_with_bot ：全球内容分发网络（包括中国大陆）标准版套餐附带bot管理；
  • ent: 全球内容分发网络（不包括中国大陆）企业版套餐；
  • ent_with_bot: 全球内容分发网络（不包括中国大陆）企业版套餐附带bot管理；
  • ent_cm: 中国大陆内容分发网络企业版套餐；
  • ent_cm_with_bot: 中国大陆内容分发网络企业版套餐附带bot管理。
  • ent_global ：全球内容分发网络（包括中国大陆）企业版套餐；
  • ent_global_with_bot ：全球内容分发网络（包括中国大陆）企业版套餐附带bot管理。
    • 当前账户可购买套餐类型请以DescribeAvailablePlans返回为准。 */ PlanType: string; } /** * 客户端设备配置 */ export interface DeviceProfile { /** *

    客户端设备类型。取值有：

  • iOS；
  • Android；
  • WebView；
  • WeChatMiniProgram。

    • */ ClientType: string; /** *

    高风险请求的最低风险分数。分数大于等于该值时，判定为高风险。

    取值范围：[2, 99]

    默认值：50

    */ HighRiskMinScore?: number; /** *

    高风险请求的处置方式。SecurityAction 的 Name 取值支持：

  • Deny：拦截；
  • Monitor：观察；
  • Redirect：重定向；
  • Challenge：挑战。
    • 默认值为 Monitor。

    */ HighRiskRequestAction?: SecurityAction; /** *

    中风险请求的最低风险分数。分数大于等于该值且小于 HighRiskMinScore 时，判定为中风险；低于该值时，判定为低风险。

    取值范围：[1, 98]

    默认值：15

    */ MediumRiskMinScore?: number; /** *

    中风险请求的处置方式。SecurityAction 的 Name 取值支持：

  • Deny：拦截；
  • Monitor：观察；
  • Redirect：重定向；
  • Challenge：挑战。
    • 默认值为 Monitor。

    */ MediumRiskRequestAction?: SecurityAction; } /** * ConfirmMultiPathGatewayOriginACL返回参数结构体 */ export interface ConfirmMultiPathGatewayOriginACLResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateJustInTimeTranscodeTemplate请求参数结构体 */ export interface CreateJustInTimeTranscodeTemplateRequest { /** * 站点ID。 */ ZoneId: string; /** * 即时转码模板名称，长度限制：64 个字符。 */ TemplateName: string; /** * 模板描述信息，长度限制：256 个字符。默认为空。 */ Comment?: string; /** * 启用视频流开关，取值：
  • on：开启；
  • off：关闭。
    • 默认值：on。 */ VideoStreamSwitch?: string; /** * 启用音频流开关，取值：
  • on：开启；
  • off：关闭。
    • 默认值：on。 */ AudioStreamSwitch?: string; /** * 视频流配置参数，当 VideoStreamSwitch 为 on，该字段必填。 */ VideoTemplate?: VideoTemplateInfo; /** * 音频流配置参数，当 AudioStreamSwitch 为 on，该字段必填。 */ AudioTemplate?: AudioTemplateInfo; } /** * 边缘函数副本。 */ export interface FunctionReplica { /** * 函数 ID。 */ FunctionId?: string; /** * 边缘函数副本名称。 */ ReplicaName?: string; /** * 边缘函数副本内容。格式为 JavaScript 代码。 */ Content?: string; /** * 边缘函数副本描述。 */ Remark?: string; /** * 边缘函数副本创建时间。 */ CreatedOn?: string; /** * 边缘函数副本更新时间。 */ ModifiedOn?: string; } /** * 统计曲线数据项 */ export interface TimingDataItem { /** * 返回数据对应时间点，采用 unix 秒级时间戳。 */ Timestamp?: number; /** * 具体数值。 */ Value?: number; } /** * DescribeZoneCustomVariables请求参数结构体 */ export interface DescribeZoneCustomVariablesRequest { /** *

    站点 ID。

    */ ZoneId: string; } /** * ModifyCustomErrorPage请求参数结构体 */ export interface ModifyCustomErrorPageRequest { /** *

    自定义响应页面 ID。

    */ PageId: string; /** *

    站点 ID。

    */ ZoneId: string; /** *

    自定义响应页面名称，名称为 2 - 60 个字符。

    */ Name?: string; /** *

    自定义响应页面描述，描述内容不超过 60 个字符。

    */ Description?: string; /** *

    自定义响应页面类型，取值有：

    • text/html
    • application/json
    • plain/text
    • text/xml
    • text/css
    • text/javascript
    • application/javascript
    • text/markdown
    */ ContentType?: string; /** *

    自定义响应页面内容。内容不超过 16KB。

    */ Content?: string; } /** * ModifyFunctionRule返回参数结构体 */ export interface ModifyFunctionRuleResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyFunctionReplica返回参数结构体 */ export interface ModifyFunctionReplicaResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeL7AccRules请求参数结构体 */ export interface DescribeL7AccRulesRequest { /** * 站点 ID。 */ ZoneId: string; /** * 过滤条件，Filters.Values 的上限为 20，不填写此参数时默认按顺序返回站点下的规则。详细的过滤条件如下：
  • rule-id：按照规则 ID 进行过滤。
    • */ Filters?: Array; /** * 分页查询限制数目，默认值：20，上限：1000。 */ Limit?: number; /** * 分页查询偏移量，默认为 0。 */ Offset?: number; } /** * 七层加速规则，执行顺序由数组顺序决定。 */ export interface ConfigGroupRuleEngineItem { /** *

    规则名称。名称长度限制不超过 255 个字符。

    */ RuleName?: string; /** *

    规则注释。可以填写多个注释。

    */ Description?: Array; /** *

    子规则分支。此列表当前只支持填写一项规则，多填无效。

    注意：此字段可能返回 null，表示取不到有效值。 */ Branches?: Array; } /** * DescribeFunctionRules返回参数结构体 */ export interface DescribeFunctionRulesResponse { /** * 规则详情列表。 */ FunctionRules?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 缓存键配置。 */ export interface CacheKey { /** * 是否开启全路径缓存，取值有：
  • on：开启全路径缓存（即关闭参数忽略）；
  • off：关闭全路径缓存（即开启参数忽略）。
    • */ FullUrlCache?: string; /** * 是否忽略大小写缓存，取值有：
  • on：忽略；
  • off：不忽略。
    • */ IgnoreCase?: string; /** * CacheKey 中包含请求参数。 注意：此字段可能返回 null，表示取不到有效值。 */ QueryString?: QueryString; } /** * DownloadL4Logs返回参数结构体 */ export interface DownloadL4LogsResponse { /** * 查询结果的总条数。 */ TotalCount?: number; /** * 四层离线日志数据列表。 */ Data?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeMultiPathGatewayOriginACL返回参数结构体 */ export interface DescribeMultiPathGatewayOriginACLResponse { /** * 多通道网关实例与回源 IP 网段的绑定关系详情。 */ MultiPathGatewayOriginACLInfo?: MultiPathGatewayOriginACLInfo; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * BindSharedCNAME请求参数结构体 */ export interface BindSharedCNAMERequest { /** * 加速域名所属站点 ID。 */ ZoneId: string; /** * 绑定类型，取值有：
  • bind：绑定；
  • unbind：解绑。
    • */ BindType: string; /** * 接入域名与共享 CNAME 的绑定关系。 */ BindSharedCNAMEMaps: Array; } /** * IP黑白名单及IP区域控制配置 */ export interface IpTableConfig { /** * 开关，取值有：
  • on：开启；
  • off：关闭；
    • */ Switch: string; /** * 基础管控规则。如果为null，默认使用历史配置。 */ IpTableRules?: Array; } /** * ModifyApplicationProxyStatus请求参数结构体 */ export interface ModifyApplicationProxyStatusRequest { /** * 站点ID。 */ ZoneId: string; /** * 代理ID。 */ ProxyId: string; /** * 状态，取值有：
  • offline: 停用；
  • online: 启用。
    • */ Status: string; } /** * DeleteOriginGroup返回参数结构体 */ export interface DeleteOriginGroupResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 修改源站配置参数。 */ export interface ModifyOriginParameters { /** * 源站类型。取值有：
  • IPDomain：IPV4、IPV6 或域名类型源站；
  • OriginGroup：源站组类型源站；
  • LoadBalance：负载均衡，该功能内测中，如需使用，请提工单；
  • COS：腾讯云 COS 对象存储源站；
  • AWSS3：支持 AWS S3 协议的所有对象存储源站。
    • */ OriginType?: string; /** * 源站地址，根据 OriginType 的取值分为以下情况：
  • 当 OriginType = IPDomain 时，该参数请填写 IPV4、IPV6 地址或域名；
  • 当 OriginType = COS 时，该参数请填写 COS 桶的访问域名；
  • 当 OriginType = AWSS3，该参数请填写 S3 桶的访问域名；
  • 当 OriginType = OriginGroup 时，该参数请填写源站组 ID；当为出参的时候，如果引用了其它站点的源站组，格式为{源站组 ID}@{ZoneID}。例如：og-testorigin@zone-38moq1z10wwwy；
  • 当 OriginType = LoadBalance 时，该参数请填写负载均衡实例 ID，该功能当前仅白名单开放；当为出参的时候，如果引用了其它站点的负载均衡，格式为{负载均衡 ID}@{ZoneID}。例如：lb-2rxpamcyqfzg@zone-38moq1z10wwwy。
    • */ Origin?: string; /** * 回源协议配置。当 OriginType 取值为 IPDomain、OriginGroup、LoadBalance 时该参数必填。取值有：
  • http：使用 HTTP 协议；
  • https：使用 HTTPS 协议；
  • follow：协议跟随。
    • */ OriginProtocol?: string; /** * HTTP 回源端口，取值范围 1～65535。当回源协议 OriginProtocol 为 http 或者 follow 时该参数必填。 */ HTTPOriginPort?: number; /** * HTTPS 回源端口，取值范围 1～65535。当回源协议 OriginProtocol 为 https 或者 follow 时该参数必填。 */ HTTPSOriginPort?: number; /** * 指定是否允许访问私有对象存储源站，当源站类型 OriginType = COS 或 AWSS3 时该参数必填，取值有：
  • on：使用私有鉴权；
  • off：不使用私有鉴权。
    • */ PrivateAccess?: string; /** * 私有鉴权使用参数，该参数仅当 OriginType = AWSS3 且 PrivateAccess = on 时会生效。 注意：此字段可能返回 null，表示取不到有效值。 */ PrivateParameters?: OriginPrivateParameters; } /** * DescribeMultiPathGatewayRegions返回参数结构体 */ export interface DescribeMultiPathGatewayRegionsResponse { /** * 网关可用地域列表。 */ GatewayRegions?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteEdgeKVNamespace请求参数结构体 */ export interface DeleteEdgeKVNamespaceRequest { /** * 站点 ID。 */ ZoneId: string; /** * 要删除的命名空间名称。 */ Namespace: string; } /** * DescribeL4Proxy请求参数结构体 */ export interface DescribeL4ProxyRequest { /** * 四层代理实例所属站点的 ID。 */ ZoneId: string; /** * 分页查询偏移量，不填写时默认为 0。 */ Offset?: number; /** * 分页查询限制数目。默认值：20，最大值：1000。 */ Limit?: number; /** * 过滤条件，Filters.Values 的上限为 20。该参数不填写时，返回当前 zone-id 下所有四层代理实例信息。详细的过滤条件如下：
  • proxy-id：按照四层代理实例 ID 进行过滤；
  • ddos-protection-type：按照安全防护类型进行过滤。
    • */ Filters?: Array; } /** * DescribeIdentifications请求参数结构体 */ export interface DescribeIdentificationsRequest { /** * 过滤条件，Filters.Values的上限为20。详细的过滤条件如下：
  • zone-name：按照站点名称进行过滤。
    • */ Filters: Array; /** * 分页查询偏移量。默认值：0。 */ Offset?: number; /** * 分页查询限制数目。默认值：20，最大值：1000。 */ Limit?: number; } /** * ModifyHostsCertificate返回参数结构体 */ export interface ModifyHostsCertificateResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeSecurityAPIService返回参数结构体 */ export interface DescribeSecurityAPIServiceResponse { /** * API 服务总数量。 */ TotalCount?: number; /** * API 服务列表。 */ APIServices?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateAccelerationDomain请求参数结构体 */ export interface CreateAccelerationDomainRequest { /** * 加速域名所属站点 ID。 */ ZoneId: string; /** * 加速域名。 */ DomainName: string; /** * 源站信息。 */ OriginInfo: OriginInfo; /** * 回源协议，取值有：
  • FOLLOW：协议跟随；
  • HTTP：HTTP 协议回源；
  • HTTPS：HTTPS 协议回源。
    • 不填默认为：FOLLOW。 */ OriginProtocol?: string; /** * HTTP 回源端口，默认值80，取值：1～65535。 当 OriginProtocol = FOLLOW 或 HTTP 时生效。 */ HttpOriginPort?: number; /** * HTTPS 回源端口，默认值443，取值：1～65535。 当 OriginProtocol = FOLLOW 或 HTTPS 时生效。 */ HttpsOriginPort?: number; /** * IPv6 状态，取值有：
  • follow：遵循站点 IPv6 配置；
  • on：开启状态；
  • off：关闭状态。
    • 不填默认为：follow。 */ IPv6Status?: string; /** * 指定域名绑定的共享 CNAME 地址，不传时使用默认 CNAME。 绑定共享 CNAME 要求所有域名的调度策略保持一致，以下配置将影响调度策略，在不一致时绑定共享 CNAME 将按照以下方式处理： - IPv6 访问：不允许创建域名，请修改 IPv6Status 已保持与共享 CNAME 绑定的其余域名配置一致； - DDoS 防护：如果选择的共享 CNAME 已启用 DDoS 防护，则创建域名时，将默认为该域名启用 DDoS 防护。 - 中国大陆网络优化（国际加速）：不允许创建域名，请保持当前域名的中国大陆网络优化（国际加速）配置与共享 CNAME 绑定的其余域名一致后重试。 注：共享 CNAME 当前仍在内测中，如需使用，请联系我们开通。 */ SharedCNAME?: string; } /** * 基于客户端和请求特征，将请求来源分为人类来源请求、合法 Bot 请求、疑似 Bot 请求和高风险 Bot 请求，并提供请求处置选项。 */ export interface BotRatings { /** * 恶意 Bot 请求的执行动作。 SecurityAction 的 Name 取值支持：
  • Deny：拦截；
  • Monitor：观察；
  • Allow：放行；
  • Challenge：挑战，其中 ChallengeActionParameters 中的 ChallengeOption 支持 JSChallenge 和 ManagedChallenge。
    • */ HighRiskBotRequestsAction?: SecurityAction; /** * 疑似 Bot 请求的执行动作。 SecurityAction 的 Name 取值支持：
  • Deny：拦截；
  • Monitor：观察；
  • Allow：放行；
  • Challenge：挑战，其中 ChallengeActionParameters 中的 ChallengeOption 支持 JSChallenge 和 ManagedChallenge。
    • */ LikelyBotRequestsAction?: SecurityAction; /** * 友好 Bot 请求的执行动作。 SecurityAction 的 Name 取值支持：
  • Deny：拦截；
  • Monitor：观察；
  • Allow：放行；
  • Challenge：挑战，其中 ChallengeActionParameters 中的 ChallengeOption 支持 JSChallenge 和 ManagedChallenge。
    • */ VerifiedBotRequestsAction?: SecurityAction; /** * 正常 Bot 请求的执行动作。 SecurityAction 的 Name 取值支持：
  • Allow：放行。
    • */ HumanRequestsAction?: SecurityAction; } /** * 引用/被引用的实例信息。 */ export interface ReferenceHolder { /** * 站点ID。 */ ZoneId: string; /** * 实例类型，取值如下：
  • acceleration-domain：加速域名；
    • */ Type: string; /** * 被引用/引用的实例信息。 */ Instance: string; } /** * 规则引擎常规类型的动作 */ export interface NormalAction { /** * 功能名称，功能名称填写规范可调用接口 [查询规则引擎的设置参数](https://cloud.tencent.com/document/product/1552/80618) 查看。 */ Action: string; /** * 参数。 */ Parameters: Array; } /** * 安全执行动作为封禁的附加参数。 */ export interface DenyActionParameters { /** * 是否对来源 IP 延长封禁。取值有：
  • on：开启；
  • off：关闭。
    • 启用后，对触发规则的客户端 IP 持续拦截。当启用该选项时，必须同时指定 BlockIpDuration 参数。 注意：该选项不可与 ReturnCustomPage 或 Stall 选项同时启用。 */ BlockIp?: string; /** * 当 BlockIP 为 on 时IP 的封禁时长。 */ BlockIpDuration?: string; /** * 是否使用自定义页面。取值有：
  • on：开启；
  • off：关闭。
    • 启用后，使用自定义页面内容拦截（响应）请求，当启用该选项时，必须同时指定 ResponseCode 和 ErrorPageId 参数。 注意：该选项不可与 BlockIp 或 Stall 选项同时启用。 */ ReturnCustomPage?: string; /** * 自定义页面的状态码。 */ ResponseCode?: string; /** * 自定义页面的PageId。 */ ErrorPageId?: string; /** * 是否对请求来源挂起不予处理。取值有：
  • on：开启；
  • off：关闭。
    • 启用后，不再响应当前连接会话内请求，且不会主动断开连接。用于爬虫对抗时，消耗客户端连接资源。 注意：该选项不可与 BlockIp 或 ReturnCustomPage 选项同时启用。 */ Stall?: string; } /** * Top数据的详细信息 */ export interface TopDetailData { /** * 字段名。 */ Key: string; /** * 字段值。 */ Value: number; } /** * KV 命名空间信息，包含命名空间的基本属性、存储容量使用情况以及被引用关系。KV 命名空间是边缘函数存储键值对数据的容器，可在边缘函数中通过绑定方式进行读写操作。 */ export interface KVNamespace { /** * 命名空间名称。在同站点下具有唯一性。 */ Namespace?: string; /** * 命名空间描述。创建时填写的备注信息，用于说明命名空间的用途或业务含义。最大支持 256 个字符。 */ Remark?: string; /** * KV 存储空间可用容量，单位为字节（Byte）。表示该命名空间可存储数据的最大容量上限，当前默认为 1 GB。 */ Capacity?: number; /** * KV 存储空间已用容量，单位为字节（Byte）。表示该命名空间当前已使用的存储空间大小。 */ CapacityUsed?: number; /** * 命名空间被引用实例的列表。展示当前命名空间被哪些边缘函数实例引用，以及引用的站点信息。若未被引用，则返回空数组。 */ References?: Array; /** * 命名空间的创建时间，遵循 ISO 8601 标准，格式为 YYYY-MM-DDThh:mm:ssZ（UTC 时间）。 */ CreatedOn?: string; /** * 命名空间的最后修改时间，遵循 ISO 8601 标准，格式为 YYYY-MM-DDThh:mm:ssZ（UTC 时间）。 */ ModifiedOn?: string; } /** * DescribeZoneSetting返回参数结构体 */ export interface DescribeZoneSettingResponse { /** * 站点配置。 注意：此字段可能返回 null，表示取不到有效值。 */ ZoneSetting?: ZoneSetting; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateMultiPathGateway返回参数结构体 */ export interface CreateMultiPathGatewayResponse { /** * 网关 ID。 */ GatewayId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteJustInTimeTranscodeTemplates返回参数结构体 */ export interface DeleteJustInTimeTranscodeTemplatesResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 回源请求携带安全头部配置，配置生效后将携带对应 keyname 的请求头部回源。 */ export interface SecurityHeadersToOrigin { /** *

    Bot 标识信息回源头部配置。

    枚举值：

    • EO-Bot-Botnet-ID： 基于 Bot 请求特征生成的识别标识。
    */ BotIdentificationHeaders?: Array; /** *

    高级 Bot 管理模块识别结果回源头部配置。

    枚举值：

    • EO-Bot-Client-Attestation： 高级 Bot 管理 - 客户端认证模块认证票据校验结果；
    • EO-Bot-Client-Risk： 高级 Bot 管理 - 客户端认证模块设备风险评估结果；
    • EO-Bot-Intelligence： 高级 Bot 管理 - Bot 智能分析模块识别结果；
    • EO-Bot-IP-Reputation： 高级 Bot 管理 - 客户端画像分析识别结果；
    • EO-Bot-Known-Tool： 高级 Bot 管理 - 基础特征管理 - UA 特征规则模块识别结果；
    • EO-Bot-Search-Engine： 高级 Bot 管理 - 基础特征管理 - 搜索引擎规则模块识别结果；
    • EO-Bot-Source-IDC： 高级 Bot 管理 - 基础特征管理 - IDC 规则模块识别结果；
    • EO-Bot-User-Risk： 高级 Bot 管理 - 客户端认证模块账号风险评估结果。
    */ BotManagementHeaders?: Array; /** *

    客户端指纹信息回源头部配置。

    枚举值：

    • EO-Bot-Fingerprint： 客户端指纹信息。
    */ ClientFingerprintHeaders?: Array; } /** * DeleteRules返回参数结构体 */ export interface DeleteRulesResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyDnsRecords请求参数结构体 */ export interface ModifyDnsRecordsRequest { /** * 站点 ID 。 */ ZoneId: string; /** * DNS 记录修改数据列表，一次最多修改100条。 */ DnsRecords?: Array; } /** * DescribeLogAnalysisDetail返回参数结构体 */ export interface DescribeLogAnalysisDetailResponse { /** *

    符合日志匹配条件的日志详情列表。

    */ LogDetail?: Array; /** *

    符合日志匹配条件的日志总数。

    */ TotalCount?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 缓存规则配置。 */ export interface CacheConfig { /** * 缓存配置。 注意：此字段可能返回 null，表示取不到有效值。 */ Cache?: Cache; /** * 不缓存配置。 注意：此字段可能返回 null，表示取不到有效值。 */ NoCache?: NoCache; /** * 遵循源站配置。 注意：此字段可能返回 null，表示取不到有效值。 */ FollowOrigin?: FollowOrigin; } /** * 客户端认证的配置。 */ export interface ClientAttestationRules { /** * 客户端认证的列表。使用 ModifySecurityPolicy 修改 Web 防护配置时：
  • 若未指定 SecurityPolicy.BotManagement.ClientAttestationRules 中的 Rules 参数，或 Rules 参数长度为零：清空所有客户端认证规则配置。
  • 若 SecurityPolicy.BotManagement 参数中，未指定 ClientAttestationRules 参数值：保持已有客户端认证规则配置，不做修改。
    • */ Rules?: Array; } /** * DescribeL7AccSetting请求参数结构体 */ export interface DescribeL7AccSettingRequest { /** * 站点 ID。 */ ZoneId: string; } /** * DescribeEdgeKVNamespaces返回参数结构体 */ export interface DescribeEdgeKVNamespacesResponse { /** * 符合条件的命名空间总数。 */ TotalCount?: number; /** * KV 命名空间信息列表。若无符合条件的命名空间，则返回空数组。 */ KVNamespaces?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UpgradePlan返回参数结构体 */ export interface UpgradePlanResponse { /** * 订单号。 */ DealName?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ACL配置 */ export interface AclConfig { /** * 开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch: string; /** * 用户自定义规则。 */ AclUserRules: Array; /** * 托管定制规则 */ Customizes?: Array; } /** * Bot智能分析规则详情 */ export interface IntelligenceRuleItem { /** * 智能分析标签，取值有：
  • evil_bot：恶意bot；
  • suspect_bot：疑似bot；
  • good_bot：良好bot；
  • normal：正常请求。
    • */ Label: string; /** * 触发智能分析标签对应的处置方式，取值有：
  • drop：拦截；
  • trans：放行；
  • alg：Javascript挑战；
  • captcha：数字验证码；
  • monitor：观察。
    • */ Action: string; } /** * 视频即时处理配置 */ export interface JITVideoProcess { /** * 视频即时处理配置开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch: string; } /** * 离线缓存是否开启 */ export interface OfflineCache { /** * 离线缓存是否开启，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch: string; } /** * 智能分析规则 */ export interface IntelligenceRule { /** * 开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch?: string; /** * 规则详情。 */ IntelligenceRuleItems?: Array; } /** * CreateLoadBalancer返回参数结构体 */ export interface CreateLoadBalancerResponse { /** *

    负载均衡实例 ID。

    */ InstanceId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateConfigGroupVersion请求参数结构体 */ export interface CreateConfigGroupVersionRequest { /** *

    站点 ID。

    */ ZoneId: string; /** *

    待新建版本的配置组 ID。您可以通过查询环境信息接口（DescribeEnvironments）获取完整的环境信息，环境信息中包含了每个配置组类型的配置组 ID。

    取值参考：DescribeEnvironments 返回值 EnvInfos

    */ GroupId: string; /** *

    待导入的配置内容。要求采用 JSON 格式，按照 UTF-8 方式进行编码。配置文件内容可参考下方示例和 配置组语法说明。

    */ Content: string; /** *

    版本描述，可输入最大长度为 50 个字符，可以通过本字段填写该版本的使用场景等。

    */ Description?: string; /** *

    新版本所基于的来源版本 ID。新版本将在该来源版本的配置基础上派生创建。该字段可选，未传入时默认采用当前生产环境正在生效的版本作为来源版本。

    取值参考：

    */ SourceVersion?: string; } /** * 用户自定义规则 */ export interface AclUserRule { /** * 规则名。 */ RuleName: string; /** * 处罚动作，取值有：
  • trans：放行；
  • drop：拦截；
  • monitor：观察；
  • ban：IP 封禁；
  • redirect：重定向；
  • page：指定页面；
  • alg：JavaScript 挑战。
    • */ Action: string; /** * 规则状态，取值有：
  • on：生效；
  • off：失效。
    • */ RuleStatus: string; /** * 自定义规则。 */ AclConditions: Array; /** * 规则优先级，取值范围0-100。 */ RulePriority: number; /** * 规则 Id。仅出参使用。 */ RuleID?: number; /** * 更新时间。仅出参使用。 */ UpdateTime?: string; /** * ip 封禁的惩罚时间。Action 是 ban 时必填，且不能为空，取值范围0-2天。 */ PunishTime?: number; /** * ip 封禁的惩罚时间单位，取值有：
  • second：秒；
  • minutes：分；
  • hour：小时。
    • 默认为 second。 */ PunishTimeUnit?: string; /** * 自定义返回页面的名称。Action 是 page 时必填，且不能为空。 */ Name?: string; /** * 自定义返回页面的实例 Id。默认为0，代表使用系统默认拦截页面。该参数已废弃。 */ PageId?: number; /** * 自定义响应 Id。该 Id 可通过查询自定义错误页列表接口获取。默认值为default，使用系统默认页面。Action 是 page 时必填，且不能为空。 */ CustomResponseId?: string; /** * 自定义返回页面的响应码。Action 是 page 时必填，且不能为空，取值: 100~600，不支持 3xx 响应码。默认值：567。 */ ResponseCode?: number; /** * 重定向时候的地址。Action 是 redirect 时必填，且不能为空。 */ RedirectUrl?: string; } /** * DescribeLoadBalancerList请求参数结构体 */ export interface DescribeLoadBalancerListRequest { /** * 站点 ID。 */ ZoneId: string; /** * 分页查询偏移量，默认为 0。 */ Offset?: number; /** * 分页查询限制数目，默认值：20，最大值：100。 */ Limit?: number; /** * 过滤条件，Filters.Values 的上限为 20。该参数不填写时，返回当前 zone-id 下所有负载均衡实例信息。详细的过滤条件如下：
  • InstanceName：按照负载均衡实例名称进行过滤；
  • InstanceId：按照负载均衡实例 ID 进行过滤。
    • */ Filters?: Array; } /** * 存储定时过期时间和对应 IP。 */ export interface IPExpireInfo { /** * 定时过期时间，遵循 ISO 8601 标准的日期和时间格式。例如 "2022-01-01T00:00:00+08:00"。 */ ExpireTime?: string; /** * IP 列表。仅支持 IP 及 IP 网段。 */ IPList?: Array; } /** * DescribeFunctionComponentBindings请求参数结构体 */ export interface DescribeFunctionComponentBindingsRequest { /** * 站点 ID。 */ ZoneId: string; /** * 函数 ID。 */ FunctionId: string; /** * 分页查询偏移量。默认值：0。 */ Offset?: number; /** * 分页查询限制数目。默认值：20，最大值：1000。 */ Limit?: number; /** * 过滤条件，Filters.Values 的上限为 20。详细的过滤条件如下：
  • name：按照绑定的变量名进行过滤，支持模糊查询；
  • type：按照绑定类型进行过滤，不支持模糊查询。
    • */ Filters?: Array; } /** * 访问 URL 重定向 配置参数。 */ export interface AccessURLRedirectParameters { /** * 状态码，取值为 301、302、303、307、308 之一。 */ StatusCode?: number; /** * 目标请求协议，取值有：
  • http：目标请求协议 HTTP；
  • https：目标请求协议 HTTPS；
  • follow：跟随请求。
    • */ Protocol?: string; /** * 目标 HostName 。 注意：此字段可能返回 null，表示取不到有效值。 */ HostName?: HostName; /** * 目标路径。 注意：此字段可能返回 null，表示取不到有效值。 */ URLPath?: URLPath; /** * 携带查询参数。 注意：此字段可能返回 null，表示取不到有效值。 */ QueryString?: AccessURLRedirectQueryString; } /** * 节点缓存 TTL 配置参数。 */ export interface CacheConfigParameters { /** * 遵循源站缓存配置。FollowOrigin、NoCache、CustomTime 最多只能配置一个 Switch 为 on。 注意：此字段可能返回 null，表示取不到有效值。 */ FollowOrigin?: FollowOrigin; /** * 不缓存配置。FollowOrigin、NoCache、CustomTime 最多只能配置一个 Switch 为 on。 注意：此字段可能返回 null，表示取不到有效值。 */ NoCache?: NoCache; /** * 自定义缓存时间配置。FollowOrigin、NoCache、CustomTime 最多只能配置一个 Switch 为 on。 注意：此字段可能返回 null，表示取不到有效值。 */ CustomTime?: CacheConfigCustomTime; } /** * 推理服务部署历史记录。 */ export interface InferenceServiceDeploymentRecord { /** * 部署记录 ID。 */ RecordId?: string; /** * 部署操作类型，取值：
  • create：创建；
  • update：更新；
  • resume：启用；
  • stop：停用。
    • */ Operation?: string; /** * 部署状态，取值：
  • processing：部署中；
  • succeeded：部署成功；
  • failed：部署失败。
    • */ Status?: string; /** * 部署时长，单位：秒。 */ Duration?: number; /** * 本次推理服务部署的配置。 */ InferenceServiceConfig?: InferenceServiceConfig; /** * 部署发起时间，使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。 */ CreateTime?: string; /** * 该部署配置是否是当前生效配置，取值：
  • active：当前生效配置；
  • inactive：历史版本或异常版本配置。
    • */ ActiveStatus?: string; } /** * 边缘函数组件绑定配置，用于建立边缘函数与组件（如 KV 命名空间）的关联关系。通过绑定配置，边缘函数代码可在运行时通过指定的变量名访问绑定的资源。 */ export interface FunctionComponentBinding { /** * 绑定的组件类型。取值有：
  • kv_namespace：KV 命名空间。
    • */ Type: string; /** * 用于绑定的变量名。限制 1-50 个字符，允许的字符为字母、数字和下划线，其中数字不能在开头。在边缘函数代码中通过该变量名访问绑定的组件。根据 Type 的取值不同，使用方式如下：
  • 当 Type 为 kv_namespace 时：在代码中可通过该变量名访问 KV 命名空间，例如设置为 "MY_KV" 时，可通过 MY_KV.get("key") 进行读写操作。
    • */ VariableName: string; /** * KV 命名空间配置参数。用于指定绑定的 KV 命名空间详情。当 Type 为 kv_namespace 时，此字段必填。 注意：此字段可能返回 null，表示取不到有效值。 */ KVNamespaceParameters?: KVNamespaceParameters; } /** * CreateL4Proxy返回参数结构体 */ export interface CreateL4ProxyResponse { /** * 四层实例 ID。 */ ProxyId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 自定义 Cache Key 配置参数。 */ export interface CacheKeyParameters { /** * 查询字符串全部保留开关，取值有：
  • on：开启；
  • off：关闭。
    • 注意：FullURLCache、IgnoreCase、Header、Scheme、Cookie 至少设置一个配置。此字段和 QueryString.Switch 必须同时设置，但不能同为 on。 */ FullURLCache?: string; /** * 查询字符串保留配置参数。此字段和 FullURLCache 必须同时设置，但不能同为 on。 注意：此字段可能返回 null，表示取不到有效值。 */ QueryString?: CacheKeyQueryString; /** * 忽略大小写开关，取值有：
  • on：开启；
  • off：关闭。
    • 注意：FullURLCache、IgnoreCase、Header、Scheme、Cookie 至少设置一个配置。 */ IgnoreCase?: string; /** * HTTP 请求头配置参数。FullURLCache、IgnoreCase、Header、Scheme、Cookie 至少设置一个配置。 注意：此字段可能返回 null，表示取不到有效值。 */ Header?: CacheKeyHeader; /** * 请求协议开关，取值有：
  • on：开启；
  • off：关闭。
    • 注意：FullURLCache、IgnoreCase、Header、Scheme、Cookie 至少设置一个配置。 */ Scheme?: string; /** * Cookie 配置参数。FullURLCache、IgnoreCase、Header、Scheme、Cookie 至少设置一个配置。 注意：此字段可能返回 null，表示取不到有效值。 */ Cookie?: CacheKeyCookie; } /** * ModifyFunction返回参数结构体 */ export interface ModifyFunctionResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateL4ProxyRules返回参数结构体 */ export interface CreateL4ProxyRulesResponse { /** * 新增转发规则的 ID，以数组的形式返回。 */ L4ProxyRuleIds?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeOriginGroup请求参数结构体 */ export interface DescribeOriginGroupRequest { /** * 站点ID，此参数必填。 */ ZoneId?: string; /** * 分页查询偏移量，不填默认为0。 */ Offset?: number; /** * 分页查询限制数目，不填默认为20，取值：1-1000。 */ Limit?: number; /** * 过滤条件，Filters.Values的上限为20。详细的过滤条件如下：
  • origin-group-id：按照源站组 ID 进行过滤，不支持模糊查询。源站组 ID 形如：origin-2ccgtb24-7dc5-46s2-9r3e-95825d53dwe3a；
  • origin-group-name： 按照源站组名称进行过滤，使用模糊查询时，仅支持填写一个源站组名称。
    • */ Filters?: Array; } /** * 商业或开源工具 UA 特征配置（原 UA 特征规则）。 */ export interface KnownBotCategories { /** * 来自已知商业工具或开源工具的访问请求的处置方式。 SecurityAction 的 Name 取值支持：
  • Deny：拦截；
  • Monitor：观察；
  • Disabled：未启用，不启用指定规则；
  • Challenge：挑战，其中 ChallengeActionParameters 中的 ChallengeOption 支持 JSChallenge 和 ManagedChallenge；
  • Allow：放行（待废弃）。
    • */ BaseAction?: SecurityAction; /** * 指定已知商业工具或开源工具的访问请求的处置方式。 */ BotManagementActionOverrides?: Array; } /** * CreateSecurityClientAttester请求参数结构体 */ export interface CreateSecurityClientAttesterRequest { /** * 站点 ID。 */ ZoneId: string; /** * 认证选项列表。 */ ClientAttesters?: Array; } /** * DescribeIPRegion请求参数结构体 */ export interface DescribeIPRegionRequest { /** * 待查询的 IP 列表，支持 IPV4 和 IPV6，最大可查询 100 条。 */ IPs: Array; } /** * 策略模板绑定的域名信息 */ export interface BindDomainInfo { /** * 域名。 */ Domain?: string; /** * 域名所属的站点 ID。 */ ZoneId?: string; /** * 绑定状态，取值有:
  • process：绑定中；
  • online：绑定成功；
  • fail：绑定失败。
    • */ Status?: string; } /** * 时序类型详细数据 */ export interface TimingTypeValue { /** * 数据和。 */ Sum: number; /** * 最大值。 */ Max: number; /** * 平均值。 */ Avg: number; /** * 指标名。 */ MetricName: string; /** * 详细数据。 注意：此字段可能返回 null，表示取不到有效值。 */ Detail: Array; } /** * CreatePlanForZone返回参数结构体 */ export interface CreatePlanForZoneResponse { /** * 购买的资源名字列表。 */ ResourceNames?: Array; /** * 购买的订单号列表。 */ DealNames?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 认证选项配置。 */ export interface ClientAttester { /** *

    认证选项 ID。

    */ Id?: string; /** *

    认证选项名称。

    */ Name?: string; /** *

    认证规则类型。仅出参返回，取值有：

  • PRESET: 系统预置规则，仅允许修改 AttesterDuration；
  • CUSTOM: 用户自定义规则。
    • */ Type?: string; /** *

    认证方法。取值有：

  • TC-RCE: 使用风险识别 RCE 进行认证；
  • TC-CAPTCHA: 使用天御验证码进行认证；
  • TC-EO-CAPTCHA: 使用 EdgeOne 人机校验进行认证。
    • */ AttesterSource?: string; /** *

    认证有效时间。默认为 60s，支持的单位有：

  • s：秒，取值范围 60～43200；
  • m：分，取值范围 1～720；
  • h：小时，取值范围 1～12。
    • */ AttesterDuration?: string; /** *

    是否开启认证结果使用限制。

    枚举值：

    • on： 开启
    • off： 关闭

    默认值：off

    */ UsageLimit?: string; /** *

    认证结果最大使用次数。当 UsageLimit 为 on 时，此字段必填。

    取值范围：[1, 100000]

    */ MaxUsageCount?: number; /** *

    TC-RCE 认证的配置信息。

  • 当 AttesterSource 参数值为 TC-RCE 时，此字段必填。
    • */ TCRCEOption?: TCRCEOption; /** *

    TC-CAPTCHA 认证的配置信息。

  • 当 AttesterSource 参数值为 TC-CAPTCHA 时，此字段必填。
    • */ TCCaptchaOption?: TCCaptchaOption; /** *

    TC-EO-CAPTCHA 认证的配置信息。

  • 当 AttesterSource 参数值为 TC-EO-CAPTCHA 时，此字段必填。
    • */ TCEOCaptchaOption?: TCEOCaptchaOption; } /** * ModifyL4ProxyRulesStatus返回参数结构体 */ export interface ModifyL4ProxyRulesStatusResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateFunctionReplica返回参数结构体 */ export interface CreateFunctionReplicaResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CheckCnameStatus返回参数结构体 */ export interface CheckCnameStatusResponse { /** * 接入域名的 CNAME 配置状态信息列表。 */ CnameStatus?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ImportZoneConfig返回参数结构体 */ export interface ImportZoneConfigResponse { /** *

    表示该次导入配置的任务 Id，通过查询站点配置导入结果接口（DescribeZoneConfigImportResult）获取本次导入任务执行的结果。注意：导入任务 Id 仅支持查询最近 7 天的导入任务。

    */ TaskId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyWebSecurityTemplate请求参数结构体 */ export interface ModifyWebSecurityTemplateRequest { /** * 站点 ID。需要传入目标策略模板在访问权限上归属的站点，可使用 DescribeWebSecurityTemplates 接口查询策略模板归属的站点。 */ ZoneId: string; /** * 策略模板 ID。 */ TemplateId: string; /** * 修改后的策略模板名称。由中文、英文、数字和下划线组成，不能以下划线开头，且长度不能超过32个字符。字段为空时则不修改。 */ TemplateName?: string; /** * 安全策略模板配置内容。值为空时不修改；没有传入的子模块结构不会被修改。目前支持 Web 防护模块中的例外规则、自定义规则、速率限制规则和托管规则配置，通过表达式语法对安全策略进行配置。 Bot 管理规则配置暂不支持，正在开发中。 特别说明：当入参某个子模块结构时，请确保携带所有需要保留的规则内容，未传入规则内容视为删除。 */ SecurityPolicy?: SecurityPolicy; } /** * DescribeWebSecurityTemplate请求参数结构体 */ export interface DescribeWebSecurityTemplateRequest { /** * 站点 ID。需要传入目标策略模板在访问权限上归属的站点，可使用 DescribeWebSecurityTemplates 接口查询策略模板归属的站点。 */ ZoneId: string; /** * 策略模板 ID。 */ TemplateId: string; } /** * 客户端认证规则 */ export interface ClientAttestationRule { /** *

    客户端认证规则的 ID。
    通过规则 ID 可支持不同的规则配置操作：

  • 增加新规则：ID 为空或不指定 ID 参数；
  • 修改已有规则：指定需要更新/修改的规则 ID；
  • 删除已有规则：BotManagement 参数中，ClientAttestationRule 列表中未包含的已有规则将被删除。

    • */ Id?: string; /** *

    客户端认证规则的名称。

    */ Name?: string; /** *

    规则是否开启。取值有：

  • on：开启；
  • off：关闭。

    • */ Enabled?: string; /** *

    规则的优先级，数值越小越优先执行，范围是 0 ~ 100，默认为 0。

    */ Priority?: number; /** *

    规则的具体内容，需符合表达式语法，详细规范参见产品文档。

    */ Condition?: string; /** *

    客户端认证选项 ID。

    */ AttesterId?: string; /** *

    客户端认证未通过的处置方式。SecurityAction.Name 取值范围如下：

    • Allow：放行，其中 AllowActionParameters 支持 MinDelayTime 和 MaxDelayTime 配置；
    • Deny：拦截，其中 DenyActionParameters 中支持 BlockIp、ReturnCustomPage 和 Stall 配置；
    • Monitor：观察；
    • Challenge：挑战，其中 ChallengeActionParameters.ChallengeOption 支持 JSChallenge、ManagedChallenge、InterstitialChallenge 和 InlineChallenge；
    • Redirect：重定向至URL。
    */ InvalidAttestationAction?: SecurityAction; /** *

    客户端设备配置。若 ClientAttestationRules 参数中，未指定 DeviceProfiles 参数值：保持已有客户端设备配置，不做修改。

    */ DeviceProfiles?: Array; /** *

    账号保护配置。

    */ AccountProtectionSettings?: AccountProtectionSettings; } /** * 实时日志投递到自定义 HTTP(S) 接口的配置信息。 */ export interface CustomEndpoint { /** * 实时日志投递的自定义 HTTP 接口地址，暂仅支持 HTTP/HTTPS 协议。 */ Url: string; /** * 填写自定义的 SecretId 用于生成加密签名，如果源站需要鉴权此参数必填。 */ AccessId?: string; /** * 填写自定义的 SecretKey 用于生成加密签名，如果源站需要鉴权此参数必填。 */ AccessKey?: string; /** * 数据压缩类型，取值有:
  • gzip：使用 gzip 方式压缩。
    • 不填表示不启用压缩。 */ CompressType?: string; /** * POST 请求投递日志时，使用的应用层协议类型，取值有：
  • http：HTTP 协议；
  • https：HTTPS 协议。
    • 如果不填默认根据填写的 URL 地址解析出协议类型。 */ Protocol?: string; /** * 投递日志时携带的自定义请求头。若您填写的头部名称为 Content-Type 等 EdgeOne 日志推送默认携带的头部，那么您填写的头部值将覆盖默认值。头部值引用单个变量${batchSize}，以获取每次 POST 请求中包含的日志条数。 */ Headers?: Array
    ; } /** * 账号保护配置。 */ export interface AccountProtectionSettings { /** *

    账号保护功能开关。

    枚举值：

    • on： 开启；
    • off： 关闭。

    默认值：off。

    */ Enabled?: string; /** *

    请求目的。用于标识请求所属的业务操作场景。

    枚举值：

    • ACCOUNT.CHANGE_PASSWORD：在已知原密码的情况下修改密码的请求；
    • ACCOUNT.CHANGE_SECURITY_QUESTION：修改账号安全问题的请求；
    • ACCOUNT.CHECK_EXISTENCE：校验账号是否已存在的请求，常见于登录或注册页面输入邮箱、手机号后的预校验；
    • ACCOUNT.LOGIN：登录账号的请求；
    • ACCOUNT.REGISTER：注册新账号的请求；
    • ACCOUNT.RESET_PASSWORD：重置密码的请求，通常通过邮箱或短信验证身份后设置新密码；
    • ACCOUNT.UPDATE：修改账号关联信息的请求，例如手机号、邮箱、支付卡号、收货地址等；
    • ASSET.CHECK_GIFTCARD_BALANCE：通过卡号等信息查询礼品卡余额的请求；
    • ASSET.CHECK_LOYALTY_POINTS：查询账号积分余额的请求；
    • ASSET.REDEEM_CODE：使用兑换码兑换权益的请求；
    • BROWSE.QUERY：站内搜索商品或服务的请求；
    • PAYMENT.ADD_TO_CART：将商品加入购物车的请求；
    • PAYMENT.GET_METHODS：获取账号已绑定支付方式列表的请求；
    • PAYMENT.MAKE_PAYMENT：提交支付、结算或转账的请求。
    */ RequestPurpose?: string; /** *

    用户标识在请求来源中的位置，其中 key 替换为实际的参数名称。

    取值有：

    • http.request.cookies["key"]：从 Cookie 中获取名称为 key 的 Cookie 值；
    • http.request.headers["key"]：从请求头中获取名称为 key 的头部值；
    • http.request.uri.args["key"]：从 URL 查询参数中获取名称为 key 的参数值。
    */ UserIDSource?: string; /** *

    用户风险等级配置。

    */ UserRiskProfile?: UserRiskProfile; } /** * ModifyOriginACL返回参数结构体 */ export interface ModifyOriginACLResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * VerifyOwnership请求参数结构体 */ export interface VerifyOwnershipRequest { /** * 站点域名或者站点下的加速域名。 */ Domain: string; } /** * 推理服务容器配置的修改参数。 */ export interface InferenceContainerConfigForModify { /** *

    镜像类型。取值有：

  • TCR：腾讯云容器镜像服务的镜像。

    • */ ImageType?: string; /** *

    TCR 镜像仓库信息。当 ImageType 为 TCR 时必填。

    */ TcrRepositoryConfig?: InferenceTCRRepositoryConfig; /** *

    容器启动时执行的命令，未填写时默认使用镜像的 Entrypoint/CMD。最长支持 1024 字符。

    */ StartupCommand?: string; /** *

    容器运行时的环境变量。最多支持 10 个变量。

    */ EnvironmentVariables?: Array; } /** * 单连接下载限速配置参数。 */ export interface ResponseSpeedLimitParameters { /** * 下载限速模式，取值有：
  • LimitUponDownload：全过程下载限速；
  • LimitAfterSpecificBytesDownloaded：全速下载特定字节后开始限速；
  • LimitAfterSpecificSecondsDownloaded：全速下载特定时间后开始限速。
    • */ Mode: string; /** * 限速值，指定限速大小，填写含单位的数值或变量。当前支持单位有：KB/s。 */ MaxSpeed: string; /** * 限速开始值，可以为下载大小或指定时长，填写含单位的数值或变量，指定下载大小或指定时长。 - 当Mode 取值为 LimitAfterSpecificBytesDownloaded 时，单位取值有： KB； - 当Mode 取值为 LimitAfterSpecificSecondsDownloaded 时，单位取值有： s。 */ StartAt?: string; } /** * ModifyMultiPathGateway返回参数结构体 */ export interface ModifyMultiPathGatewayResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Web 安全的 BOT 规则结构。 */ export interface BotManagement { /** * Bot 管理是否开启。取值有：
  • on：开启；
  • off：关闭。
    • */ Enabled?: string; /** * Bot 管理的自定义规则，组合各类爬虫和请求行为特征，精准定义 Bot 并配置定制化处置方式。 */ CustomRules?: BotManagementCustomRules; /** * Bot 管理的基础配置，对策略关联的所有域名生效。可以通过 CustomRules 进行精细化定制。 */ BasicBotSettings?: BasicBotSettings; /** * 客户端认证规则的定义列表。该功能内测中，如需使用，请提工单。 */ ClientAttestationRules?: ClientAttestationRules; /** * 配置浏览器伪造识别规则（原主动特征识别规则）。设置注入 JavaScript 的响应页面范围，浏览器校验选项，以及对非浏览器客户端的处置方式。 */ BrowserImpersonationDetection?: BrowserImpersonationDetection; } /** * DeleteL4Proxy请求参数结构体 */ export interface DeleteL4ProxyRequest { /** * 站点 ID。 */ ZoneId: string; /** * 四层代理实例 ID。 */ ProxyId: string; } /** * DeleteApplicationProxy请求参数结构体 */ export interface DeleteApplicationProxyRequest { /** * 站点ID。 */ ZoneId: string; /** * 代理ID。 */ ProxyId: string; } /** * 权重策略配置。 */ export interface ConfigGroupFunctionWeightedSelection { /** *

    指定执行的函数，取值为函数在站点内的唯一标识。当 TriggerType 为 direct 时生效。

    */ Function: string; /** *

    选中权重。取值范围0-100，所有的权重之和需要为100。 选中概率计算方式为： weight/100。例如设置了两个函数 A 和 B ，其中 A 的权重为30，那么 B 的权重必须为70，最终选中 A 的概率为30%，选中 B 的概率为70%。

    */ Weight: number; } /** * 中国大陆加速优化配置。 */ export interface AccelerateMainlandParameters { /** * 中国大陆加速优化配置开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch?: string; } /** * ModifyZoneStatus请求参数结构体 */ export interface ModifyZoneStatusRequest { /** * 站点 ID。 */ ZoneId: string; /** * 站点状态，取值有：
  • false：开启站点；
  • true：关闭站点。
    • */ Paused: boolean; } /** * 回源 URL 重写 配置参数。 */ export interface UpstreamURLRewriteParameters { /** * 回源 URL 重写类型。仅支持填写 Path。 */ Type?: string; /** * 回源 URL 重写动作。取值有：
  • replace：指替换完整路径。用于将完整的请求 URL Path 替换为指定路径。
  • addPrefix：指增加路径前缀。用于增加指定路径前缀至请求 URL Path。
  • rmvPrefix：指移除路径前缀。用于移除请求 URL Path 的指定路径前缀。
  • regexReplace：指正则替换完整路径。用于通过 Google RE2 正则表达式匹配和替换完整路径。
    • */ Action?: string; /** * 回源 URL 重写值。需要满足 URL Path 规范，且保证重写后的 Path 以 / 开头，以防止回源 URL 的 Host 被修改，长度范围为 1～1024。当 Action 为 addPrefix 时，不能以 / 结尾；当 Action 为 rmvPrefix 时，不能存在 *；当 Action 为 regexReplace 时，支持用 $NUM 引用正则捕获组，其中 NUM 代表组编号，如 $1，最多支持 $9。 */ Value?: string; /** * 回源 URL 重写用于正则替换匹配完整路径的正则表达式。需要满足 Google RE2 规范，长度范围为 1～1024。当 Action 为 regexReplace 时，此字段必填，否则无需填写此字段。 */ Regex?: string; } /** * 失败原因 */ export interface FailReason { /** * 失败原因。 */ Reason: string; /** * 处理失败的资源列表。 */ Targets: Array; } /** * 边缘函数触发规则。 */ export interface ConfigGroupFunctionTrigger { /** *

    匹配条件。

    */ Condition: string; /** *

    函数选择配置类型：

    枚举值：

    • direct： 直接指定执行函数
    • weight： 基于权重比选择函数
    • region： 基于客户端 IP 的国家/地区选择函数
    */ TriggerType?: string; /** *

    指定执行的函数，取值为函数在站点内的唯一标识。当 TriggerType 为 direct 时生效。

    */ Function?: string; /** *

    基于客户端 IP 国家/地区的函数选择配置。

    */ RegionMappingSelections?: Array; /** *

    基于权重的函数选择配置。

    */ WeightedSelections?: Array; /** *

    规则描述。

    */ Remark?: string; } /** * ModifyHostsCertificate请求参数结构体 */ export interface ModifyHostsCertificateRequest { /** * 站点 ID。 */ ZoneId: string; /** * 需要修改证书配置的加速域名。 */ Hosts: Array; /** * 配置服务端证书的模式，取值有：
    • disable：不配置服务端证书；
    • eofreecert：通过自动验证申请免费证书并部署。验证方式详见：[申请免费证书支持的验证方式](https://cloud.tencent.com/document/product/1552/90437) - 在 NS 或者 DNSPod 托管接入模式下，仅支持自动验证的方式申请免费证书。 - 当免费证书申请失败时会导致证书部署失败，您可以通过检查免费证书申请结果接口获取申请失败原因。
  • eofreecert_manual：部署 DNS 委派验证或者文件验证申请的免费证书。在部署免费证书前，您需要触发申请免费证书接口申请免费证书。在免费证书申请成功后，你可以通过该枚举值对免费证书进行部署；
    • 注意：在对免费证书部署时，需要保证当前已存在申请成功的免费证书。您可以通过检查免费证书申请结果接口检查当前是否已存在申请成功的免费证书。
  • sslcert：配置 SSL 托管服务端证书。
    • */ Mode?: string; /** * SSL 证书配置，本参数仅在 mode 为 sslcert 时生效，传入对应证书的 CertId 即可。您可以前往 [SSL 证书列表](https://console.cloud.tencent.com/ssl) 查看 CertId。 */ ServerCertInfo?: Array; /** * 托管类型，取值有：
  • none：不托管EO；
  • apply：托管EO
    • 不填，默认取值为none。 * @deprecated */ ApplyType?: string; /** * 在边缘双向认证场景下，该字段为客户端的 CA 证书，部署在 EO 节点内，用于客户端对 EO 节点进行认证。默认关闭，不填写表示保持原有配置。 */ ClientCertInfo?: MutualTLS; /** * 用于分别开启/关闭回源双向认证和源站证书校验。默认关闭，不填写表示保持原有配置。回源双向认证配置当前为白名单内侧中，如需使用，请[联系我们](https://cloud.tencent.com/online-service)。 */ UpstreamCertInfo?: UpstreamCertInfo; } /** * ModifyOriginACL请求参数结构体 */ export interface ModifyOriginACLRequest { /** * 站点 ID。 */ ZoneId: string; /** * 需要启用/关闭特定回源 IP 网段回源的实例。 */ OriginACLEntities?: Array; /** * 源站防护回源ACL控制域，不填则默认不变；控制域信息可以通过DescribeAvailableOriginACLFamily接口查询获得。 具体取值说明如下：
  • gaz：标准全球可用区控制域；
  • mlc：标准中国大陆可用区控制域；
  • emc：标准全球(不含中国大陆)可用区控制域；
  • plat-gaz：精简全球可用区控制域；
  • plat-mlc：精简中国大陆可用区控制域；
  • plat-emc：精简全球(不含中国大陆)可用区控制域；
    • */ OriginACLFamily?: string; } /** * ModifyOriginGroup返回参数结构体 */ export interface ModifyOriginGroupResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteAccelerationDomains请求参数结构体 */ export interface DeleteAccelerationDomainsRequest { /** * 加速域名所属站点ID。 */ ZoneId: string; /** * 需要删除的加速域名ID列表。 */ DomainNames: Array; /** * 是否强制删除。当域名存在关联资源（如马甲域名、流量调度功能）时，是否强制删除该域名，取值有：
  • true：删除该域名及所有关联资源；
  • false：当该加速域名存在关联资源时，不允许删除。
    • 不填写，默认值为：false。 */ Force?: boolean; } /** * RenewPlan返回参数结构体 */ export interface RenewPlanResponse { /** * 订单号。 */ DealName?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 自定义错误码页面结构体。 */ export interface CustomErrorPage { /** * 自定义错误页面 ID。 */ PageId?: string; /** * 站点 ID。 */ ZoneId?: string; /** * 自定义错误页面名称。 */ Name?: string; /** * 自定义错误页面类型。 */ ContentType?: string; /** * 自定义错误页面描述。 */ Description?: string; /** * 自定义错误页面内容。 */ Content?: string; /** * 自定义错误页面引用。 */ References?: Array; } /** * DescribeDeployHistory请求参数结构体 */ export interface DescribeDeployHistoryRequest { /** * 站点 ID。 */ ZoneId: string; /** * 环境 ID。 */ EnvId: string; /** * 过滤条件，Filters.Values 的上限为 20，详细的过滤条件如下：
  • record-id：按照发布记录 ID 进行过滤进行过滤。
    • */ Filters?: Array; } /** * 刷新预热附带的头部信息 */ export interface Header { /** * HTTP头部名称。 */ Name: string; /** * HTTP头部值。 */ Value: string; } /** * CreateMultiPathGatewayLine返回参数结构体 */ export interface CreateMultiPathGatewayLineResponse { /** * 线路 ID ， 取值有:
  • line-1： EdgeOne 四层代理线路，支持修改实例和规则，不支持删除；
  • line-2 及以上：EdgeOne 四层代理线路或者自定义线路，支持修改、删除实例和规则。
    • */ LineId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 计费数据项。 */ export interface BillingData { /** * 数据时间戳。 */ Time?: string; /** * 数值。 */ Value?: number; /** * 数据点所属站点 ID。若使用内容标识符功能，则该项值为内容标识符。 */ ZoneId?: string; /** * 数据点所属域名。 */ Host?: string; /** * 数据点所属四层代理实例 ID。 */ ProxyId?: string; /** * 数据点所属计费大区 ID。计费大区以实际服务用户客户端的 EdgeOne 节点所在区域为准。取值有：
  • CH：中国大陆境内
  • AF：非洲
  • AS1：亚太一区
  • AS2：亚太二区
  • AS3：亚太三区
  • EU：欧洲
  • MidEast：中东
  • NA：北美
  • SA：南美
    • */ RegionId?: string; } /** * ModifySecurityPolicy返回参数结构体 */ export interface ModifySecurityPolicyResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribePlans请求参数结构体 */ export interface DescribePlansRequest { /** * 过滤条件，Filters.Values 的上限为 20。详细的过滤条件如下：
  • plan-type
      按照【套餐类型】进行过滤。
      可选的类型有：
      plan-trial：试用版套餐；
      plan-personal：个人版套餐；
      plan-basic：基础版套餐；
      plan-standard：标准版套餐；
      plan-enterprise：企业版套餐。 
  • plan-id
      按照【套餐 ID】进行过滤。套餐 ID 形如：edgeone-268z103ob0sx。
  • area
      按照【套餐加速地域】进行过滤。
    •   服务区域，可选的类型有：
      mainland: 中国大陆；
      overseas: 全球（不包括中国大陆)；
      global: 全球（包括中国大陆)。
  • status
      按照【套餐状态】进行过滤。
      可选的状态有：
      normal：正常状态；
      expiring-soon：即将过期；
      expired：已到期;
      isolated：已隔离。
    • */ Filters?: Array; /** * 排序字段，取值有：
  • enable-time：生效时间；
  • expire-time：过期时间。
    • 不填写使用默认值 enable-time。 */ Order?: string; /** * 排序方向，取值有：
  • asc：从小到大排序；
  • desc：从大到小排序。
    • 不填写使用默认值 desc。 */ Direction?: string; /** * 分页查询限制数目。默认值：20，最大值：200。 */ Limit?: number; /** * 分页查询偏移量。默认值：0。 */ Offset?: number; } /** * CreateSecurityJSInjectionRule返回参数结构体 */ export interface CreateSecurityJSInjectionRuleResponse { /** * JavaScript 注入规则 ID 列表。 */ JSInjectionRuleIds?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyOriginGroup请求参数结构体 */ export interface ModifyOriginGroupRequest { /** * 站点 ID */ ZoneId: string; /** * 源站组 ID，此参数必填。 */ GroupId: string; /** * 源站组名称，不填保持原有配置，可输入1 - 200个字符，允许的字符为 a - z, A - Z, 0 - 9, _, - 。 */ Name?: string; /** * 源站组类型，取值有：
  • GENERAL：通用型源站组，仅支持添加 IP/域名 源站，可以被域名服务、规则引擎、四层代理、通用型负载均衡引用；
  • HTTP： HTTP专用型源站组，支持添加 IP/域名、对象存储源站，无法被四层代理引用。
    • 不填保持原有配置。 */ Type?: string; /** * 源站记录信息，不填保持原有配置。 */ Records?: Array; /** * 回源 Host Header，仅 Type = HTTP 时生效， 不填或者填空表示不配置回源Host，规则引擎修改 Host Header 配置优先级高于源站组的 Host Header。 */ HostHeader?: string; } /** * RefreshMultiPathGatewaySecretKey返回参数结构体 */ export interface RefreshMultiPathGatewaySecretKeyResponse { /** * 多通道安全加速网关接入密钥。 */ SecretKey?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteZone返回参数结构体 */ export interface DeleteZoneResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateRule返回参数结构体 */ export interface CreateRuleResponse { /** * 规则 ID。 */ RuleId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyL7AccSetting返回参数结构体 */ export interface ModifyL7AccSettingResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 边缘推理定时伸缩有效期范围配置。 */ export interface InferenceScheduledScalingEffectiveRange { /** *

    有效期类型。取值有：

  • LongTerm：长期有效；
  • Custom：自定义起止日期。

    • */ EffectiveType: string; /** *

    有效期起始日期。当 EffectiveType 为 Custom 时必填；当 EffectiveType 为 LongTerm 时不传该字段。

    */ StartDate?: string; /** *

    有效期终止日期。当 EffectiveType 为 Custom 时必填，且不得早于 StartDate；当 EffectiveType 为 LongTerm 时不传该字段。

    */ EndDate?: string; } /** * DeleteSecurityJSInjectionRule返回参数结构体 */ export interface DeleteSecurityJSInjectionRuleResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Web安全自定义页面的附加参数 */ export interface ReturnCustomPageActionParameters { /** * 响应状态码。 */ ResponseCode: string; /** * 响应的自定义页面ID。 */ ErrorPageId: string; } /** * DescribeSecurityIPGroupContent请求参数结构体 */ export interface DescribeSecurityIPGroupContentRequest { /** * 站点 ID。 */ ZoneId: string; /** * IP 组 ID。 */ GroupId: number; /** * 分页查询限制数目。默认值：2000，最大值：100000。 */ Limit?: number; /** * 分页查询偏移量。默认值：0。 */ Offset?: number; } /** * BindZoneToPlan返回参数结构体 */ export interface BindZoneToPlanResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteWebSecurityTemplate请求参数结构体 */ export interface DeleteWebSecurityTemplateRequest { /** * 站点 ID。需要传入目标策略模板在访问权限上归属的站点，可使用 DescribeWebSecurityTemplates 接口查询策略模板归属的站点。 */ ZoneId: string; /** * 策略模板 ID。 */ TemplateId: string; } /** * DescribeL7AccSetting返回参数结构体 */ export interface DescribeL7AccSettingResponse { /** * 站点加速全局配置。 注意：此字段可能返回 null，表示取不到有效值。 */ ZoneSetting?: ZoneConfigParameters; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * HTTP2 回源配置。 */ export interface UpstreamHTTP2Parameters { /** * HTTP2 回源配置开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch?: string; } /** * ModifyAliasDomain请求参数结构体 */ export interface ModifyAliasDomainRequest { /** * 站点 ID。 */ ZoneId: string; /** * 别称域名名称。 */ AliasName: string; /** * 目标域名名称。 */ TargetName: string; /** * 证书配置，取值有：
  • none：不配置；
  • hosting：SSL托管证书；
  • apply：申请免费证书。
    • 不填写保持原有配置。 */ CertType?: string; /** * 当 CertType 取值为 hosting 时填入相应证书 ID。 */ CertId?: Array; } /** * 加速域名源站信息。 */ export interface OriginInfo { /** * 源站类型，取值有：
  • IP_DOMAIN：IPV4、IPV6 或域名类型源站；
  • COS：腾讯云 COS 对象存储源站；
  • AWS_S3：AWS S3 对象存储源站；
  • ORIGIN_GROUP：源站组类型源站；
  • VOD：云点播；
  • SPACE：源站卸载，当前仅白名单开放；
  • LB：负载均衡，当前仅白名单开放。
    • */ OriginType: string; /** * 源站地址，根据 OriginType 的取值分为以下情况：
  • 当 OriginType = IP_DOMAIN 时，该参数为 IPv4、IPv6 地址或域名；
  • 当 OriginType = COS 时，该参数为 COS 桶的访问域名；
  • 当 OriginType = AWS_S3，该参数为 S3 桶的访问域名；
  • 当 OriginType = ORIGIN_GROUP 时，该参数为源站组 ID；如果引用了其它站点的源站组，格式为{源站组 ID}@{ZoneID}。例如：og-testorigin@zone-38moq1z10wwwy；
  • 当 OriginType = VOD 时，该参数为云点播应用 ID；
  • 当 OriginType = LB 时，该参数为负载均衡实例 ID，该功能当前仅白名单开放；如果引用了其它站点的负载均衡，格式为{负载均衡 ID}@{ZoneID}。例如：lb-2rxpamcyqfzg@zone-38moq1z10wwwy；
  • 当 OriginType = SPACE 时，该参数为源站卸载空间 ID，该功能当前仅白名单开放。
    • */ Origin: string; /** * 备用源站组 ID，该参数仅在 OriginType = ORIGIN_GROUP 时生效，该字段为旧版能力，调用后控制台无法进行配置修改，如需使用请提交工单咨询。 */ BackupOrigin?: string; /** * 指定是否允许访问私有对象存储源站，该参数仅当源站类型 OriginType = COS 或 AWS_S3 时会生效，取值有：
  • on：使用私有鉴权；
  • off：不使用私有鉴权。
    • 不填写时，默认值为off。 */ PrivateAccess?: string; /** * 私有鉴权使用参数，该参数仅当源站类型 PrivateAccess = on 时会生效。 */ PrivateParameters?: Array; /** * 自定义回源 HOST 头，该参数仅当 OriginType = IP_DOMAIN 时生效。当 OriginType 是其它类型源站时，不需要传入该参数，否则会报错。 当 OriginType = COS 或 AWS_S3 时，回源 HOST 头将与源站域名保持一致。 当 OriginType = ORIGIN_GROUP 时，回源 HOST 头遵循源站组内配置，如果没有配置则默认为加速域名。 当 OriginType = VOD 或 SPACE 时，无需配置该头部，按对应的回源域名生效。 */ HostHeader?: string; /** * VODEO 子应用 ID。该参数当 OriginType = VODEO 时必填。 * @deprecated */ VodeoSubAppId?: number; /** * VODEO 分发范围，该参数当 OriginType = VODEO 时必填。取值有：
  • All：当前应用下所有存储桶；
  • Bucket：指定的某一个存储桶。
    • * @deprecated */ VodeoDistributionRange?: string; /** * VODEO 存储桶 ID，该参数当 OriginType = VODEO 且 VodeoDistributionRange = Bucket 时必填。 * @deprecated */ VodeoBucketId?: string; /** * 云点播回源范围，该参数当 OriginType = VOD 时生效。取值有：
  • all：当前源站对应的云点播应用内所有文件；
  • bucket：当前源站对应的云点播应用下指定某一个存储桶内的文件，通过参数 VodBucketId 来指定存储桶。
    • 不填写时，默认值为 all。 */ VodOriginScope?: string; /** * VOD 存储桶 ID，该参数当 OriginType = VOD 且 VodOriginScope = bucket 时必填。数据来源：云点播专业版应用下存储桶的存储 ID 。 */ VodBucketId?: string; } /** * CreateDnsRecord请求参数结构体 */ export interface CreateDnsRecordRequest { /** * 站点 ID。 */ ZoneId: string; /** * DNS 记录名，如果是中文、韩文、日文域名，需要转换为 punycode 后输入。 */ Name: string; /** * DNS 记录类型，取值有：
  • A：将域名指向一个外网 IPv4 地址，如 8.8.8.8；
  • AAAA：将域名指向一个外网 IPv6 地址；
  • MX：用于邮箱服务器。存在多条 MX 记录时，优先级越低越优先；
  • CNAME：将域名指向另一个域名，再由该域名解析出最终 IP 地址；
  • TXT：对域名进行标识和说明，常用于域名验证和 SPF 记录（反垃圾邮件）；
  • NS：如果需要将子域名交给其他 DNS 服务商解析，则需要添加 NS 记录。根域名无法添加 NS 记录；
  • CAA：指定可为本站点颁发证书的 CA；
  • SRV：标识某台服务器使用了某个服务，常见于微软系统的目录管理。
    • 不同的记录类型呢例如 SRV、CAA 记录对主机记录名称、记录值格式有不同的要求，各记录类型的详细说明介绍和格式示例请参考：[解析记录类型介绍](https://cloud.tencent.com/document/product/1552/90453#2f681022-91ab-4a9e-ac3d-0a6c454d954e)。 */ Type: string; /** * DNS 记录内容，根据 Type 值填入与之相对应的内容，如果是中文、韩文、日文域名，需要转换为 punycode 后输入。 */ Content: string; /** * DNS 记录解析线路，不指定默认为 Default，表示默认解析线路，代表全部地域生效。 - 解析线路配置仅适用于当 Type（DNS 记录类型）为 A、AAAA、CNAME 时。 - 解析线路配置仅适用于标准版、企业版套餐使用，取值请参考：[解析线路及对应代码枚举](https://cloud.tencent.com/document/product/1552/112542)。 */ Location?: string; /** * 缓存时间，用户可指定值范围 60~86400，数值越小，修改记录各地生效时间越快，默认为 300，单位：秒。 */ TTL?: number; /** * DNS 记录权重，用户可指定值范围 -1~100，设置为 0 时表示不解析，不指定默认为 -1，表示不设置权重。权重配置仅适用于当 Type（DNS 记录类型）为 A、AAAA、CNAME 时。
    注意：同一个子域名下，相同解析线路的不同 DNS 记录，应保持同时设置权重或者同时都不设置权重。 */ Weight?: number; /** * MX 记录优先级，该参数仅在当 Type（DNS 记录类型）为 MX 时生效，值越小优先级越高，用户可指定值范围0~50，不指定默认为0。 */ Priority?: number; } /** * Waf规则 */ export interface WafRule { /** * 托管规则开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch: string; /** * 黑名单ID列表，将规则ID加入本参数列表中代表该ID关闭，即该规则ID不再生效。 */ BlockRuleIDs: Array; /** * 观察模式ID列表，将规则ID加入本参数列表中代表该ID使用观察模式生效，即该规则ID进入观察模式。 */ ObserveRuleIDs: Array; } /** * 浏览器伪造识别规则（原主动特征识别规则）的配置。 */ export interface BrowserImpersonationDetection { /** * 浏览器伪造识别规则的列表。使用 ModifySecurityPolicy 修改 Web 防护配置时：
  • 若未指定 SecurityPolicy.BotManagement.BrowserImpersonationDetection 中的 Rules 参数，或 Rules 参数长度为零： 清空所有浏览器伪造识别规则配置。
  • 若 SecurityPolicy.BotManagement 参数中，未指定 BrowserImpersonationDetection 参数值： 保持已有浏览器伪造识别规则配置，不做修改。
    • */ Rules?: Array; } /** * ModifyApplicationProxy请求参数结构体 */ export interface ModifyApplicationProxyRequest { /** * 站点 ID。 */ ZoneId: string; /** * 代理 ID。 */ ProxyId: string; /** * 当 ProxyType=hostname 时，表示域名或子域名； 当 ProxyType=instance 时，表示代理名称。 */ ProxyName: string; /** * 会话保持时间，取值范围：30-3600，单位：秒。 不填写保持原有配置。 */ SessionPersistTime?: number; /** * 四层代理模式，取值有：
  • instance：表示实例模式。
    • 不填写使用默认值instance。 */ ProxyType?: string; /** * Ipv6 访问配置，不填写保持原有配置。 */ Ipv6?: Ipv6; /** * 中国大陆加速优化配置。 不填写表示保持原有配置。 */ AccelerateMainland?: AccelerateMainland; } /** * 域名的独立 DDoS 防护信息。 */ export interface DomainDDoSProtection { /** * 域名。 */ Domain: string; /** * 域名的独立 DDoS 开关，取值为：
  • on：已开启；
  • off：已关闭。
    • */ Switch: string; } /** * ModifyAliasDomainStatus请求参数结构体 */ export interface ModifyAliasDomainStatusRequest { /** * 站点 ID。 */ ZoneId: string; /** * 别称域名状态，取值有：
  • false：开启别称域名；
  • true：关闭别称域名。
    • */ Paused: boolean; /** * 待修改状态的别称域名名称。如果为空，则不执行修改状态操作。 */ AliasNames?: Array; } /** * DeleteFunction请求参数结构体 */ export interface DeleteFunctionRequest { /** * 站点 ID。 */ ZoneId: string; /** * 函数 ID。 */ FunctionId: string; } /** * 共享 CNAME 和接入域名的绑定关系 */ export interface BindSharedCNAMEMap { /** * 需要绑定或解绑的共享 CNAME。 */ SharedCNAME: string; /** * 加速域名，可传递多个，最多20个。 */ DomainNames: Array; } /** * DeleteRealtimeLogDeliveryTask请求参数结构体 */ export interface DeleteRealtimeLogDeliveryTaskRequest { /** * 站点 ID。 */ ZoneId: string; /** * 实时日志投递任务 ID。 */ TaskId: string; } /** * 规则引擎可应用于匹配请求的设置列表及其详细信息 */ export interface RulesSettingAction { /** * 功能名称，取值有：
  • 访问URL 重写（AccessUrlRedirect）；
  • 回源 URL 重写 （UpstreamUrlRedirect）；
  • 自定义错误页面 (ErrorPage)；
  • QUIC（QUIC）；
  • WebSocket （WebSocket）；
  • 视频拖拽（VideoSeek）；
  • Token 鉴权（Authentication）；
  • 自定义CacheKey（CacheKey）；
  • 节点缓存 TTL （Cache）；
  • 浏览器缓存 TTL（MaxAge）；
  • 离线缓存（OfflineCache）；
  • 智能加速（SmartRouting）；
  • 分片回源（RangeOriginPull）；
  • HTTP/2 回源（UpstreamHttp2）；
  • Host Header 重写（HostHeader）；
  • 强制 HTTPS（ForceRedirect）；
  • 回源 HTTPS（OriginPullProtocol）；
  • 缓存预刷新（CachePrefresh）；
  • 智能压缩（Compression）；
  • 修改 HTTP 请求头（RequestHeader）；
  • 修改HTTP响应头（ResponseHeader）;
  • 状态码缓存 TTL（StatusCodeCache）;
  • Hsts；
  • ClientIpHeader；
  • TlsVersion；
  • OcspStapling。
    • */ Action: string; /** * 参数信息。 */ Properties: Array; } /** * 访问协议强制 HTTPS 跳转配置。 */ export interface ForceRedirectHTTPSParameters { /** * 访问强制跳转配置开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch?: string; /** * 重定向状态码。当 Switch 为 on 时，此字段必填，否则此字段不生效。取值有：
  • 301：301跳转；
  • 302：302跳转。
    • */ RedirectStatusCode?: number; } /** * HTTPS 双向认证。 */ export interface MutualTLS { /** * 双向认证配置开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch: string; /** * 双向认证证书列表。 注意：MutualTLS 在 ModifyHostsCertificate 作为入参使用时，该参数传入对应证书的 CertId 即可。您可以前往 [SSL 证书列表](https://console.cloud.tencent.com/ssl) 查看 CertId。 */ CertInfos?: Array; } /** * 客户端行为校验 */ export interface ClientBehaviorDetection { /** * 工作量证明校验强度。取值有：
  • low：低；
  • medium：中；
  • high：高。
    • */ CryptoChallengeIntensity?: string; /** * 客户端行为校验的执行方式。取值有：
  • 0ms：立即执行；
  • 100ms：延迟 100ms 执行；
  • 200ms：延迟 200ms 执行；
  • 300ms：延迟 300ms 执行；
  • 400ms：延迟 400ms 执行；
  • 500ms：延迟 500ms 执行；
  • 600ms：延迟 600ms 执行；
  • 700ms：延迟 700ms 执行；
  • 800ms：延迟 800ms 执行；
  • 900ms：延迟 900ms 执行；
  • 1000ms：延迟 1000ms 执行。
    • */ CryptoChallengeDelayBefore?: string; /** * 触发阈值统计的时间窗口，取值有：
  • 5s：5 秒内；
  • 10s：10 秒内；
  • 15s：15 秒内；
  • 30s：30 秒内；
  • 60s：60 秒内；
  • 5m：5 分钟内；
  • 10m：10 分钟内；
  • 30m：30 分钟内；
  • 60m：60 分钟内。
    • */ MaxChallengeCountInterval?: string; /** * 触发阈值统计的累计次数，取值范围 1 ~ 100000000。 */ MaxChallengeCountThreshold?: number; /** * 客户端未启用 JS（未完成检测）时的执行动作。 SecurityAction 的 Name 取值支持：
  • Deny：拦截，其中 DenyActionParameters 中支持 Stall 配置；
  • Monitor：观察；
  • Allow：等待后响应，其中 AllowActionParameters 需要 MinDelayTime 和 MaxDelayTime 配置。
    • */ ChallengeNotFinishedAction?: SecurityAction; /** * 客户端检测超时的执行动作。 SecurityAction 的 Name 取值支持：
  • Deny：拦截，其中 DenyActionParameters 中支持 Stall 配置；
  • Monitor：观察；
  • Allow：等待后响应，其中 AllowActionParameters 需要 MinDelayTime 和 MaxDelayTime 配置。
    • */ ChallengeTimeoutAction?: SecurityAction; /** * Bot 客户端的执行动作。 SecurityAction 的 Name 取值支持：
  • Deny：拦截，其中 DenyActionParameters 中支持 Stall 配置；
  • Monitor：观察；
  • Allow：等待后响应，其中 AllowActionParameters 需要 MinDelayTime 和 MaxDelayTime 配置。
    • */ BotClientAction?: SecurityAction; } /** * DescribeLogAnalysisDownloadTasks请求参数结构体 */ export interface DescribeLogAnalysisDownloadTasksRequest { /** *

    站点 ID。

    */ ZoneId: string; /** *

    数据归属地区，可选值：

    • mainland：中国大陆境内；
    • overseas：全球（不含中国大陆）。
    注意：若站点服务区域为“全球可用区”，获取全部数据需要分别查询 mainland 和 overseas 的数据。

    */ Area: string; /** *

    日志类型，可选值：

    • l7-access-logs：七层访问日志；
    • web-attack：托管规则日志。
    默认为 l7-access-logs 。

    */ LogType?: string; /** *

    过滤条件，Filters.Values 的上限为 20。详细的过滤条件如下：

    • task-id：按照日志下载任务 ID进行过滤，可选值参考 CreateLogAnalysisDownloadTask 接口返回的 TaskId。

    取值参考：CreateLogAnalysisDownloadTask

    */ Filters?: Array; /** *

    分页查询限制数目，默认值：20，最大值 100。

    */ Limit?: number; /** *

    分页查询偏移量，默认为 0。

    */ Offset?: number; } /** * ModifyApplicationProxyRule请求参数结构体 */ export interface ModifyApplicationProxyRuleRequest { /** * 站点ID。 */ ZoneId: string; /** * 代理ID。 */ ProxyId: string; /** * 规则ID。 */ RuleId: string; /** * 源站类型，取值有：
  • custom：手动添加；
  • origins：源站组。
    • */ OriginType: string; /** * 端口，支持格式：
  • 80：80端口；
  • 81-90：81至90端口。
    • */ Port: Array; /** * 协议，取值有：
  • TCP：TCP协议；
  • UDP：UDP协议。
    • 不填保持原有值。 */ Proto?: string; /** * 源站信息：
  • 当 OriginType 为 custom 时，表示一个或多个源站，如`["8.8.8.8","9.9.9.9"]` 或 `OriginValue=["test.com"]`；
  • 当 OriginType 为 origins 时，要求有且仅有一个元素，表示源站组ID，如`["origin-537f5b41-162a-11ed-abaa-525400c5da15"]`。
    • 不填保持原有值。 */ OriginValue?: Array; /** * 传递客户端IP，取值有：
  • TOA：TOA（仅Proto=TCP时可选）；
  • PPV1：Proxy Protocol传递，协议版本V1（仅Proto=TCP时可选）；
  • PPV2：Proxy Protocol传递，协议版本V2；
  • OFF：不传递。
    • 不填保持原有值。 */ ForwardClientIp?: string; /** * 是否开启会话保持，取值有：
  • true：开启；
  • false：关闭。
    • 不填为false。 */ SessionPersist?: boolean; /** * 会话保持的时间，单位为秒，只有当SessionPersist为true时，该值才会生效。 */ SessionPersistTime?: number; /** * 源站端口，支持格式：
  • 单端口：80；
  • 端口段：81-90，81至90端口。
    • */ OriginPort?: string; /** * 规则标签。不填保持原有值。 */ RuleTag?: string; } /** * 推理服务人工设置实例配置。 */ export interface InferenceManualInstanceConfig { /** * 固定实例数量。 */ FixedInstanceCount: number; } /** * CreateFunction返回参数结构体 */ export interface CreateFunctionResponse { /** * 函数 ID。 */ FunctionId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLoadBalancerList返回参数结构体 */ export interface DescribeLoadBalancerListResponse { /** * 负载均衡实例总数。 */ TotalCount?: number; /** * 负载均衡实例列表。 */ LoadBalancerList?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Bot主动特征识别客户端行为校验。 */ export interface AlgDetectJS { /** * 操作名称。 */ Name?: string; /** * 工作量证明 (proof_Of-Work)校验强度，默认low，取值有：
  • low：低；
  • middle：中；
  • high：高。
    • */ WorkLevel?: string; /** * 执行方式，js延迟执行的时间。单位为ms，默认500，取值：0～1000。 */ ExecuteMode?: number; /** * 客户端末启用JS（末完成检测）统计周期。单位为秒，默认10，取值：5～3600。 */ InvalidStatTime?: number; /** * 客户端末启用JS（末完成检测）触发阈值。单位为次，默认300，取值：1～100000000。 */ InvalidThreshold?: number; /** * Bot主动特征识别客户端行为校验结果。 */ AlgDetectResults?: Array; } /** * 规则引擎嵌套规则 */ export interface SubRuleItem { /** * 嵌套规则信息。 */ Rules: Array; /** * 规则标签。 */ Tags?: Array; } /** * DescribeL7AccRules返回参数结构体 */ export interface DescribeL7AccRulesResponse { /** * 规则总数。 */ TotalCount?: number; /** * 规则列表，规则按照从上到下的顺序执行，详情参考[规则生效优先级](https://cloud.tencent.com/document/product/1552/70901#.E4.BC.98.E5.85.88.E7.BA.A7)。 注意：此字段可能返回 null，表示取不到有效值。 */ Rules?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteSecurityIPGroup请求参数结构体 */ export interface DeleteSecurityIPGroupRequest { /** * 站点 Id。 */ ZoneId: string; /** * IP 组 Id。 */ GroupId: number; } /** * 源站组里的源站健康状态。 */ export interface OriginHealthStatus { /** * 源站。 */ Origin?: string; /** * 源站健康状态，取值有：
  • Healthy：健康；
  • Unhealthy：不健康；
  • Undetected：未探测到数据。
    • */ Healthy?: string; } /** * 自定义变量运算子规则分支。 */ export interface CustomVariableOperationRuleBranch { /** *

    匹配条件。

    */ Condition?: string; /** *

    操作。
    注意：Actions 和 SubRules 不可同时为空。

    注意：此字段可能返回 null，表示取不到有效值。 */ Actions?: Array; /** *

    子规则列表。此列表中若存在多条规则，按照从上往下的顺序依次执行。
    注意：SubRules 和 Actions 不可同时为空。且当前只支持填写一层 SubRules。

    注意：此字段可能返回 null，表示取不到有效值。 */ SubRules?: Array; } /** * Grpc配置项 */ export interface Grpc { /** * 是否开启 Grpc 配置，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch: string; } /** * CreateAliasDomain返回参数结构体 */ export interface CreateAliasDomainResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 回源时携带客户端IP所属地域信息，值的格式为ISO-3166-1两位字母代码。 */ export interface ClientIpCountry { /** * 配置开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch: string; /** * 存放客户端 IP 所属地域信息的请求头名称，当 Switch=on 时有效。 为空则使用默认值：EO-Client-IPCountry。 */ HeaderName?: string; } /** * DeleteSecurityClientAttester请求参数结构体 */ export interface DeleteSecurityClientAttesterRequest { /** * 站点 ID。 */ ZoneId: string; /** * 客户端认证选项 ID。 */ ClientAttesterIds?: Array; } /** * DeleteApplicationProxyRule请求参数结构体 */ export interface DeleteApplicationProxyRuleRequest { /** * 站点ID。 */ ZoneId: string; /** * 代理ID。 */ ProxyId: string; /** * 规则ID。 */ RuleId: string; } /** * 托管规则的项配置 */ export interface ManagedRuleAction { /** * 托管规则组下的具体项，用于改写此单条规则项配置的内容，具体参考产品文档。 */ RuleId: string; /** * RuleId 中指定托管规则项的处置动作。 SecurityAction 的 Name 取值支持：
  • Deny：拦截，响应拦截页面；
  • Monitor：观察，不处理请求记录安全事件到日志中；
  • Disabled：未启用，不扫描请求跳过该规则。
    • */ Action: SecurityAction; } /** * ModifyL7AccRule返回参数结构体 */ export interface ModifyL7AccRuleResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 自定义变量规则操作。 */ export interface CustomVariableOperationRuleAction { /** *

    操作名称。名称需要与参数结构体对应，例如 Name=Set，则 SetParameters 必填。当前仅支持填写 Set。

  • Set：自定义变量设置；
    • */ Name: string; /** *

    自定义变量设置参数。此参数中若存在多条运算，按照数组的顺序依次执行。当 Name 取值为 Set 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ SetParameters?: SetParameters; } /** * 站点归属权校验——文件校验信息。 */ export interface FileAscriptionInfo { /** * 文件校验目录。 */ IdentifyPath: string; /** * 文件校验内容。 */ IdentifyContent: string; } /** * CreateRealtimeLogDeliveryTask返回参数结构体 */ export interface CreateRealtimeLogDeliveryTaskResponse { /** *

    创建成功的任务ID。

    */ TaskId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 基于会话ID的亲和配置。 */ export interface SessionIdAffinityConfig { /** *

    会话 ID 参数的传递位置。不填写时默认为 Header。

    枚举值：

    • Header： 在请求头中传递参数。

    默认值：Header。

    */ Source?: string; /** *

    传递会话 ID 的请求头名称。当 Source 为 Header 时必填。
    不填写时默认为 EO-Infer-Session-Id。

    入参限制：长度为 1-64 个字符，仅支持字母、数字、中划线。

    默认值：EO-Infer-Session-Id。

    */ HeaderName?: string; } /** * DescribeTopL7CacheData返回参数结构体 */ export interface DescribeTopL7CacheDataResponse { /** * 查询结果的总条数。 */ TotalCount?: number; /** * 七层缓存TopN流量数据列表。 注意：此字段可能返回 null，表示取不到有效值。 */ Data?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeFunctionRuntimeEnvironment返回参数结构体 */ export interface DescribeFunctionRuntimeEnvironmentResponse { /** * 环境变量列表。 */ EnvironmentVariables?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInferenceServiceDeploymentLogs请求参数结构体 */ export interface DescribeInferenceServiceDeploymentLogsRequest { /** * 站点ID。 */ ZoneId: string; /** * 推理服务 ID。 */ ServiceId: string; /** * 部署记录 ID。 */ RecordId: string; /** * 需检索日志的开始时间。 */ StartTime?: string; /** * 需检索日志的结束时间。默认查询时间范围（EndTime - StartTime）为最近 7 天。 */ EndTime?: string; /** * 排序字段，取值有：
  • timestamp：日志生成时间。
    • 默认值为：timestamp。 */ SortBy?: string; /** * 排序方式，取值有：
  • asc：升序方式；
  • desc：降序方式。
    • 默认值为：desc。 */ SortOrder?: string; /** * 分页偏移量，默认值：0。 */ Offset?: number; /** * 返回记录条数，默认值：20，最大值：1000。 */ Limit?: number; } /** * gRPC 配置项。 */ export interface GrpcParameters { /** * gRPC 配置开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch?: string; } /** * 自定义变量设置参数。 */ export interface SetParameters { /** *

    自定义变量名称。自定义变量必须先被定义才可进行运算。

    */ Name: string; /** *

    自定义变量赋值。支持使用常量字符串、变量以及公式，不支持中文。长度不能超过 1000 个字符。

    */ Value: string; } /** * Bot 自定义规则的配置。 */ export interface BotManagementCustomRules { /** * Bot 自定义规则的列表。使用 ModifySecurityPolicy 修改 Web 防护配置时：
  • 若未指定 SecurityPolicy.BotManagement.CustomRules 中的 Rules 参数，或 Rules 参数长度为零：清空所有 Bot 自定义规则配置。
  • 若 SecurityPolicy.BotManagement 参数中，未指定 CustomRules 参数值：保持已有 Bot 自定义规则配置，不做修改。
    • */ Rules?: Array; } /** * 当回源 IP 网段发生更新时，该字段会返回下一个版本将要生效的回源 IP 网段，包含与当前生效的回源 IP 网段的对比。 */ export interface MultiPathGatewayNextOriginACL { /** * 版本号。 */ Version?: number; /** * 回源 IP 网段详情。 */ EntireAddresses?: Addresses; /** * 最新回源 IP 网段相较于 MultiPathGatewayCurrentOrginACL 中回源 IP 网段新增的部分。 */ AddedAddresses?: Addresses; /** * 最新回源 IP 网段相较于 MultiPathGatewayCurrentOrginACL 中回源 IP 网段删减的部分。 */ RemovedAddresses?: Addresses; /** * 最新回源 IP 网段相较于 MultiPathGatewayCurrentOrginACL 中回源 IP 网段无变化的部分。 */ NoChangeAddresses?: Addresses; } /** * 规则引擎可应用于匹配请求的设置详细信息，可选参数配置项 */ export interface RuleChoicePropertiesItem { /** * 参数名称。 */ Name: string; /** * 参数值类型。
  • CHOICE：参数值只能在 ChoicesValue 中选择；
  • TOGGLE：参数值为开关类型，可在 ChoicesValue 中选择；
  • CUSTOM_NUM：参数值用户自定义，整型类型；
  • CUSTOM_STRING：参数值用户自定义，字符串类型。
    • */ Type: string; /** * 参数值的可选值。 注意：若参数值为用户自定义则该数组为空数组。 */ ChoicesValue: Array; /** * 数值参数的最小值，非数值参数或 Min 和 Max 值都为 0 则此项无意义。 */ Min: number; /** * 数值参数的最大值，非数值参数或 Min 和 Max 值都为 0 则此项无意义。 */ Max: number; /** * 参数值是否支持多选或者填写多个。 */ IsMultiple: boolean; /** * 是否允许为空。 */ IsAllowEmpty: boolean; /** * 特殊参数。
  • 为 NULL：RuleAction 选择 NormalAction；
  • 成员参数 Id 为 Action：RuleAction 选择 RewirteAction；
  • 成员参数 Id 为 StatusCode：RuleAction 选择 CodeAction。
    • */ ExtraParameter: RuleExtraParameter; } /** * DescribeSecurityTemplateBindings返回参数结构体 */ export interface DescribeSecurityTemplateBindingsResponse { /** * 指定策略模板的绑定关系列表。 当某个站点中的域名包含在指定策略模板的绑定关系中时，绑定关系列表 `TemplateScope` 中会包含该站点的 `ZoneId`，和该站点下的和该策略模板有关的域名绑定关系。 注意：当没有任何域名正在绑定或已经绑定到指定策略模板时，绑定关系为空。即：返回结构体中，`TemplateScope` 数组长度为 0。 绑定关系中，同一域名可能在 `EntityStatus` 列表中重复出现，并标记为不同 `Status` 。例如，正在被绑定到其他策略模板的域名，会同时标记为 `online` 和 `pending` 。 */ SecurityTemplate?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 内容标识配置参数。 */ export interface SetContentIdentifierParameters { /** * 内容标识id */ ContentIdentifier?: string; } /** * ModifyAliasDomainStatus返回参数结构体 */ export interface ModifyAliasDomainStatusResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 自定义变量运算子规则。 */ export interface CustomVariableOperationSubRule { /** *

    子规则分支

    注意：此字段可能返回 null，表示取不到有效值。 */ Branches?: Array; /** *

    规则注释。

    */ Description?: Array; } /** * DeleteFunctionRules请求参数结构体 */ export interface DeleteFunctionRulesRequest { /** * 站点 ID。 */ ZoneId: string; /** * 规则 ID 列表。 */ RuleIds: Array; } /** * DescribeTimingL7AnalysisData请求参数结构体 */ export interface DescribeTimingL7AnalysisDataRequest { /** *

    开始时间。

    */ StartTime: string; /** *

    结束时间。查询时间范围（EndTime - StartTime）需小于等于 31 天。

    */ EndTime: string; /** *

    指标列表，取值有:

  • l7Flow_outFlux: L7 EdgeOne 响应流量，单位：Byte；
  • l7Flow_inFlux: L7 客户端请求流量，单位：Byte；
  • l7Flow_flux: L7 访问总流量（EdgeOne 响应+客户端请求），单位：Byte；
  • l7Flow_outBandwidth: L7 EdgeOne 响应带宽，单位：bps；
  • l7Flow_inBandwidth：L7 客户端请求带宽，单位：bps；
  • l7Flow_bandwidth：L7 访问总带宽（EdgeOne 响应+客户端请求），单位：bps；
  • l7Flow_request: L7 访问请求数，单位：次；
  • l7Flow_avgResponseTime: L7 访问平均响应耗时，单位：ms；
  • l7Flow_avgFirstByteResponseTime: L7 访问平均首字节响应耗时，单位：ms；
  • l7Flow_requestRate: L7 访问请求速率，单位：qps。
    • */ MetricNames: Array; /** *

    站点 ID 集合，此参数将于2024年05月30日后由可选改为必填，详见公告：【腾讯云 EdgeOne】云 API 变更通知。最多传入 100 个站点 ID。若需查询腾讯云主账号下所有站点数据，请用 * 代替，查询账号级别数据需具备本接口全部站点资源权限。

    */ ZoneIds?: Array; /** *

    查询时间粒度。

    枚举值：

    • min： 1分钟
    • 5min： 5分钟
    • hour： 1小时
    • day： 1天

    不填将根据开始时间跟结束时间的间距自动推算粒度，具体为：2 小时范围内以 min 粒度查询，2 天范围内以 5min 粒度查询，7 天范围内以 hour 粒度查询，超过 7 天以 day 粒度查询。

    */ Interval?: string; /** *

    筛选数据时使用的过滤条件，取值参考 指标分析筛选条件说明 中针对 L7 访问流量、带宽、请求数的可用筛选项。
    如需限定站点或内容标识符，请在 ZoneIds.N 参数中另行传入对应的值。

    */ Filters?: Array; /** *

    数据归属地区。该参数已废弃。请在 Filters.country 中按客户端地域过滤数据。

    */ Area?: string; } /** * 不缓存配置 */ export interface NoCache { /** * 不缓存配置开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch: string; } /** * ModifyFunction请求参数结构体 */ export interface ModifyFunctionRequest { /** * 站点 ID。 */ ZoneId: string; /** * 函数 ID。 */ FunctionId: string; /** * 函数描述，最大支持 60 个字符，不填写保持原有配置。 */ Remark?: string; /** * 函数内容，当前仅支持 JavaScript 代码，最大支持 5MB 大小，不填写保持原有配置。 */ Content?: string; } /** * 托管规则组配置。 */ export interface ManagedRuleGroup { /** * 托管规则的组名称，未指定配置的规则分组将按照默认配置处理，GroupId 的具体取值参考产品文档。 */ GroupId: string; /** * 托管规则组的防护级别。取值有：
  • loose：宽松，只包含超高风险规则，此时需配置Action，且RuleActions配置无效；
  • normal：正常，包含超高风险和高风险规则，此时需配置Action，且RuleActions配置无效；
  • strict：严格，包含超高风险、高风险和中风险规则，此时需配置Action，且RuleActions配置无效；
  • extreme：超严格，包含超高风险、高风险、中风险和低风险规则，此时需配置Action，且RuleActions配置无效；
  • custom：自定义，精细化策略，按单条规则配置处置方式，此时Action字段无效，使用RuleActions配置单条规则的精细化策略。
    • */ SensitivityLevel: string; /** * 托管规则组的处置动作。SecurityAction 的 Name 取值支持：
  • Deny：拦截，响应拦截页面；
  • Monitor：观察，不处理请求记录安全事件到日志中；
  • Disabled：未启用，不扫描请求跳过该规则。
    • */ Action: SecurityAction; /** * 托管规则组下规则项的具体配置，仅在 SensitivityLevel 为 custom 时配置生效。 */ RuleActions?: Array; /** * 托管规则组信息，仅出参。 */ MetaData?: ManagedRuleGroupMeta; } /** * DummyParseZoneFullConfig返回参数结构体 */ export interface DummyParseZoneFullConfigResponse { /** *

    站点完整配置结构。

    */ ZoneFullConfig?: ZoneFullConfig; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Cookie 校验和会话跟踪行为具体配置。 */ export interface BotSessionValidation { /** * 是否更新 Cookie 并校验。取值有：
  • on：更新 Cookie 并校验；
  • off：仅校验。
    • */ IssueNewBotSessionCookie?: string; /** * 更新 Cookie 并校验时的触发阈值，仅当 IssueNewBotSessionCookie 为 on 时有效。 */ MaxNewSessionTriggerConfig?: MaxNewSessionTriggerConfig; /** * 未携带 Cookie 或 Cookie 已过期的执行动作。 SecurityAction 的 Name 取值支持：
  • Deny：拦截，其中 DenyActionParameters 中支持 Stall 配置；
  • Monitor：观察；
  • Allow：等待后响应，其中 AllowActionParameters 需要 MinDelayTime 和 MaxDelayTime 配置。
    • */ SessionExpiredAction?: SecurityAction; /** * 不合法 Cookie 的执行动作。 SecurityAction 的 Name 取值支持：
  • Deny：拦截，其中 DenyActionParameters 中支持 Stall 配置；
  • Monitor：观察；
  • Allow：等待后响应，其中 AllowActionParameters 需要 MinDelayTime 和 MaxDelayTime 配置。
    • */ SessionInvalidAction?: SecurityAction; /** * 会话速率和周期特征校验的具体配置。 */ SessionRateControl?: SessionRateControl; } /** * 安全策略配置 */ export interface SecurityPolicy { /** *

    自定义规则配置。

    */ CustomRules?: CustomRules; /** *

    托管规则配置。

    */ ManagedRules?: ManagedRules; /** *

    HTTP DDOS 防护配置。

    */ HttpDDoSProtection?: HttpDDoSProtection; /** *

    速率限制规则配置。

    */ RateLimitingRules?: RateLimitingRules; /** *

    例外规则配置。

    */ ExceptionRules?: ExceptionRules; /** *

    Bot 管理配置。

    */ BotManagement?: BotManagement; /** *

    基础 Bot 管理配置。

    */ BotManagementLite?: BotManagementLite; /** *

    默认拦截动作配置。

    */ DefaultDenySecurityActionParameters?: DefaultDenySecurityActionParameters; /** *

    回源请求携带安全头部配置，配置生效后将携带对应 keyname 的请求头部回源。

    */ SecurityHeadersToOrigin?: SecurityHeadersToOrigin; } /** * 站点归属信息 */ export interface AscriptionInfo { /** * 主机记录。 */ Subdomain?: string; /** * 记录类型。 */ RecordType?: string; /** * 记录值。 */ RecordValue?: string; } /** * DescribeInferenceServiceDeploymentRecords请求参数结构体 */ export interface DescribeInferenceServiceDeploymentRecordsRequest { /** *

    站点 ID。

    */ ZoneId: string; /** *

    推理服务 ID。

    */ ServiceId: string; /** *

    排序字段，取值有：

  • create-time：部署创建时间。
    • 默认值为：create-time。

    */ SortBy?: string; /** *

    排序方式，取值有：

  • asc：升序方式；
  • desc：降序方式。
    • 默认值为：desc。

    */ SortOrder?: string; /** *

    分页偏移量，默认值：0。

    */ Offset?: number; /** *

    返回记录条数，默认值：20，最大值：100。

    */ Limit?: number; } /** * ModifySecurityClientAttester返回参数结构体 */ export interface ModifySecurityClientAttesterResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CheckFreeCertificateVerification返回参数结构体 */ export interface CheckFreeCertificateVerificationResponse { /** * 免费证书申请成功时，该证书颁发给的域名。 注意：一个域名只允许申请一本免费证书， 如果已经有泛域名申请了免费证书的情况下，其子域名会匹配使用该泛域名证书。 */ CommonName?: string; /** * 免费证书申请成功时，该证书使用的签名算法，当前仅支持 RSA 2048。 */ SignatureAlgorithm?: string; /** * 免费证书申请成功时，该证书的过期时间。时间为世界标准时间（UTC）， 遵循 ISO 8601 标准的日期和时间格式。 */ ExpireTime?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 慢速攻击的首段包配置。 */ export interface FirstPartConfig { /** * 开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch: string; /** * 首段包的统计时长，单位是秒，即期望首段包的统计时长是多少，默认5秒。 */ StatTime?: number; } /** * 无 */ export interface Waf { /** * Waf开关，取值为：
  • on：开启；
  • off：关闭。
    • */ Switch: string; /** * 策略ID。 */ PolicyId?: number; } /** * CreateApplicationProxyRule请求参数结构体 */ export interface CreateApplicationProxyRuleRequest { /** * 站点ID。 */ ZoneId: string; /** * 代理ID。 */ ProxyId: string; /** * 协议，取值有：
  • TCP：TCP协议；
  • UDP：UDP协议。
    • */ Proto: string; /** * 端口，支持格式：
  • 80：80端口；
  • 81-90：81至90端口。
    • */ Port: Array; /** * 源站类型，取值有：
  • custom：手动添加；
  • loadbalancer：负载均衡；
  • origins：源站组。
    • */ OriginType: string; /** * 源站信息：
  • 当 OriginType 为 custom 时，表示一个或多个源站，如`["8.8.8.8","9.9.9.9"]` 或 `OriginValue=["test.com"]`；
  • 当 OriginType 为 loadbalancer 时，表示一个负载均衡，如`["lb-xdffsfasdfs"]`；
  • 当 OriginType 为 origins 时，要求有且仅有一个元素，表示源站组ID，如`["origin-537f5b41-162a-11ed-abaa-525400c5da15"]`。
    • */ OriginValue: Array; /** * 传递客户端IP，取值有：
  • TOA：TOA（仅Proto=TCP时可选）；
  • PPV1：Proxy Protocol传递，协议版本V1（仅Proto=TCP时可选）；
  • PPV2：Proxy Protocol传递，协议版本V2；
  • OFF：不传递。
    • 默认值：OFF。 */ ForwardClientIp?: string; /** * 是否开启会话保持，取值有：
  • true：开启；
  • false：关闭。
    • 默认值：false。 */ SessionPersist?: boolean; /** * 会话保持的时间，单位为秒，只有当SessionPersist为true时，该值才会生效。 */ SessionPersistTime?: number; /** * 源站端口，支持格式：
  • 单端口：80；
  • 端口段：81-90，81至90端口。
    • */ OriginPort?: string; /** * 规则标签。默认值为空字符串。 */ RuleTag?: string; } /** * 即时转码模板详情。 */ export interface JustInTimeTranscodeTemplate { /** * 即时转码模板唯一标识。 */ TemplateId?: string; /** * 转码模板名称。 */ TemplateName?: string; /** * 模板描述信息。 */ Comment?: string; /** * 模板类型，取值：
  • preset：系统预置模板；
  • custom：用户自定义模板。
    • */ Type?: string; /** * 启用视频流开关，取值：
  • on：开启；
  • off：关闭。
    • */ VideoStreamSwitch?: string; /** * 启用音频流开关，取值：
  • on：开启；
  • off：关闭。
    • */ AudioStreamSwitch?: string; /** * 视频流配置参数，仅当 VideoStreamSwitch 为 on，该字段有效。 */ VideoTemplate?: VideoTemplateInfo; /** * 音频流配置参数，仅当 AudioStreamSwitch 为 on，该字段有效。 */ AudioTemplate?: AudioTemplateInfo; /** * 模板创建时间，使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。 */ CreateTime?: string; /** * 模板最后修改时间，使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。 */ UpdateTime?: string; } /** * ModifyInferenceService返回参数结构体 */ export interface ModifyInferenceServiceResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDnsRecords返回参数结构体 */ export interface DescribeDnsRecordsResponse { /** * DNS 记录总数。 */ TotalCount?: number; /** * DNS 记录列表。 */ DnsRecords?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateWebSecurityTemplate请求参数结构体 */ export interface CreateWebSecurityTemplateRequest { /** * 站点 ID。该参数明确策略模板在访问权限上归属的站点。 */ ZoneId: string; /** * 策略模板名称。由中文、英文、数字和下划线组成，不能以下划线开头，且长度不能超过 32 个字符。 */ TemplateName: string; /** * 安全策略模板配置内容，字段为空时生成默认配置。目前支持 Web 防护模块中的例外规则、自定义规则、速率限制规则和托管规则配置，通过表达式语法对安全策略进行配置。 Bot 管理规则配置暂不支持，正在开发中。 */ SecurityPolicy?: SecurityPolicy; } /** * CreateL4Proxy请求参数结构体 */ export interface CreateL4ProxyRequest { /** * 站点 ID。 */ ZoneId: string; /** * 四层代理实例名称，可输入 1-50 个字符，允许的字符为 a-z、0-9、-，且 - 不能单独注册或连续使用，不能放在开头或结尾。创建完成后不支持修改。 */ ProxyName: string; /** * 四层代理实例加速区域。
  • mainland：中国大陆可用区；
  • overseas：全球可用区（不含中国大陆）；
  • global：全球可用区。
    • */ Area: string; /** * 是否开启 IPv6 访问，不填写时默认为 off。该配置仅在部分加速区域和安全防护配置下支持开启，详情请参考 [新建四层代理实例](https://cloud.tencent.com/document/product/1552/90025) 。取值为：
  • on：开启；
  • off：关闭。
    • */ Ipv6?: string; /** * 是否开启固定 IP，不填写时默认为 off。该配置仅在部分加速区域和安全防护配置下支持开启，详情请参考 [新建四层代理实例](https://cloud.tencent.com/document/product/1552/90025) 。取值为：
  • on：开启；
  • off：关闭。
    • */ StaticIp?: string; /** * 是否开启中国大陆网络优化，不填写时默认为 off。该配置仅在部分加速区域和安全防护配置下支持开启，详情请参考 [新建四层代理实例](https://cloud.tencent.com/document/product/1552/90025) 。取值为：
  • on：开启；
  • off：关闭。
    • */ AccelerateMainland?: string; /** * L3/L4 DDoS 防护配置，不填写时默认使用平台默认防护选项。详情参考 [独立 DDoS 防护](https://cloud.tencent.com/document/product/1552/95994)。 本字段已废弃，请使用 DDosProtectionId 字段指定关联的DDoS防护配置。 * @deprecated */ DDosProtectionConfig?: DDosProtectionConfig; } /** * 推理容器运行时的环境变量。 */ export interface InferenceEnvironmentVariable { /** * 变量名。仅允许包含大小写字母、数字、下划线，且必须以字母或下划线开头。长度限制不超过 64 个字符。 */ Key: string; /** * 变量值。支持任意可见字符如字母、数字、符号等。长度限制不超过 2048 个字符。 */ Value?: string; } /** * CreatePlan返回参数结构体 */ export interface CreatePlanResponse { /** * 套餐 ID，形如 edgeone-2unuvzjmmn2q。 */ PlanId?: string; /** * 订单号。 */ DealName?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeApplicationProxies请求参数结构体 */ export interface DescribeApplicationProxiesRequest { /** * 站点ID。该参数必填。 */ ZoneId?: string; /** * 过滤条件，Filters.Values的上限为20。详细的过滤条件如下：
  • proxy-id
       按照【代理ID】进行过滤。代理ID形如：proxy-ev2sawbwfd。
       类型：String
       必选：否
  • zone-id
       按照【站点ID】进行过滤。站点ID形如：zone-vawer2vadg。
       类型：String
       必选：否
  • rule-tag
       按照【规则标签】对应用代理下的规则进行过滤。规则标签形如：rule-service-1。
       类型：String
       必选：否
    • */ Filters?: Array; /** * 分页查询偏移量。默认为0。 */ Offset?: number; /** * 分页查询限制数目。默认值：20，最大值：1000。 */ Limit?: number; } /** * DescribeIPGroupReferences请求参数结构体 */ export interface DescribeIPGroupReferencesRequest { /** *

    站点 ID。

    */ ZoneId: string; /** *

    IP 组 ID。

    */ GroupId: number; /** *

    分页偏移量。

    默认值：0

    */ Offset?: number; /** *

    分页查询引用 IP 组的配置条数。

    取值范围：[1, 200]

    默认值：20

    */ Limit?: number; } /** * 多通道安全网关线路信息 */ export interface MultiPathGatewayLine { /** * 线路 ID ， 其中 line-0 和 line-1 为系统内置线路 ID，取值有:
  • line-0：直连线路，不支持添加、编辑和删除；
  • line-1： EdgeOne 四层代理线路，支持修改实例和规则，不支持删除；
  • line-2 及以上：EdgeOne 四层代理线路或者自定义线路，支持修改、删除实例和规则。
    • */ LineId?: string; /** * 线路类型，取值有：
  • direct ：直连线路，不支持编辑、不支持删除；
  • proxy ：EdgeOne 四层代理线路，支持编辑修改实例和规则，不支持删除；
  • custom ：自定义线路，支持编辑、支持删除。
    • */ LineType?: string; /** * 线路地址，格式为 host:port 。 */ LineAddress?: string; /** * 四层代理实例 ID ，当线路类型 LineType 取值为 proxy（EdgeOne 四层代理）返回。 */ ProxyId?: string; /** * 转发规则 ID ，当线路类型 LineType 取值为 proxy（EdgeOne 四层代理）返回。 */ RuleId?: string; } /** * Web 安全 Allow 的附加参数 */ export interface AllowActionParameters { /** * 最小延迟响应时间，当配置为 0s 时，表示不延迟直接响应。支持的单位有：
  • s：秒，取值范围 0～5。
    • */ MinDelayTime?: string; /** * 最大延迟响应时间，支持的单位有：
  • s：秒，取值范围 5～10。
    • */ MaxDelayTime?: string; } /** * 日志分析的日志信息 */ export interface LogItem { /** * 日志产生的时间点，采用 unix 毫秒级时间戳。 */ Timestamp?: number; /** * 日志的具体内容，采用JSON字符串格式。 */ LogJson?: string; } /** * 推理服务资源配置的修改参数。 */ export interface InferenceResourceConfigForModify { /** *

    扩容缩容的方式。取值有：

  • Auto：根据请求量自动调整实例数量；
  • Manual：人工设置固定的实例数量。

    • */ ScalingMode?: string; /** *

    推理服务自动伸缩配置。当 ScalingMode 为 Auto 时必填。

    */ AutoScalingConfig?: InferenceAutoScalingConfig; /** *

    推理服务人工设置实例配置。当 ScalingMode 为 Manual 时必填。

    */ ManualInstanceConfig?: InferenceManualInstanceConfig; /** *

    单实例的并发数。默认值为 1。

    */ Concurrency?: number; /** *

    推理服务的硬件资源配置。

    */ HardwareConfig?: InferenceHardwareConfigForModify; } /** * Hsts配置 */ export interface Hsts { /** * 是否开启，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch: string; /** * MaxAge 数值。单位为秒，最大值为1天。 */ MaxAge?: number; /** * 是否包含子域名，取值有：
  • on：开启；
  • off：关闭。
    • */ IncludeSubDomains?: string; /** * 是否开启预加载，取值有：
  • on：开启；
  • off：关闭。
    • */ Preload?: string; } /** * 该结构体表示各种场景、模式下，用于验证用户对站点域名的归属权内容。 */ export interface OwnershipVerification { /** * CNAME 、无域名接入时，使用 DNS 解析验证时所需的信息。详情参考 [站点/域名归属权验证 ](https://cloud.tencent.com/document/product/1552/70789#7af6ecf8-afca-4e35-8811-b5797ed1bde5)。 注意：此字段可能返回 null，表示取不到有效值。 */ DnsVerification?: DnsVerification; /** * CNAME 、无域名接入时，使用文件验证时所需的信息。详情参考 [站点/域名归属权验证 ](https://cloud.tencent.com/document/product/1552/70789#7af6ecf8-afca-4e35-8811-b5797ed1bde5)。 注意：此字段可能返回 null，表示取不到有效值。 */ FileVerification?: FileVerification; /** * NS 接入，切换 DNS 服务器所需的信息。详情参考 [修改 DNS 服务器](https://cloud.tencent.com/document/product/1552/90452)。 注意：此字段可能返回 null，表示取不到有效值。 */ NsVerification?: NsVerification; } /** * CreateRule请求参数结构体 */ export interface CreateRuleRequest { /** * 站点 ID。 */ ZoneId: string; /** * 规则名称，名称字符串长度 1～255。 */ RuleName: string; /** * 规则状态，取值有：
  • enable: 启用；
  • disable: 未启用。
    • */ Status: string; /** * 规则内容。 */ Rules: Array; /** * 规则标签。 */ Tags?: Array; } /** * ModifyL4ProxyStatus请求参数结构体 */ export interface ModifyL4ProxyStatusRequest { /** * 站点 ID。 */ ZoneId: string; /** * 四层代理实例 ID。 */ ProxyId: string; /** * 四层代理实例状态，取值有：
  • online：启用；
  • offline：停用。
    • */ Status: string; } /** * DescribeSecurityPolicy返回参数结构体 */ export interface DescribeSecurityPolicyResponse { /** * 安全策略配置。 注意：此字段可能返回 null，表示取不到有效值。 */ SecurityPolicy?: SecurityPolicy; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 套餐信息 */ export interface Plan { /** * 套餐类型。取值有：
  • plan-trial: 试用版套餐；
  • plan-personal: 个人版套餐；
  • plan-basic: 基础版套餐；
  • plan-standard: 标准版套餐；
  • plan-enterprise-v2: 企业版套餐；
  • plan-enterprise-model-a: 企业版 Model A 套餐。
  • plan-enterprise: 旧企业版套餐。
    • */ PlanType?: string; /** * 套餐 ID。形如 edgeone-2y041pblwaxe。 */ PlanId?: string; /** * 服务区域，取值有：
  • mainland: 中国大陆；
  • overseas: 全球（不包括中国大陆）；
  • global: 全球（包括中国大陆）。
    • */ Area?: string; /** * 自动续费开关。取值有：
  • true: 已开启自动续费；
  • false: 未开启自动续费。
    • */ AutoRenewal?: boolean; /** * 套餐状态，取值有：
  • normal：正常状态；
  • expiring-soon：即将到期状态；
  • expired：到期状态；
  • isolated：隔离状态；
  • overdue-isolated：欠费隔离状态。
    • */ Status?: string; /** * 付费类型，取值有：
  • 0: 后付费；
  • 1: 预付费。
    • */ PayMode?: number; /** * 套餐绑定的站点信息，包括站点id和站点名称，站点状态。 */ ZonesInfo?: Array; /** * 套餐内智能加速请求数规格，单位：次。 */ SmartRequestCapacity?: number; /** * 套餐内VAU规格，单位：个。 */ VAUCapacity?: number; /** * 套餐内内容加速流量规格，单位：字节。 */ AccTrafficCapacity?: number; /** * 套餐内智能加速流量规格，单位：字节。 */ SmartTrafficCapacity?: number; /** * 套餐内DDoS防护流量规格，单位：字节。 */ DDoSTrafficCapacity?: number; /** * 套餐内安全流量规格，单位：字节。 */ SecTrafficCapacity?: number; /** * 套餐内安全请求数规格，单位：次。 */ SecRequestCapacity?: number; /** * 套餐内四层加速流量规格，单位：字节。 */ L4TrafficCapacity?: number; /** * 套餐内中国大陆网络优化流量规格，单位：字节。 */ CrossMLCTrafficCapacity?: number; /** * 套餐是否允许绑定新站点，取值有：
  • true: 允许绑定新站点；
  • false: 不允许绑定新站点。
    • */ Bindable?: string; /** * 套餐生效时间。 */ EnabledTime?: string; /** * 套餐过期时间。 */ ExpiredTime?: string; /** * 套餐所支持的功能，取值有：
  • ContentAcceleration：内容加速功能；
  • SmartAcceleration：智能加速功能；
  • L4：四层加速功能；
  • Waf：高级 Web 防护；
  • QUIC：QUIC功能；
  • CrossMLC：中国大陆网络优化功能；
  • ProcessMedia：媒体处理功能；
  • L4DDoS：四层DDoS防护功能；
    • L7DDoS功能只会出现以下所有规格中的一项
  • L7DDoS.CM30G；七层DDoS防护功能-中国大陆30G保底带宽规格；
  • L7DDoS.CM60G；七层DDoS防护功能-中国大陆60G保底带宽规格；
  • L7DDoS.CM100G；七层DDoS防护功能-中国大陆100G保底带宽规格；
  • L7DDoS.Anycast300G；七层DDoS防护功能-中国大陆以外Anycast300G保底带宽规格；
  • L7DDoS.AnycastUnlimited；七层DDoS防护功能-中国大陆以外Anycast无上限全力防护规格；
  • L7DDoS.CM30G_Anycast300G；七层DDoS防护功能-中国大陆30G保底带宽规格，中国大陆以外Anycast300G保底带宽规格；
  • L7DDoS.CM60G_Anycast300G；七层DDoS防护功能-中国大陆60G保底带宽规格，中国大陆以外Anycast300G保底带宽规格；
  • L7DDoS.CM100G_Anycast300G；七层DDoS防护功能-中国大陆100G保底带宽规格，中国大陆以外Anycast300G保底带宽规格；
  • L7DDoS.CM30G_AnycastUnlimited；七层DDoS防护功能-中国大陆30G保底带宽规格，中国大陆以外Anycast无上限全力防护规格；
  • L7DDoS.CM60G_AnycastUnlimited；七层DDoS防护功能-中国大陆60G保底带宽规格，中国大陆以外Anycast无上限全力防护规格；
  • L7DDoS.CM100G_AnycastUnlimited；七层DDoS防护功能-中国大陆100G保底带宽规格，中国大陆以外Anycast无上限全力防护规格；
    • */ Features?: Array; } /** * DescribeInferenceServiceMonitorData请求参数结构体 */ export interface DescribeInferenceServiceMonitorDataRequest { /** *

    站点 ID。

    */ ZoneId: string; /** *

    推理服务 ID。最多传入10个推理服务 ID。

    */ ServiceIds: Array; /** *

    指标列表，最多支持 10 个指标。取值有：

  • cpu_usage_average: CPU 平均使用率，单位：%，指标类型：Float；
  • cpu_usage_max: CPU 最大使用率，单位：%，指标类型：Float；
  • gpu_usage_average: GPU 平均使用率，单位：%，指标类型：Float；
  • gpu_usage_max: GPU 最大使用率，单位：%，指标类型：Float；
  • instance_num_average: 实例平均数量，单位：个，指标类型：Float；
  • instance_num_max: 实例最大数量，单位：个，指标类型：Float；
  • gpu_memory_usage_max: 显存最大使用率，单位：%，指标类型：Float；
  • memory_usage_average: 内存平均使用率，单位：%，指标类型：Float；
  • memory_usage_max: 内存最大使用率，单位：%，指标类型：Float；

    • */ MetricNames: Array; /** *

    开始时间。

    */ StartTime: string; /** *

    结束时间。查询时间范围（EndTime - StartTime）需小于等于 30 天。

    */ EndTime: string; /** *

    查询时间粒度，取值有：

  • min: 1分钟，支持1天范围内的查询；
  • 5min: 5分钟，支持7天范围内的查询；
  • hour: 1小时，支持30天范围内的查询；
  • day: 1天，支持30天范围内的查询；
    • 不填将根据开始时间跟结束时间的间距自动推算粒度，具体为：2小时范围内以 min 粒度查询，2天范围内以 5min 粒度查询，7天范围内以 hour 粒度查询，超过7天以 day 粒度查询。 */ Interval?: string; } /** * CreateApplicationProxyRule返回参数结构体 */ export interface CreateApplicationProxyRuleResponse { /** * 规则ID */ RuleId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 源站组记录 */ export interface OriginRecord { /** * 源站记录值，不包含端口信息，可以为：IPv4，IPv6，域名格式。 */ Record: string; /** * 源站类型，取值有：
  • IP_DOMAIN：IPV4、IPV6、域名类型源站；
  • COS：COS源。
  • AWS_S3：AWS S3对象存储源站。
    • */ Type?: string; /** * 源站记录ID。 */ RecordId?: string; /** * 【源站权重】：用于控制流量分配优先级的参数，取值范围：0-100（整数）：
  • 空值：不设置权重，系统按默认策略调度；
  • 0 值：明确设置权重为0，流量将不会分配到该源站，注意事项：必须确保至少有一个源站的权重值大于0；
  • 正常值：数值越大分配流量越多 ；
    • 注意：此字段可能返回 null，表示取不到有效值。 */ Weight?: number; /** * 是否私有鉴权，当源站类型 RecordType=COS/AWS_S3 时生效，取值有：
  • true：使用私有鉴权；
  • false：不使用私有鉴权。
    • 不填写，默认值为：false。 */ Private?: boolean; /** * 私有鉴权参数，当源站类型Private=true时有效。 */ PrivateParameters?: Array; } /** * 速率限制的具体配置。 */ export interface RateLimitingRule { /** * 精准速率限制的 ID。
    通过规则 ID 可支持不同的规则配置操作：
  • 增加新规则：ID 为空或不指定 ID 参数；
  • 修改已有规则：指定需要更新/修改的规则 ID；
  • 删除已有规则：RateLimitingRules 参数中，Rules 列表中未包含的已有规则将被删除。
    • */ Id?: string; /** * 精准速率限制的名称。 */ Name?: string; /** * 精准速率限制的具体内容，需符合表达式语法，详细规范参见[产品文档](https://cloud.tencent.com/document/product/1552/125343)。 */ Condition?: string; /** * 限速方式。在统计时间窗口 CountingPeriod 内，对满足特征 CountBy 的请求，支持配置以下限速方式：
  • Block: 阻断访问源。当统计次数超过阈值 MaxRequestThreshold 时，在 ActionDuration 时长内，对满足特征的所有后续请求执行 Action 处置；
  • Throttle: 仅处置超额请求。当统计次数超过阈值 MaxRequestThreshold 时，仅对超过阈值的请求执行 Action 处置，窗口结束后停止处置。此时，ActionDuration 参数将被忽略。

    • 默认值为 Block。 */ Mode?: string; /** * 速率阈值请求特征的匹配方式， 当 Enabled 为 on 时，此字段必填。

    当条件有多个时，将组合多个条件共同进行统计计算，条件最多不可超过5条。取值有：
  • http.request.ip：客户端 IP；
  • http.request.xff_header_ip：客户端 IP（优先匹配 XFF 头部）；
  • http.request.uri.path：请求的访问路径；
  • http.request.cookies['session']：名称为 session 的 Cookie，其中 session 可替换为自己指定的参数；
  • http.request.headers['user-agent']：名称为 user-agent 的 HTTP 头部，其中 user-agent 可替换为自己指定的参数；
  • http.request.ja3：请求的 JA3 指纹；
  • http.request.ja4：请求的 JA4 指纹；
  • http.request.uri.query['test']：名称为 test 的 URL 查询参数，其中 test 可替换为自己指定的参数。
    • */ CountBy?: Array; /** * 精准速率限制在时间范围内的累计拦截次数，取值范围 1 ~ 100000。 */ MaxRequestThreshold?: number; /** * 统计的时间窗口，取值有：
  • 1s：1秒；
  • 5s：5秒；
  • 10s：10秒；
  • 20s：20秒；
  • 30s：30秒；
  • 40s：40秒；
  • 50s：50秒；
  • 1m：1分钟；
  • 2m：2分钟；
  • 5m：5分钟；
  • 10m：10分钟；
  • 1h：1小时。
    • */ CountingPeriod?: string; /** * Action 动作的持续时长，单位仅支持：
  • s：秒，取值 1 ~ 120；
  • m：分钟，取值 1 ~ 120；
  • h：小时，取值 1 ~ 48；
  • d：天，取值 1 ~ 30。

    • 当 Mode 为 Throttle 时，此参数将被忽略，不会生效。 */ ActionDuration?: string; /** * 精准速率限制的处置方式。取值有：
  • Monitor：观察；
  • Deny：拦截，其中DenyActionParameters.Name支持Deny和ReturnCustomPage；
  • Challenge：挑战，其中ChallengeActionParameters.Name支持JSChallenge和ManagedChallenge；
  • Redirect：重定向至URL；
    • */ Action?: SecurityAction; /** * 精准速率限制的优先级，范围是 0 ~ 100，默认为 0。 */ Priority?: number; /** * 精准速率限制规则是否开启。取值有：
  • on：开启；
  • off：关闭。
    • */ Enabled?: string; } /** * https 证书配置。 */ export interface CertificateInfo { /** * 证书 ID。来源于 SSL 侧，您可以前往 [SSL 证书列表](https://console.cloud.tencent.com/ssl) 查看 CertId。 */ CertId: string; /** * 证书备注名。 */ Alias?: string; /** * 证书类型，取值有：
  • default：默认证书；
  • upload：用户上传；
  • managed：腾讯云托管。
    • */ Type?: string; /** * 证书过期时间。 */ ExpireTime?: string; /** * 证书部署时间。 */ DeployTime?: string; /** * 签名算法。 */ SignAlgo?: string; /** * 证书状态，取值有：
  • deployed：已部署；
  • processing：部署中；
  • applying：申请中；
  • failed：申请失败；
  • issued：绑定失败。
    • */ Status?: string; } /** * CreateApplicationProxy请求参数结构体 */ export interface CreateApplicationProxyRequest { /** * 站点 ID。 */ ZoneId: string; /** * 当 ProxyType=hostname 时，表示域名或子域名； 当 ProxyType=instance 时，表示代理名称。 */ ProxyName: string; /** * 调度模式，取值有：
  • ip：表示Anycast IP调度；
  • domain：表示CNAME调度。
    • */ PlatType: string; /** * 是否开启安全，取值有：
  • 0：关闭安全；
  • 1：开启安全。
    • */ SecurityType: number; /** * 是否开启加速，取值有：
  • 0：关闭加速；
  • 1：开启加速。
    • */ AccelerateType: number; /** * 四层代理模式，取值有：
  • instance：表示实例模式。
    • 不填写使用默认值instance。 */ ProxyType?: string; /** * 会话保持时间，取值范围：30-3600，单位：秒。 不填写使用默认值600。 */ SessionPersistTime?: number; /** * Ipv6 访问配置。 不填写表示关闭 Ipv6 访问。 */ Ipv6?: Ipv6; /** * 规则详细信息。 不填写则不创建规则。 */ ApplicationProxyRules?: Array; /** * 中国大陆加速优化配置。不填写表示关闭中国大陆加速优化。 */ AccelerateMainland?: AccelerateMainland; } /** * ConfirmMultiPathGatewayOriginACL请求参数结构体 */ export interface ConfirmMultiPathGatewayOriginACLRequest { /** * 站点 ID。 */ ZoneId: string; /** * 网关 ID。 */ GatewayId: string; /** * 回源 IP 版本号。 */ OriginACLVersion: number; } /** * cc配置项。 */ export interface CC { /** * Waf开关，取值为：
  • on：开启；
  • off：关闭。
    • */ Switch: string; /** * 策略ID。 */ PolicyId?: number; } /** * HandleFunctionRuntimeEnvironment请求参数结构体 */ export interface HandleFunctionRuntimeEnvironmentRequest { /** * 站点 ID。 */ ZoneId: string; /** * 函数 ID。 */ FunctionId: string; /** * 操作类型，取值有：
  • setEnvironmentVariable：设置环境变量，当环境变量存在时为修改行为，否则为添加行为；
  • deleteEnvironmentVariable：删除环境变量变量；
  • clearEnvironmentVariable：清空环境变量变量；
  • resetEnvironmentVariable：重置环境变量变量。
    • */ Operation: string; /** * 环境变量列表，函数运行环境最多支持 64 个变量。当 Operation 取值为 setEnvironmentVariable、deleteEnvironmentVariable、resetEnvironmentVariable 时必填。 */ EnvironmentVariables?: Array; } /** * ModifyL4ProxyRulesStatus请求参数结构体 */ export interface ModifyL4ProxyRulesStatusRequest { /** * 站点 ID。 */ ZoneId: string; /** * 四层代理实例 ID。 */ ProxyId: string; /** * 转发规则 ID 列表。单次最多支持 200 条转发规则。 */ RuleIds: Array; /** * 转发规则状态，取值有：
  • online：启用；
  • offline：停用。
    • */ Status: string; } /** * DescribeCustomErrorPages请求参数结构体 */ export interface DescribeCustomErrorPagesRequest { /** *

    站点 ID。

    */ ZoneId: string; /** *

    过滤条件，Filters.Values 的上限为 20，详细的过滤条件Name值如下：

  • page-id： 按照页面 ID 进行过滤；
  • name： 按照页面名称进行过滤；
  • description：按照页面描述过滤；
  • content-type：按照页面类型过滤。

    • */ Filters?: Array; /** *

    分页查询偏移量。默认值：0。

    */ Offset?: number; /** *

    分页查询限制数目。默认值：20，最大值：1000。

    */ Limit?: number; } /** * 多通道安全网关可用地域 */ export interface GatewayRegion { /** * 地域 ID 。 */ RegionId?: string; /** * 中文地域名称。 */ CNName?: string; /** * 英文地域名称。 */ ENName?: string; } /** * 缓存预刷新 配置参数。 */ export interface CachePrefreshParameters { /** * 缓存预刷新开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch?: string; /** * 预刷新时间设置为节点缓存时间的百分比数值，取值：1～99。
    注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。 */ CacheTimePercent?: number; } /** * 规则引擎操作定制配置。 */ export interface RuleEngineCustomAction { /** *

    定制配置唯一 ID。

    */ ActionId?: string; /** *

    定制配置名称。

    */ Name?: string; /** *

    定制配置描述。

    */ Description?: string; /** *

    定制配置参数定义列表。

    */ Parameters?: Array; /** *

    定制配置支持的匹配条件。

    支持匹配条件参考官方文档 通用参考-配置语法-变量。

    */ SupportedConditions?: Array; } /** * 规则引擎功能项操作，对于一种功能只对应下面三种类型的其中一种，RuleAction 数组中的每一项只能是其中一个类型，更多功能项的填写规范可调用接口 [查询规则引擎的设置参数](https://cloud.tencent.com/document/product/1552/80618) 查看。 */ export interface Action { /** * 常规功能操作，选择该类型的功能项有：
  • 访问URL 重写（AccessUrlRedirect）；
  • 回源 URL 重写 （UpstreamUrlRedirect）；
  • QUIC（QUIC）；
  • WebSocket （WebSocket）；
  • 视频拖拽（VideoSeek）；
  • Token 鉴权（Authentication）；
  • 自定义CacheKey（CacheKey）；
  • 节点缓存 TTL （Cache）；
  • 浏览器缓存 TTL（MaxAge）；
  • 离线缓存（OfflineCache）；
  • 智能加速（SmartRouting）；
  • 分片回源（RangeOriginPull）；
  • HTTP/2 回源（UpstreamHttp2）；
  • Host Header 重写（HostHeader）；
  • 强制 HTTPS（ForceRedirect）；
  • 回源 HTTPS（OriginPullProtocol）；
  • 单连接下载限速（ResponseSpeedLimit）；
  • 缓存预刷新（CachePrefresh）；
  • 智能压缩（Compression）；
  • Hsts；
  • ClientIpHeader；
  • SslTlsSecureConf；
  • OcspStapling；
  • HTTP/2 访问（Http2）；
  • 回源跟随重定向(UpstreamFollowRedirect)；
  • 修改源站(Origin)。
  • 七层回源超时(HTTPUpstreamTimeout)。
  • Http应答（HttpResponse）。
    • 注意：此字段可能返回 null，表示取不到有效值。 */ NormalAction?: NormalAction; /** * 带有请求头/响应头的功能操作，选择该类型的功能项有：
  • 修改 HTTP 请求头（RequestHeader）；
  • 修改HTTP响应头（ResponseHeader）。
    • 注意：此字段可能返回 null，表示取不到有效值。 */ RewriteAction?: RewriteAction; /** * 带有状态码的功能操作，选择该类型的功能项有：
  • 自定义错误页面（ErrorPage）；
  • 状态码缓存 TTL（StatusCodeCache）。
    • 注意：此字段可能返回 null，表示取不到有效值。 */ CodeAction?: CodeAction; } /** * JavaScript 注入规则。 */ export interface JSInjectionRule { /** * 规则 ID。 */ RuleId?: string; /** * 规则名称。 */ Name?: string; /** * 规则优先级，数值越小越优先执行，范围是 0 ~ 100，默认为 0。 */ Priority?: number; /** * 匹配条件内容。需符合表达式语法，详细规范参见产品文档。 */ Condition?: string; /** * JavaScript 注入选项。默认值为 run-attestations，取值有：
  • no-injection: 不注入 JavaScript;
  • inject-sdk-only: 注入当前支持的所有认证方式的 SDK，当前支持：TC-RCE 和 TC-CAPTCHA。注意：若需执行认证检测，请配置挑战规则。
    • */ InjectJS?: string; } /** * 回源跟随重定向参数配置。 */ export interface UpstreamFollowRedirectParameters { /** * 回源跟随重定向配置开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch?: string; /** * 最大重定向次数。取值为 1-5。 注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。 */ MaxTimes?: number; } /** * DeleteSecurityAPIService请求参数结构体 */ export interface DeleteSecurityAPIServiceRequest { /** * 站点 ID。 */ ZoneId: string; /** * API 服务 ID 列表。 */ APIServiceIds?: Array; } /** * 应用代理实例 */ export interface ApplicationProxy { /** * 站点ID。 */ ZoneId?: string; /** * 站点名称。 */ ZoneName?: string; /** * 代理ID。 */ ProxyId?: string; /** * 当ProxyType=hostname时，表示域名或子域名； 当ProxyType=instance时，表示代理名称。 */ ProxyName?: string; /** * 四层代理模式，取值有：
  • hostname：表示子域名模式；
  • instance：表示实例模式。
    • */ ProxyType?: string; /** * 调度模式，取值有：
  • ip：表示Anycast IP调度；
  • domain：表示CNAME调度。
    • */ PlatType?: string; /** * 加速区域，取值有：
  • mainland：中国大陆境内;
  • overseas：全球（不含中国大陆）。
    • 默认值：overseas */ Area?: string; /** * 是否开启安全，取值有：
  • 0：关闭安全；
  • 1：开启安全。
    • */ SecurityType?: number; /** * 是否开启加速，取值有：
  • 0：关闭加速；
  • 1：开启加速。
    • */ AccelerateType?: number; /** * 会话保持时间，单位为秒。 */ SessionPersistTime?: number; /** * 状态，取值有：
  • online：启用；
  • offline：停用；
  • progress：部署中；
  • stopping：停用中；
  • fail：部署失败/停用失败。
    • */ Status?: string; /** * 封禁状态，取值有：
  • banned：已封禁;
  • banning：封禁中；
  • recover：已解封；
  • recovering：解封禁中。
    • */ BanStatus?: string; /** * 调度信息。 */ ScheduleValue?: Array; /** * 当ProxyType=hostname时： 表示代理加速唯一标识。 */ HostId?: string; /** * Ipv6访问配置。 */ Ipv6?: Ipv6; /** * 更新时间。 */ UpdateTime?: string; /** * 规则列表。 */ ApplicationProxyRules?: Array; /** * 中国大陆加速优化配置。 */ AccelerateMainland?: AccelerateMainland; } /** * ModifyApplicationProxy返回参数结构体 */ export interface ModifyApplicationProxyResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifySecurityIPGroup返回参数结构体 */ export interface ModifySecurityIPGroupResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 安全类型配置项。 */ export interface SecurityType { /** * 安全类型开关，取值为：
  • on：开启；
  • off：关闭。
    • */ Switch: string; } /** * 站点配置。 */ export interface ZoneSetting { /** * 站点名称。 */ ZoneName?: string; /** * 站点加速区域信息，取值有：
  • mainland：中国境内加速；
  • overseas：中国境外加速。
    • */ Area?: string; /** * 节点缓存键配置。 注意：此字段可能返回 null，表示取不到有效值。 */ CacheKey?: CacheKey; /** * Quic访问配置。 注意：此字段可能返回 null，表示取不到有效值。 */ Quic?: Quic; /** * POST请求传输配置。 注意：此字段可能返回 null，表示取不到有效值。 */ PostMaxSize?: PostMaxSize; /** * 智能压缩配置。 注意：此字段可能返回 null，表示取不到有效值。 */ Compression?: Compression; /** * Http2回源配置。 注意：此字段可能返回 null，表示取不到有效值。 */ UpstreamHttp2?: UpstreamHttp2; /** * 访问协议强制Https跳转配置。 注意：此字段可能返回 null，表示取不到有效值。 */ ForceRedirect?: ForceRedirect; /** * 缓存过期时间配置。 注意：此字段可能返回 null，表示取不到有效值。 */ CacheConfig?: CacheConfig; /** * 源站配置。 注意：此字段可能返回 null，表示取不到有效值。 */ Origin?: Origin; /** * 智能加速配置。 注意：此字段可能返回 null，表示取不到有效值。 */ SmartRouting?: SmartRouting; /** * 浏览器缓存配置。 注意：此字段可能返回 null，表示取不到有效值。 */ MaxAge?: MaxAge; /** * 离线缓存配置。 注意：此字段可能返回 null，表示取不到有效值。 */ OfflineCache?: OfflineCache; /** * WebSocket配置。 注意：此字段可能返回 null，表示取不到有效值。 */ WebSocket?: WebSocket; /** * 客户端IP回源请求头配置。 注意：此字段可能返回 null，表示取不到有效值。 */ ClientIpHeader?: ClientIpHeader; /** * 缓存预刷新配置。 注意：此字段可能返回 null，表示取不到有效值。 */ CachePrefresh?: CachePrefresh; /** * Ipv6访问配置。 注意：此字段可能返回 null，表示取不到有效值。 */ Ipv6?: Ipv6; /** * Https 加速配置。 注意：此字段可能返回 null，表示取不到有效值。 */ Https?: Https; /** * 回源时是否携带客户端IP所属地域信息的配置。 注意：此字段可能返回 null，表示取不到有效值。 */ ClientIpCountry?: ClientIpCountry; /** * Grpc协议支持配置。 注意：此字段可能返回 null，表示取不到有效值。 */ Grpc?: Grpc; /** * 网络错误日志记录配置。 注意：此字段可能返回 null，表示取不到有效值。 */ NetworkErrorLogging?: NetworkErrorLogging; /** * 图片优化相关配置。 注意：此字段可能返回 null，表示取不到有效值。 */ ImageOptimize?: ImageOptimize; /** * 中国大陆加速优化配置。 注意：此字段可能返回 null，表示取不到有效值。 */ AccelerateMainland?: AccelerateMainland; /** * 标准 Debug 配置。 注意：此字段可能返回 null，表示取不到有效值。 */ StandardDebug?: StandardDebug; /** * 视频即时处理配置。 注意：此字段可能返回 null，表示取不到有效值。 */ JITVideoProcess?: JITVideoProcess; } /** * ModifyL4Proxy请求参数结构体 */ export interface ModifyL4ProxyRequest { /** * 站点 ID。 */ ZoneId: string; /** * 应用 ID。 */ ProxyId: string; /** * 是否开启 IPv6 访问。 不填该参数时，表示不修改该配置。该配置仅在部分加速区域和安全防护配置下支持开启，详情请参考 [新建四层代理实例](https://cloud.tencent.com/document/product/1552/90025) 。取值为：
  • on：开启；
  • off：关闭。
    • */ Ipv6?: string; /** * 是否开启中国大陆网络优化。不填该参数时，表示不修改该配置。该配置仅在部分加速区域和安全防护配置下支持开启，详情请参考 [新建四层代理实例](https://cloud.tencent.com/document/product/1552/90025) 。取值为：
  • on：开启；
  • off：关闭。
    • */ AccelerateMainland?: string; } /** * DescribeSecurityJSInjectionRule请求参数结构体 */ export interface DescribeSecurityJSInjectionRuleRequest { /** * 站点 ID。 */ ZoneId: string; /** * 分页查询限制数目。默认值：20，最大值：100。 */ Limit?: number; /** * 分页查询偏移量。默认值：0。 */ Offset?: number; } /** * 拦截页面的总体配置，用于配置各个模块的拦截后行为。 */ export interface DropPageConfig { /** * 配置开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch: string; /** * Waf(托管规则)模块的拦截页面配置。如果为null，默认使用历史配置。 */ WafDropPageDetail?: DropPageDetail; /** * 自定义页面的拦截页面配置。如果为null，默认使用历史配置。 */ AclDropPageDetail?: DropPageDetail; } /** * DescribeSecurityIPGroupInfo请求参数结构体 */ export interface DescribeSecurityIPGroupInfoRequest { /** * 站点的 ID ，用于指定查询的站点范围。 */ ZoneId: string; /** * 单次返回的最大条目数。默认值为 20 ，最大查询条目为 1000 。 */ Limit?: number; /** * 分页查询的起始条目偏移量。默认值为 0 。 */ Offset?: number; } /** * 例外规则的生效范围。 */ export interface ExceptUserRuleScope { /** * 例外规则类型。其中complete模式代表全量数据进行例外，partial模式代表可选择指定模块指定字段进行例外，该字段取值有：
  • complete：完全跳过模式；
  • partial：部分跳过模式。
    • */ Type?: string; /** * 生效的模块，该字段取值有：
  • waf：托管规则；
  • rate：速率限制；
  • acl：自定义规则；
  • cc：cc攻击防护；
  • bot：Bot防护。
    • */ Modules?: Array; /** * 跳过部分规则ID的例外规则详情。如果为null，默认使用历史配置。 */ PartialModules?: Array; /** * 跳过具体字段不去扫描的例外规则详情。如果为null，默认使用历史配置。 */ SkipConditions?: Array; } /** * CreateLogAnalysisDownloadTask请求参数结构体 */ export interface CreateLogAnalysisDownloadTaskRequest { /** *

    站点 ID。

    */ ZoneId: string; /** *

    数据归属地区，可选值：

    • mainland：中国大陆境内；
    • overseas：全球（不含中国大陆）。
    注意：若站点服务区域为“全球可用区”，获取全部数据需要分别查询 mainland 和 overseas 的数据。

    */ Area: string; /** *

    开始时间，示例值：2020-04-29T00:00:00Z。套餐版本不同，支持的可查询开始时间至今的最大时间跨度不同，详情请见 套餐选型对比。

    */ StartTime: string; /** *

    结束时间，示例值：2020-04-30T00:00:00Z。单次查询的开始时间到结束时间跨度最大为 31 天。

    */ EndTime: string; /** *

    日志类型，可选值：

    • l7-access-logs：七层访问日志；
    • web-attack：托管规则日志。
    默认为 l7-access-logs 。

    */ LogType?: string; /** *

    日志匹配条件，最大长度 12KB。

    */ Condition?: string; /** *

    文件格式，可选值：

    • csv
    默认为 csv。

    */ Format?: string; /** *

    原始日志的时间排序，可选值：

    • asc：升序；
    • desc：降序。
    默认为 desc。

    */ Sort?: string; } /** * 例外规则的详细模块配置。 */ export interface PartialModule { /** * 模块名称，取值为：
  • managed-rule：托管规则 Id；
  • managed-group：托管规则组；
  • waf：待废弃，托管规则。
    • */ Module?: string; /** * 模块下的需要例外的具体规则ID列表。 */ Include?: Array; } /** * DescribeZoneConfigImportResult请求参数结构体 */ export interface DescribeZoneConfigImportResultRequest { /** * 站点 ID。 */ ZoneId: string; /** * 表示需要查询结果的导入配置任务 Id，导入任务 Id 仅支持查询最近 7 天的导入任务。 */ TaskId: string; } /** * ModifyApplicationProxyRuleStatus请求参数结构体 */ export interface ModifyApplicationProxyRuleStatusRequest { /** * 站点ID。 */ ZoneId: string; /** * 代理ID。 */ ProxyId: string; /** * 规则ID。 */ RuleId: string; /** * 状态，取值有：
  • offline: 停用；
  • online: 启用。
    • */ Status: string; } /** * 加速类型 */ export interface AccelerateType { /** * 加速开关。取值范围：
  • on：打开;
  • off：关闭。
    • */ Switch: string; } /** * 实时日志投递条件，用于定义投递日志范围。DeliveryCondition 数组内多个项的关系为“或”，内层 Conditions 数组内多个项的关系为“且”。 */ export interface DeliveryCondition { /** * 日志过滤条件，详细的过滤条件如下：
  • EdgeResponseStatusCode：按照 EdgeOne 节点响应返回给客户端的状态码进行过滤。
       支持运算符：equal、great、less、great_equal、less_equal
       取值范围：任意大于等于 0 的整数
  • OriginResponseStatusCode：按照源站响应状态码进行过滤。
       支持运算符：equal、great、less、great_equal、less_equal
       取值范围：任意大于等于 -1 的整数
  • SecurityAction：按照请求命中安全规则后的最终处置动作进行过滤。
       支持运算符：equal
       可选项如下：
       -：未知/未命中
       Monitor：观察
       JSChallenge：JavaScript 挑战
       Deny：拦截
       Allow：放行
       BlockIP：IP 封禁
       Redirect：重定向
       ReturnCustomPage：返回自定义页面
       ManagedChallenge：托管挑战
       Silence：静默
       LongDelay：长时间等待后响应
       ShortDelay：短时间等待后响应
  • SecurityModule：按照最终处置请求的安全模块名称进行过滤。
       支持运算符：equal
       可选项如下：
       -：未知/未命中
       CustomRule：Web防护 - 自定义规则
       RateLimitingCustomRule：Web防护 - 速率限制规则
       ManagedRule：Web防护 - 托管规则
       L7DDoS：Web防护 - CC攻击防护
       BotManagement：Bot管理 - Bot基础管理
       BotClientReputation：Bot管理 - 客户端画像分析
       BotBehaviorAnalysis：Bot管理 - Bot智能分析
       BotCustomRule：Bot管理 - 自定义Bot规则
       BotActiveDetection：Bot管理 - 主动特征识别
    • */ Conditions?: Array; } /** * 推理 API Token 信息。 */ export interface InferenceAPIToken { /** * 推理 API Token ID。 */ TokenId?: string; /** * 推理 API Token 名称。 */ Name?: string; /** * 推理 API Token 内容。 */ Content?: string; /** * 创建时间，使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。 */ CreateTime?: string; } /** * Web安全的例外规则 */ export interface ExceptionRule { /** * 例外规则的 ID。
    通过规则 ID 可支持不同的规则配置操作：
  • 增加新规则：ID 为空或不指定 ID 参数；
  • 修改已有规则：指定需要更新/修改的规则 ID；
  • 删除已有规则：ExceptionRules 参数中，Rules 列表中未包含的已有规则将被删除。
    • */ Id?: string; /** * 例外规则的名称。 */ Name?: string; /** * 例外规则的具体内容，需符合表达式语法，详细规范参见产品文档。 */ Condition?: string; /** * 例外规则执行选项，取值有：
  • WebSecurityModules: 指定例外规则的安全防护模块，需配合 ⁠WebSecurityModulesForException⁠ 使用；
  • WebSecuritySubmodules: 指定例外规则的安全防护子模块，需配合 ⁠WebSecuritySubmodulesForException⁠ 使用；
  • ManagedRules：指定例外规则的具体托管规则，需配合 ⁠ManagedRulesForException⁠ 使用；
  • ManagedRuleGroups：指定例外规则的托管规则组，需配合 ⁠ManagedRuleGroupsForException⁠ 使用。
    • */ SkipScope?: string; /** * 跳过请求的具体类型，取值有：
  • SkipOnAllRequestFields: 跳过所有请求；
  • SkipOnSpecifiedRequestFields: 跳过指定请求字段。
    • 仅当 SkipScope 为 ManagedRules 或 ManagedRuleGroups 时有效。 */ SkipOption?: string; /** * 指定例外规则的安全防护模块，仅当 SkipScope 为 WebSecurityModules 时有效，取值有：
  • websec-mod-managed-rules：托管规则；
  • websec-mod-rate-limiting：速率限制；
  • websec-mod-custom-rules：自定义规则；
  • websec-mod-adaptive-control：自适应频控、智能客户端过滤、慢速攻击防护、流量盗刷防护；
  • websec-mod-bot：Bot管理。
    • */ WebSecurityModulesForException?: Array; /** * 指定例外规则的安全防护子模块，仅当 SkipScope 为 WebSecuritySubmodules 时有效，取值有：
    • 托管规则（ManagedRules）模块功能：
      • websec-mod-managed-rules/managed-rule-groups：规则集；
      • websec-mod-managed-rules/frequent-scanning-protection：高频扫描防护；
    • 速率限制（RateLimitingRules）模块功能：
      • websec-mod-rate-limiting-rules：速率限制规则；
    • 自定义规则（CustomRules）模块功能：
      • websec-mod-custom-rules：自定义规则；
    • HTTP DDoS 防护（HttpDDoSProtection）模块功能：
      • websec-mod-http-ddos-protection/adaptive-frequency-control：自适应频控；
      • websec-mod-http-ddos-protection/client-filtering：智能客户端过滤；
      • websec-mod-http-ddos-protection/bandwidth-abuse-defense：流量盗刷防护；
    • 高级 Bot 管理（BotManagement）模块功能：
      • websec-mod-bot-management/basic-feature：基础特征管理；
      • websec-mod-bot-management/ip-reputation：客户端画像分析；
      • websec-mod-bot-management/bot-intelligence：智能 Bot 分析；
      • websec-mod-bot-management/custom-rules：自定义规则；
      • websec-mod-bot-management/browser-impersonation-detection：主动特征识别；
      • websec-mod-bot-management/client-attestation-rules：客户端认证；
    • 基础 Bot 管理（BotManagementLite）模块功能：
      • websec-mod-bot-management-lite/ai-crawler-detection：AI 爬虫处置；
      • websec-mod-bot-management-lite/captcha-page-challenge：人机校验页。
    */ WebSecuritySubmodulesForException?: Array; /** * 指定例外规则的具体托管规则，仅当 SkipScope 为 ManagedRules 时有效。 */ ManagedRulesForException?: Array; /** * 指定例外规则的托管规则组，仅当 SkipScope 为 ManagedRuleGroups 时有效。 */ ManagedRuleGroupsForException?: Array; /** * 指定例外规则跳过指定请求字段的具体配置，仅当 SkipScope 为 ManagedRules 或 ManagedRuleGroups 并且 SkipOption 为 SkipOnSpecifiedRequestFields 时有效。 */ RequestFieldsForException?: Array; /** * 例外规则是否开启。取值有：
  • on：开启
  • off：关闭
    • */ Enabled?: string; } /** * 缓存遵循源站配置。 */ export interface FollowOrigin { /** * 遵循源站配置开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch: string; /** * 源站未返回 Cache-Control 头时，缓存/不缓存开关。当 Switch 为 on 时，此字段必填，当 Switch 为 off 时，无需填写此字段，若填写则不生效。取值有：
  • on：缓存；
  • off：不缓存。
    • */ DefaultCache?: string; /** * 源站未返回 Cache-Control 头时，使用/不使用默认缓存策略开关。当 DefaultCache 为 on 时，此字段必填，否则此字段不生效；当 DefaultCacheTime 不为 0 时，此字段必须为 off。取值有：
  • on：使用默认缓存策略；
  • off：不使用默认缓存策略。
    • */ DefaultCacheStrategy?: string; /** * 源站未返回 Cache-Control 头时，表示默认的缓存时间，单位为秒，取值：0-315360000。当 DefaultCache 为 on 时，此字段必填，否则此字段不生效；当 DefaultCacheStrategy 为 on 时， 此字段必须为 0。 */ DefaultCacheTime?: number; } /** * EdgeKVDelete请求参数结构体 */ export interface EdgeKVDeleteRequest { /** * 站点 ID。 */ ZoneId: string; /** * 命名空间名称。 */ Namespace: string; /** * 键名列表。数组长度上限为 20。每个键名不能为空，长度为 1-512 个字符，支持合法 UTF-8 字符。删除单个键时传入包含一个元素的数组。 */ Keys: Array; } /** * DescribeMultiPathGateway返回参数结构体 */ export interface DescribeMultiPathGatewayResponse { /** * 网关详情。 */ GatewayDetail?: MultiPathGateway; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * IP 归属信息查询 */ export interface IPRegionInfo { /** * IP 地址，IPV4 或 IPV6。 */ IP?: string; /** * IP 是否属于 EdgeOne 节点，取值有：
  • yes：该 IP 属于 EdgeOne 节点；
  • no：该 IP 不属于 EdgeOne 节点。
    • */ IsEdgeOneIP?: string; } /** * DestroyPlan返回参数结构体 */ export interface DestroyPlanResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateSecurityAPIResource请求参数结构体 */ export interface CreateSecurityAPIResourceRequest { /** * 站点 ID。 */ ZoneId: string; /** * API 资源列表。 */ APIResources?: Array; } /** * SSL/TLS 安全配置参数。 */ export interface TLSConfigParameters { /** * TLS 版本。至少填写一个，如果是多个时，需要为连续版本号，例如：开启 TLS1、1.1、1.2 和 1.3，不可仅开启 1 和 1.2 而关闭 1.1。取值有：
  • TLSv1：TLSv1 版本；
  • TLSv1.1：TLSv1.1 版本；
  • TLSv1.2：TLSv1.2 版本；
  • TLSv1.3：TLSv1.3 版本。
    • */ Version?: Array; /** * 密码套件。详细介绍请参考 [TLS 版本及密码套件说明](https://cloud.tencent.com/document/product/1552/86545)。取值有：
  • loose-v2023：loose-v2023 密码套件；
  • general-v2023：general-v2023 密码套件；
  • strict-v2023：strict-v2023 密码套件。
    • */ CipherSuite?: string; } /** * 查询条件 */ export interface QueryCondition { /** * 筛选条件的key。 */ Key: string; /** * 查询条件操作符，操作类型有：
  • equals: 等于；
  • notEquals: 不等于；
  • include: 包含；
  • notInclude: 不包含;
  • startWith: 开始的值是value；
  • notStartWith: 不以value的值开始；
  • endWith: 结尾是value值；
  • notEndWith: 不以value的值结尾。
    • */ Operator: string; /** * 筛选条件的值。 */ Value: Array; } /** * 规则引擎条件 HTTP 请求/响应头操作动作参数。 */ export interface RuleRewriteActionParams { /** * 功能参数名称，参数填写规范可调用接口 [查询规则引擎的设置参数](https://cloud.tencent.com/document/product/1552/80618) 查看。现在只有三种取值：
  • add：添加 HTTP 头部；
  • set：重写 HTTP 头部；
  • del：删除 HTTP 头部。
    • */ Action: string; /** * 参数名称。 */ Name: string; /** * 参数值。 */ Values: Array; } /** * DescribeL4ProxyRules返回参数结构体 */ export interface DescribeL4ProxyRulesResponse { /** * 转发规则总数。 */ TotalCount?: number; /** * 转发规则列表。 */ L4ProxyRules?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 存储客户端请求IP的头部信息配置。 */ export interface ClientIPHeaderParameters { /** * 配置开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch?: string; /** * 回源时，存放客户端 IP 的请求头名称。当 Switch 为 on 时，该参数必填。该参数不允许填写 X-Forwarded-For。 */ HeaderName?: string; } /** * 离线日志详细信息 */ export interface L4OfflineLog { /** * 四层代理实例 ID。 */ ProxyId?: string; /** * 日志所属区域，取值有：
  • mainland：中国大陆境内;
  • overseas：全球（不含中国大陆）。
    • */ Area?: string; /** * 离线日志数据包名。 */ LogPacketName?: string; /** * 离线日志下载地址。 */ Url?: string; /** * 日志打包时间，此参数已经废弃。 */ LogTime?: number; /** * 日志打包开始时间。 */ LogStartTime?: string; /** * 日志打包结束时间。 */ LogEndTime?: string; /** * 日志大小，单位为 Byte。 */ Size?: number; } /** * ModifyAliasDomain返回参数结构体 */ export interface ModifyAliasDomainResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteDnsRecords请求参数结构体 */ export interface DeleteDnsRecordsRequest { /** * 站点 ID。 */ ZoneId: string; /** * 待删除的 DNS 记录 ID 列表，上限：1000。 */ RecordIds: Array; } /** * DescribeAvailableCustomActionsForRuleEngine返回参数结构体 */ export interface DescribeAvailableCustomActionsForRuleEngineResponse { /** *

    符合条件的规则引擎定制配置的总数。

    */ TotalCount?: number; /** *

    符合条件的规则引擎定制配置的列表。

    */ CustomActionSet?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 离线缓存是否开启。 */ export interface OfflineCacheParameters { /** * 离线缓存开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch?: string; } /** * 定制配置操作参数。 */ export interface CustomActionParameters { /** *

    需要配置的定制配置列表。

    */ CustomActions: Array; } /** * DeleteAliasDomain请求参数结构体 */ export interface DeleteAliasDomainRequest { /** * 站点 ID。 */ ZoneId: string; /** * 待删除别称域名名称。如果为空，则不执行删除操作。 */ AliasNames?: Array; } /** * DeleteFunctionRules返回参数结构体 */ export interface DeleteFunctionRulesResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTopL7AnalysisData返回参数结构体 */ export interface DescribeTopL7AnalysisDataResponse { /** * 查询结果的总条数。 */ TotalCount?: number; /** * 七层访问数据按照 MetricName 指定统计维度的前 topN 数据列表。 注意：此字段可能返回 null，表示取不到有效值。 */ Data?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyContentIdentifier请求参数结构体 */ export interface ModifyContentIdentifierRequest { /** * 内容标识符 ID。 */ ContentId: string; /** * 内容标识符描述，长度限制不超过 20 个字符。 */ Description: string; } /** * DeleteMultiPathGatewayLine请求参数结构体 */ export interface DeleteMultiPathGatewayLineRequest { /** * 站点 ID。 */ ZoneId: string; /** * 网关 ID。 */ GatewayId: string; /** * 线路 ID。 */ LineId: string; } /** * 计费资源 */ export interface Resource { /** * 资源 ID。 */ Id?: string; /** * 付费模式，取值有：
  • 0：后付费。
    • */ PayMode?: number; /** * 创建时间。 */ CreateTime?: string; /** * 生效时间。 */ EnableTime?: string; /** * 失效时间。 */ ExpireTime?: string; /** * 套餐状态，取值有：
  • normal：正常；
  • isolated：隔离；
  • destroyed：销毁。
    • */ Status?: string; /** * 询价参数。 */ Sv?: Array; /** * 是否自动续费，取值有：
  • 0：默认状态；
  • 1：自动续费；
  • 2：不自动续费。
    • */ AutoRenewFlag?: number; /** * 套餐关联资源 ID。 */ PlanId?: string; /** * 地域，取值有：
  • mainland：中国大陆境内；
  • overseas：中国大陆境外。
  • global：全球。
    • */ Area?: string; /** * 资源类型，取值有：
  • plan：套餐类型；
  • pay-as-you-go：后付费类型。
  • value-added：增值服务类型。
    • 注意：此字段可能返回 null，表示取不到有效值。 */ Group?: string; /** * 当前资源绑定的站点数量。 注意：此字段可能返回 null，表示取不到有效值。 */ ZoneNumber?: number; /** * 资源标记类型，取值有：
  • vodeo：vodeo资源。
    • */ Type?: string; } /** * 独立 DDoS 防护配置。 */ export interface DDoSProtection { /** * 指定独立 DDoS 的防护范围。取值为：
  • protect_all_domains：独立 DDoS 防护对站点内全部域名生效，新接入域名自动开启独立 DDoS 防护，入参为 protect_all_domains 时，入参 DomainDDoSProtections 不作处理；
  • protect_specified_domains：仅对指定域名生效，具体范围可通过 DomainDDoSProtection 参数指定。
    • */ ProtectionOption: string; /** * 域名的独立 DDoS 防护配置。在入参场景中：
  • 当 ProtectionOption 保持为 protect_specified_domains 时：未填写的域名维持原有独立 DDoS 防护配置不变，显式指定的域名​按传入参数更新；
  • 当 ProtectionOption 由 protect_all_domains 切换为 protect_specified_domains 时：若 DomainDDoSProtections 传空，停用站点下全部域名的独立 DDoS 防护；若 DomainDDoSProtections 不为空，参数中指定的域名停用或保持独立 DDoS 防护，其余未列出的域名统一停用独立 DDoS 防护。
    • */ DomainDDoSProtections?: Array; /** * 共享 CNAME 的独立 DDoS 防护配置。仅作为出参使用。 */ SharedCNAMEDDoSProtections?: Array; } /** * 修改 HTTP 节点响应头配置参数。 */ export interface ModifyResponseHeaderParameters { /** * HTTP 回源头部规则列表。 注意：此字段可能返回 null，表示取不到有效值。 */ HeaderActions?: Array; } /** * DescribeOriginProtection请求参数结构体 */ export interface DescribeOriginProtectionRequest { /** * 查询的站点ID集合。该参数必填。 */ ZoneIds?: Array; /** * 过滤条件，Filters.Values的上限为20。详细的过滤条件如下：
  • need-update
       按照【站点是否需要更新源站防护IP白名单】进行过滤。
       类型：String
       必选：否
       可选项：
       true：需要更新
       false：无需更新
  • plan-support
       按照【站点套餐是否支持源站防护】进行过滤。
       类型：String
       必选：否
       可选项：
       true：支持
       false：不支持
    • */ Filters?: Array; /** * 分页查询偏移量，默认为0。 */ Offset?: number; /** * 分页查询限制数目。默认值：20，最大值：1000。 */ Limit?: number; } /** * DeleteContentIdentifier返回参数结构体 */ export interface DeleteContentIdentifierResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeHostsSetting请求参数结构体 */ export interface DescribeHostsSettingRequest { /** * 站点ID。 */ ZoneId: string; /** * 分页查询偏移量。默认值： 0，最小值：0。 */ Offset?: number; /** * 分页查询限制数目。默认值： 100，最大值：1000。 */ Limit?: number; /** * 过滤条件，Filters.Values的上限为20。详细的过滤条件如下：
  • host：按照域名进行过滤。
    • */ Filters?: Array; } /** * DescribeDDoSAttackEvent请求参数结构体 */ export interface DescribeDDoSAttackEventRequest { /** * 开始时间，时间范围为 30 天。 */ StartTime: string; /** * 结束时间。查询时间范围（`EndTime` - `StartTime`）需小于等于 31 天。 */ EndTime: string; /** * ddos策略组集合，不填默认选择全部策略。 */ PolicyIds?: Array; /** * 站点 ID 集合，此参数将于2024年05月30日后由可选改为必填，详见公告：[【腾讯云 EdgeOne】云 API 变更通知](https://cloud.tencent.com/document/product/1552/104902)。最多传入 100 个站点 ID。若需查询腾讯云主账号下所有站点数据，请用 `*` 代替，查询账号级别数据需具备本接口全部站点资源权限。 */ ZoneIds?: Array; /** * 分页查询的限制数目，默认值为20，最大查询条目为1000。 */ Limit?: number; /** * 分页的偏移量，默认值为0。 */ Offset?: number; /** * 展示攻击详情的参数，若填false，默认只返回攻击次数，不返回攻击详情；若填true，返回攻击详情。 */ ShowDetail?: boolean; /** * 数据归属地区，取值有：
  • overseas：全球（除中国大陆地区）数据；
  • mainland：中国大陆地区数据；
  • global：全球数据；
    • 不填默认取值为global。 */ Area?: string; /** * 排序字段，取值有：
  • MaxBandWidth：带宽峰值；
  • AttackStartTime：攻击开始时间。
    • 不填默认值为：AttackStartTime。 */ OrderBy?: string; /** * 排序方式，取值有：
  • asc：升序方式；
  • desc：降序方式。
    • 不填默认值为：desc。 */ OrderType?: string; } /** * 源站组信息 */ export interface OriginGroup { /** * 源站组ID。 */ GroupId?: string; /** * 源站组名称。 */ Name?: string; /** * 源站组类型，取值有：
  • GENERAL：通用型源站组；
  • HTTP： HTTP专用型源站组。
    • */ Type?: string; /** * 源站记录信息。 */ Records?: Array; /** * 源站组被引用实例列表。 */ References?: Array; /** * 源站组创建时间。 */ CreateTime?: string; /** * 源站组更新时间。 */ UpdateTime?: string; /** * 回源Host Header。 */ HostHeader?: string; } /** * ModifySecurityIPGroup请求参数结构体 */ export interface ModifySecurityIPGroupRequest { /** * 站点 Id。 */ ZoneId: string; /** * IP 组配置。 */ IPGroup: IPGroup; /** * 操作类型，取值有：
  • append: 向 IPGroup 中添加新的 IP 地址或设置定时过期时间；
  • remove: 从 IPGroup 中删除指定的 IP 地址或其定时过期时间；
  • update: 完全替换 IPGroup 中 Content 或 ExpireInfo 的内容，并且可以修改 IPGroup 的名称。
    • 使用 append 操作时注意：
  • 为 IP 或网段添加定时过期时间时，必须晚于当前时间。如果该 IP 或网段在组中不存在，必须同时在 Content 参数中添加该 IP 或网段。若该 IP 或网段已存在过期时间，则新时间将覆盖原有时间。
    • 使用 remove 操作时注意：
  • 删除 IP 或网段时，相关的未过期的定时过期时间也会被删除；
  • 删除定时过期时间时，仅能删除当前未过期的时间。
    • 使用 update 操作时注意：
  • 替换 Content 内容时，不在 Content 中的 IP 或网段的未过期时间会被删除；
  • 替换 IPExpireInfo 内容时，IPExpireInfo 中的 IP 或网段必须在 Content 中或在 IP 组中存在。
    • */ Mode: string; } /** * DescribeFunctionReplicas请求参数结构体 */ export interface DescribeFunctionReplicasRequest { /** * 站点 ID。 */ ZoneId: string; /** * 函数 ID。 */ FunctionId: string; /** * 分页查询偏移量。默认值：0。 */ Offset?: number; /** * 分页查询限制数目。默认值：20，最大值：200。 */ Limit?: number; /** * 排序依据，取值有：
  • created-on：创建时间。
    • 默认根据 created-on 属性排序。 */ SortBy?: string; /** * 列表排序方式，取值有：
  • asc：升序排列；
  • desc：降序排列。
    • 默认值为 asc。 */ SortOrder?: string; /** * 过滤条件，Filters.Values 的上限为 20。该参数不填写时，返回函数 ID 下全部函数副本。详细的过滤条件如下：
  • replica-name：按照函数副本名称进行过滤，支持模糊查询。
    • */ Filters?: Array; } /** * 站点完整配置结构。 */ export interface ZoneFullConfig { /** *

    语法版本，当前默认为 1.0，输入其他值将会报错。

    */ FormatVersion: string; /** *

    站点级配置，包含「站点加速」中所有配置项，且所有项均为必选，否则配置无效。

    */ ZoneConfig?: ZoneConfig; /** *

    规则级配置，包含「规则引擎」中所有规则，且数组可为空，表示不启用任何规则。

    */ Rules?: Array; /** *

    Web 安全防护配置，对应控制台中「安全防护 - Web 防护」里支持的功能。

    */ WebSecurity?: WebSecurity; /** *

    边缘函数触发规则配置，包含触发「边缘函数」中所有规则，且数组可为空，表示不启用任何规则。

    */ FunctionTriggers?: Array; } /** * IdentifyZone请求参数结构体 */ export interface IdentifyZoneRequest { /** * 站点名称。 */ ZoneName: string; /** * 站点下的子域名。如果验证站点下的子域名，则传该值，否则为空。 */ Domain?: string; } /** * ModifyZoneCustomVariables返回参数结构体 */ export interface ModifyZoneCustomVariablesResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * [Vary 特性](https://cloud.tencent.com/document/product/1552/89301) 配置参数。 */ export interface VaryParameters { /** * Vary 特性配置开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch: string; } /** * 四层代理实例。 */ export interface L4Proxy { /** * 站点 ID。 */ ZoneId?: string; /** * 四层代理实例 ID。 */ ProxyId?: string; /** * 四层代理实例名称。 */ ProxyName?: string; /** * 四层代理实例的加速区域。
  • mainland：中国大陆可用区；
  • overseas： 全球可用区（不含中国大陆）；
  • global：全球可用区。
    • */ Area?: string; /** * 接入 CNAME。 */ Cname?: string; /** * 开启固定 IP 后，该值会返回对应的接入 IP；未开启时，该值为空。 */ Ips?: Array; /** * 四层代理实例状态。
  • online：已启用；
  • offline：已停用；
  • progress：部署中；
  • stopping：停用中；
  • banned：已封禁；
  • fail：部署失败/停用失败。
    • */ Status?: string; /** * 是否开启 IPv6 访问。
  • on：开启；
  • off：关闭。
    • */ Ipv6?: string; /** * 是否开启固定 IP。
  • on：开启；
  • off：关闭。
    • */ StaticIp?: string; /** * 是否开启中国大陆网络优化。
  • on：开启
  • off：关闭
    • */ AccelerateMainland?: string; /** * 安全防护配置。 本字段已废弃。 注意：此字段可能返回 null，表示取不到有效值。 * @deprecated */ DDosProtectionConfig?: DDosProtectionConfig; /** * 四层代理实例下的转发规则数量。 */ L4ProxyRuleCount?: number; /** * 最新变更时间。 */ UpdateTime?: string; } /** * 例外规则的跳过匹配条件，即在例外时根据本匹配条件，略过指定字段及内容。 */ export interface SkipCondition { /** * 例外跳过类型，取值为：
  • header_fields：HTTP请求Header；
  • cookie：HTTP请求Cookie；
  • query_string：HTTP请求URL中的Query参数；
  • uri：HTTP请求URI；
  • body_raw：HTTP请求Body；
  • body_json： JSON格式的HTTP Body。
    • */ Type: string; /** * 选择跳过的字段，取值为：
  • args：uri 下选择 query 参数: ?name1=jack&age=12；
  • path：uri 下选择部分路径：/path/to/resource.jpg；
  • full：uri 下选择完整路径：example.com/path/to/resource.jpg?name1=jack&age=12；
  • upload_filename：分段文件名，即分段传输文件时；
  • keys：所有的Key；
  • values：匹配Key对应的值；
  • key_value：匹配Key及匹配Value。
    • */ Selector: string; /** * 匹配Key所使用的匹配方式，取值为：
  • equal：精准匹配，等于；
  • wildcard：通配符匹配，支持 * 通配。
    • */ MatchFromType?: string; /** * 匹配Key的值。 */ MatchFrom?: Array; /** * 匹配Content所使用的匹配方式，取值为：
  • equal：精准匹配，等于；
  • wildcard：通配符匹配，支持 * 通配。
    • */ MatchContentType?: string; /** * 匹配Value的值。 */ MatchContent?: Array; } /** * CreateSharedCNAME请求参数结构体 */ export interface CreateSharedCNAMERequest { /** * 共享 CNAME 所属站点的 ID。 */ ZoneId: string; /** * 共享 CNAME 前缀。请输入合法的域名前缀，例如"test-api"、"test-api.com"，限制输入 50 个字符。 共享 CNAME 完整格式为：`<自定义前缀>++share.dnse[0-5].com`。 例如前缀传入 example.com，EO 会为您创建共享 CNAME：example.com.sai2ig51kaa5.share.dnse2.com。 */ SharedCNAMEPrefix: string; /** * 描述。可输入 1-50 个任意字符。 */ Description?: string; } /** * Http2回源配置 */ export interface UpstreamHttp2 { /** * http2 回源配置开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch: string; } /** * EnableOriginACL返回参数结构体 */ export interface EnableOriginACLResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteAliasDomain返回参数结构体 */ export interface DeleteAliasDomainResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 因政府法律法规、用户协议等规定，对资源进行地区访问限制信息。 */ export interface ComplianceRestriction { /** *

    下发访问限制的原因。

    枚举值：

    • ICP_RECORD_REQUIRED： 未备案；
    • GOVERNMENT_ORDER： 政府指令。
    */ Reason?: string; /** *

    限制访问地区的具体国家/地区码，使用“ISO 3166 国家/地区代码标准”。

    参数格式：查看链接：https://www.iso.org/iso-3166-country-codes.html。

    */ Region?: string; } /** * DeleteSecurityJSInjectionRule请求参数结构体 */ export interface DeleteSecurityJSInjectionRuleRequest { /** * 站点 ID。 */ ZoneId: string; /** * JavaScript 注入规则 ID 列表。 */ JSInjectionRuleIds: Array; } /** * 安全Bot配置 */ export interface BotConfig { /** * bot开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch: string; /** * 通用详细基础规则。如果为null，默认使用历史配置。 */ BotManagedRule?: BotManagedRule; /** * 用户画像规则。如果为null，默认使用历史配置。 */ BotPortraitRule?: BotPortraitRule; /** * Bot智能分析。如果为null，默认使用历史配置。 */ IntelligenceRule?: IntelligenceRule; /** * Bot自定义规则。如果为null，默认使用历史配置。 */ BotUserRules?: Array; /** * Bot主动特征识别规则。 */ AlgDetectRule?: Array; /** * Bot托管定制策略，入参可不填，仅出参使用。 */ Customizes?: Array; } /** * ModifyFunctionComponentBindings请求参数结构体 */ export interface ModifyFunctionComponentBindingsRequest { /** * 站点 ID。 */ ZoneId: string; /** * 函数 ID。 */ FunctionId: string; /** * 操作类型，取值有：
  • bind：绑定组件；
  • bind-override：绑定组件。若绑定已存在则为重绑定行为，否则为绑定行为；
  • unbind：解绑组件；
  • rebind：重置绑定关系。清空所有现有绑定，并设置为传入的绑定列表。若传入空列表，则清空所有绑定。
    • */ Operation: string; /** * 操作的函数组件绑定列表。当 Operation 为 rebind 且传入空列表时，表示清空所有绑定。 */ FunctionComponentBindings: Array; } /** * 序列化的安全结构 */ export interface WebSecurity { /** * 站点级策略的配置详情。 */ ZoneDefaultPolicy?: SecurityPolicy; /** * 域名级策略的配置详情。 */ HostPolicy?: HostPolicy; /** * 策略模板的配置详情。 */ Templates?: WebSecurityTemplates; } /** * NS 接入类型站点参数详情。 */ export interface NSDetail { /** * 是否开启 CNAME 加速，取值有：
  • enabled：开启；
  • disabled：关闭。
    • */ CnameSpeedUp?: string; /** * 是否存在同名站点，取值有：
  • 0：不存在同名站点；
  • 1：已存在同名站点。
    • */ IsFake?: number; /** * 归属权验证信息。针对 NS 接入类型的站点，将当前的 NS 服务器切换至腾讯云 EdgeOne 指定的 NS 服务器，即视为通过归属权验证。详情请参考 [站点/域名归属权验证](https://cloud.tencent.com/document/product/1552/70789) 。 */ OwnershipVerification?: OwnershipVerification; /** * 由 EdgeOne 检测到的站点当前正在使用的 NS 服务器列表。 */ OriginalNameServers?: Array; /** * 腾讯云 EdgeOne 分配的 NS 服务器列表。需要将当前站点 NS 服务器指向该地址，站点才能生效。 */ NameServers?: Array; /** * 用户自定义 NS 服务器域名信息。如果启用了自定义 NS 服务，需要在域名注册厂商内将 NS 指向该地址。 */ VanityNameServers?: VanityNameServers; /** * 用户自定义 NS 服务器对应的 IP 地址信息。 */ VanityNameServersIps?: Array; } /** * EnableOriginACL请求参数结构体 */ export interface EnableOriginACLRequest { /** * 站点 ID。 */ ZoneId: string; /** * 站点首次开启源站防护时，为七层加速域名配置特定回源 IP 网段的模式。
  • all：针对当前站点下的所有七层加速域名开启，当域名数量超过 200 时，请先通过 specific 模式启用 200 个域名，剩余资源通过 ModifyOriginACL 接口启用。
  • specific：针对站点下指定的七层加速域名开启。
    • 注意：当参数为空时，默认为 specific。后续新增七层加速域名/四层代理实例均请通过 ModifyOriginACL 接口配置。 */ L7EnableMode?: string; /** * 开启源站防护的七层加速域名列表，仅当参数 L7EnableMode 为 specific 时生效。L7EnableMode 为 all 时，请保留此参数为空。单次最大仅支持填写 200 个七层加速域名。 */ L7Hosts?: Array; /** * 站点首次开启源站防护时，为四层代理实例配置特定回源 IP 网段的模式。
  • all：针对当前站点下的所有四层代理实例开启，当实例数量超过 100 时，请先通过 specific 模式启用 100 个域名，剩余资源通过 ModifyOriginACL 接口启用。
  • specific：针对站点下指定的四层代理实例开启。
    • 注意：当参数为空时，默认为 specific。后续新增七层加速域名/四层代理实例均请通过 ModifyOriginACL 接口配置。 */ L4EnableMode?: string; /** * 开启源站防护的四层代理实例列表，仅当参数 L4EnableMode 为 specific 时生效。L4EnableMode 为 all 时，请保留此参数为空。单次最大仅支持填写 100 个四层代理实例。 */ L4ProxyIds?: Array; /** * 源站防护回源ACL控制域，不填则默认用标准全球控制域；可用控制域信息可以通过DescribeAvailableOriginACLFamily接口查询获得。 具体取值说明如下：
  • gaz：标准全球可用区控制域；
  • mlc：标准中国大陆可用区控制域；
  • emc：标准全球(不含中国大陆)可用区控制域；
  • plat-gaz：精简全球可用区控制域；
  • plat-mlc：精简中国大陆可用区控制域；
  • plat-emc：精简全球(不含中国大陆)可用区控制域；
    • */ OriginACLFamily?: string; } /** * CreateEdgeKVNamespace返回参数结构体 */ export interface CreateEdgeKVNamespaceResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyZone返回参数结构体 */ export interface ModifyZoneResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteMultiPathGatewayLine返回参数结构体 */ export interface DeleteMultiPathGatewayLineResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 智能客户端过滤 */ export interface ClientFiltering { /** * 智能客户端过滤是否开启。取值有：
  • on：开启；
  • off：关闭。
    • */ Enabled: string; /** * 智能客户端过滤的规则 ID，仅作为出参返回。 */ Id?: string; /** * 智能客户端过滤的处置方式，当 Enabled 为 on 时，此字段必填。SecurityAction 的 Name 取值支持：
  • Monitor：观察；
  • Deny：拦截；
  • Challenge：挑战，其中ChallengeActionParameters.Name仅支持JSChallenge。
    • */ Action?: SecurityAction; } /** * DescribePrefetchOriginLimit请求参数结构体 */ export interface DescribePrefetchOriginLimitRequest { /** * 站点ID。 */ ZoneId: string; /** * 分页查询偏移量，默认为 0。 */ Offset?: number; /** * 分页查询限制数目，默认值：20，上限：100。 */ Limit?: number; /** * 过滤条件，Filters.Values 的上限为 20。详细的过滤条件如下：
  • domain-name：按照域名过滤。domain-name 形如：www.qq.com，不支持模糊查询；
  • area：按照限制加速区域过滤，不支持模糊查询。可选项：
     Overseas：全球可用区（不含中国大陆）；
     MainlandChina：中国大陆可用区。
    • */ Filters?: Array; } /** * DescribeTopL7CacheData请求参数结构体 */ export interface DescribeTopL7CacheDataRequest { /** * 开始时间。 */ StartTime: string; /** * 结束时间。 */ EndTime: string; /** * 查询的指标，取值有：
  • l7Cache_outFlux_domain：host/域名；
  • l7Cache_outFlux_url：url地址；
  • l7Cache_outFlux_resourceType：资源类型；
  • l7Cache_outFlux_statusCode：状态码。
    • */ MetricName: string; /** * 站点 ID 集合，此参数必填。 */ ZoneIds: Array; /** * 查询前多少个数据，最大值为1000，不填默认为10， 表示查询前top 10的数据。 */ Limit?: number; /** * 过滤条件，详细的过滤条件如下：
  • domain
       按照【子域名】进行过滤，子域名形如： test.example.com。
       类型：String
       必选：否
  • url
       按照【URL】进行过滤，此参数只支持30天的时间范围，URL形如：/content。
       类型：String
       必选：否
  • resourceType
       按照【资源类型】进行过滤，此参数只支持30天的时间范围，资源类型形如：jpg，png。
       类型：String
       必选：否
  • cacheType
       按照【缓存类型】进行过滤。
       类型：String
       必选：否
       可选项：
       hit：命中缓存；
       dynamic：资源不可缓存；
       miss：未命中缓存。
  • statusCode
       按照【状态码】进行过滤，此参数只支持30天的时间范围。
       类型：String
       必选：否
       可选项：
       1XX：1xx类型的状态码；
       100：100状态码；
       101：101状态码；
       102：102状态码；
       2XX：2xx类型的状态码；
       200：200状态码；
       201：201状态码；
       202：202状态码；
       203：203状态码；
       204：204状态码；
       100：100状态码；
       206：206状态码；
       207：207状态码；
       3XX：3xx类型的状态码；
       300：300状态码；
       301：301状态码；
       302：302状态码；
       303：303状态码；
       304：304状态码；
       305：305状态码；
       307：307状态码；
       4XX：4xx类型的状态码；
       400：400状态码；
       401：401状态码；
       402：402状态码；
       403：403状态码；
       404：404状态码；
       405：405状态码；
       406：406状态码；
       407：407状态码；
       408：408状态码；
       409：409状态码；
       410：410状态码；
       411：411状态码；
       412：412状态码；
       412：413状态码；
       414：414状态码；
       415：415状态码；
       416：416状态码；
       417：417状态码；
       422：422状态码；
       423：423状态码；
       424：424状态码；
       426：426状态码；
       451：451状态码；
       5XX：5xx类型的状态码；
       500：500状态码；
       501：501状态码；
       502：502状态码；
       503：503状态码；
       504：504状态码；
       505：505状态码；
       506：506状态码；
       507：507状态码；
       510：510状态码；
       514：514状态码；
       544：544状态码。
  • tagKey
       按照【标签Key】进行过滤。
       类型：String
       必选：否
  • tagValue
       按照【标签Value】进行过滤。
       类型：String
       必选：否
    • */ Filters?: Array; /** * 查询时间粒度，取值有：
  • min: 1分钟；
  • 5min: 5分钟；
  • hour: 1小时；
  • day: 1天。
    • 不填将根据开始时间跟结束时间的间距自动推算粒度，具体为：一小时范围内以min粒度查询，两天范围内以5min粒度查询，七天范围内以hour粒度查询，超过七天以day粒度查询。 */ Interval?: string; /** * 数据归属地区，取值有：
  • overseas：全球（除中国大陆地区）数据；
  • mainland：中国大陆地区数据；
  • global：全球数据。
    • 不填默认取值为global。 */ Area?: string; } /** * 推理服务硬件配置。 */ export interface InferenceHardwareConfig { /** *

    推理服务单个实例分配的 GPU 卡数，当前仅支持整数值，且必须为 HardwareSpecId 对应规格的 AllowedGPUNums 中的可选值。

    若不填充，则使用所选 HardwareSpecId 规格对应的默认 GPUNum 值。

    */ GPUNum?: number; /** *

    推理服务单个实例分配的 CPU 核数，当前仅支持整数值。

    若不填充，则使用所选 HardwareSpecId 规格对应的默认 CPUNum 值。

    */ CPUNum?: number; /** *

    推理服务单实例分配的内存大小。

    单位：MB

    若不填充，则使用所选 HardwareSpecId 对应规格的默认 MemSize 值；若填充，则必须为 1024 的整数倍。

    */ MemSize?: number; /** *

    推理服务单实例分配的临时磁盘大小。

    单位：MB

    若不填充，则使用所选 HardwareSpecId 对应规格的默认 DiskSize 值；若填充，则必须为 1024 的整数倍。

    */ DiskSize?: number; } /** * 会话速率和周期特征校验配置。 */ export interface SessionRateControl { /** * 会话速率和周期特征校验配置是否开启。取值有：
  • on：启用
  • off：关闭
    • */ Enabled?: string; /** * 会话速率和周期特征校验高风险的执行动作。 SecurityAction 的 Name 取值支持：
  • Deny：拦截，其中 DenyActionParameters 中支持 Stall 配置；
  • Monitor：观察；
  • Allow：等待后响应，其中 AllowActionParameters 需要 MinDelayTime 和 MaxDelayTime 配置。
    • */ HighRateSessionAction?: SecurityAction; /** * 会话速率和周期特征校验中风险的执行动作。 SecurityAction 的 Name 取值支持：
  • Deny：拦截，其中 DenyActionParameters 中支持 Stall 配置；
  • Monitor：观察；
  • Allow：等待后响应，其中 AllowActionParameters 需要 MinDelayTime 和 MaxDelayTime 配置。
    • */ MidRateSessionAction?: SecurityAction; /** * 会话速率和周期特征校验低风险的执行动作。 SecurityAction 的 Name 取值支持：
  • Deny：拦截，其中 DenyActionParameters 中支持 Stall 配置；
  • Monitor：观察；
  • Allow：等待后响应，其中 AllowActionParameters 需要 MinDelayTime 和 MaxDelayTime 配置。
    • */ LowRateSessionAction?: SecurityAction; } /** * CreateLoadBalancer请求参数结构体 */ export interface CreateLoadBalancerRequest { /** *

    站点 ID。

    */ ZoneId: string; /** *

    实例名称，可输入 1-200 个字符，允许字符为 a-z，A-Z，0-9，_，-。

    */ Name: string; /** *

    实例类型，取值有：

  • HTTP_V2：HTTP 专用型（V2），支持添加 HTTP 专用型和通用型源站组，仅支持被站点加速相关服务引用（如域名服务和规则引擎）。该实例类型支持选择发起探测的区域，可显著降低探测请求量但对源站的健康感知灵敏度更低；
  • HTTP：HTTP 专用型（V1），支持添加 HTTP 专用型和通用型源站组，仅支持被站点加速相关服务引用（如域名服务和规则引擎）。该实例类型不支持选择发起探测的区域，探测请求量较大但对源站的健康感知灵敏度更高；
  • GENERAL：通用型，仅支持添加通用型源站组，能被站点加速服务（如域名服务和规则引擎）和四层代理引用。该实例类型不支持选择发起探测的区域，探测请求量较大但对源站的健康感知灵敏度更高。
    • */ Type: string; /** *

    源站组列表及其对应的容灾调度优先级。详情请参考 快速创建负载均衡实例 中的示例场景。

    */ OriginGroups: Array; /** *

    健康检查策略。详情请参考 健康检查策略介绍。不填写时，默认为不启用健康检查。

    */ HealthChecker?: HealthChecker; /** *

    源站组间的流量调度策略，取值有：

  • Pritory：按优先级顺序进行故障转移。
    • 默认值为 Pritory。 */ SteeringPolicy?: string; /** *

    实际访问某源站失败时的请求重试策略，详情请参考 请求重试策略介绍，取值有：

  • OtherOriginGroup：单次请求失败后，请求优先重试下一优先级源站组；
  • OtherRecordInOriginGroup：单次请求失败后，请求优先重试同源站组内的其他源站。
    • 默认值为 OtherRecordInOriginGroup。 */ FailoverPolicy?: string; } /** * 域名 https 加速配置，默认为关闭状态 */ export interface Https { /** * http2 配置开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Http2?: string; /** * OCSP 配置开关，取值有：
  • on：开启；
  • off：关闭。
    • */ OcspStapling?: string; /** * Tls 版本设置，取值有：
  • TLSv1：TLSv1版本；
  • TLSv1.1：TLSv1.1版本；
  • TLSv1.2：TLSv1.2版本；
  • TLSv1.3：TLSv1.3版本。
    • 修改时必须开启连续的版本。 */ TlsVersion?: Array; /** * HSTS 配置。 注意：此字段可能返回 null，表示取不到有效值。 */ Hsts?: Hsts; /** * 证书配置。 注意：此字段可能返回 null，表示取不到有效值。 */ CertInfo?: Array; /** * 申请类型，取值有：
  • apply：托管EdgeOne；
  • none：不托管EdgeOne。
    • 不填，默认取值为none。 */ ApplyType?: string; /** * 密码套件，取值有：
  • loose-v2023：提供高兼容性，安全性一般，支持 TLS 1.0-1.3 密码套件；
  • general-v2023：提供较高兼容性，安全性中等，支持 TLS 1.2-1.3 密码套件；
  • strict-v2023：提供高安全性能，禁用所有含不安全隐患的加密套件，支持 TLS 1.2-1.3 密码套件。
    • */ CipherSuite?: string; } /** * DescribeOriginGroupHealthStatus请求参数结构体 */ export interface DescribeOriginGroupHealthStatusRequest { /** * 站点 ID。 */ ZoneId: string; /** * 负载均衡实例 ID。 */ LBInstanceId: string; /** * 源站组 ID。不填写时默认获取负载均衡下所有源站组的健康状态。 */ OriginGroupIds?: Array; } /** * DescribeContentIdentifiers请求参数结构体 */ export interface DescribeContentIdentifiersRequest { /** * 分页查询偏移量。默认值：0。 */ Offset?: number; /** * 分页查询限制数目。默认值：20，最大值：100。 */ Limit?: number; /** * 过滤条件，Filters 的上限为 20，Filters.Values 的上限为 20。该参数不填写时，默认返回当前 AppId 下有权限的内容标识符。详细的过滤条件如下：
  • description：按照内容标识符描述批量进行过滤；例如：test；
  • content-id：按照内容标识符 ID 批量进行过滤；例如：eocontent-2noz78a8ev6k；
  • tag-key：按照标签键进行过滤；
  • tag-value： 按照标签值进行过滤；
  • status：按照内容标识符状态进行过滤，取值有：active：生效中；deleted：已删除。
    • 仅支持按照 description 模糊查询，其余字段需要精准查询。 */ Filters?: Array; } /** * ExportZoneConfig请求参数结构体 */ export interface ExportZoneConfigRequest { /** * 站点 ID。 */ ZoneId: string; /** * 导出配置项的类型列表，不填表示导出所有类型的配置，当前支持的取值有：
  • L7AccelerationConfig：表示导出七层加速配置，对应控制台「站点加速-全局加速配置」和「站点加速-规则引擎」。
  • WebSecurity：表示导出 Web 防护配置。
  • AccelerationDomain：表示导出加速域名配置，对应控制台「域名服务-域名管理」和「域名服务-共享 CNAME 管理」。
  • Origin：表示导出源站配置，对应控制台「源站配置-源站组」和「源站配置-负载均衡」。
    • 需注意：后续支持导出的类型会随着迭代增加，导出所有类型时需要注意导出文件大小，建议使用时指定需要导出的配置类型，以便控制请求响应包负载大小。 */ Types?: Array; } /** * 源站组健康状态详情。 */ export interface OriginGroupHealthStatusDetail { /** * 源站组 ID。 */ OriginGroupId?: string; /** * 根据所有探测区域的结果综合决策出来的源站组下各个源站的健康状态。超过一半的地域判定该源站不健康，则对应状态为不健康，否则为健康。 */ OriginHealthStatus?: Array; /** * 各个健康检查区域下源站的健康状态。 */ CheckRegionHealthStatus?: Array; } /** * 四层代理转发规则详情。 */ export interface L4ProxyRule { /** * 转发规则 ID。 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数请勿填写；在 ModifyL4ProxyRules 作为入参使用时，该参数必填。 */ RuleId?: string; /** * 转发协议。取值有：
  • TCP：TCP 协议；
  • UDP：UDP 协议。
    • 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。 */ Protocol?: string; /** * 转发端口，支持按照以下形式填写：
  • 单端口，如：80；
  • 端口段，如：81-85。表示 81、82、83、84、85 五个端口。
    • 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。 */ PortRange?: Array; /** * 源站类型，取值有：
  • IP_DOMAIN：IP/域名源站；
  • ORIGIN_GROUP：源站组；
  • LB：负载均衡，当前仅白名单开放。
    • 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。 */ OriginType?: string; /** * 源站地址：
  • 当 OriginType 为 IP_DOMAIN 时，填写 IP 或域名，如 8.8.8.8 或 test.com ；
  • 当 OriginType 为 ORIGIN_GROUP 时，填写源站组 ID，如 og-537y24vf5b41；
  • 当 OriginType 为 LB 时，填写负载均衡实例 ID，如 lb-2qwk30xf7s9g。
    • 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。 */ OriginValue?: Array; /** * 源站端口，支持按照以下形式填写：
  • 单端口，如：80；
  • 端口段，如：81-85，表示 81、82、83、84、85 五个端口。填写端口段时，则需要与转发端口段长度保持一致，例如转发端口：80-90，则转发端口：90-100。
    • 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。 */ OriginPortRange?: string; /** * 传递客户端 IP 的形式，取值有：
  • TOA：TOA（仅 Protocol = TCP 时可选）；
  • PPV1：Proxy Protocol 传递，协议版本 V1（仅 Protocol = TCP 时可选）；
  • PPV2：Proxy Protocol 传递，协议版本 V2；
  • SPP：Simple Proxy Protocol 传递，（仅 Protocol = UDP 时可选）；
  • OFF：不传递。
    • 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 OFF；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。 */ ClientIPPassThroughMode?: string; /** * 是否开启会话保持，取值有：
  • on：开启；
  • off：关闭。
    • 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 off；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。 */ SessionPersist?: string; /** * 会话保持时间，取值范围为 30-3600，单位为秒。 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，仅当 SessionPersist = on 时，该值才会生效，且当 SessionPersist = on ，该值不填写默认为 3600；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。 */ SessionPersistTime?: number; /** * 规则标签。可输入1-50 个任意字符。 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。 */ RuleTag?: string; /** * 规则状态，取值有：
  • online：已启用；
  • offline：已停用；
  • progress：部署中；
  • stopping：停用中；
  • fail：部署失败/停用失败。
    • 注意：L4ProxyRule 在 CreateL4ProxyRules、ModifyL4ProxyRules 作为入参使用时，该参数请勿填写。 */ Status?: string; /** * BuID。 */ BuId?: string; /** * 远程鉴权信息。 注意：RemoteAuth 在 CreateL4ProxyRules 或 ModifyL4ProxyRules 不可作为入参使用，如有传此参数，会忽略。在 DescribeL4ProxyRules 返回为空时，表示没有开启远程鉴权。 注意：此字段可能返回 null，表示取不到有效值。 */ RemoteAuth?: L4ProxyRemoteAuth; } /** * 网络错误日志记录配置项。 */ export interface NetworkErrorLoggingParameters { /** * 网络错误日志记录配置开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch?: string; } /** * 自定义 Cache Key 查询字符串配置参数。 */ export interface CacheKeyQueryString { /** * 查询字符串保留/忽略指定参数开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch?: string; /** * 查询字符串保留/忽略指定参数动作。取值有：
  • includeCustom：表示保留部分参数；
  • excludeCustom：表示忽略部分参数。
    • 注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。 */ Action?: string; /** * 查询字符串中需保留/忽略的参数名列表。
    注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。 */ Values?: Array; } /** * ModifyMultiPathGatewayLine请求参数结构体 */ export interface ModifyMultiPathGatewayLineRequest { /** * 站点 ID。 */ ZoneId: string; /** * 多通道安全加速网关 ID 。 */ GatewayId: string; /** * 线路 ID ， 取值有:
  • line-1： EdgeOne 四层代理线路，支持修改实例和规则，不支持删除；
  • line-2 及以上：EdgeOne 四层代理线路或者自定义线路，支持修改、删除实例和规则。
    • */ LineId: string; /** * 线路类型，取值有：
  • proxy ：EdgeOne 四层代理线路，支持修改实例和规则，不支持删除；
  • custom ：自定义线路，支持编辑、删除实例和规则。
    • */ LineType?: string; /** * 线路地址，格式为 host:port，直连线路（ LineType 取值为 direct ）不允许修改，其余类型支持修改。 */ LineAddress?: string; /** * 四层代理实例 ID ，当线路类型 LineType 取值为 proxy（EdgeOne 四层代理）可传入，进行修改。 */ ProxyId?: string; /** * 转发规则 ID ，当线路类型 LineType 取值为 proxy（EdgeOne 四层代理）可传入，进行修改。 */ RuleId?: string; } /** * 描述键值对过滤器，用于条件过滤查询，支持模糊查询。例如过滤ID、名称、状态等。 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。 */ export interface AdvancedFilter { /** * 需要过滤的字段。 */ Name: string; /** * 字段的过滤值。 */ Values: Array; /** * 是否启用模糊查询。 */ Fuzzy?: boolean; } /** * DescribeDDoSAttackData返回参数结构体 */ export interface DescribeDDoSAttackDataResponse { /** *

    查询结果的总条数。

    */ TotalCount?: number; /** *

    DDoS 攻击数据内容列表。

    注意：此字段可能返回 null，表示取不到有效值。 */ Data?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 安全模板配置 */ export interface TemplateConfig { /** * 模板ID。 */ TemplateId: string; /** * 模板名称。 */ TemplateName: string; } /** * Bot 规则项的具体配置，用于覆盖上层的默认配置。 */ export interface BotManagementActionOverrides { /** * Bot 规则组下的具体项，用于改写此单条规则项配置的内容，Ids 所对应的具体信息请参考 DescribeBotManagedRules 接口返回的信息。 */ Ids?: Array; /** * Ids 中指定 Bot 规则项的处置动作。 SecurityAction 的 Name 取值支持：
  • Deny：拦截；
  • Monitor：观察；
  • Disabled：未启用，不启用指定规则；
  • Challenge：挑战，其中 ChallengeActionParameters 中的 ChallengeOption 支持 JSChallenge 和 ManagedChallenge；
  • Allow：放行（仅限Bot基础特征管理）。
    • */ Action?: SecurityAction; } /** * 自定义错误页面被引用的来源 */ export interface ErrorPageReference { /** * 引用的业务 ID，如自定义拦截规则 ID。 */ BusinessId?: string; } /** * DescribeIdentifications返回参数结构体 */ export interface DescribeIdentificationsResponse { /** * 符合条件的站点个数。 */ TotalCount?: number; /** * 站点验证信息列表。 */ Identifications?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Web 安全的 Bot 自定义规则。 */ export interface BotManagementCustomRule { /** * Bot 自定义规则的 ID。
    通过规则 ID 可支持不同的规则配置操作：
  • 增加新规则：ID 为空或不指定 ID 参数；
  • 修改已有规则：指定需要更新/修改的规则 ID；
  • 删除已有规则：BotManagementCustomRules 参数中，Rules 列表中未包含的已有规则将被删除。
    • */ Id?: string; /** * Bot 自定义规则的名称。 */ Name?: string; /** * Bot 自定义规则是否开启。取值有：
  • on：开启；
  • off：关闭。
    • */ Enabled?: string; /** * Bot 自定义规则的优先级，范围是 1 ~ 100，默认为 50。 */ Priority?: number; /** * Bot 自定义规则的具体内容，需符合表达式语法，详细规范参见产品文档。 */ Condition?: string; /** * Bot 自定义规则的处置方式。取值有：
  • Monitor：观察；
  • Deny：拦截，其中 DenyActionParameters.Name 支持 Deny 和 ReturnCustomPage；
  • Challenge：挑战，其中 ChallengeActionParameters.Name 支持 JSChallenge 和 ManagedChallenge；
  • Redirect：重定向至 URL。
    • */ Action?: Array; } /** * DeleteL4Proxy返回参数结构体 */ export interface DeleteL4ProxyResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyApplicationProxyRuleStatus返回参数结构体 */ export interface ModifyApplicationProxyRuleStatusResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DisableOriginACL请求参数结构体 */ export interface DisableOriginACLRequest { /** * 站点 ID。 */ ZoneId: string; } /** * 验证码认证实例信息。 */ export interface TCCaptchaOption { /** * CaptchaAppId 信息。 */ CaptchaAppId: string; /** * AppSecretKey 信息。 */ AppSecretKey: string; } /** * 回源时携带客户端 IP 所属地域信息，值的格式为 ISO-3166-1 两位字母代码。 */ export interface ClientIPCountryParameters { /** * 配置开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch?: string; /** * 存放客户端 IP 所属地域信息的请求头名称，当 Switch=on 时有效。为空则使用默认值：EO-Client-IPCountry。 */ HeaderName?: string; } /** * 域名级策略。 */ export interface HostPolicy { /** *

    站点级策略，针对站点下所有域名生效的策略，详情见 站点级策略。

    */ Host?: string; /** *

    当前域名使用的策略类型。取值有：

  • ZoneDefault：使用站点级策略，即 ZoneDefaultPolicy 中定义的策略配置。
  • Custom：使用域名级策略。使用该选项时，必须同时配置 Policy 字段，指定详细策略配置。
  • Template：使用策略模板。使用该选项时，必须同时配置 TemplateId 字段，指定当前域名使用的策略模板。

    • */ PolicyType?: string; /** *

    可选。当 PolicyType 为 Custom 时，该字段为当前域名的详细策略配置，对当前域名生效。

    */ Policy?: SecurityPolicy; /** *

    可选。当 PolicyType 为 Template 时，该字段用于指定当前域名所使用的策略模板的 Id。

    */ TemplateId?: string; } /** * IncreasePlanQuota返回参数结构体 */ export interface IncreasePlanQuotaResponse { /** * 订单号。 */ DealName?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeIPRegion返回参数结构体 */ export interface DescribeIPRegionResponse { /** * IP 归属信息列表。 */ IPRegionInfo?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAvailablePlans请求参数结构体 */ export type DescribeAvailablePlansRequest = null; /** * 自定义变量运算详情。 */ export interface CustomVariableOperation { /** *

    子规则分支。此列表当前只支持填写一项规则，多填无效。

    注意：此字段可能返回 null，表示取不到有效值。 */ Branches?: Array; /** *

    规则注释。可以填写多个注释。

    */ Description?: Array; } /** * ModifyMultiPathGatewayStatus返回参数结构体 */ export interface ModifyMultiPathGatewayStatusResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * IP 情报库（原客户端画像分析）的具体配置。 */ export interface IPReputationGroup { /** * IP 情报库（原客户端画像分析）的执行动作。SecurityAction 的 Name 取值支持：
  • Deny：拦截；
  • Monitor：观察；
  • Disabled：未启用，不启用指定规则；
  • Challenge：挑战，其中 ChallengeActionParameters 中的 ChallengeOption 支持 JSChallenge 和 ManagedChallenge。
    • */ BaseAction?: SecurityAction; /** * IP 情报库（原客户端画像分析）的具体配置，用于覆盖 BaseAction 中的默认配置。其中 BotManagementActionOverrides 的 Ids 中可以填写：
  • IPREP_WEB_AND_DDOS_ATTACKERS_LOW：网络攻击 - 一般置信度；
  • IPREP_WEB_AND_DDOS_ATTACKERS_MID：网络攻击 - 中等置信度；
  • IPREP_WEB_AND_DDOS_ATTACKERS_HIGH：网络攻击 - 高置信度；
  • IPREP_PROXIES_AND_ANONYMIZERS_LOW：网络代理 - 一般置信度；
  • IPREP_PROXIES_AND_ANONYMIZERS_MID：网络代理 - 中等置信度；
  • IPREP_PROXIES_AND_ANONYMIZERS_HIGH：网络代理 - 高置信度；
  • IPREP_SCANNING_TOOLS_LOW：扫描器 - 一般置信度；
  • IPREP_SCANNING_TOOLS_MID：扫描器 - 中等置信度；
  • IPREP_SCANNING_TOOLS_HIGH：扫描器 - 高置信度；
  • IPREP_ATO_ATTACKERS_LOW：账号接管攻击 - 一般置信度；
  • IPREP_ATO_ATTACKERS_MID：账号接管攻击 - 中等置信度；
  • IPREP_ATO_ATTACKERS_HIGH：账号接管攻击 - 高置信度；
  • IPREP_WEB_SCRAPERS_AND_TRAFFIC_BOTS_LOW：恶意 BOT - 一般置信度；
  • IPREP_WEB_SCRAPERS_AND_TRAFFIC_BOTS_MID：恶意 BOT - 中等置信度；
  • IPREP_WEB_SCRAPERS_AND_TRAFFIC_BOTS_HIGH：恶意 BOT - 高置信度。
    • */ BotManagementActionOverrides?: Array; } /** * EdgeKVDelete返回参数结构体 */ export interface EdgeKVDeleteResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 站点 CNAME 模式接入验证归属权或域名申请免费证书时，使用 DNS 解析验证时所需的信息。 */ export interface DnsVerification { /** * 主机记录。 */ Subdomain?: string; /** * 记录类型。 */ RecordType?: string; /** * 记录值。 */ RecordValue?: string; } /** * Cookie校验与会话跟踪。 */ export interface AlgDetectSession { /** * 操作名称。 */ Name?: string; /** * 校验方式，默认update_detect，取值有：
  • detect：仅校验；
  • update_detect：更新Cookie并校验。
    • */ DetectMode?: string; /** * 会话速率和周期特征校验开关，默认off，取值有：
  • off：关闭；
  • on：打开。
    • */ SessionAnalyzeSwitch?: string; /** * 校验结果为未携带Cookie或Cookie已过期的统计周期。单位为秒，默认10，取值：5～3600。 */ InvalidStatTime?: number; /** * 校验结果为未携带Cookie或Cookie已过期的触发阈值。单位为次，默认300，取值：1～100000000。 */ InvalidThreshold?: number; /** * Cookie校验校验结果。 */ AlgDetectResults?: Array; /** * 会话速率和周期特征校验结果。 */ SessionBehaviors?: Array; } /** * ModifyZoneStatus返回参数结构体 */ export interface ModifyZoneStatusResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteContentIdentifier请求参数结构体 */ export interface DeleteContentIdentifierRequest { /** * 内容标识符 ID。 */ ContentId: string; } /** * RefreshMultiPathGatewaySecretKey请求参数结构体 */ export interface RefreshMultiPathGatewaySecretKeyRequest { /** * 站点 ID。 */ ZoneId: string; } /** * CreateContentIdentifier请求参数结构体 */ export interface CreateContentIdentifierRequest { /** * 内容标识符的描述，长度限制不超过 20 个字符。 */ Description: string; /** * 待绑定的目标套餐 ID，仅限企业版可用。
  • 当您账号下已存在套餐时，需要先前往 [套餐管理](https://console.cloud.tencent.com/edgeone/package) 获取套餐 ID，直接将内容标识符绑定至该套餐；
  • 若您当前没有可绑定的套餐时，请先购买企业版套餐。
    • */ PlanId: string; /** * 标签。该参数用于对内容标识符进行分权限管控。您需要先前往 [标签控制台](https://console.cloud.tencent.com/tag/taglist) 创建标签才可以在此处传入对应的标签键和标签值。 */ Tags?: Array; } /** * 源站防护信息 */ export interface OriginProtectionInfo { /** * 站点ID。 */ ZoneId?: string; /** * 域名列表。 */ Hosts?: Array; /** * 代理ID列表。 */ ProxyIds?: Array; /** * 当前版本的IP白名单。 注意：此字段可能返回 null，表示取不到有效值。 */ CurrentIPWhitelist?: IPWhitelist; /** * 该站点是否需要更新源站白名单，取值有：
  • true ：需要更新IP白名单 ；
  • false ：无需更新IP白名单。
    • */ NeedUpdate?: boolean; /** * 源站防护状态，取值有：
  • online ：源站防护启用中 ；
  • offline ：源站防护已停用 ；
  • nonactivate ：源站防护未激活，仅在从未使用过源站防护功能的站点调用中返回。
    • */ Status?: string; /** * 站点套餐是否支持源站防护，取值有：
  • true ：支持 ；
  • false ：不支持。
    • */ PlanSupport?: boolean; /** * 最新IP白名单与当前IP白名单的对比。 注意：此字段可能返回 null，表示取不到有效值。 */ DiffIPWhitelist?: DiffIPWhitelist; } /** * DeleteInferenceAPIToken请求参数结构体 */ export interface DeleteInferenceAPITokenRequest { /** * 站点 ID。 */ ZoneId: string; /** * 推理 API Token 的 ID。 */ TokenId: string; } /** * ModifyPrefetchOriginLimit请求参数结构体 */ export interface ModifyPrefetchOriginLimitRequest { /** * 站点 ID。 */ ZoneId: string; /** * 加速域名。 */ DomainName: string; /** * 回源限速限制的加速区域。 预热时，该加速区域将会受到配置的Bandwidth值限制。取值有：
  • Overseas：全球可用区（不含中国大陆）；
  • MainlandChina：中国大陆可用区。
    • */ Area: string; /** * 回源限速带宽。 预热时回到源站的带宽上限值，取值范围 100 - 100,000，单位 Mbps。 */ Bandwidth: number; /** * 回源限速限制控制开关。 用于启用/删除本条回源限速限制，取值有：
  • on：启用限制；
  • off：删除限制。
    • */ Enabled: string; } /** * ModifyDnsRecordsStatus返回参数结构体 */ export interface ModifyDnsRecordsStatusResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifySecurityJSInjectionRule返回参数结构体 */ export interface ModifySecurityJSInjectionRuleResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 别称域名信息。 */ export interface AliasDomain { /** * 别称域名名称。 */ AliasName?: string; /** * 站点 ID。 */ ZoneId?: string; /** * 目标域名名称。 */ TargetName?: string; /** * 别称域名状态，取值有：
  • active：已生效；
  • pending：部署中；
  • conflict：被找回。
  • stop：已停用；
    • */ Status?: string; /** * 封禁模式，取值有：
  • 0：未封禁；
  • 11：合规封禁；
  • 14：未备案封禁。
    • */ ForbidMode?: number; /** * 别称域名创建时间。 */ CreatedOn?: string; /** * 别称域名修改时间。 */ ModifiedOn?: string; } /** * ImportZoneConfig请求参数结构体 */ export interface ImportZoneConfigRequest { /** *

    站点 ID。

    */ ZoneId: string; /** *

    待导入的配置内容。要求采用 JSON 格式，按照 UTF-8 方式进行编码。配置内容可通过站点配置导出接口（ExportZoneConfig）获取。您可以单独导入「站点加速-全局加速配置」或「站点加速-规则引擎」，传入对应的字段即可，详情可以参考下方示例。
    注意：ExportZoneConfig 导出的 AccelerationDomain（加速域名配置）、Origin（源站配置）暂不支持通过本接口导入，若 Content 中包含上述配置内容，将导致导入失败。

    */ Content: string; } /** * 自定义规则-基础访问管控配置。 */ export interface IpTableRule { /** * 动作，取值有：
  • drop：拦截；
  • trans：放行；
  • monitor：观察。
    • */ Action: string; /** * 根据类型匹配，取值有：
  • ip：客户端 IP 进行匹配；
  • area：客户端 IP 所属地区匹配；
  • asn：客户端所属的自治系统进行匹配；
  • referer：请求头 Referer 进行匹配；
  • ua：请求头 User-Agent 进行匹配；
  • url：请求 URL 进行匹配。
    • */ MatchFrom: string; /** * 规则的匹配方式。取值有：
  • match：匹配，适用于 MatchFrom 为 ip；
  • not_match：不匹配，适用于 MatchFrom 为 ip；
  • include_area：地域包含，适用于 MatchFrom 为 area；
  • not_include_area：地域不包含，适用于 MatchFrom 为 area；
  • asn_match：ASN 包含，适用于 MatchFrom 为 asn；
  • asn_not_match：ASN 不包含，适用于 MatchFrom 为 asn；
  • equal：等于，适用于 MatchFrom 为 ua , referer；
  • not_equal：不等于，适用于 MatchFrom 为 ua , referer；
  • include：通配符匹配，适用于 MatchFrom 为 ua , referer , url；
  • not_include：通配符不匹配，适用于 MatchFrom 为 ua , referer；
  • is_emty：配置内容为空，适用于 MatchFrom 为 ua , referer；
  • not_exists：配置内容不存在，适用于 MatchFrom 为 ua , referer。
    • */ Operator?: string; /** * 规则id。仅出参使用。 */ RuleID?: number; /** * 更新时间。仅出参使用。 */ UpdateTime?: string; /** * 规则启用状态。取值有：
  • on：启用；
  • off：未启用。
    • 当入参缺省时，按 on 取值。 */ Status?: string; /** * 规则名。 */ RuleName?: string; /** * 匹配内容。支持多值输入。
  • 当输入多个匹配值时，请使用英文逗号分隔；
  • 当 MatchFrom 为 ua 时，不支持多值输入；
  • 当 Operator 为 is_empty 或 not_exists 时，本字段入参值无效。
    • */ MatchContent?: string; } /** * 适用于四层代理或 Web 站点服务的独立 DDoS 防护规格配置。 */ export interface DDosProtectionConfig { /** * 中国大陆地区独立 DDoS 防护的规格。详情请参考 [独立 DDoS 防护相关费用](https://cloud.tencent.com/document/product/1552/94162)
  • PLATFORM：平台默认防护，即不开启独立 DDoS 防护；
  • BASE30_MAX300：开启独立 DDoS 防护，提供 30 Gbps 保底防护带宽以及 300 Gbps 弹性防护带宽；
  • BASE60_MAX600：开启独立 DDoS 防护，提供 60 Gbps 保底防护带宽以及 600 Gbps 弹性防护带宽。
    • 不填写参数时，取默认值 PLATFORM。 */ LevelMainland?: string; /** * 中国大陆地区独立 DDoS 防护的弹性防护带宽配置。 仅当开启中国大陆区域独立 DDos 防护时有效（详见 LevelMainland 参数配置），且取值范围有如下限制：
  • 开启中国大陆地区独立 DDoS 防护，使用 30 Gbps 保底防护带宽规格时（ LevelMainland 参数值为 BASE30_MAX300 ）：有效取值范围为 30 至 300，单位为 Gbps；
  • 开启中国大陆地区独立 DDoS 防护，使用 60 Gbps 保底防护带宽规格时（ LevelMainland 参数值为 BASE60_MAX600 ）：有效取值范围为 60 至 600，单位为 Gbps；
  • 使用平台默认防护（ LevelMainland 参数值为 PLATFORM ）：不支持配置，本参数值无效。
    • */ MaxBandwidthMainland?: number; /** * 全球（除中国大陆以外）地区独立 DDoS 防护的规格。
  • PLATFORM：平台默认防护，即不开启独立 DDoS 防护；
  • ANYCAST300：开启独立 DDoS 防护，提供 300 Gbps 防护带宽；
  • ANYCAST_ALLIN：开启独立 DDoS 防护，使用全部可用防护资源进行防护。
    • 不填写参数时，取默认值 PLATFORM。 */ LevelOverseas?: string; } /** * 用户风险等级配置。风险分数范围为 0～100，分数越高表示风险越高。 */ export interface UserRiskProfile { /** *

    高风险请求的最低风险分数。分数大于等于该值时，判定为高风险。

    取值范围：[2, 99]

    默认值：50

    */ HighRiskMinScore?: number; /** *

    高风险请求的处置方式。SecurityAction 的 Name 取值支持：

  • Deny：拦截；
  • Monitor：观察；
  • Redirect：重定向；
  • Challenge：挑战。
    • 默认值：Monitor

    */ HighRiskRequestAction?: SecurityAction; /** *

    中风险请求的最低风险分数。分数大于等于该值且小于 HighRiskMinScore 时，判定为中风险；低于该值时，判定为低风险。

    取值范围：[1, 98]

    默认值：15

    */ MediumRiskMinScore?: number; /** *

    中风险请求的处置方式。SecurityAction 的 Name 取值支持：

  • Deny：拦截；
  • Monitor：观察；
  • Redirect：重定向；
  • Challenge：挑战。
    • 默认值：Monitor

    */ MediumRiskRequestAction?: SecurityAction; } /** * ModifyFunctionRule请求参数结构体 */ export interface ModifyFunctionRuleRequest { /** * 站点 ID。 */ ZoneId: string; /** * 规则 ID。您可以先通过 DescribeFunctionRules 接口来获取需要修改的规则的 RuleId，然后传入修改后的规则内容，原规则内容会被覆盖式更新。 */ RuleId: string; /** * 规则条件列表，相同触发规则的不同条件匹配项之间为或关系，不填写保持原有配置。 */ FunctionRuleConditions?: Array; /** * 函数选择配置类型：
  • direct：直接指定执行函数；
  • weight：基于权重比选择函数；
  • region：基于客户端 IP 的国家/地区选择函数。
    • 不填时默认为 direct 。 */ TriggerType?: string; /** * 指定执行的函数 ID。当 TriggerType 为 direct 或 TriggerType 不填时生效。 */ FunctionId?: string; /** * 基于客户端 IP 国家/地区的函数选择配置，当 TriggerType 为 region 时生效且 RegionMappingSelections 必填。RegionMappingSelections 中至少包含一项 Regions 为 Default 的配置。 */ RegionMappingSelections?: Array; /** * 基于权重的函数选择配置，当 TriggerType 为 weight 时生效且 WeightedSelections 必填。WeightedSelections 中的所有权重之和需要为100。 */ WeightedSelections?: Array; /** * 规则描述，最大支持 60 个字符，不填写保持原有配置。 */ Remark?: string; } /** * DescribeSecurityIPGroup返回参数结构体 */ export interface DescribeSecurityIPGroupResponse { /** * 安全 IP 组的详细配置信息。包含每个安全 IP 组的 ID 、名称、IP / 网段总数量、 IP / 网段列表信息和过期时间信息。 */ IPGroups?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * IncreasePlanQuota请求参数结构体 */ export interface IncreasePlanQuotaRequest { /** * 套餐 ID, 形如 edgeone-2unuvzjmmn2q。 */ PlanId: string; /** * 新增的套餐配额类型，取值有：
  • site：站点数；
  • precise_access_control_rule：Web 防护 - 自定义规则 - 精准匹配策略的规则配额；
  • rate_limiting_rule：Web 防护 - 速率限制 - 精准速率限制模块的规则配额。
    • */ QuotaType: string; /** * 新增的配额个数。单次新增的配额个数上限为 100。 */ QuotaNumber: number; } /** * 边缘函数触发规则。 */ export interface FunctionRule { /** * 规则ID。 */ RuleId?: string; /** * 规则条件列表，列表项之间为或关系。 */ FunctionRuleConditions?: Array; /** * 函数选择配置类型：
  • direct：直接指定执行函数；
  • weight：基于权重比选择函数；
  • region：基于客户端 IP 的国家/地区选择函数。
    • */ TriggerType?: string; /** * 指定执行的函数 ID。当 TriggerType 为 direct 时有效。 */ FunctionId?: string; /** * 指定执行的函数名称。 */ FunctionName?: string; /** * 基于客户端 IP 国家/地区的函数选择配置。 */ RegionMappingSelections?: Array; /** * 基于权重的函数选择配置。 */ WeightedSelections?: Array; /** * 函数触发规则优先级，数值越大，优先级越高。 */ Priority?: number; /** * 规则描述。 */ Remark?: string; /** * 创建时间。时间为世界标准时间（UTC）， 遵循 ISO 8601 标准的日期和时间格式。 */ CreateTime?: string; /** * 更新时间。时间为世界标准时间（UTC）， 遵循 ISO 8601 标准的日期和时间格式。 */ UpdateTime?: string; } /** * 回源请求参数 Cookie 配置。 */ export interface UpstreamRequestCookie { /** * 回源请求参数 Cookie 配置开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch?: string; /** * 回源请求参数 Cookie 模式。当 Switch 为 on 时，该参数必填。取值有：
  • full：表示全部保留；
  • ignore：表示全部忽略；
  • includeCustom：表示保留部分参数；
  • excludeCustom：表示忽略部分参数。
    • */ Action?: string; /** * 指定参数值。仅当查询字符串模式 Action 为 includeCustom 或者 excludeCustom 时该参数生效，用于指定需要保留或者忽略的参数。最大支持 10 个参数。 */ Values?: Array; } /** * 网络错误日志记录配置项 */ export interface NetworkErrorLogging { /** * 是否开启网络错误日志记录配置，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch: string; } /** * KV 键值对数据，包含键名、键值和过期时间信息。 */ export interface KeyValuePair { /** * 键名。每个键名不能为空，长度为 1-512 个字符，支持合法 UTF-8 字符。 */ Key?: string; /** * 键值。入参时不能为空，最大支持 1 MB。出参时若键不存在，则返回空字符串。 */ Value?: string; /** * 过期时间，遵循 ISO 8601 标准，格式为 YYYY-MM-DDThh:mm:ssZ（UTC 时间）。出参时若为空字符串，表示该键值对永不过期。 */ Expiration?: string; } /** * DescribeDDoSAttackTopData请求参数结构体 */ export interface DescribeDDoSAttackTopDataRequest { /** * 开始时间。 */ StartTime: string; /** * 结束时间。查询时间范围（`EndTime` - `StartTime`）需小于等于 31 天。 */ EndTime: string; /** * 查询的统计指标，取值有：
  • ddos_attackFlux_protocol：按各协议的攻击流量排行；
  • ddos_attackPackageNum_protocol：按各协议的攻击包量排行；
  • ddos_attackNum_attackType：按各攻击类型的攻击数量排行；
  • ddos_attackNum_sregion：按攻击源地区的攻击数量排行；
  • ddos_attackFlux_sip：按攻击源IP的攻击数量排行；
  • ddos_attackFlux_sregion：按攻击源地区的攻击数量排行。
    • */ MetricName: string; /** * 站点 ID 集合，此参数将于2024年05月30日后由可选改为必填，详见公告：[【腾讯云 EdgeOne】云 API 变更通知](https://cloud.tencent.com/document/product/1552/104902)。最多传入 100 个站点 ID。若需查询腾讯云主账号下所有站点数据，请用 `*` 代替，查询账号级别数据需具备本接口全部站点资源权限。 */ ZoneIds?: Array; /** * DDoS策略组ID集合，不填默认选择全部策略ID。 */ PolicyIds?: Array; /** * 攻击类型，取值有：
  • flood：洪泛攻击；
  • icmpFlood：icmp洪泛攻击；
  • all：所有的攻击类型。
    • 不填默认为all，表示查询全部攻击类型。 */ AttackType?: string; /** * 协议类型，取值有：
  • tcp：tcp协议；
  • udp：udp协议；
  • all：所有的协议类型。
    • 不填默认为all，表示查询所有协议。 */ ProtocolType?: string; /** * 端口号。 */ Port?: number; /** * 查询前多少个数据，不填默认默认为10， 表示查询前top 10的数据。 */ Limit?: number; /** * 数据归属地区，取值有：
  • overseas：全球（除中国大陆地区）数据；
  • mainland：中国大陆地区数据。
    • 不填将根据用户所在地智能选择地区。 */ Area?: string; } /** * Quic配置项 */ export interface Quic { /** * 是否开启 Quic 配置，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch: string; } /** * DescribeDDoSAttackData请求参数结构体 */ export interface DescribeDDoSAttackDataRequest { /** *

    开始时间。时间为世界标准时间（UTC），遵循 ISO 8601 标准的日期和时间格式。

    */ StartTime: string; /** *

    结束时间。时间为世界标准时间（UTC），遵循 ISO 8601 标准的日期和时间格式。查询时间范围（EndTime - StartTime）需小于等于 31 天。

    */ EndTime: string; /** *

    统计指标列表，至少填写 1 个，且不允许重复。

    枚举值：

    • ddos_attackMaxBandwidth： 攻击带宽峰值，单位 bps；
    • ddos_attackMaxPackageRate： 攻击包速率峰值，单位 pps；
    • ddos_attackBandwidth： 攻击带宽曲线，单位 bps；
    • ddos_attackPackageRate： 攻击包速率曲线，单位 pps。
    */ MetricNames: Array; /** *

    站点 ID 集合，此参数将于2024年05月30日后由可选改为必填，详见公告：【腾讯云 EdgeOne】云 API 变更通知。最多传入 100 个站点 ID。若需查询腾讯云主账号下所有站点数据，请用 * 代替，查询账号级别数据需具备本接口全部站点资源权限。

    */ ZoneIds: Array; /** *

    DDoS 策略组 ID 列表，不填默认选择全部策略 ID。

    */ PolicyIds?: Array; /** *

    查询时间粒度，不填将根据开始时间与结束时间的间隔自动推算粒度，具体为：1 小时范围内以 min 粒度查询，2 天范围内以 5min 粒度查询，7 天范围内以 hour 粒度查询，超过 7 天以 day 粒度查询。

    枚举值：

    • min： 1 分钟；
    • 5min： 5分钟；
    • hour： 1小时；
    • day： 1天。
    */ Interval?: string; /** *

    数据归属地区。

    枚举值：

    • overseas： 全球（除中国大陆地区）数据；
    • mainland： 中国大陆地区数据；
    • global： 全球数据。

    默认值：global

    */ Area?: string; /** *

    过滤条件，QueryCondition.Value 的集合数量上限为 20，详细的过滤条件 QueryCondition.Key 值如下：

  • ddos-attack-dip：按照 DDoS 攻击目的 IP 进行过滤，QueryCondition.Operator 仅支持 equals。
    • */ Filters?: Array; } /** * 慢速攻击防护的具体配置。 */ export interface SlowAttackDefense { /** * 慢速攻击防护是否开启。取值有：
  • on：开启；
  • off：关闭。
    • */ Enabled: string; /** * 慢速攻击防护的规则 ID，仅作为出参返回。 */ Id?: string; /** * 慢速攻击防护的处置方式，当 Enabled 为 on 时，此字段必填。SecurityAction 的 Name 取值支持：
  • Monitor：观察；
  • Deny：拦截；
    • */ Action?: SecurityAction; /** * 正文传输最小速率阈值的具体配置，当 Enabled 为 on 时，此字段必填。 */ MinimalRequestBodyTransferRate?: MinimalRequestBodyTransferRate; /** * 正文传输超时时长的具体配置，当 Enabled 为 on 时，此字段必填。 */ RequestBodyTransferTimeout?: RequestBodyTransferTimeout; } /** * CreateCLSIndex请求参数结构体 */ export interface CreateCLSIndexRequest { /** * 站点 ID。 */ ZoneId: string; /** * 实时日志投递任务 ID。 */ TaskId: string; } /** * DescribeRules请求参数结构体 */ export interface DescribeRulesRequest { /** * 站点 ID。 */ ZoneId: string; /** * 过滤条件，Filters.Values的上限为20。详细的过滤条件如下：
  • rule-id：按照规则 ID 进行过滤。
    • */ Filters?: Array; } /** * DescribeContentQuota返回参数结构体 */ export interface DescribeContentQuotaResponse { /** * 刷新相关配额。 注意：此字段可能返回 null，表示取不到有效值。 */ PurgeQuota?: Array; /** * 预热相关配额。 注意：此字段可能返回 null，表示取不到有效值。 */ PrefetchQuota?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyZoneSetting返回参数结构体 */ export interface ModifyZoneSettingResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DownloadL7Logs返回参数结构体 */ export interface DownloadL7LogsResponse { /** * 查询结果的总条数。 */ TotalCount?: number; /** * 七层离线日志数据列表。 */ Data?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 加速域名 */ export interface AccelerationDomain { /** *

    站点 ID。

    */ ZoneId?: string; /** *

    加速域名名称。

    */ DomainName?: string; /** *

    加速域名状态

    枚举值：

    • online： 已生效
    • process： 部署中
    • offline： 已停用
    • init： 未生效，待激活站点
    */ DomainStatus?: string; /** *

    CNAME 地址。

    */ Cname?: string; /** *

    IPv6 状态，取值有：

  • follow：遵循站点IPv6配置；
  • on：开启状态；
  • off：关闭状态。
    • 注意：此字段可能返回 null，表示取不到有效值。 */ IPv6Status?: string; /** *

    加速域名归属权验证状态，取值有：

  • pending：待验证；
  • finished：已完成验证。
    • 注意：此字段可能返回 null，表示取不到有效值。 */ IdentificationStatus?: string; /** *

    加速域名需进行归属权验证才能继续提供服务时，该对象会携带对应验证方式所需要的信息。

    注意：此字段可能返回 null，表示取不到有效值。 */ OwnershipVerification?: OwnershipVerification; /** *

    源站信息。

    注意：此字段可能返回 null，表示取不到有效值。 */ OriginDetail?: OriginDetail; /** *

    回源协议，取值有：

  • FOLLOW：协议跟随；
  • HTTP：HTTP协议回源；
  • HTTPS：HTTPS协议回源。
    • 注意：此字段可能返回 null，表示取不到有效值。 */ OriginProtocol?: string; /** *

    HTTP 回源端口。

    注意：此字段可能返回 null，表示取不到有效值。 */ HttpOriginPort?: number; /** *

    HTTPS 回源端口。

    注意：此字段可能返回 null，表示取不到有效值。 */ HttpsOriginPort?: number; /** *

    加速域名证书信息。

    注意：此字段可能返回 null，表示取不到有效值。 */ Certificate?: AccelerationDomainCertificate; /** *

    创建时间。

    */ CreatedOn?: string; /** *

    修改时间。

    */ ModifiedOn?: string; /** *

    域名因合规问题产生的地区访问限制列表。

    */ ComplianceRestrictions?: Array; } /** * 内容标识符。该功能仅白名单开放。 */ export interface ContentIdentifier { /** * 内容标识符 ID。 */ ContentId?: string; /** * 内容标识符描述。 */ Description?: string; /** * 被规则引擎引用的次数。 */ ReferenceCount?: number; /** * 绑定的套餐 ID。 */ PlanId?: string; /** * 绑定的标签。 */ Tags?: Array; /** * 内容标识符状态，取值有：
  • active：已生效；
  • deleted：已删除。
    • */ Status?: string; /** * 创建时间，时间为世界标准时间（UTC）， 遵循 ISO 8601 标准的日期和时间格式。 */ CreatedOn?: string; /** * 最新一次更新时间，时间为世界标准时间（UTC）， 遵循 ISO 8601 标准的日期和时间格式。 */ ModifiedOn?: string; /** * 删除时间，状态非 deleted 时候为空；时间为世界标准时间（UTC）， 遵循 ISO 8601 标准的日期和时间格式。 注意：此字段可能返回 null，表示取不到有效值。 */ DeletedOn?: string; } /** * CreateCustomizeErrorPage返回参数结构体 */ export interface CreateCustomizeErrorPageResponse { /** *

    自定义响应页面 ID。

    */ PageId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeMultiPathGatewayOriginACL请求参数结构体 */ export interface DescribeMultiPathGatewayOriginACLRequest { /** * 站点 ID。 */ ZoneId: string; /** * 网关 ID。 */ GatewayId: string; } /** * Ipv6访问配置 */ export interface Ipv6 { /** * Ipv6 访问功能配置，取值有：
  • on：开启Ipv6访问功能；
  • off：关闭Ipv6访问功能。
    • */ Switch: string; } /** * ApplyFreeCertificate请求参数结构体 */ export interface ApplyFreeCertificateRequest { /** * 站点ID。 */ ZoneId: string; /** * 申请免费证书的目标域名。 */ Domain: string; /** * 申请免费证书的验证方式，详细验证方式说明参考[免费证书申请方式说明文档](https://cloud.tencent.com/document/product/1552/90437) ，相关取值有：
  • http_challenge：HTTP 访问文件验证方式，通过 HTTP 访问域名指定 URL 获取文件信息以完成免费证书申请验证；
  • dns_challenge：DNS 委派验证方式，通过添加指定的主机记录解析指向 EdgeOne 以完成免费证书申请验证。
    • 注意：在触发本接口后，你需要根据返回的验证信息，完成验证内容配置。配置完成后，还需要通过检查免费证书申请结果接口进行验证，验证通过后，即可申请成功。在免费证书申请成功后，你可以调用配置域名证书接口为当前域名部署免费证书。 */ VerificationMethod: string; } /** * 状态码缓存 TTL 配置参数。 */ export interface StatusCodeCacheParameters { /** * 状态码缓存 TTL 。 注意：此字段可能返回 null，表示取不到有效值。 */ StatusCodeCacheParams?: Array; } /** * 规则引擎HTTP请求头/响应头类型的动作 */ export interface RewriteAction { /** * 功能名称，功能名称填写规范可调用接口 [查询规则引擎的设置参数](https://cloud.tencent.com/document/product/1552/80618) 查看。 */ Action: string; /** * 参数。 */ Parameters: Array; } /** * 安全模板绑定域名状态 */ export interface TemplateScope { /** * 站点ID。 注意：此字段可能返回 null，表示取不到有效值。 */ ZoneId?: string; /** * 实例状态列表。 注意：此字段可能返回 null，表示取不到有效值。 */ EntityStatus?: Array; } /** * AI 爬虫检测的具体配置。 */ export interface AICrawlerDetection { /** * AI 爬虫检测是否开启。取值有：
  • on：开启；
  • off：关闭。
    • */ Enabled?: string; /** * AI 爬虫检测的执行动作，当 Enabled 为 on 时，此字段必填。SecurityAction 的 Name 取值仅支持：
  • Deny：拦截；
  • Monitor：观察；
  • Allow：放行；
  • Challenge：挑战，其中 ChallengeActionParameters 中的 ChallengeOption 仅支持 JSChallenge 和 ManagedChallenge。
    • */ Action?: SecurityAction; } /** * 自定义错误页面。 */ export interface ErrorPage { /** * 状态码。支持范围为 400、403、404、405、414、416、451、500、501、502、503、504。 */ StatusCode: number; /** * 重定向 URL，需要为完整跳转路径，如 https://www.test.com/error.html。 */ RedirectURL: string; } /** * API 资源。 */ export interface APIResource { /** * 资源 ID。 */ Id?: string; /** * 资源名称。 */ Name?: string; /** * API 资源关联的 API 服务 ID 列表。 */ APIServiceIds?: Array; /** * 资源路径。 */ Path?: string; /** * 请求方法列表。支持以下取值：GET, POST, PUT, HEAD, PATCH, OPTIONS, DELETE。 */ Methods?: Array; /** * 请求内容匹配规则的具体内容，需符合表达式语法，详细规范参见产品文档。 */ RequestConstraint?: string; } /** * HTTP2 接入配置参数。 */ export interface HTTP2Parameters { /** * HTTP2 接入配置开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch?: string; } /** * 推理服务的亲和配置 */ export interface InferenceAffinityConfig { /** *

    推理服务亲和总开关。

    枚举值：

    • On： 开启推理服务亲和；
    • Off： 关闭推理服务亲和。
    */ Switch: string; /** *

    推理服务亲和方式。

    枚举值：

    • SessionId： 根据会话 ID 实现亲和。

    默认值：SessionId。

    */ AffinityMode?: string; /** *

    推理服务亲和性配置。当 AffinityMode 为 SessionId 时必填。

    */ SessionIdAffinityConfig?: SessionIdAffinityConfig; } /** * DescribeOverviewL7Data请求参数结构体 */ export interface DescribeOverviewL7DataRequest { /** * 开始时间。 */ StartTime: string; /** * 结束时间。 */ EndTime: string; /** * 查询的指标，取值有：
  • l7Flow_outFlux: Edegone响应流量；
  • l7Flow_inFlux: Edgeone请求流量；
  • l7Flow_outBandwidth: Edegone响应带宽；
  • l7Flow_inBandwidth: Edegone请求带宽；
  • l7Flow_hit_outFlux: 缓存命中流量；
  • l7Flow_request: 访问请求数；
  • l7Flow_flux: 访问请求上行+下行流量；
  • l7Flow_bandwidth：访问请求上行+下行带宽。
    • */ MetricNames: Array; /** * 站点 ID 集合，此参数必填。 */ ZoneIds?: Array; /** * 查询的域名集合，此参数已经废弃。 */ Domains?: Array; /** * 查询的协议类型，取值有：
  • http: http协议；
  • https: https协议；
  • http2: http2协议；
  • all: 所有协议。
    • 不填默认为all，此参数暂未生效。 */ Protocol?: string; /** * 查询时间粒度，取值有：
  • min：1分钟；
  • 5min：5分钟；
  • hour：1小时；
  • day：1天。
    • 不填将根据开始时间跟结束时间的间距自动推算粒度，具体为：1小时范围内以min粒度查询，2天范围内以5min粒度查询，7天范围内以hour粒度查询，超过7天以day粒度查询。 */ Interval?: string; /** * 过滤条件，详细的过滤条件Key值如下：
  • socket
       按照【HTTP协议类型】进行过滤。
       对应的Value可选项如下：
       HTTP：HTTP 协议；
       HTTPS：HTTPS协议；
       QUIC：QUIC协议。
  • domain
       按照【域名】进行过滤。
  • tagKey
       按照【标签Key】进行过滤。
  • tagValue
       按照【标签Value】进行过滤。
    • */ Filters?: Array; /** * 数据归属地区，取值有：
  • overseas：全球（除中国大陆地区）数据；
  • mainland：中国大陆地区数据；
  • global：全球数据。
    • 不填默认取值为global。 */ Area?: string; } /** * CreateMultiPathGateway请求参数结构体 */ export interface CreateMultiPathGatewayRequest { /** * 站点 ID。 */ ZoneId: string; /** * 网关类型，取值有：
  • cloud：云上网关，腾讯云创建和管理的网关；
  • private：自有网关，用户部署的私有网关。
    • */ GatewayType: string; /** * 网关名称，16 个字符以内，可用字符（a-z,A-Z,0-9,-,_）。 */ GatewayName: string; /** * 网关端口，范围 1～65535（除去 8888 ）。 */ GatewayPort: number; /** * 网关地域，GatewayType 取值为 cloud（云上网关）必填。可以从接口 DescribeMultiPathGatewayRegions 获取 RegionId 列表。 */ RegionId?: string; /** * 网关地址，GatewayType 取值为 private（自有网关）必填，使用该地址时，请确保该地址已录入腾讯云多通道安全加速网关系统。如未录入，需要在本接口调用前通过工单或者联系架构师把网关 IP 地址提前录入腾讯云多通道安全加速网关系统。 */ GatewayIP?: string; } /** * DeleteSharedCNAME返回参数结构体 */ export interface DeleteSharedCNAMEResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyMultiPathGatewaySecretKey返回参数结构体 */ export interface ModifyMultiPathGatewaySecretKeyResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeMultiPathGatewaySecretKey请求参数结构体 */ export interface DescribeMultiPathGatewaySecretKeyRequest { /** * 站点 ID。 */ ZoneId: string; } /** * DDoS封禁解封信息 */ export interface DDoSBlockData { /** * 开始时间，采用unix时间戳。 */ StartTime: number; /** * 结束时间，采用unix时间戳, 为0表示还处于封禁中。 */ EndTime: number; /** * 封禁受影响区域。 */ BlockArea: string; } /** * IP SSL 配置信息 */ export interface IPSSLSetting { /** * 操作类型， 取值如下：
  • bind：绑定
  • unbind：解绑
    • */ Operation: string; /** * 要绑定的IP SSL的所属域名。 */ AssociatedDomain: string; } /** * ModifyZoneCustomVariables请求参数结构体 */ export interface ModifyZoneCustomVariablesRequest { /** *

    站点 ID。

    */ ZoneId: string; /** *

    站点级自定义变量列表。CustomVariable.Name 需要使用 user.zone. 作为前缀。变量按照数组顺序依次初始化，InitialValue 仅支持引用位于当前变量之前的变量，不支持引用当前变量自身或位于当前变量之后的变量。

    */ CustomVariables?: Array; /** *

    站点级自定义变量运算规则。运算中支持引用已定义的站点级自定义变量。此列表当前只支持填写一项规则，多填无效。

    */ CustomVariableOperations?: Array; } /** * DescribeContentQuota请求参数结构体 */ export interface DescribeContentQuotaRequest { /** * 站点 ID。 */ ZoneId: string; } /** * DescribeAvailableOriginACLFamily请求参数结构体 */ export interface DescribeAvailableOriginACLFamilyRequest { /** *

    站点ID。

    */ ZoneId: string; /** *

    过滤条件，Filters.Values 的上限为 20。该参数不填写时，返回当前站点下所有可用版本。源站防护的 IP 段控制域包含标准控制域和精简控制域。标准控制域和精简控制域主要区别在于提供的回源 IP 网段数量差异，后者数量更少,但是使用上有限制，如需使用请联系技术支持。具体取值说明如下：
    详细的过滤条件如下：
    OriginACLFamily：按照控制域进行过滤；

  • gaz：标准全球可用区控制域；
  • mlc：标准中国大陆可用区控制域；
  • emc：标准全球(不含中国大陆)可用区控制域；
  • plat-gaz：精简全球可用区控制域；
  • plat-mlc：精简中国大陆可用区控制域；
  • plat-emc：精简全球(不含中国大陆)可用区控制域；
  • plat-specific-gaz：定制版控全球可用区制域；
  • plat-specific-mlc：定制版控中国大陆可用区控制域；
  • plat-specific-emc：定制版控全球（不含中国大陆）可用区控制域。
    • */ Filters?: Array; /** *

    分页查询偏移量，默认为 0。

    */ Offset?: number; /** *

    分页查询限制数目，默认值：20，最大值：100。

    */ Limit?: number; } /** * ModifyFunctionReplica请求参数结构体 */ export interface ModifyFunctionReplicaRequest { /** * 站点 ID。 */ ZoneId: string; /** * 函数 ID。 */ FunctionId: string; /** * 需要修改的边缘函数副本名称。 */ ReplicaName: string; /** * 边缘函数副本内容，当前仅支持 JavaScript 代码，最大支持 5MB。 */ Content?: string; /** * 边缘函数副本描述。最大支持 50 个字符。 */ Remark?: string; } /** * DescribeMultiPathGateways请求参数结构体 */ export interface DescribeMultiPathGatewaysRequest { /** * 站点 ID。 */ ZoneId: string; /** * 分页查询偏移量。默认值：0。 */ Offset?: number; /** * 分页查询限制数目。默认值：20，最大值：1000。 */ Limit?: number; /** * 网关列表的过滤字段，该参数不填写时，返回当前 appid 下所有网关信息，详细的过滤条件如下：
  • gateway-type：按照网关类型进行过滤，支持取值 cloud 和 private，分别代表过滤云上网关和自由网关；
  • keyword：按照网关名的关键字进行过滤。
    • */ Filters?: Array; } /** * bot 用户画像规则 */ export interface BotPortraitRule { /** * 本功能的开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch: string; /** * 本规则的ID。仅出参使用。 */ RuleID?: number; /** * JS挑战的规则ID。默认所有规则不配置JS挑战。 */ AlgManagedIds?: Array; /** * 数字验证码的规则ID。默认所有规则不配置数字验证码。 */ CapManagedIds?: Array; /** * 观察的规则ID。默认所有规则不配置观察。 */ MonManagedIds?: Array; /** * 拦截的规则ID。默认所有规则不配置拦截。 */ DropManagedIds?: Array; } /** * DeleteL4ProxyRules返回参数结构体 */ export interface DeleteL4ProxyRulesResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyMultiPathGatewaySecretKey请求参数结构体 */ export interface ModifyMultiPathGatewaySecretKeyRequest { /** * 站点 ID。 */ ZoneId: string; /** * 多通道安全加速网关接入密钥，base64 字符串，编码前字符串长度为 32-48 个字符。 */ SecretKey: string; } /** * 四层远程鉴权信息 */ export interface L4ProxyRemoteAuth { /** * 四层远程鉴权开关，取值有：
  • on：表示开启;
  • off：表示关闭。
    • */ Switch: string; /** * 远程鉴权服务地址，格式为: domain/ip:port。例：example.auth.com:8888 */ Address: string; /** * 远程鉴权服务不可访问后，经过四层转发规则默认回源行为，取值有：
  • reject：表示进行拦截，拒绝访问;
  • allow：表示允许通过。
    • */ ServerFaultyBehavior: string; } /** * DNS 记录 */ export interface DnsRecord { /** * 站点 ID。
    注意：ZoneId 仅做出参使用，在 ModifyDnsRecords 不可作为入参使用，如有传此参数，会忽略。 */ ZoneId?: string; /** * DNS 记录 ID。 */ RecordId?: string; /** * DNS 记录名。 */ Name?: string; /** * DNS 记录类型，取值有：
  • A：将域名指向一个外网 IPv4 地址，如 8.8.8.8；
  • AAAA：将域名指向一个外网 IPv6 地址；
  • MX：用于邮箱服务器。存在多条 MX 记录时，优先级越低越优先；
  • CNAME：将域名指向另一个域名，再由该域名解析出最终 IP 地址；
  • TXT：对域名进行标识和说明，常用于域名验证和 SPF 记录（反垃圾邮件）；
  • NS：如果需要将子域名交给其他 DNS 服务商解析，则需要添加 NS 记录。根域名无法添加 NS 记录；
  • CAA：指定可为本站点颁发证书的 CA；
  • SRV：标识某台服务器使用了某个服务，常见于微软系统的目录管理。
    • */ Type?: string; /** * DNS 记录解析线路，不指定默认为 Default，表示默认解析线路，代表全部地域生效。
    解析线路配置仅适用于当 Type（DNS 记录类型）为 A、AAAA、CNAME 时。
    取值请参考：[解析线路及对应代码枚举](https://cloud.tencent.com/document/product/1552/112542)。 */ Location?: string; /** * DNS 记录内容。根据 Type 值填入与之相对应的内容。 */ Content?: string; /** * 缓存时间，取值范围 60~86400，数值越小，修改记录各地生效时间越快，单位：秒。 */ TTL?: number; /** * DNS 记录权重，取值范围 -1~100，为 -1 时表示不分配权重，为 0 时表示不解析。权重配置仅适用于当 Type（DNS 记录类型）为 A、AAAA、CNAME 时。 */ Weight?: number; /** * MX 记录优先级，取值范围 0~50，数值越小越优先。 */ Priority?: number; /** * DNS 记录解析状态，取值有：
  • enable：已生效；
  • disable：已停用。
    • 注意：Status 仅做出参使用，在 ModifyDnsRecords 不可作为入参使用，如有传此参数，会忽略。 */ Status?: string; /** * 创建时间。
    注意：CreatedOn 仅做出参使用，在 ModifyDnsRecords 不可作为入参使用，如有传此参数，会忽略。 */ CreatedOn?: string; /** * 修改时间。
    注意：ModifiedOn 仅做出参使用，在 ModifyDnsRecords 不可作为入参使用，如有传此参数，会忽略。 */ ModifiedOn?: string; } /** * 推理服务的容器配置。 */ export interface InferenceContainerConfig { /** *

    镜像类型。取值有：

  • TCR：腾讯云容器镜像服务的镜像。

    • */ ImageType: string; /** *

    TCR 镜像仓库信息。当 ImageType 为 TCR 时必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ TcrRepositoryConfig?: InferenceTCRRepositoryConfig; /** *

    容器启动时执行的命令，未填写时默认使用镜像的 Entrypoint/CMD。最长支持 1024 字符。

    */ StartupCommand?: string; /** *

    容器运行时的环境变量。最多支持 10 个变量。

    */ EnvironmentVariables?: Array; } /** * 对象存储源站私有鉴权参数。 */ export interface OriginPrivateParameters { /** * 鉴权参数 Access Key ID。 */ AccessKeyId: string; /** * 鉴权参数 Secret Access Key。 */ SecretAccessKey: string; /** * 鉴权版本。取值有：
  • v2：v2版本；
  • v4：v4版本。
    • */ SignatureVersion: string; /** * 存储桶地域。 */ Region?: string; } /** * 规则引擎操作定制配置参数结构定义。 */ export interface RuleEngineCustomActionParameterSchema { /** *

    参数字段名称。

    */ Name?: string; /** *

    参数字段类型，取值有：

  • Boolean：布尔；
  • Integer：整型；
  • Float：浮点型；
  • String：字符串；
  • ArrayOfInteger：整型数组；
  • ArrayOfFloat：浮点型数组；
  • ArrayOfString：字符串数组。

    • */ ValueType?: string; /** *

    参数字段描述。

    */ Description?: string; /** *

    参数字段默认值。

    */ Default?: string; /** *

    参数字段单位。

    */ Unit?: string; /** *

    参数字段是否必填。

    默认值：false

    若填充，则适用于所有参数字段类型校验；若不填充则不校验。

    */ Required?: boolean; /** *

    参数字段最小值。

    若填充，适用于整数、浮点数、整数数组、浮点数数组类型参数的数值校验；若不填充则不校验。

    */ MinValue?: number; /** *

    参数字段最大值。

    若填充，适用于整数、浮点数、整数数组、浮点数数组类型参数的数值校验；若不填充则不校验。

    */ MaxValue?: number; /** *

    参数字段最小长度。

    若填充，适用于字符串、字符串数组类型参数的数值校验；若不填充则不校验。

    */ MinLength?: number; /** *

    参数字段最大长度。

    若填充，适用于字符串、字符串数组类型参数的数值校验；若不填充则不校验。

    */ MaxLength?: number; /** *

    参数字段最小项数。

    若填充，适用于各类数组类型参数的数值校验；若不填充则不校验。

    */ MinItems?: number; /** *

    参数字段最大项数。

    若填充，适用于各类数组类型参数的数值校验；若不填充则不校验。

    */ MaxItems?: number; /** *

    参数字段项是否唯一。

    默认值：false

    若填充，适用于各类数组类型参数的数值校验；若不填充则不校验。

    */ UniqueItems?: boolean; /** *

    参数字段允许的格式。

    若填充，需要校验字符串或者字符串数组内容合适；若不填充则不校验。

    */ AllowedPattern?: string; /** *

    参数字段允许的取值，若为空则不校验。

    若本参数填充，则说明对应参数为枚举类型，仅允许填充本参数数组中的值；若不填充则不校验。

    */ AllowedValues?: Array; /** *

    参数字段最小步长。若填充，适用于浮点型和浮点型数组类型参数的数值校验；若不填充则不校验。

    */ MultipleOf?: string; } /** * ModifyZoneWorkMode返回参数结构体 */ export interface ModifyZoneWorkModeResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * HSTS 配置参数。 */ export interface HSTSParameters { /** * HSTS 配置开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch?: string; /** * 缓存 HSTS 头部时间，单位为秒，取值：1-31536000。
    注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。 */ Timeout?: number; /** * 是否允许其他子域名继承相同的 HSTS 头部，取值有：
  • on：允许其他子域名继承相同的 HSTS 头部；
  • off：不允许其他子域名继承相同的 HSTS 头部。
    • 注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。 */ IncludeSubDomains?: string; /** * 是否允许浏览器预加载 HSTS 头部，取值有：
  • on：允许浏览器预加载 HSTS 头部；
  • off：不允许浏览器预加载 HSTS 头部。
    • 注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。 */ Preload?: string; } /** * 标签配置 */ export interface Tag { /** * 标签键。 注意：此字段可能返回 null，表示取不到有效值。 */ TagKey: string; /** * 标签值。 注意：此字段可能返回 null，表示取不到有效值。 */ TagValue: string; } /** * DeleteSecurityAPIResource返回参数结构体 */ export interface DeleteSecurityAPIResourceResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * BindZoneToPlan请求参数结构体 */ export interface BindZoneToPlanRequest { /** * 未绑定套餐的站点ID。 */ ZoneId: string; /** * 待绑定的目标套餐ID。 */ PlanId: string; } /** * DeleteFunction返回参数结构体 */ export interface DeleteFunctionResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Web 安全的基础 BOT 规则结构。 */ export interface BotManagementLite { /** * 人机校验页的具体配置。 */ CAPTCHAPageChallenge?: CAPTCHAPageChallenge; /** * AI爬虫检测的具体配置。 */ AICrawlerDetection?: AICrawlerDetection; } /** * 源站防护IP白名单 */ export interface IPWhitelist { /** * IPv4列表。 */ IPv4: Array; /** * IPv6列表。 */ IPv6: Array; } /** * DescribeSharedCNAME请求参数结构体 */ export interface DescribeSharedCNAMERequest { /** * 共享CNAME所属站点ID。 */ ZoneId: string; /** * 过滤条件，Filters.Values的上限为20。详细的过滤条件如下：
  • shared-cname
       按照【共享CNAME】进行过滤。
       类型：String
       必选：否
  • type
       按照【共享canme类型】进行过滤。
       类型：String
       必选：否
  • description
       按照【描述】进行过滤。
       类型：String
       必选：否
    • */ Filters?: Array; /** * 列表排序方式，取值有：
  • asc：升序排列；
  • desc：降序排列。
    • 默认值为asc。 */ Direction?: string; /** * 匹配方式，取值有：
  • all：返回匹配所有查询条件的共享CNAME；
  • any：返回匹配任意一个查询条件的共享CNAME。
    • 默认值为all。 */ Match?: string; /** * 排序依据，取值有：
  • create-time：创建时间；
  • shared-cname：共享CNAME；
    • 默认根据shared-cname属性排序。 */ Order?: string; /** * 分页查询偏移量，默认为 0。 */ Offset?: number; /** * 分页查询限制数目，默认值：20，上限：200。 */ Limit?: number; } /** * ModifyZone请求参数结构体 */ export interface ModifyZoneRequest { /** * 站点 ID。 */ ZoneId: string; /** * 站点接入方式，取值有：
  • full：NS 接入；
  • partial：CNAME 接入，如果站点当前是无域名接入，仅支持切换到 CNAME 接入；
  • dnsPodAccess：DNSPod 托管接入，该接入模式要求您的域名已托管在 DNSPod 内。
    • 不填写保持原有配置。 */ Type?: string; /** * 自定义站点信息，以替代系统默认分配的名称服务器。不填写保持原有配置。当站点是无域名接入方式时不允许传此参数。 */ VanityNameServers?: VanityNameServers; /** * 同名站点标识。限制输入数字、英文、"." 、"-" 和 "_"，长度 200 个字符以内。 */ AliasZoneName?: string; /** * 站点接入地域，取值有：
  • global：全球；
  • mainland：中国大陆；
  • overseas：境外区域。
    • 当站点是无域名接入方式时，不允许传此参数。 */ Area?: string; /** * 站点名称。仅当站点由无域名接入方式切换到CNAME接入方式的场景下有效。 */ ZoneName?: string; } /** * ModifyL7AccSetting请求参数结构体 */ export interface ModifyL7AccSettingRequest { /** * 站点 ID。 */ ZoneId: string; /** * 站点加速全局配置，该参数中的配置会对站点下的所有域名生效。您只需直接修改所需的配置，未传入的其他配置将保持原有状态。 */ ZoneConfig: ZoneConfig; } /** * ModifyFunctionRulePriority返回参数结构体 */ export interface ModifyFunctionRulePriorityResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateCustomizeErrorPage请求参数结构体 */ export interface CreateCustomizeErrorPageRequest { /** *

    站点 ID。

    */ ZoneId: string; /** *

    自定义响应页面名称，名称为 2-30 个字符。

    */ Name: string; /** *

    自定义响应页面类型，取值有：

    • text/html
    • application/json
    • plain/text
    • text/xml
    • text/css
    • text/javascript
    • application/javascript
    • text/markdown
    */ ContentType: string; /** *

    自定义响应页面描述，描述不超过 60 个字符。

    */ Description?: string; /** *

    自定义响应页面内容，内容不超过 16KB。

    */ Content?: string; } /** * 边缘推理定时伸缩策略配置。 */ export interface InferenceScheduledScalingPolicy { /** * 定时伸缩动作列表。至少填写 1 个，最多支持 10 个。 */ ScheduledActions: Array; /** * 有效期范围，用于描述该定时伸缩策略长期有效或仅在指定日期范围内有效。 */ EffectiveRange: InferenceScheduledScalingEffectiveRange; /** * 时区，使用 [IANA 时区](https://www.iana.org/time-zones) 标识 ScheduledActions 中的触发时间，例如 UTC、Asia/Shanghai、America/New_York、Europe/London、Asia/Kolkata。不传时默认使用 UTC。 */ TimeZone?: string; } /** * DescribeRealtimeLogDeliveryTasks返回参数结构体 */ export interface DescribeRealtimeLogDeliveryTasksResponse { /** * 符合查询条件的实时日志投递任务个数。 */ TotalCount?: number; /** * 符合查询条件的所有实时日志投递任务列表。 */ RealtimeLogDeliveryTasks?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyApplicationProxyStatus返回参数结构体 */ export interface ModifyApplicationProxyStatusResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInferenceHardwareSpecifications请求参数结构体 */ export interface DescribeInferenceHardwareSpecificationsRequest { /** *

    站点 ID。

    */ ZoneId: string; } /** * DescribeMultiPathGatewayLine返回参数结构体 */ export interface DescribeMultiPathGatewayLineResponse { /** * 线路信息。 */ Line?: MultiPathGatewayLine; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 负载均衡实例中需要绑定的源站组和优先级关系。 */ export interface OriginGroupInLoadBalancer { /** * 优先级，填写格式为 "priority_" + "数字"，最高优先级为 "priority_1"。参考取值有：
  • priority_1：第一优先级；
  • priority_2：第二优先级；
  • priority_3：第三优先级。
    • 其他优先级可以将数字递增，最多可以递增至 "priority_10"。 */ Priority: string; /** * 源站组 ID。 */ OriginGroupId: string; } /** * HTTP 应答配置参数。 */ export interface HTTPResponseParameters { /** * 响应状态码。支持 2XX、4XX、5XX，不包括 499、514、101、301、302、303、509、520-599。 */ StatusCode?: number; /** * 响应页面 ID。 */ ResponsePage?: string; } /** * DescribeEdgeKVNamespaces请求参数结构体 */ export interface DescribeEdgeKVNamespacesRequest { /** * 站点 ID。 */ ZoneId: string; /** * 分页查询偏移量。默认值：0。 */ Offset?: number; /** * 分页查询限制数目。默认值：20，最大值：1000。 */ Limit?: number; /** * 排序依据，取值有：
  • created-on：创建时间；
  • updated-on：更新时间。
    • 默认值为 created-on。 */ SortBy?: string; /** * 列表排序方式，取值有：
  • asc：升序排列；
  • desc：降序排列。
    • 默认值为 desc。 */ SortOrder?: string; /** * 过滤条件，Filters.Values 的上限为 20。该参数不填写时，返回站点 ID 下全部 KV 命名空间。详细的过滤条件如下：
  • namespace：按照 KV 命名空间名称进行过滤，支持模糊查询；
  • remark：按照命名空间描述进行过滤，支持模糊查询。
    • */ Filters?: Array; } /** * 回源请求参数配置参数。 */ export interface UpstreamRequestParameters { /** * 查询字符串配置。可选配置项，不填表示不配置。 注意：此字段可能返回 null，表示取不到有效值。 */ QueryString?: UpstreamRequestQueryString; /** * Cookie 配置。可选配置项，不填表示不配置。 注意：此字段可能返回 null，表示取不到有效值。 */ Cookie?: UpstreamRequestCookie; } /** * ModifyMultiPathGatewayStatus请求参数结构体 */ export interface ModifyMultiPathGatewayStatusRequest { /** * 网关 ID。 */ GatewayId: string; /** * 站点 ID。 */ ZoneId: string; /** * 修改网关的启用停用状态，取值有：
  • offline：停用；
  • online：启用。
    • */ GatewayStatus?: string; } /** * DeleteSecurityClientAttester返回参数结构体 */ export interface DeleteSecurityClientAttesterResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RCE 认证选项实例信息。 */ export interface TCRCEOption { /** * Channel 信息。 */ Channel: string; /** * RCE Channel 的开通地域，目前可选的取值范围：
  • ap-beijing：华北地区（北京）；
  • ap-jakarta：亚太东南（雅加达）；
  • ap-singapore：亚太东南（新加坡）；
  • eu-frankfurt：欧洲地区（法兰克福）；
  • na-siliconvalley：美国西部（硅谷）。
    • */ Region?: string; } /** * NS 接入，切换 DNS 服务器所需的信息。 */ export interface NsVerification { /** * NS 接入时，分配给用户的 DNS 服务器地址，需要将域名的 NameServer 切换至该地址。 */ NameServers?: Array; } /** * 中国大陆加速优化配置。 */ export interface AccelerateMainland { /** * 是否开启中国大陆加速优化配置，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch: string; } /** * Web 安全 Challenge 挑战的附加参数 */ export interface ChallengeActionParameters { /** * 安全执行的具体挑战动作。取值有：
  • InterstitialChallenge：插页式挑战；
  • InlineChallenge：内嵌式挑战；
  • JSChallenge：JavaScript 挑战；
  • ManagedChallenge：托管挑战。
    • */ ChallengeOption: string; /** * 重复挑战的时间间隔，当 Name 为 InterstitialChallenge/InlineChallenge 时，该字段必填。默认值为 300s。支持的单位有：
  • s：秒，取值范围1～60；
  • m：分，取值范围1～60；
  • h：小时，取值范围1～24。
    • */ Interval?: string; /** * 客户端认证方式 ID 。当 Name 为 InterstitialChallenge/InlineChallenge 时，该字段必填。 */ AttesterId?: string; } /** * 策略模板信息 */ export interface SecurityPolicyTemplateInfo { /** * 策略模板所属的站点 ID。 */ ZoneId?: string; /** * 策略模板 ID。 */ TemplateId?: string; /** * 策略模板名称。 */ TemplateName?: string; /** * 策略模板绑定的域名信息。 */ BindDomains?: Array; } /** * 支持标准debug结构体 */ export interface StandardDebug { /** * Debug 功能开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch: string; /** * 允许的客户端来源。支持填写 IPv4 以及 IPv6 的 IP/IP 段。0.0.0.0/0 表示允许所有 IPv4 客户端进行调试，::/0 表示允许所有 IPv6 客户端进行调试。 */ AllowClientIPList: Array; /** * Debug 功能到期时间。超出设置的时间，则功能失效。 */ ExpireTime: string; } /** * 模板当前详细配置 */ export interface RateLimitTemplateDetail { /** * 模板等级名称，取值有：
  • sup_loose：超级宽松；
  • loose：宽松；
  • emergency：紧急；
  • normal：适中；
  • strict：严格；
  • close：关闭，仅精准速率限制生效。
    • */ Mode: string; /** * 唯一id。 */ ID: number; /** * 模板处置方式，取值有：
  • alg：JavaScript挑战；
  • monitor：观察。
    • */ Action: string; /** * 惩罚时间，取值范围0-2天，单位秒。 */ PunishTime: number; /** * 统计阈值，单位是次，取值范围0-4294967294。 */ Threshold: number; /** * 统计周期，取值范围0-120秒。 */ Period: number; } /** * Token 鉴权 配置参数。 */ export interface AuthenticationParameters { /** * 鉴权类型。取值有：
  • TypeA：鉴权方式 A 类型，具体含义请参考 [鉴权方式 A](https://cloud.tencent.com/document/product/1552/109329)；
  • TypeB：鉴权方式 B 类型，具体含义请参考 [鉴权方式 B](https://cloud.tencent.com/document/product/1552/109330)；
  • TypeC：鉴权方式 C 类型，具体含义请参考 [鉴权方式 C](https://cloud.tencent.com/document/product/1552/109331)；
  • TypeD：鉴权方式 D 类型，具体含义请参考 [鉴权方式 D](https://cloud.tencent.com/document/product/1552/109332)；
  • TypeVOD：鉴权方式 V 类型，具体含义请参考 [鉴权方式 V](https://cloud.tencent.com/document/product/1552/109333)。
    • */ AuthType?: string; /** * 主鉴权密钥，由 6～40 位大小写英文字母或数字组成，不能包含 " 和 $。 */ SecretKey?: string; /** * 鉴权 URL 的有效时长，单位为秒，取值：1～630720000。用于判断客户端访问请求是否过期：
  • 若当前时间超过 “timestamp + 有效时长” 时间，则为过期请求，直接返回 403。
  • 若当前时间未超过 “timestamp + 有效时长” 时间，则请求未过期，继续校验 md5 字符串。
    • 注意：当 AuthType 为 TypeA、TypeB、TypeC、TypeD 之一时，此字段必填。 */ Timeout?: number; /** * 备鉴权密钥，由 6～40 位大小写英文字母或数字组成，不能包含 " 和 $。 */ BackupSecretKey?: string; /** * 鉴权参数名称，节点将校验此参数名对应的值。由 1～100 位大小写字母、数字或下划线组成。
    注意：当 AuthType 为 TypeA、TypeD 之一时，此字段必填。 */ AuthParam?: string; /** * 鉴权时间戳，和 AuthParam 字段的值不能相同。
    注意：当 AuthType 为 TypeD 时，此字段必填。 */ TimeParam?: string; /** * 鉴权时间格式，取值有：
  • dec：十进制；
  • hex：十六进制。
    • 注意：当 AuthType 为 TypeD 时，此字段必填。默认为 hex。 */ TimeFormat?: string; } /** * BindSecurityTemplateToEntity请求参数结构体 */ export interface BindSecurityTemplateToEntityRequest { /** * 需要绑定或解绑的策略模板所属站点 ID。 */ ZoneId: string; /** * 绑定至策略模板（或者从策略模板解绑）的域名列表。 */ Entities: Array; /** * 绑定或解绑操作选项，取值有：
  • bind：绑定域名至策略模板。
  • unbind-keep-policy：将域名从策略模板解绑，解绑时保留当前策略。
  • unbind-use-default：将域名从策略模板解绑，并使用默认空白策略。
    • 注意：解绑操作当前仅支持单个域名解绑。即：当 Operate 参数取值为 unbind-keep-policy 或 unbind-use-default 时，Entities 参数列表仅支持填写一个域名。 */ Operate: string; /** * 指定绑定或解绑的策略模板 ID 或站点全局策略
  • 如需绑定至策略模板，或从策略模板解绑，请指定策略模板 ID。
  • 如需绑定至站点全局策略，或从站点全局策略解绑，请使用 @ZoneLevel@domain 参数值。
    • 注意：解绑后，域名将使用独立策略，并单独计算规则配额，请确保解绑前套餐规则配额充足。 */ TemplateId: string; /** * 传入域名如果已经绑定了策略模板（含站点级防护策略），通过设置该参数表示是否替换该模板，默认值为 true。支持下列取值：
  • true： 替换域名当前绑定的模板。
  • false：不替换域名当前绑定的模板。
    • 注意：当设置为 false 时，若传入域名已经绑定策略模板，API 将返回错误；站点级防护策略也为一种策略模板。 */ OverWrite?: boolean; } /** * 子规则。 */ export interface RuleEngineSubRule { /** * 子规则分支 注意：此字段可能返回 null，表示取不到有效值。 */ Branches?: Array; /** * 规则注释。 */ Description?: Array; } /** * 推理服务资源硬件配置的修改参数。 */ export interface InferenceHardwareConfigForModify { /** *

    推理服务单实例分配的 CPU 核数，当前仅支持整数值。

    若不填充，则不修改。

    */ CPUNum?: number; /** *

    推理服务单实例分配的内存大小。

    单位：MB

    若不填充，则不修改；若填写，则必须为 1024 的整数倍。

    */ MemSize?: number; /** *

    推理服务单实例分配的临时磁盘大小。

    单位：MB

    若不填充，则不修改；若填充，则必须为 1024 的整数倍。

    */ DiskSize?: number; } /** * ExportZoneConfig返回参数结构体 */ export interface ExportZoneConfigResponse { /** * 导出的配置的具体内容。以 JSON 格式返回，按照 UTF-8 方式进行编码。配置内容可参考下方示例。 */ Content?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * POST请求上传文件流式传输最大限制 */ export interface PostMaxSize { /** * 是否开启 POST 请求上传文件限制，平台默认为限制为32MB，取值有：
  • on：开启限制；
  • off：关闭限制。
    • */ Switch: string; /** * 最大限制，该字段仅在 Switch 为 on 时生效，取值在 1MB 和 800MB 之间，单位字节。 */ MaxSize?: number; } /** * DescribeBillingData返回参数结构体 */ export interface DescribeBillingDataResponse { /** * 数据点列表。 注意：此字段可能返回 null，表示取不到有效值。 */ Data?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 描述键值对过滤器，用于条件过滤查询。例如过滤ID、名称、状态等。 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。 */ export interface Filter { /** * 需要过滤的字段。 */ Name: string; /** * 字段的过滤值。 */ Values: Array; } /** * CreateAccelerationDomain返回参数结构体 */ export interface CreateAccelerationDomainResponse { /** * 当您的站点未进行归属权验证时，您可通过该参数返回的信息单独对域名进行归属权校验。详情参考 [站点/域名归属权验证](https://cloud.tencent.com/document/product/1552/70789)。 注意：此字段可能返回 null，表示取不到有效值。 */ OwnershipVerification?: OwnershipVerification; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyAccelerationDomainStatuses请求参数结构体 */ export interface ModifyAccelerationDomainStatusesRequest { /** * 加速域名所属站点ID。 */ ZoneId: string; /** * 要执行状态变更的加速域名列表。 */ DomainNames: Array; /** * 加速域名状态，取值有：
  • online：启用；
  • offline：停用。
    • */ Status: string; /** * 是否强制停用。当域名存在关联资源（如马甲域名、流量调度功能）时，是否强制停用该域名，取值有：
  • true：停用该域名及所有关联资源；
  • false：当该加速域名存在关联资源时，不允许停用。
    • 不填写，默认值为：false。 */ Force?: boolean; } /** * CreateZone返回参数结构体 */ export interface CreateZoneResponse { /** * 站点 ID。 */ ZoneId?: string; /** * 站点归属权验证信息。站点完成创建后，您还需要完成归属权校验，站点才能正常服务。 Type = partial 时，您需要参考 [站点/域名归属权验证](https://cloud.tencent.com/document/product/1552/70789) 前往您的域名解析服务商添加 TXT 记录或者前往根域名服务器添加文件，再调用接口 [VerifyOwnership]() 完成验证； Type = full 时，您需要参考 [修改 DNS 服务器](https://cloud.tencent.com/document/product/1552/90452) 切换 DNS 服务器即可，可通过接口 [VerifyOwnership]() 查询 DNS 是否切换成功； Type = noDomainAccess 时，该值为空，不需要进行任何操作。 注意：此字段可能返回 null，表示取不到有效值。 */ OwnershipVerification?: OwnershipVerification; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 边缘函数触发规则条件。 */ export interface FunctionRuleCondition { /** * 边缘函数触发规则条件，该列表内所有项全部满足即判断该条件满足。 */ RuleConditions: Array; } /** * EdgeKVPut请求参数结构体 */ export interface EdgeKVPutRequest { /** * 站点 ID。 */ ZoneId: string; /** * 命名空间名称。 */ Namespace: string; /** * 键名，长度为 1-512 个字符，支持合法 UTF-8 字符。 */ Key: string; /** * 键值。不能为空，最大支持 1 MB。支持存储字符串数据。 */ Value: string; /** * 键值对的过期时间，绝对时间，单位为秒，表示从 1970 年 1 月 1 日 00:00:00（UTC）起经过的秒数（即 Unix 时间戳）。取值必须大于等于当前时间 + 60，即过期时间距当前至少 60 秒。当 Expiration 与 ExpirationTTL 同时填写时，以 ExpirationTTL 为准；当两者均不填写时，键值对永不过期。 */ Expiration?: number; /** * 键值对的存活时长，相对时间，单位为秒，表示数据将在写入后经过指定秒数过期。取值范围：大于等于 60。当 Expiration 与 ExpirationTTL 同时填写时，以 ExpirationTTL 为准；当两者均不填写时，键值对永不过期。 */ ExpirationTTL?: number; } /** * EdgeKVPut返回参数结构体 */ export interface EdgeKVPutResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteLoadBalancer返回参数结构体 */ export interface DeleteLoadBalancerResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteL7AccRules返回参数结构体 */ export interface DeleteL7AccRulesResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeOriginGroupHealthStatus返回参数结构体 */ export interface DescribeOriginGroupHealthStatusResponse { /** * 源站组下源站的健康状态。 */ OriginGroupHealthStatusList?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeContentIdentifiers返回参数结构体 */ export interface DescribeContentIdentifiersResponse { /** * 符合过滤条件的内容标识符总数。 */ TotalCount?: number; /** * 内容标识符详细内容列表。 */ ContentIdentifiers?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 节点缓存 TTL 自定义缓存时间配置参数。 */ export interface CacheConfigCustomTime { /** * 自定义缓存时间开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch?: string; /** * 自定义缓存时间数值，单位为秒，取值：0-315360000。
    注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。 */ CacheTime?: number; } /** * Web安全的托管规则 */ export interface ManagedRules { /** * 托管规则是否开启。取值有：
  • on：开启，所有托管规则按配置生效；
  • off：关闭，所有托管规则不生效。
    • */ Enabled: string; /** * 评估模式是否开启，仅在 Enabled 参数为 on 时有效。取值有：
  • on：开启，表示所有托管规则以观察模式生效；
  • off：关闭，表示所有托管规则以实际配置生效。
    • */ DetectionOnly: string; /** * 托管规则语义分析选项是否开启，仅在 Enabled 参数为 on 时有效。取值有：
  • on：开启，对请求进行语义分析后进行处理；
  • off：关闭，对请求不进行语义分析，直接进行处理。

    • 默认为 off。 */ SemanticAnalysis?: string; /** * 托管规则自动更新选项。 */ AutoUpdate?: ManagedRuleAutoUpdate; /** * 托管规则组的配置。如果此结构传空数组或 GroupId 未包含在列表内将按照默认方式处理。 */ ManagedRuleGroups?: Array; /** * 高频扫描防护配置选项，当某一访客的请求频繁命中「配置为拦截」的托管规则时，在一段时间内封禁该访客所有请求。 */ FrequentScanningProtection?: FrequentScanningProtection; } /** * 安全策略模板的绑定关系。 */ export interface SecurityTemplateBinding { /** * 模板ID */ TemplateId?: string; /** * 模板绑定状态。 */ TemplateScope?: Array; } /** * DescribeMultiPathGatewaySecretKey返回参数结构体 */ export interface DescribeMultiPathGatewaySecretKeyResponse { /** * 接入密钥。 */ SecretKey?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateSecurityAPIResource返回参数结构体 */ export interface CreateSecurityAPIResourceResponse { /** * API 资源 ID 列表。 */ APIResourceIds?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 回源 HTTPS 配置参数。 */ export interface OriginPullProtocolParameters { /** * 回源协议配置，取值有：
  • http：使用 HTTP 协议回源；
  • https：使用 HTTPS 协议回源；
  • follow：协议跟随。
    • */ Protocol?: string; } /** * 节点缓存清除类型取值为 purge_cache_tag 时附带的信息。 */ export interface CacheTag { /** * 待清除缓存的域名列表。 */ Domains: Array; } /** * CreateSecurityClientAttester返回参数结构体 */ export interface CreateSecurityClientAttesterResponse { /** * 认证选项 ID 列表。 */ ClientAttesterIds?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 按权重分配的 SecurityAction。 */ export interface SecurityWeightedAction { /** * Bot 自定义规则的处置方式。取值有：
  • Allow：放行，其中 AllowActionParameters 支持 MinDelayTime 和 MaxDelayTime 配置；
  • Deny：拦截，其中 DenyActionParameters 中支持 BlockIp、ReturnCustomPage 和 Stall 配置；
  • Monitor：观察；
  • Challenge：挑战，其中 ChallengeActionParameters.ChallengeOption 支持 JSChallenge 和 ManagedChallenge；
  • Redirect：重定向至URL。
    • */ SecurityAction?: SecurityAction; /** * 当前 SecurityAction 的权重，仅支持 10 ~ 100 且必须为 10 的倍数，其中 Weight 参数全部相加须等于 100。 */ Weight?: number; } /** * ModifyMultiPathGatewayLine返回参数结构体 */ export interface ModifyMultiPathGatewayLineResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDefaultCertificates返回参数结构体 */ export interface DescribeDefaultCertificatesResponse { /** * 证书总数。 */ TotalCount?: number; /** * 默认证书列表。 */ DefaultServerCertInfo?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateOriginGroup返回参数结构体 */ export interface CreateOriginGroupResponse { /** * 源站组ID。 */ OriginGroupId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateMultiPathGatewayLine请求参数结构体 */ export interface CreateMultiPathGatewayLineRequest { /** * 站点 ID 。 */ ZoneId: string; /** * 多通道安全网关 ID 。 */ GatewayId: string; /** * 线路类型，取值有：
  • direct ：直连线路，不支持修改和删除。
  • proxy ：EdgeOne 四层代理线路，支持修改实例 ID 和规则 ID，不支持删除。
  • custom ：自定义线路，支持修改、删除实例 ID 和规则 ID。
    • */ LineType: string; /** * 线路地址，格式为 ip:port。 */ LineAddress: string; /** * 四层代理实例 ID，当线路类型 LineType 取值为 proxy（EdgeOne 四层代理）必传，可由接口 [DescribeL4Proxy](https://cloud.tencent.com/document/api/1552/103413) 获取。 */ ProxyId?: string; /** * 转发规则 ID ，当线路类型 LineType 取值为 proxy（EdgeOne 四层代理）必传，可以从接口 [DescribeL4ProxyRules](https://cloud.tencent.com/document/api/1552/103412) 获取。 */ RuleId?: string; } /** * 引用 IP 组的安全模块 */ export interface IPGroupReference { /** *

    站点 ID。

    */ ZoneId?: string; /** *

    实体类型。

    枚举值：

    • WebSec.ZonePolicy： 站点级防护策略
    • WebSec.HostPolicy： 域名级防护策略
    • WebSec.Template： 策略模板
    • DDoS.L4Proxy： 四层代理 DDoS 防护
    • DDoS.L3Transit： 三层代播 DDoS 防护
    */ EntityType?: string; /** *

    实体标识，根据 EntityType 不同代表不同的含义：

    • WebSec.ZonePolicy：站点 ID；
    • WebSec.HostPolicy：域名；
    • WebSec.Template：模板 ID；
    • DDoS.L4Proxy：实例 ID；
    • DDoS.L3Transit：实例 ID。
    */ EntityId?: string; /** *

    实体标识，根据 EntityType 不同代表不同的含义：

    • WebSec.ZonePolicy：空；
    • WebSec.HostPolicy：空；
    • WebSec.Template：模板名称；
    • DDoS.L4Proxy：空；
    • DDoS.L3Transit：空。
    */ EntityName?: string; /** *

    子实体类型。

    枚举值：

    • WebSec.ExceptionRule： 防护例外规则
    • WebSec.BasicAccessRule： 基础访问管控
    • WebSec.PreciseMatchRule： 精确匹配规则
    • WebSec.RateLimitRule： 精准速率限制
    • WebSec.BotCustomRule： 高级 Bot 管理 - 自定义规则
    • DDoS.L4Proxy.IpAccessControl： 四层代理 DDoS 防护 - IP 黑白名单
    • DDoS.L3Transit.IpAccessControl： 三层代播 DDoS 防护 - IP 黑白名单
    */ SubEntityType?: string; /** *

    子实体标识，根据 SubEntityType 不同代表不同的含义：

    • WebSec.ExceptionRule：规则 ID；
    • WebSec.BasicAccessRule：规则 ID；
    • WebSec.PreciseMatchRule：规则 ID；
    • WebSec.RateLimitRule：规则 ID；
    • WebSec.BotCustomRule：规则 ID；
    • DDoS.L4Proxy.IpAccessControl：空；
    • DDoS.L3Transit.IpAccessControl：空。

    EntityType 与 SubEntityType 为对应关系，不同的 EntityType 支持不同的 SubEntityType。
    WebSec.ZonePolicy，WebSec.HostPolicy 和 WebSec.Template 支持如下 SubEntityType：

    • WebSec.ExceptionRule；
    • WebSec.BasicAccessRule；
    • WebSec.PreciseMatchRule；
    • WebSec.RateLimitRule；
    • WebSec.BotCustomRule。
    DDoS.L4Proxy 支持如下 SubEntityType：
    • DDoS.L4Proxy.IpAccessControl；
    DDoS.L3Transit 支持如下 SubEntityType：
    • DDoS.L3Transit.IpAccessControl。
    */ SubEntityId?: string; /** *

    子实体名称，根据 SubEntityType 不同代表不同的含义：

    • WebSec.ExceptionRule：规则名称；
    • WebSec.BasicAccessRule：规则名称；
    • WebSec.PreciseMatchRule：规则名称；
    • WebSec.RateLimitRule：规则名称；
    • WebSec.BotCustomRule：规则名称；
    • DDoS.L4Proxy.IpAccessControl：规则名称，block 表示黑名单，allow 表示白名单；
    • DDoS.L3Transit.IpAccessControl：规则名称，block 表示黑名单，allow 表示白名单。
    */ SubEntityName?: string; } /** * CreateContentIdentifier返回参数结构体 */ export interface CreateContentIdentifierResponse { /** * 生成的内容标识符 ID。创建完成之后您可以前往规则引擎在一定匹配条件下「设置内容标识符」。 */ ContentId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Host Header 重写配置参数。 */ export interface HostHeaderParameters { /** * 执行动作，取值有：
  • followOrigin：跟随源站域名；
  • custom：自定义。
    • */ Action?: string; /** * Host Header 重写，需要填写完整域名。
    注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。 */ ServerName?: string; } /** * DescribeConfigGroupVersions请求参数结构体 */ export interface DescribeConfigGroupVersionsRequest { /** * 站点 ID。 */ ZoneId: string; /** * 配置组 ID。 */ GroupId: string; /** * 过滤条件，Filters.Values 的上限为 20，该参数不填写时，返回所选配置组下的所有版本信息。详细的过滤条件如下：
  • version-id：按照版本 ID 进行过滤；
    • */ Filters?: Array; /** * 分页查询偏移量。默认值为 0。 */ Offset?: number; /** * 分页查询限制数目。默认值为 20，最大值为 100。 */ Limit?: number; } /** * 当前生效的回源 IP 网段。 */ export interface MultiPathGatewayCurrentOriginACL { /** * 回源 IP 网段详情。 */ EntireAddresses?: Addresses; /** * 版本号。 */ Version?: number; /** * 本参数用于记录当前版本生效前是否完成「我已更新至最新回源 IP 网段」的确认。取值有：
  • true：已完成更新至最新回源 IP 的确认；
  • false：未完成更新至最新回源 IP 的确认；
    • 注意：本参数返回 false 时，请及时确认您的源站防火墙配置是否已更新至最新的回源 IP 网段，以避免出现回源失败。 */ IsPlaned?: string; } /** * OperateInferenceService返回参数结构体 */ export interface OperateInferenceServiceResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeL4ProxyRules请求参数结构体 */ export interface DescribeL4ProxyRulesRequest { /** * 站点 ID。 */ ZoneId: string; /** * 四层代理实例 ID。 */ ProxyId: string; /** * 分页查询偏移量，不填写时默认为 0。 */ Offset: number; /** * 分页查询限制数目。默认值：20，最大值：1000。 */ Limit: number; /** * 过滤条件，Filters.Values的上限为20。不填写时返回当前四层实例下所有的规则信息，详细的过滤条件如下：
  • rule-id：按照规则 ID 对四层代理实例下的规则进行过滤。规则 ID 形如：rule-31vv7qig0vjy；
  • rule-tag：按照规则标签对四层代理实例下的规则进行过滤。
    • */ Filters?: Array; } /** * AI规则引擎防护 */ export interface AiRule { /** * AI规则引擎状态，取值有：
  • smart_status_close：关闭；
  • smart_status_open：拦截处置；
  • smart_status_observe：观察处置。
    • */ Mode: string; } /** * 边缘函数详情 */ export interface Function { /** *

    函数 ID。

    */ FunctionId?: string; /** *

    站点 ID。

    */ ZoneId?: string; /** *

    函数名字。

    */ Name?: string; /** *

    函数描述。

    */ Remark?: string; /** *

    函数内容。

    */ Content?: string; /** *

    函数默认域名。

    */ Domain?: string; /** *

    边缘函数默认域名因合规问题产生的地区访问限制列表。

    */ DomainComplianceRestrictions?: Array; /** *

    创建时间。时间为世界标准时间（UTC）， 遵循 ISO 8601 标准的日期和时间格式。

    */ CreateTime?: string; /** *

    修改时间。时间为世界标准时间（UTC）， 遵循 ISO 8601 标准的日期和时间格式。

    */ UpdateTime?: string; } /** * 拦截页面的配置信息 */ export interface DropPageDetail { /** * 拦截页面的唯一 Id。系统默认包含一个自带拦截页面，Id 值为0。 该 Id 可通过创建拦截页面接口进行上传获取。如传入0，代表使用系统默认拦截页面。该参数已废弃。 */ PageId: number; /** * 拦截页面的 HTTP 状态码。状态码取值：100～600，不支持 3xx 状态码。托管规则拦截页面默认：566，安全防护（除托管规则外）拦截页面默认：567. */ StatusCode: number; /** * 页面文件名或 url。 */ Name: string; /** * 页面的类型，取值有：
  • page：指定页面。
    • */ Type: string; /** * 自定义响应 Id。该 Id 可通过查询自定义错误页列表接口获取。默认值为default，使用系统默认页面。Type 类型是 page 时必填，且不能为空。 */ CustomResponseId?: string; } /** * DescribeWebSecurityTemplates返回参数结构体 */ export interface DescribeWebSecurityTemplatesResponse { /** * 策略模板总数。 */ TotalCount?: number; /** * 策略模板列表。 */ SecurityPolicyTemplates?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 边缘函数绑定 KV 命名空间时所需的详细配置参数，用于指定绑定的命名空间来源。通过此配置，边缘函数可操作指定站点下的 KV 命名空间。 */ export interface KVNamespaceParameters { /** * KV 命名空间所属的站点 ID。指定要绑定的 KV 命名空间所在的站点，支持跨站点绑定。 */ ZoneId: string; /** * KV 命名空间名称。指定要绑定的具体命名空间，可通过 DescribeKVNamespace 接口获取站点下的命名空间列表。 */ Namespace: string; } /** * DescribePrefetchOriginLimit返回参数结构体 */ export interface DescribePrefetchOriginLimitResponse { /** * 回源限速限制总数。 */ TotalCount?: number; /** * 回源限速限制详情List。 */ Limits?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 刷新/预热 可用量及配额 */ export interface Quota { /** * 单次批量提交配额上限。 */ Batch: number; /** * 每日提交配额上限。 */ Daily: number; /** * 每日剩余的可提交配额。 */ DailyAvailable: number; /** * 刷新预热缓存类型，取值有：
  • purge_prefix：按前缀刷新；
  • purge_url：按URL刷新；
  • purge_host：按Hostname刷新；
  • purge_all：刷新全部缓存内容；
  • purge_cache_tag：按CacheTag刷新；
  • prefetch_url：按URL预热。
    • */ Type: string; } /** * CheckCnameStatus请求参数结构体 */ export interface CheckCnameStatusRequest { /** * 站点 ID。 */ ZoneId: string; /** * 需要检测 CNAME 配置状态的域名列表，可以为：
  • 加速域名;
  • 别称域名。
    • */ RecordNames: Array; } /** * CheckFreeCertificateVerification请求参数结构体 */ export interface CheckFreeCertificateVerificationRequest { /** * 站点 ID。 */ ZoneId: string; /** * 加速域名，该域名为[申请免费证书](https://cloud.tencent.com/document/product/1552/124807)时使用的域名。 */ Domain: string; } /** * 检测长度限制配置条件。 */ export interface DetectLengthLimitCondition { /** * 匹配条件的参数名称，取值有：
  • body_depth：请求正文包部分的检测深度。
    • */ Name: string; /** * 匹配条件的参数值，取值与 Name 成对使用。 当 Name 值为 body_depth 时， Values 只支持传入单个值，取值有：
  • 10KB；
  • 64KB；
  • 128KB。
    • */ Values: Array; } /** * 推理服务信息。 */ export interface InferenceService { /** * 推理服务 ID。 */ ServiceId?: string; /** * 推理服务的名称。 */ Name?: string; /** * 描述信息。 */ Description?: string; /** * 模型服务需要监听的端口。仅支持 1-65535 之间的整数。 */ ListenPort?: number; /** * 推理服务的请求路径列表。最多支持 20 个路径。 */ RequestPaths?: Array; /** * 推理服务的容器配置。 */ Containers?: Array; /** * 推理服务的资源配置。 */ ResourceConfig?: InferenceResourceConfig; /** * 推理服务状态，包含以下几种状态：
  • Deploying：部署中；
  • Running：运行中；
  • Stopping：停止中；
  • Stopped：已停止；
  • Exception：异常；
  • Banned：被封禁。
    • */ Status?: string; /** * 伸缩状态。取值有：
  • Normal：稳定运行，无进行中的伸缩操作；
  • ScalingOut：扩容中；
  • ScalingIn：缩容中。
    • */ ScalingStatus?: string; /** * 当前运行中的实例数量。 */ CurrentInstanceCount?: number; /** * 推理访问地址，可通过链接访问底层模型进行推理。 */ InferenceURL?: string; /** * 创建时间，使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。 */ CreateTime?: string; /** * 最后修改时间，使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。 */ UpdateTime?: string; } /** * DeleteInferenceAPIToken返回参数结构体 */ export interface DeleteInferenceAPITokenResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifySecurityAPIResource返回参数结构体 */ export interface ModifySecurityAPIResourceResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribePlans返回参数结构体 */ export interface DescribePlansResponse { /** * 符合条件的套餐个数。 */ TotalCount?: number; /** * 套餐信息列表。 */ Plans?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UpgradePlan请求参数结构体 */ export interface UpgradePlanRequest { /** * 套餐 ID，形如 edgeone-2unuvzjmmn2q。 */ PlanId: string; /** * 需要升级到的目标套餐版本，取值有：
  • basic：基础版套餐；
  • standard：标准版套餐。
    • */ PlanType: string; /** * 是否自动使用代金券，取值有：
  • true：是；
  • false：否。
    • 不填写使用默认值 false。 */ AutoUseVoucher?: string; } /** * CreatePurgeTask请求参数结构体 */ export interface CreatePurgeTaskRequest { /** * 站点 ID。 若您希望快速提交不同站点下的 Targets Url，可以将其填写为 *，但前提是调用该 API 的账号必须具备主账号下全部站点资源的权限。 */ ZoneId: string; /** * 节点缓存清除类型，取值有：
  • purge_url：URL刷新；
  • purge_prefix：目录刷新；
  • purge_host：Hostname 刷新；
  • purge_all：站点下全部缓存刷新（取该值时不支持 ZoneId 入参为 *）；
  • purge_cache_tag：cache-tag 刷新。
    • 缓存清除类型详情请查看[清除缓存](https://cloud.tencent.com/document/product/1552/70759)。 */ Type: string; /** * 节点缓存清除方法，针对目录刷新、Hostname 刷新以及刷新全部缓存类型有效，取值有：
  • invalidate：仅刷新目录下产生了更新的资源；
  • delete：无论目录下资源是否更新都刷新节点资源。
    • 默认值： invalidate。 */ Method?: string; /** * 需清除缓存的资源列表，如 https://www.example.com/example.jpg，必须携带协议信息。更多元素格式依据清除缓存类型而定，可参考下方接口调用示例。
  • 单次提交的任务数受计费套餐配额限制，请查看 [EO 计费套餐](https://cloud.tencent.com/document/product/1552/77380)。
    • */ Targets?: Array; /** * 若有编码转换，仅清除编码转换后匹配的资源。 若内容含有非 ASCII 字符集的字符，请开启此开关进行编码转换（编码规则遵循 RFC3986）。 * @deprecated */ EncodeUrl?: boolean; /** * 节点缓存清除类型取值为 purge_cache_tag 时，该参数必填，入参值为域名。 */ CacheTag?: CacheTag; } /** * DeleteDnsRecords返回参数结构体 */ export interface DeleteDnsRecordsResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 修改 HTTP 回源请求头配置参数。 */ export interface ModifyRequestHeaderParameters { /** * HTTP 头部设置规则列表。 注意：此字段可能返回 null，表示取不到有效值。 */ HeaderActions?: Array; } /** * 边缘推理弹性伸缩策略。 */ export interface InferenceScalingPolicy { /** * 策略名称。长度限制为 1~30 个字符。同一服务内策略名称需唯一。 */ PolicyName: string; /** * 策略类型，创建后不可修改。取值：
  • ScheduledScaling：定时伸缩。
    • */ PolicyType: string; /** * 定时伸缩配置。当 PolicyType 取值为 ScheduledScaling 时，该字段必填。 */ ScheduledScalingPolicy?: InferenceScheduledScalingPolicy; } /** * CreateWebSecurityTemplate返回参数结构体 */ export interface CreateWebSecurityTemplateResponse { /** * 策略模板 ID。 */ TemplateId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Bot 智能分析的具体配置。 */ export interface BotIntelligence { /** * Bot 智能分析的具体配置开关。取值有： on：开启； off：关闭。 */ Enabled?: string; /** * Bot 智能分析的规则 ID，仅作为出参返回。 */ Id?: string; /** * 基于客户端和请求特征，将请求来源分为人类来源请求、合法 Bot 请求、疑似 Bot 请求和高风险 Bot 请求，并提供请求处置选项。 */ BotRatings?: BotRatings; } /** * HTTPS 源站证书校验的模式。 */ export interface OriginCertificateVerify { /** * 源站证书校验模式。取值有：
  • disable:禁用源站证书校验。
  • custom_ca:使用指定受信任 CA 证书校验。
    • */ VerificationMode: string; /** * 指定受信任的 CA 证书列表，源站证书需要由该 CA 签发才能校验通过。 注意：仅当 VerificationMode 为 custom_ca 时，需要传入该参数，指定受信任的CA证书信息。 OriginCertificateVerify 在 ModifyHostsCertificate 作为入参使用时，该参数传入对应证书的 CertId 即可。您可以前往 [SSL 证书列表](https://console.cloud.tencent.com/ssl) 查看 CertId。 */ CustomCACerts?: Array; } /** * 搜索引擎规则配置。 */ export interface SearchEngineBots { /** * 来自搜索引擎爬虫的请求的执行动作。 SecurityAction 的 Name 取值支持：
  • Deny：拦截；
  • Monitor：观察；
  • Disabled：未启用，不启用指定规则；
  • Challenge：挑战，其中 ChallengeActionParameters 中的 ChallengeOption 支持 JSChallenge 和 ManagedChallenge；
  • Allow：放行（待废弃）。
    • */ BaseAction?: SecurityAction; /** * 指定搜索引擎爬虫请求的处置方式。 */ BotManagementActionOverrides?: Array; } /** * DescribePurgeTasks返回参数结构体 */ export interface DescribePurgeTasksResponse { /** * 该查询条件总共条目数。 */ TotalCount?: number; /** * 任务结果列表。 */ Tasks?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * HTTP DDOS防护配置。 */ export interface HttpDDoSProtection { /** * 自适应频控的具体配置。 */ AdaptiveFrequencyControl?: AdaptiveFrequencyControl; /** * 智能客户端过滤的具体配置。 */ ClientFiltering?: ClientFiltering; /** * 流量防盗刷的具体配置。 */ BandwidthAbuseDefense?: BandwidthAbuseDefense; /** * 慢速攻击防护的具体配置。 */ SlowAttackDefense?: SlowAttackDefense; } /** * 各个健康检查区域下源站的健康状态。 */ export interface CheckRegionHealthStatus { /** * 健康检查区域，ISO-3166-1 两位字母代码。 */ Region?: string; /** * 单健康检查区域下探测源站的健康状态，取值有：
  • Healthy：健康；
  • Unhealthy：不健康；
  • Undetected：未探测到数据。
    • 说明：单健康检查区域下所有源站为健康，则状态为健康，否则为不健康。 */ Healthy?: string; /** * 源站健康状态。 */ OriginHealthStatus?: Array; } /** * 高频扫描防护配置选项，当某一访客的请求频繁命中「配置为拦截」的托管规则时，在一段时间内封禁该访客所有请求。 */ export interface FrequentScanningProtection { /** * 高频扫描防护规则是否开启。取值有：
  • on：开启，高频扫描防护规则生效；
  • off：关闭，高频扫描防护规则不生效。
    • */ Enabled?: string; /** * 高频扫描防护的规则 ID，仅作为出参返回。 */ Id?: string; /** * 高频扫描防护的处置动作。 当 Enabled 为 on 时，此字段必填。SecurityAction 的 Name 取值支持：
  • Deny：拦截，响应拦截页面；
  • Monitor：观察，不处理请求记录安全事件到日志中；
  • JSChallenge：JavaScript 挑战，响应 JavaScript 挑战页面。
    • */ Action?: SecurityAction; /** * 请求统计的匹配方式，当 Enabled 为 on 时，此字段必填。取值有：
  • http.request.xff_header_ip：客户端 IP（优先匹配 XFF 头部）；
  • http.request.ip：客户端 IP。
    • */ CountBy?: string; /** * 此参数指定高频扫描防护的阈值，即在 CountingPeriod 所设置时间范围内命中「配置为拦截」的托管规则时的累计拦截次数，取值范围 1 ~ 4294967294，例如 100，当超过此统计值时，后续请求将触发 Action 所设置的处置动作。当 Enabled 为 on 时，此字段必填。 */ BlockThreshold?: number; /** * 此参数指定高频扫描防护所统计的时间窗口，即命中「配置为拦截」的托管规则的请求的统计时间窗口，取值 5 ~ 1800，单位仅支持秒（s），例如 5s。 当 Enabled 为 on 时，此字段必填。 */ CountingPeriod?: string; /** * 此参数指定高频扫描防护 Action 参数所设置处置动作的持续时长，取值范围 60 ~ 86400，单位仅支持秒（s），例如 60s。当 Enabled 为 on 时，此字段必填。 */ ActionDuration?: string; } /** * DescribeFunctionRules请求参数结构体 */ export interface DescribeFunctionRulesRequest { /** * 站点 ID。 */ ZoneId: string; /** * 过滤条件列表，多个条件为且关系，Filters.Values 的上限为 20。详细的过滤条件如下：
  • rule-id：按照【规则 ID】进行精确匹配。
  • function-id：按照【函数 ID】进行精确匹配。
  • remark：按照【规则描述】进行模糊匹配。
    • */ Filters?: Array; } /** * DeployConfigGroupVersion返回参数结构体 */ export interface DeployConfigGroupVersionResponse { /** * 发布记录 ID。 */ RecordId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * IP 网段详情。 */ export interface Addresses { /** * IPv4 网段列表。 */ IPv4?: Array; /** * IPv6 网段列表。 */ IPv6?: Array; } /** * 智能客户端过滤 */ export interface RateLimitIntelligence { /** * 功能开关，取值有：
  • on：开启；
  • off：关闭。
    • */ Switch: string; /** * 执行动作，取值有：
  • monitor：观察；
  • alg：挑战。
    • */ Action: string; /** * 规则id，仅出参使用。 */ RuleId?: number; } /** * DescribeDeployHistory返回参数结构体 */ export interface DescribeDeployHistoryResponse { /** * 发布记录总数。 */ TotalCount?: number; /** * 发布记录详情。 */ Records?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeJustInTimeTranscodeTemplates请求参数结构体 */ export interface DescribeJustInTimeTranscodeTemplatesRequest { /** * 站点ID。 */ ZoneId: string; /** * 过滤条件，Filters 的上限为 20，Filters.Values 的上限为 20。该参数不填写时，默认返回当前 ZoneId 下有权限的即时转码模板。详细的过滤条件如下：
  • template-name：按照模板名批量进行过滤。例如：mytemplate；
  • template-type：按照模板类型批量进行过滤。例如：preset 或 custom。
  • template-id：按照模板 ID 批量进行过滤。例如：C1LZ7982VgTpYhJ7M。
    • 默认为空。 */ Filters?: Array; /** * 排序字段，取值有：
  • createTime：模板创建时间。
    • 默认值为：createTime。 */ SortBy?: string; /** * 排序方式，取值有：
  • asc：升序方式；
  • desc：降序方式。
    • 默认值为：desc。 */ SortOrder?: string; /** * 分页偏移量，默认值：0。 */ Offset?: number; /** * 返回记录条数，默认值：20，最大值：1000。 */ Limit?: number; } /** * CacheKey中包含请求参数 */ export interface QueryString { /** * CacheKey是否由QueryString组成，取值有：
  • on：是；
  • off：否。
    • */ Switch: string; /** * CacheKey使用QueryString的方式，取值有：
  • includeCustom：使用部分url参数；
  • excludeCustom：排除部分url参数。
    • */ Action?: string; /** * 使用/排除的url参数数组。 */ Value?: Array; } /** * ModifySecurityClientAttester请求参数结构体 */ export interface ModifySecurityClientAttesterRequest { /** * 站点 ID。 */ ZoneId: string; /** * 认证选项列表。 */ ClientAttesters?: Array; } /** * DescribeAccelerationDomains请求参数结构体 */ export interface DescribeAccelerationDomainsRequest { /** * 加速域名所属站点 ID。 */ ZoneId: string; /** * 分页查询偏移量，默认为 0。 */ Offset?: number; /** * 分页查询限制数目，默认值：20，上限：200。 */ Limit?: number; /** * 过滤条件，Filters.Values 的上限为 20。该参数不填写时，返回当前 zone-id 下所有域名信息。详细的过滤条件如下：
  • domain-name：按照加速域名进行过滤；
  • origin-type：按照源站类型进行过滤；
  • origin：按照主源站地址进行过滤；
  • backup-origin： 按照备用源站地址进行过滤；
  • domain-cname：按照 CNAME 进行过滤；
  • share-cname：按照共享 CNAME 进行过滤；
    • */ Filters?: Array; /** * 可根据该字段对返回结果进行排序，取值有：
  • created_on：加速域名创建时间；
  • domain-name：加速域名。
    • 不填写时，默认对返回结果按照 domain-name 排序。 */ Order?: string; /** * 排序方向，如果是字段值为数字，则根据数字大小排序；如果字段值为文本，则根据 ascill 码的大小排序。取值有：
  • asc：升序排列；
  • desc：降序排列。
    • 不填写使用默认值 asc。 */ Direction?: string; /** * 匹配方式，取值有：
  • all：返回匹配所有查询条件的加速域名；
  • any：返回匹配任意一个查询条件的加速域名。
    • 不填写时默认值为 all。 */ Match?: string; } /** * CreateDnsRecord返回参数结构体 */ export interface CreateDnsRecordResponse { /** * DNS 记录 ID。 */ RecordId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTimingL4Data请求参数结构体 */ export interface DescribeTimingL4DataRequest { /** * 开始时间。 */ StartTime: string; /** * 结束时间。查询时间范围（`EndTime` - `StartTime`）需小于等于 31 天。 */ EndTime: string; /** * 查询指标，取值有：
    • **l4Flow_flux**: 访问总流量，单位：Byte，指标值类型：Integer；
    • **l4Flow_inFlux**: 访问入流量，单位：Byte，指标值类型：Integer；
    • **l4Flow_outFlux**: 访问出流量，单位：Byte，指标值类型：Integer；
    • **l4Flow_inBandwidth**: 访问入向带宽峰值，单位：bps，指标值类型：Integer；
    • **l4Flow_outBandwidth**: 访问出向带宽峰值，单位：bps，指标值类型：Integer；
    • **l4Flow_connections**: 访问并发连接数，单位：个，指标值类型：Integer ；
    • **l4Flow_newConnectionsRate**: 新建连接数速率，单位：个/秒，指标值类型： Float，保留两位小数。
    **注意**：
    • Integer 值类型的指标将从 Data.N.TypeValue 返回对应时序数据；
    • Float 值类型的指标将从 Data.N.FloatTypeValue 返回对应时序数据。
    */ MetricNames: Array; /** * 站点ID，此参数将于2024年05月30日后由可选改为必填，详见公告：[【腾讯云 EdgeOne】云 API 变更通知](https://cloud.tencent.com/document/product/1552/104902)。 最多传入 100 个站点 ID。若需查询腾讯云主账号下所有站点数据，请用 `*` 代替，查询账号级别数据需具备本接口全部站点资源权限。 */ ZoneIds: Array; /** * 四层实例列表, 不填表示选择全部实例。 */ ProxyIds?: Array; /** * 查询时间粒度，取值有：
    • **min**: 1分钟 ；
    • **5min**: 5分钟 ；
    • **hour**: 1小时 ；
    • **day**: 1天 。
    不填将根据开始时间跟结束时间的间距自动推算粒度，具体为：1小时范围内以 min 粒度查询，2天范围内以 5min 粒度查询，7天范围内以 hour 粒度查询，超过7天以 day 粒度查询。 */ Interval?: string; /** * 过滤条件，详细的过滤条件Key值如下：
    • **ruleId**：按照转发规则 ID 进行过滤。
    • **proxyId**：按照四层代理实例 ID 进行过滤。
    */ Filters?: Array; /** * 数据归属地区。该参数已废弃。请在 Filters.country 中按客户端地域过滤数据。 * @deprecated */ Area?: string; } /** * DescribeTimingL4Data返回参数结构体 */ export interface DescribeTimingL4DataResponse { /** * 查询结果的总条数。 */ TotalCount?: number; /** *

    四层时序流量数据列表。
    对于不同的查询指标，根据指标值类型的不同，会从不同的参数返回时序数据。
    目前存在的值类型有以下两种：

    • Integer：Integer 值类型的指标将从 Data.N.TypeValue 返回对应时序数据。
      对应的查询指标 MetricName 有：
      • l4Flow_flux：访问总流量；
      • l4Flow_inFlux：访问入流量；
      • l4Flow_outFlux：访问出流量；
      • l4Flow_inBandwidth：访问入向带宽峰值；
      • l4Flow_outBandwidth：访问出向带宽峰值；
      • l4Flow_connections：访问并发连接数。
    • Float：Float 值类型的指标将从 Data.N.FloatTypeValue 返回对应时序数据。
      对应的查询指标 MetricName 有：
      • l4Flow_newConnectionsRate：新建连接数速率。

    本接口暂不支持指定维度查询，默认按主账号汇总返回数据，即 Data.N.TypeKey = AppId，AppId 是腾讯云主账号唯一标识，N 恒等于 1。

    注意：此字段可能返回 null，表示取不到有效值。 */ Data?: Array; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CNAME 接入类型站点参数详情。 */ export interface CNAMEDetail { /** * 是否伪站点，取值有：
  • 0：非伪站点；
  • 1：伪站点。
    • */ IsFake?: number; /** * 归属权验证信息。详情请参考 [站点/域名归属权验证](https://cloud.tencent.com/document/product/1552/70789) 。 */ OwnershipVerification?: OwnershipVerification; } /** * 回源鉴权参数。 */ export interface OriginAuthenticationParameters { /** * 回源鉴权请求属性。 */ RequestProperties: Array; } /** * 规则引擎操作。 */ export interface RuleEngineAction { /** *

    操作名称。名称需要与参数结构体对应，例如 Name=Cache，则 CacheParameters 必填。

  • Cache：节点缓存 TTL；
  • CacheKey：自定义 Cache Key；
  • CachePrefresh：缓存预刷新；
  • AccessURLRedirect：访问 URL 重定向；
  • UpstreamURLRewrite：回源 URL 重写；
  • QUIC：QUIC；
  • WebSocket：WebSocket；
  • Authentication：Token 鉴权；
  • MaxAge：浏览器缓存 TTL；
  • StatusCodeCache：状态码缓存 TTL；
  • OfflineCache：离线缓存；
  • SmartRouting：智能加速；
  • AdvancedOriginRouting：高级回源优化；
  • RangeOriginPull：分片回源 ；
  • UpstreamHTTP2：HTTP2 回源；
  • HostHeader：Host Header 重写；
  • ForceRedirectHTTPS：访问协议强制 HTTPS 跳转配置；
  • OriginPullProtocol：回源 HTTPS；
  • Compression：智能压缩配置；
  • HSTS：HSTS；
  • ClientIPHeader：存储客户端请求 IP 的头部信息配置；
  • OCSPStapling：OCSP 装订；
  • HTTP2：HTTP2 接入；
  • PostMaxSize：POST 请求上传文件流式传输最大限制配置；
  • ClientIPCountry：回源时携带客户端 IP 所属地域信息；
  • UpstreamFollowRedirect：回源跟随重定向参数配置；
  • UpstreamRequest：回源请求参数；
  • Shield：源站卸载配置；
  • TLSConfig：SSL/TLS 安全；
  • ModifyOrigin：修改源站；
  • SiteFailover：源站故障转移；
  • HTTPUpstreamTimeout：七层回源超时配置；
  • HttpResponse：HTTP 应答；
  • ErrorPage：自定义错误页面；
  • ModifyResponseHeader：修改 HTTP 节点响应头；
  • ModifyRequestHeader：修改 HTTP 节点请求头；
  • ResponseSpeedLimit：单连接下载限速；
  • SetContentIdentifier：设置内容标识符；
  • Vary：Vary 特性配置；
  • ContentCompression：内容压缩配置；
  • OriginAuthentication：回源鉴权配置；
  • CustomAction：定制配置。

    • */ Name: string; /** *

    节点缓存 TTL 配置参数，当 Name 取值为 Cache 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ CacheParameters?: CacheParameters; /** *

    自定义 Cache Key 配置参数，当 Name 取值为 CacheKey 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ CacheKeyParameters?: CacheKeyParameters; /** *

    缓存预刷新配置参数，当 Name 取值为 CachePrefresh 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ CachePrefreshParameters?: CachePrefreshParameters; /** *

    访问 URL 重定向配置参数，当 Name 取值为 AccessURLRedirect 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ AccessURLRedirectParameters?: AccessURLRedirectParameters; /** *

    回源 URL 重写配置参数，当 Name 取值为 UpstreamURLRewrite 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ UpstreamURLRewriteParameters?: UpstreamURLRewriteParameters; /** *

    QUIC 配置参数，当 Name 取值为 QUIC 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ QUICParameters?: QUICParameters; /** *

    WebSocket 配置参数，当 Name 取值为 WebSocket 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ WebSocketParameters?: WebSocketParameters; /** *

    Token 鉴权配置参数，当 Name 取值为 Authentication 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ AuthenticationParameters?: AuthenticationParameters; /** *

    浏览器缓存 TTL 配置参数，当 Name 取值为 MaxAge 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ MaxAgeParameters?: MaxAgeParameters; /** *

    状态码缓存 TTL 配置参数，当 Name 取值为 StatusCodeCache 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ StatusCodeCacheParameters?: StatusCodeCacheParameters; /** *

    离线缓存配置参数，当 Name 取值为 OfflineCache 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ OfflineCacheParameters?: OfflineCacheParameters; /** *

    智能加速配置参数，当 Name 取值为 SmartRouting 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ SmartRoutingParameters?: SmartRoutingParameters; /** *

    高级回源优化配置参数，当 Name 取值为 AdvancedOriginRouting 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ AdvancedOriginRoutingParameters?: AdvancedOriginRoutingParameters; /** *

    分片回源配置参数，当 Name 取值为 RangeOriginPull 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ RangeOriginPullParameters?: RangeOriginPullParameters; /** *

    HTTP2 回源配置参数，当 Name 取值为 UpstreamHTTP2 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ UpstreamHTTP2Parameters?: UpstreamHTTP2Parameters; /** *

    Host Header 重写配置参数，当 Name 取值为 HostHeader 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ HostHeaderParameters?: HostHeaderParameters; /** *

    访问协议强制 HTTPS 跳转配置，当 Name 取值为 ForceRedirectHTTPS 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ ForceRedirectHTTPSParameters?: ForceRedirectHTTPSParameters; /** *

    回源 HTTPS 配置参数，当 Name 取值为 OriginPullProtocol 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ OriginPullProtocolParameters?: OriginPullProtocolParameters; /** *

    智能压缩配置，当 Name 取值为 Compression 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ CompressionParameters?: CompressionParameters; /** *

    HSTS 配置参数，当 Name 取值为 HSTS 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ HSTSParameters?: HSTSParameters; /** *

    存储客户端请求 IP 的头部信息配置，当 Name 取值为 ClientIPHeader 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ ClientIPHeaderParameters?: ClientIPHeaderParameters; /** *

    OCSP 装订配置参数，当 Name 取值为 OCSPStapling 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ OCSPStaplingParameters?: OCSPStaplingParameters; /** *

    HTTP2 接入配置参数，当 Name 取值为 HTTP2 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ HTTP2Parameters?: HTTP2Parameters; /** *

    POST 请求上传文件流式传输最大限制配置，当 Name 取值为 PostMaxSize 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ PostMaxSizeParameters?: PostMaxSizeParameters; /** *

    回源时携带客户端 IP 所属地域信息配置参数，当 Name 取值为 ClientIPCountry 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ ClientIPCountryParameters?: ClientIPCountryParameters; /** *

    回源跟随重定向参数配置，当 Name 取值为 UpstreamFollowRedirect 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ UpstreamFollowRedirectParameters?: UpstreamFollowRedirectParameters; /** *

    回源请求参数配置参数，当 Name 取值为 UpstreamRequest 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ UpstreamRequestParameters?: UpstreamRequestParameters; /** *

    源站卸载配置参数，当 Name 取值为 Shield 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ ShieldParameters?: ShieldParameters; /** *

    SSL/TLS 安全配置参数，当 Name 取值为 TLSConfig 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ TLSConfigParameters?: TLSConfigParameters; /** *

    修改源站配置参数，当 Name 取值为 ModifyOrigin 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ ModifyOriginParameters?: ModifyOriginParameters; /** *

    源站故障转移配置参数，当 Name 取值为 SiteFailover 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ SiteFailoverParameters?: SiteFailoverParameters; /** *

    七层回源超时配置，当 Name 取值为 HTTPUpstreamTimeout 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ HTTPUpstreamTimeoutParameters?: HTTPUpstreamTimeoutParameters; /** *

    HTTP 应答配置参数，当 Name 取值为 HttpResponse 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ HttpResponseParameters?: HTTPResponseParameters; /** *

    自定义错误页面配置参数，当 Name 取值为 ErrorPage 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ ErrorPageParameters?: ErrorPageParameters; /** *

    修改 HTTP 节点响应头配置参数，当 Name 取值为 ModifyResponseHeader 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ ModifyResponseHeaderParameters?: ModifyResponseHeaderParameters; /** *

    修改 HTTP 节点请求头配置参数，当 Name 取值为 ModifyRequestHeader 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ ModifyRequestHeaderParameters?: ModifyRequestHeaderParameters; /** *

    单连接下载限速配置参数，当 Name 取值为 ResponseSpeedLimit 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ ResponseSpeedLimitParameters?: ResponseSpeedLimitParameters; /** *

    内容标识配置参数，当 Name 取值为 SetContentIdentifier 时，该参数必填。

    注意：此字段可能返回 null，表示取不到有效值。 */ SetContentIdentifierParameters?: SetContentIdentifierParameters; /** *

    Vary 特性配置参数，当 Name 取值为 Vary 时，该参数必填。

    */ VaryParameters?: VaryParameters; /** *

    内容压缩配置参数，当 Name 取值为 ContentCompression 时，该参数必填。该参数为白名单功能，如有需要，请联系腾讯云工程师处理。

    */ ContentCompressionParameters?: ContentCompressionParameters; /** *

    回源鉴权配置参数，当 Name 取值为 OriginAuthentication 时，该参数必填。该参数为白名单功能，如有需要，请联系腾讯云工程师处理。

    */ OriginAuthenticationParameters?: OriginAuthenticationParameters; /** *

    定制配置操作参数，当 Name 取值为 CustomAction 时，该参数必填。

    您可以通过 DescribeAvailableCustomActionsForRuleEngine 接口的返回值 CustomActionSet 获取您当前支持的定制配置项列表。

    */ CustomActionParameters?: CustomActionParameters; } /** * 自定义名字服务器 IP 信息 */ export interface VanityNameServersIps { /** * 自定义名字服务器名称。 */ Name: string; /** * 自定义名字服务器 IPv4 地址。 */ IPv4: string; }