@nocobase/plugin-verification
Version:
User identity verification management, including SMS, TOTP authenticator, with extensibility.
2,475 lines (2,472 loc) • 241 kB
TypeScript
/**
* CreatePlanForZone返回参数结构体
*/
export interface CreatePlanForZoneResponse {
/**
* 购买的资源名字列表。
*/
ResourceNames: Array<string>;
/**
* 购买的订单号列表。
*/
DealNames: Array<string>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeployConfigGroupVersion请求参数结构体
*/
export interface DeployConfigGroupVersionRequest {
/**
* 站点 ID。
*/
ZoneId: string;
/**
* 环境 ID。请填写版本需要发布到的环境 ID。
*/
EnvId: string;
/**
* 需要发布的版本信息。可以同时变更多个不同配置组的版本，每个配置组一次仅支持变更一个版本。
*/
ConfigGroupVersionInfos: Array<ConfigGroupVersionInfo>;
/**
* 变更说明。用于描述此次变更的内容、原因，最大支持 100 个字符。
*/
Description: string;
}
/**
* DescribeEnvironments请求参数结构体
*/
export interface DescribeEnvironmentsRequest {
/**
* 站点 ID。
*/
ZoneId: string;
}
/**
* 智能压缩配置。
*/
export interface Compression {
/**
* 智能压缩配置开关，取值有：
<li>on：开启；</li>
<li>off：关闭。</li>
*/
Switch: string;
/**
* 支持的压缩算法列表，取值有：
<li>brotli：brotli算法；</li>
<li>gzip：gzip算法。</li>
注意：此字段可能返回 null，表示取不到有效值。
*/
Algorithms?: Array<string>;
}
/**
* DeleteRules请求参数结构体
*/
export interface DeleteRulesRequest {
/**
* 站点 ID。
*/
ZoneId: string;
/**
* 指定删除的规则 ID 列表。
*/
RuleIds: Array<string>;
}
/**
* 例外规则生效的具体条件。
*/
export interface ExceptUserRuleCondition {
/**
* 匹配项，取值有：
<li>host：请求域名；</li>
<li>sip：客户端IP；</li>
<li>ua：User-Agent；</li>
<li>cookie：会话 Cookie；</li>
<li>cgi：CGI 脚本；</li>
<li>xff：XFF 扩展头部；</li>
<li>url：请求 URL；</li>
<li>accept：请求内容类型；</li>
<li>method：请求方式；</li>
<li>header：请求头部；</li>
<li>sip_proto：网络层协议。</li>
*/
MatchFrom?: string;
/**
* 匹配项的参数。仅当 MatchFrom 为 header 时，可以使用本参数，值可填入 header 的 key 作为参数。
*/
MatchParam?: string;
/**
* 匹配操作符，取值有：
<li>equal：字符串等于；</li>
<li>not_equal：数值不等于；</li>
<li>include：字符包含；</li>
<li>not_include：字符不包含；</li>
<li>match：ip匹配；</li>
<li>not_match：ip不匹配；</li>
<li>include_area：地域包含；</li>
<li>is_empty：存在字段但值为空；</li>
<li>not_exists：不存在关键字段；</li>
<li>regexp：正则匹配；</li>
<li>len_gt：数值大于；</li>
<li>len_lt：数值小于；</li>
<li>len_eq：数值等于；</li>
<li>match_prefix：前缀匹配；</li>
<li>match_suffix：后缀匹配；</li>
<li>wildcard：通配符。</li>
*/
Operator?: string;
/**
* 匹配值。
*/
MatchContent?: string;
}
/**
* CheckCnameStatus返回参数结构体
*/
export interface CheckCnameStatusResponse {
/**
* 加速域名 CNAME 状态信息列表。
*/
CnameStatus?: Array<CnameStatus>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyZone返回参数结构体
*/
export interface ModifyZoneResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeOriginGroup返回参数结构体
*/
export interface DescribeOriginGroupResponse {
/**
* 记录总数。
*/
TotalCount?: number;
/**
* 源站组信息。
*/
OriginGroups?: Array<OriginGroup>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeTopL7CacheData请求参数结构体
*/
export interface DescribeTopL7CacheDataRequest {
/**
* 开始时间。
*/
StartTime: string;
/**
* 结束时间。
*/
EndTime: string;
/**
* 查询的指标，取值有：
<li> l7Cache_outFlux_domain：host/域名；</li>
<li> l7Cache_outFlux_url：url地址；</li>
<li> l7Cache_outFlux_resourceType：资源类型；</li>
<li> l7Cache_outFlux_statusCode：状态码。</li>
*/
MetricName: string;
/**
* 站点 ID 集合，此参数必填。
*/
ZoneIds?: Array<string>;
/**
* 查询前多少个数据，最大值为1000，不填默认为10， 表示查询前top 10的数据。
*/
Limit?: number;
/**
* 过滤条件，详细的过滤条件如下：
<li>domain<br> 按照【<strong>子域名</strong>】进行过滤，子域名形如： test.example.com。<br> 类型：String<br> 必选：否</li>
<li>url<br> 按照【<strong>URL</strong>】进行过滤，此参数只支持30天的时间范围，URL形如：/content。<br> 类型：String<br> 必选：否</li>
<li>resourceType<br> 按照【<strong>资源类型</strong>】进行过滤，此参数只支持30天的时间范围，资源类型形如：jpg，png。<br> 类型：String<br> 必选：否</li>
<li>cacheType<br> 按照【<strong>缓存类型</strong>】进行过滤。<br> 类型：String<br> 必选：否<br> 可选项：<br> hit：命中缓存；<br> dynamic：资源不可缓存；<br> miss：未命中缓存。</li>
<li>statusCode<br> 按照【<strong>状态码</strong>】进行过滤，此参数只支持30天的时间范围。<br> 类型：String<br> 必选：否<br> 可选项：<br> 1XX：1xx类型的状态码；<br> 100：100状态码；<br> 101：101状态码；<br> 102：102状态码；<br> 2XX：2xx类型的状态码；<br> 200：200状态码；<br> 201：201状态码；<br> 202：202状态码；<br> 203：203状态码；<br> 204：204状态码；<br> 100：100状态码；<br> 206：206状态码；<br> 207：207状态码；<br> 3XX：3xx类型的状态码；<br> 300：300状态码；<br> 301：301状态码；<br> 302：302状态码；<br> 303：303状态码；<br> 304：304状态码；<br> 305：305状态码；<br> 307：307状态码；<br> 4XX：4xx类型的状态码；<br> 400：400状态码；<br> 401：401状态码；<br> 402：402状态码；<br> 403：403状态码；<br> 404：404状态码；<br> 405：405状态码；<br> 406：406状态码；<br> 407：407状态码；<br> 408：408状态码；<br> 409：409状态码；<br> 410：410状态码；<br> 411：411状态码；<br> 412：412状态码；<br> 412：413状态码；<br> 414：414状态码；<br> 415：415状态码；<br> 416：416状态码；<br> 417：417状态码；<br> 422：422状态码；<br> 423：423状态码；<br> 424：424状态码；<br> 426：426状态码；<br> 451：451状态码；<br> 5XX：5xx类型的状态码；<br> 500：500状态码；<br> 501：501状态码；<br> 502：502状态码；<br> 503：503状态码；<br> 504：504状态码；<br> 505：505状态码；<br> 506：506状态码；<br> 507：507状态码；<br> 510：510状态码；<br> 514：514状态码；<br> 544：544状态码。</li>
<li>tagKey<br> 按照【<strong>标签Key</strong>】进行过滤。<br> 类型：String<br> 必选：否</li>
<li>tagValue<br> 按照【<strong>标签Value</strong>】进行过滤。<br> 类型：String<br> 必选：否</li>
*/
Filters?: Array<QueryCondition>;
/**
* 查询时间粒度，取值有：
<li>min: 1分钟；</li>
<li>5min: 5分钟；</li>
<li>hour: 1小时；</li>
<li>day: 1天。</li>不填将根据开始时间跟结束时间的间距自动推算粒度，具体为：一小时范围内以min粒度查询，两天范围内以5min粒度查询，七天范围内以hour粒度查询，超过七天以day粒度查询。
*/
Interval?: string;
/**
* 数据归属地区，取值有：
<li>overseas：全球（除中国大陆地区）数据；</li>
<li>mainland：中国大陆地区数据；</li>
<li>global：全球数据。</li>不填默认取值为global。
*/
Area?: string;
}
/**
* DeleteApplicationProxy返回参数结构体
*/
export interface DeleteApplicationProxyResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 域名 https 加速配置，默认为关闭状态
*/
export interface Https {
/**
* http2 配置开关，取值有：
<li>on：开启；</li>
<li>off：关闭。</li>
注意：此字段可能返回 null，表示取不到有效值。
*/
Http2?: string;
/**
* OCSP 配置开关，取值有：
<li>on：开启；</li>
<li>off：关闭。</li>
注意：此字段可能返回 null，表示取不到有效值。
*/
OcspStapling?: string;
/**
* Tls 版本设置，取值有：
<li>TLSv1：TLSv1版本；</li>
<li>TLSV1.1：TLSv1.1版本；</li>
<li>TLSV1.2：TLSv1.2版本；</li>
<li>TLSv1.3：TLSv1.3版本。</li>修改时必须开启连续的版本。
注意：此字段可能返回 null，表示取不到有效值。
*/
TlsVersion?: Array<string>;
/**
* HSTS 配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
Hsts?: Hsts;
/**
* 证书配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
CertInfo?: Array<ServerCertInfo>;
/**
* 申请类型，取值有：
<li>apply：托管EdgeOne；</li>
<li>none：不托管EdgeOne。</li>不填，默认取值为none。
注意：此字段可能返回 null，表示取不到有效值。
*/
ApplyType?: string;
/**
* 密码套件，取值有：
<li>loose-v2023：提供最高的兼容性，安全性一般，支持 TLS 1.0-1.3 密码套件；</li>
<li>general-v2023：提供较高的兼容性，安全性中等，支持 TLS 1.2-1.3 密码套件；</li>
<li>strict-v2023：提供最高的安全性能，禁用所有含不安全隐患的加密套件，支持 TLS 1.2-1.3 密码套件。
注意：此字段可能返回 null，表示取不到有效值。
*/
CipherSuite?: string;
}
/**
* Bot主动特征识别规则。
*/
export interface AlgDetectRule {
/**
* 规则id。
*/
RuleID?: number;
/**
* 规则名。
*/
RuleName?: string;
/**
* 规则开关。
*/
Switch?: string;
/**
* 自定义规则。
*/
AlgConditions?: Array<AclCondition>;
/**
* Cookie校验和会话行为分析。
注意：此字段可能返回 null，表示取不到有效值。
*/
AlgDetectSession?: AlgDetectSession;
/**
* 客户端行为校验。
*/
AlgDetectJS?: Array<AlgDetectJS>;
/**
* 更新时间。仅出参使用。
*/
UpdateTime?: string;
}
/**
* 安全数据维度值信息
*/
export interface SecEntryValue {
/**
* 指标名称。
*/
Metric: string;
/**
* 时序数据详情。
*/
Detail: Array<TimingDataItem>;
/**
* 最大值。
*/
Max: number;
/**
* 平均值。
*/
Avg: number;
/**
* 数据总和。
*/
Sum: number;
}
/**
* DescribeZones请求参数结构体
*/
export interface DescribeZonesRequest {
/**
* 分页查询偏移量。默认值：0。
*/
Offset?: number;
/**
* 分页查询限制数目。默认值：20，最大值：100。
*/
Limit?: number;
/**
* 过滤条件，Filters.Values 的上限为 20。该参数不填写时，返回当前 appid 下有权限的所有站点信息。详细的过滤条件如下：
<li>zone-name：按照站点名称进行过滤；</li><li>zone-id：按照站点 ID进行过滤。站点 ID 形如：zone-2noz78a8ev6k；</li><li>status：按照站点状态进行过滤；</li><li>tag-key：按照标签键进行过滤；</li><li>tag-value： 按照标签值进行过滤。</li>模糊查询时仅支持过滤字段名为 zone-name。
*/
Filters?: Array<AdvancedFilter>;
/**
* 可根据该字段对返回结果进行排序，取值有：
<li> type：接入类型；</li>
<li> area：加速区域；</li>
<li> create-time：创建时间；</li>
<li> zone-name：站点名称；</li>
<li> use-time：最近使用时间；</li>
<li> active-status：生效状态。</li>不填写时对返回结果默认按照 create-time 排序。
*/
Order?: string;
/**
* 排序方向，如果是字段值为数字，则根据数字大小排序；如果字段值为文本，则根据 ascill 码的大小排序。取值有：
<li> asc：从小到大排序；</li>
<li> desc：从大到小排序。</li>不填写使用默认值 desc。
*/
Direction?: string;
}
/**
* 离线日志详细信息
*/
export interface L4OfflineLog {
/**
* 四层代理实例 ID。
*/
ProxyId?: string;
/**
* 日志所属区域，取值有：
<li>mainland：中国大陆境内;</li>
<li>overseas：全球（不含中国大陆）。</li>
*/
Area?: string;
/**
* 离线日志数据包名。
*/
LogPacketName?: string;
/**
* 离线日志下载地址。
*/
Url?: string;
/**
* 日志打包时间，此参数已经废弃。
*/
LogTime?: number;
/**
* 日志打包开始时间。
*/
LogStartTime?: string;
/**
* 日志打包结束时间。
*/
LogEndTime?: string;
/**
* 日志大小，单位为 Byte。
*/
Size?: number;
}
/**
* 最新IP白名单列表相比于当前IP白名单列表的区别
*/
export interface DiffIPWhitelist {
/**
* 最新IP白名单列表。
*/
LatestIPWhitelist: IPWhitelist;
/**
* 最新IP白名单列表相比于当前IP白名单列表，新增部分。
*/
AddedIPWhitelist: IPWhitelist;
/**
* 最新IP白名单列表相比于当前IP白名单列表，删减部分。
*/
RemovedIPWhitelist: IPWhitelist;
/**
* 最新IP白名单列表相比于当前IP白名单列表，不变部分。
*/
NoChangeIPWhitelist: IPWhitelist;
}
/**
* VerifyOwnership请求参数结构体
*/
export interface VerifyOwnershipRequest {
/**
* 站点或者加速域名。
*/
Domain: string;
}
/**
* DeleteSecurityIPGroup返回参数结构体
*/
export interface DeleteSecurityIPGroupResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyRule请求参数结构体
*/
export interface ModifyRuleRequest {
/**
* 站点 ID。
*/
ZoneId: string;
/**
* 规则名称，字符串名称长度 1~255。
*/
RuleName: string;
/**
* 规则内容。
*/
Rules: Array<Rule>;
/**
* 规则 ID。
*/
RuleId: string;
/**
* 规则状态，取值有：
<li> enable: 启用； </li>
<li> disable: 未启用。</li>
*/
Status: string;
/**
* 规则标签。
*/
Tags?: Array<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;
}
/**
* 源站组记录
*/
export interface OriginRecord {
/**
* 源站记录值，不包含端口信息，可以为：IPv4，IPv6，域名格式。
*/
Record: string;
/**
* 源站类型，取值有：
<li>IP_DOMAIN：IPV4、IPV6、域名类型源站；</li>
<li>COS：COS源。</li>
<li>AWS_S3：AWS S3对象存储源站。</li>
*/
Type?: string;
/**
* 源站记录ID。
*/
RecordId?: string;
/**
* 源站权重，取值为0-100, 不填表示不设置权重，由系统自由调度，填0表示权重为0, 流量将不会调度到此源站。
注意：此字段可能返回 null，表示取不到有效值。
*/
Weight?: number;
/**
* 是否私有鉴权，当源站类型 RecordType=COS/AWS_S3 时生效，取值有：
<li>true：使用私有鉴权；</li>
<li>false：不使用私有鉴权。</li>不填写，默认值为：false。
*/
Private?: boolean;
/**
* 私有鉴权参数，当源站类型Private=true时有效。
*/
PrivateParameters?: Array<PrivateParameter>;
}
/**
* DescribePrefetchTasks返回参数结构体
*/
export interface DescribePrefetchTasksResponse {
/**
* 该查询条件总共条目数。
*/
TotalCount?: number;
/**
* 任务结果列表。
*/
Tasks?: Array<Task>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 描述键值对过滤器，用于条件过滤查询，支持模糊查询。例如过滤ID、名称、状态等。
若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。
若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。
*/
export interface AdvancedFilter {
/**
* 需要过滤的字段。
*/
Name: string;
/**
* 字段的过滤值。
*/
Values: Array<string>;
/**
* 是否启用模糊查询。
*/
Fuzzy?: boolean;
}
/**
* DeleteApplicationProxy请求参数结构体
*/
export interface DeleteApplicationProxyRequest {
/**
* 站点ID。
*/
ZoneId: string;
/**
* 代理ID。
*/
ProxyId: string;
}
/**
* DescribeConfigGroupVersionDetail返回参数结构体
*/
export interface DescribeConfigGroupVersionDetailResponse {
/**
* 版本信息。
*/
ConfigGroupVersionInfo?: ConfigGroupVersionInfo;
/**
* 版本文件的内容。以 JSON 格式返回。
*/
Content?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 加速域名源站信息。
*/
export interface OriginDetail {
/**
* 源站类型，取值有：
<li>IP_DOMAIN：IPV4、IPV6 或域名类型源站；</li>
<li>COS：腾讯云 COS 对象存储源站；</li>
<li>AWS_S3：AWS S3 对象存储源站；</li>
<li>ORIGIN_GROUP：源站组类型源站；</li>
<li>VODEO：云点播（混合云版）；</li>
<li>SPACE：源站卸载，当前仅白名单开放；</li>
<li>LB：负载均衡，当前仅白名单开放。</li>
*/
OriginType?: string;
/**
* 源站地址，根据 OriginType 的取值分为以下情况：
<li>当 OriginType = IP_DOMAIN 时，该参数为 IPv4、IPv6 地址或域名；</li>
<li>当 OriginType = COS 时，该参数为 COS 桶的访问域名；</li>
<li>当 OriginType = AWS_S3，该参数为 S3 桶的访问域名；</li>
<li>当 OriginType = ORIGIN_GROUP 时，该参数为源站组 ID；</li>
<li>当 OriginType = VODEO 时，如果 VodeoDistributionRange = ALL，则该参数为 "all-buckets-in-vodeo-application"；如果 VodeoDistributionRange = Bucket，则该参数为对应存储桶域名。</li>
*/
Origin?: string;
/**
* 备用源站组 ID，该参数仅在 OriginType = ORIGIN_GROUP 且配置了备源站组时会生效。
*/
BackupOrigin?: string;
/**
* 主源源站组名称，当 OriginType = ORIGIN_GROUP 时该参数会返回值。
*/
OriginGroupName?: string;
/**
* 备用源站组名称，该参数仅当 OriginType = ORIGIN_GROUP 且配置了备用源站组时会生效。
*/
BackOriginGroupName?: string;
/**
* 指定是否允许访问私有对象存储源站，该参数仅当源站类型 OriginType = COS 或 AWS_S3 时会生效，取值有：
<li>on：使用私有鉴权；</li>
<li>off：不使用私有鉴权。</li>
不填写，默认值为off。
*/
PrivateAccess?: string;
/**
* 私有鉴权使用参数，该参数仅当源站类型 PrivateAccess = on 时会生效。
注意：此字段可能返回 null，表示取不到有效值。
*/
PrivateParameters?: Array<PrivateParameter>;
/**
* MO 子应用 ID
*/
VodeoSubAppId?: number;
/**
* MO 分发范围，取值有： <li>All：全部</li> <li>Bucket：存储桶</li>
*/
VodeoDistributionRange?: string;
/**
* MO 存储桶 ID，分发范围(DistributionRange)为存储桶(Bucket)时必填
*/
VodeoBucketId?: string;
}
/**
* DescribeDDoSAttackData返回参数结构体
*/
export interface DescribeDDoSAttackDataResponse {
/**
* 查询结果的总条数。
*/
TotalCount: number;
/**
* DDoS攻击数据内容列表。
注意：此字段可能返回 null，表示取不到有效值。
*/
Data: Array<SecEntry>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeZoneSetting请求参数结构体
*/
export interface DescribeZoneSettingRequest {
/**
* 站点ID。
*/
ZoneId: string;
}
/**
* ModifyZoneStatus请求参数结构体
*/
export interface ModifyZoneStatusRequest {
/**
* 站点 ID。
*/
ZoneId: string;
/**
* 站点状态，取值有：
<li> false：开启站点；</li>
<li> true：关闭站点。</li>
*/
Paused: boolean;
}
/**
* CNAME 接入，使用文件验证时所需的信息。
*/
export interface FileVerification {
/**
* EdgeOne 后台服务器将通过 Scheme + Host + URL Path 的格式（例如 https://www.example.com/.well-known/teo-verification/z12h416twn.txt）获取文件验证信息。该字段为您需要创建的 URL Path 部分。
*/
Path?: string;
/**
* 验证文件的内容。该字段的内容需要您填写至 Path 字段返回的 txt 文件中。
*/
Content?: string;
}
/**
* DescribeIdentifications返回参数结构体
*/
export interface DescribeIdentificationsResponse {
/**
* 符合条件的站点个数。
*/
TotalCount: number;
/**
* 站点验证信息列表。
*/
Identifications: Array<Identification>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifySecurityPolicy请求参数结构体
*/
export interface ModifySecurityPolicyRequest {
/**
* 站点Id。
*/
ZoneId: string;
/**
* 安全配置。
*/
SecurityConfig: SecurityConfig;
/**
* 子域名/应用名。当使用Entity时可不填写TemplateId，否则必须填写TemplateId。
*/
Entity?: string;
/**
* 模板策略id。当使用模板Id时可不填Entity，否则必须填写Entity。
*/
TemplateId?: string;
}
/**
* 无
*/
export interface Waf {
/**
* Waf开关，取值为：
<li> on：开启；</li>
<li> off：关闭。</li>
*/
Switch: string;
/**
* 策略ID。
*/
PolicyId?: number;
}
/**
* ModifyApplicationProxyRuleStatus返回参数结构体
*/
export interface ModifyApplicationProxyRuleStatusResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: 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;
/**
* 图片优化配置。
不填写表示关闭。
*/
ImageOptimize?: ImageOptimize;
/**
* 标准 Debug 配置。
*/
StandardDebug?: StandardDebug;
}
/**
* 规则引擎条件 HTTP 请求/响应头操作动作参数。
*/
export interface RuleRewriteActionParams {
/**
* 功能参数名称，参数填写规范可调用接口 [查询规则引擎的设置参数](https://cloud.tencent.com/document/product/1552/80618) 查看。现在只有三种取值：
<li> add：添加 HTTP 头部；</li>
<li> set：重写 HTTP 头部；</li>
<li> del：删除 HTTP 头部。</li>
*/
Action: string;
/**
* 参数名称。
*/
Name: string;
/**
* 参数值。
*/
Values: Array<string>;
}
/**
* CreateApplicationProxy返回参数结构体
*/
export interface CreateApplicationProxyResponse {
/**
* 新增的四层代理应用ID。
*/
ProxyId?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* Bot自定义规则
*/
export interface BotUserRule {
/**
* 规则名，只能以英文字符，数字，下划线组合，且不能以下划线开头。
*/
RuleName: string;
/**
* 处置动作，取值有：
<li>drop：拦截；</li>
<li>monitor：观察；</li>
<li>trans：放行；</li>
<li>redirect：重定向；</li>
<li>page：指定页面；</li>
<li>alg：JavaScript 挑战；</li>
<li>captcha：托管挑战；</li>
<li>random：随机处置；</li>
<li>silence：静默；</li>
<li>shortdelay：短时响应；</li>
<li>longdelay：长时响应。</li>
*/
Action: string;
/**
* 规则状态，取值有：
<li>on：生效；</li>
<li>off：不生效。</li>默认 on 生效。
*/
RuleStatus: string;
/**
* 规则详情。
*/
AclConditions: Array<AclCondition>;
/**
* 规则权重，取值范围0-100。
*/
RulePriority: number;
/**
* 规则 Id。仅出参使用。
*/
RuleID?: number;
/**
* 随机处置的处置方式及占比，非随机处置可不填暂不支持。
*/
ExtendActions?: Array<BotExtendAction>;
/**
* 过滤词，取值有：
<li>sip：客户端 ip。</li>
默认为空字符串。
*/
FreqFields?: Array<string>;
/**
* 更新时间。仅出参使用。
*/
UpdateTime?: string;
/**
* 统计范围。取值有：
<li>source_to_eo：（响应）源站到 EdgeOne；</li>
<li>client_to_eo：（请求）客户端到 EdgeOne。</li>
默认为 source_to_eo。
*/
FreqScope?: Array<string>;
/**
* 自定义返回页面的名称。Action 是 page 时必填，且不能为空。
*/
Name?: string;
/**
* 自定义响应 Id。该 Id 可通过查询自定义错误页列表接口获取。默认值为default，使用系统默认页面。Action 是 page 时必填，且不能为空。
*/
CustomResponseId?: string;
/**
* 自定义返回页面的响应码。Action 是 page 时必填，且不能为空，取值: 100~600，不支持 3xx 响应码。默认值：567。
*/
ResponseCode?: number;
/**
* 重定向时候的地址。Action 是 redirect 时必填，且不能为空。
*/
RedirectUrl?: string;
}
/**
* ModifyOriginGroup返回参数结构体
*/
export interface ModifyOriginGroupResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteAccelerationDomains请求参数结构体
*/
export interface DeleteAccelerationDomainsRequest {
/**
* 加速域名所属站点ID。
*/
ZoneId: string;
/**
* 需要删除的加速域名ID列表。
*/
DomainNames: Array<string>;
/**
* 是否强制删除。当域名存在关联资源（如马甲域名、流量调度功能）时，是否强制删除该域名，取值有：
<li> true：删除该域名及所有关联资源；</li>
<li> false：当该加速域名存在关联资源时，不允许删除。</li>不填写，默认值为：false。
*/
Force?: boolean;
}
/**
* DescribeApplicationProxies返回参数结构体
*/
export interface DescribeApplicationProxiesResponse {
/**
* 应用代理列表。
*/
ApplicationProxies?: Array<ApplicationProxy>;
/**
* 记录总数。
*/
TotalCount?: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 例外规则的生效范围。
*/
export interface ExceptUserRuleScope {
/**
* 例外规则类型。其中complete模式代表全量数据进行例外，partial模式代表可选择指定模块指定字段进行例外，该字段取值有：
<li>complete：完全跳过模式；</li>
<li>partial：部分跳过模式。</li>
*/
Type?: string;
/**
* 生效的模块，该字段取值有：
<li>waf：托管规则；</li>
<li>rate：速率限制；</li>
<li>acl：自定义规则；</li>
<li>cc：cc攻击防护；</li>
<li>bot：Bot防护。</li>
注意：此字段可能返回 null，表示取不到有效值。
*/
Modules?: Array<string>;
/**
* 跳过部分规则ID的例外规则详情。如果为null，默认使用历史配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
PartialModules?: Array<PartialModule>;
/**
* 跳过具体字段不去扫描的例外规则详情。如果为null，默认使用历史配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
SkipConditions?: Array<SkipCondition>;
}
/**
* DescribeDeployHistory请求参数结构体
*/
export interface DescribeDeployHistoryRequest {
/**
* 站点 ID。
*/
ZoneId: string;
/**
* 环境 ID。
*/
EnvId: string;
/**
* 过滤条件，Filters.Values 的上限为 20，详细的过滤条件如下：
<li>record-id：按照发布记录 ID 进行过滤进行过滤。</li>
*/
Filters?: Array<AdvancedFilter>;
}
/**
* DescribeAvailablePlans请求参数结构体
*/
export declare type DescribeAvailablePlansRequest = null;
/**
* 加速域名源站信息。
*/
export interface OriginInfo {
/**
* 源站类型，取值有：
<li>IP_DOMAIN：IPV4、IPV6 或域名类型源站；</li>
<li>COS：腾讯云 COS 对象存储源站；</li>
<li>AWS_S3：AWS S3 对象存储源站；</li>
<li>ORIGIN_GROUP：源站组类型源站；</li>
<li>VODEO：云点播（混合云版）；</li>
<li>SPACE：源站卸载，当前仅白名单开放；</li>
<li>LB：负载均衡，当前仅白名单开放。</li>
*/
OriginType: string;
/**
* 源站地址，根据 OriginType 的取值分为以下情况：
<li>当 OriginType = IP_DOMAIN 时，该参数请填写 IPv4、IPv6 地址或域名；</li>
<li>当 OriginType = COS 时，该参数请填写 COS 桶的访问域名；</li>
<li>当 OriginType = AWS_S3，该参数请填写 S3 桶的访问域名；</li>
<li>当 OriginType = ORIGIN_GROUP 时，该参数请填写源站组 ID；</li>
<li>当 OriginType = VODEO 时，如果 VodeoDistributionRange = ALL，则该参数填写 "all-buckets-in-vodeo-application"；如果 VodeoDistributionRange = Bucket，则该参数请填写对应存储桶域名；</li>
<li>当 OriginType = LB 时，该参数请填写负载均衡实例 ID，该功能当前仅白名单开放；</li>
<li>当 OriginType = SPACE 时，该参数请填写源站卸载空间 ID，该功能当前仅白名单开放。</li>
*/
Origin: string;
/**
* 备用源站组 ID，该参数仅在 OriginType = ORIGIN_GROUP 时生效，该字段为旧版能力，调用后控制台无法进行配置修改，如需使用请提交工单咨询。
*/
BackupOrigin?: string;
/**
* 指定是否允许访问私有对象存储源站，该参数仅当源站类型 OriginType = COS 或 AWS_S3 时会生效，取值有：
<li>on：使用私有鉴权；</li>
<li>off：不使用私有鉴权。</li>
不填写时，默认值为off。
*/
PrivateAccess?: string;
/**
* 私有鉴权使用参数，该参数仅当源站类型 PrivateAccess = on 时会生效。
*/
PrivateParameters?: Array<PrivateParameter>;
/**
* VODEO 子应用 ID。该参数当 OriginType = VODEO 时必填。
*/
VodeoSubAppId?: number;
/**
* VODEO 分发范围，该参数当 OriginType = VODEO 时必填。取值有：
<li>All：当前应用下所有存储桶；</li>
<li>Bucket：指定的某一个存储桶。</li>
*/
VodeoDistributionRange?: string;
/**
* VODEO 存储桶 ID，该参数当 OriginType = VODEO 且 VodeoDistributionRange = Bucket 时必填。
*/
VodeoBucketId?: string;
}
/**
* 标签配置
*/
export interface Tag {
/**
* 标签键。
注意：此字段可能返回 null，表示取不到有效值。
*/
TagKey: string;
/**
* 标签值。
注意：此字段可能返回 null，表示取不到有效值。
*/
TagValue: string;
}
/**
* ModifySecurityPolicy返回参数结构体
*/
export interface ModifySecurityPolicyResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeHostsSetting返回参数结构体
*/
export interface DescribeHostsSettingResponse {
/**
* 域名列表。
*/
DetailHosts?: Array<DetailHost>;
/**
* 域名数量。
*/
TotalNumber?: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyZoneStatus返回参数结构体
*/
export interface ModifyZoneStatusResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CNAME 接入，使用 DNS 解析验证时所需的信息。
*/
export interface DnsVerification {
/**
* 主机记录。
*/
Subdomain?: string;
/**
* 记录类型。
*/
RecordType?: string;
/**
* 记录值。
*/
RecordValue?: string;
}
/**
* Cookie校验与会话跟踪。
*/
export interface AlgDetectSession {
/**
* 操作名称。
*/
Name?: string;
/**
* 校验方式，默认update_detect，取值有：
<li>detect：仅校验；</li>
<li>update_detect：更新Cookie并校验。</li>
*/
DetectMode?: string;
/**
* 会话速率和周期特征校验开关，默认off，取值有：
<li>off：关闭；</li>
<li>on：打开。</li>
*/
SessionAnalyzeSwitch?: string;
/**
* 校验结果为未携带Cookie或Cookie已过期的统计周期。单位为秒，默认10，取值：5～3600。
*/
InvalidStatTime?: number;
/**
* 校验结果为未携带Cookie或Cookie已过期的触发阈值。单位为次，默认300，取值：1～100000000。
*/
InvalidThreshold?: number;
/**
* Cookie校验校验结果。
*/
AlgDetectResults?: Array<AlgDetectResult>;
/**
* 会话速率和周期特征校验结果。
*/
SessionBehaviors?: Array<AlgDetectResult>;
}
/**
* ModifyZone请求参数结构体
*/
export interface ModifyZoneRequest {
/**
* 站点 ID。
*/
ZoneId: string;
/**
* 站点接入方式，取值有：
<li> full：NS 接入；</li>
<li> partial：CNAME 接入，如果站点当前是无域名接入，仅支持切换到CNAME接入。</li>不填写保持原有配置。
*/
Type?: string;
/**
* 自定义站点信息，以替代系统默认分配的名称服务器。不填写保持原有配置。当站点是无域名接入方式时不允许传此参数。
*/
VanityNameServers?: VanityNameServers;
/**
* 站点别名。数字、英文、-和_组合，限制20个字符。
*/
AliasZoneName?: string;
/**
* 站点接入地域，取值有：
<li> global：全球；</li>
<li> mainland：中国大陆；</li>
<li> overseas：境外区域。</li>当站点是无域名接入方式时，不允许传此参数。
*/
Area?: string;
/**
* 站点名称。仅当站点由无域名接入方式切换到CNAME接入方式的场景下有效。
*/
ZoneName?: string;
}
/**
* ModifyApplicationProxyStatus返回参数结构体
*/
export interface ModifyApplicationProxyStatusResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteZone返回参数结构体
*/
export interface DeleteZoneResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateRule返回参数结构体
*/
export interface CreateRuleResponse {
/**
* 规则 ID。
*/
RuleId?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* Bot扩展处置方式，多处置动作组合。
*/
export interface BotExtendAction {
/**
* 处置动作，取值有：
<li>monitor：观察；</li>
<li>alg：JavaScript挑战；</li>
<li>captcha：托管挑战；</li>
<li>random：随机，按照ExtendActions分配处置动作和比例；</li>
<li>silence：静默；</li>
<li>shortdelay：短时响应；</li>
<li>longdelay：长时响应。</li>
*/
Action: string;
/**
* 处置方式的触发概率，范围0-100。
注意：此字段可能返回 null，表示取不到有效值。
*/
Percent?: number;
}
/**
* CreatePurgeTask返回参数结构体
*/
export interface CreatePurgeTaskResponse {
/**
* 任务 ID。
*/
JobId?: string;
/**
* 失败的任务列表及原因。
注意：此字段可能返回 null，表示取不到有效值。
*/
FailedList?: Array<FailReason>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteApplicationProxyRule返回参数结构体
*/
export interface DeleteApplicationProxyRuleResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeRules返回参数结构体
*/
export interface DescribeRulesResponse {
/**
* 站点 ID。
*/
ZoneId?: string;
/**
* 规则列表，按规则执行顺序从先往后排序。
*/
RuleItems?: Array<RuleItem>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 时序数据信息
*/
export interface TimingDataRecord {
/**
* 查询维度值。
*/
TypeKey: string;
/**
* 详细时序数据。
*/
TypeValue: Array<TimingTypeValue>;
}
/**
* 源站防护信息
*/
export interface OriginProtectionInfo {
/**
* 站点ID。
*/
ZoneId: string;
/**
* 域名列表。
*/
Hosts: Array<string>;
/**
* 代理ID列表。
*/
ProxyIds: Array<string>;
/**
* 当前版本的IP白名单。
注意：此字段可能返回 null，表示取不到有效值。
*/
CurrentIPWhitelist: IPWhitelist;
/**
* 该站点是否需要更新源站白名单，取值有：
<li>true ：需要更新IP白名单 ；</li>
<li>false ：无需更新IP白名单。</li>
*/
NeedUpdate: boolean;
/**
* 源站防护状态，取值有：
<li>online ：源站防护启用中 ；</li>
<li>offline ：源站防护已停用 ；</li>
<li>nonactivate ：源站防护未激活，仅在从未使用过源站防护功能的站点调用中返回。</li>
*/
Status: string;
/**
* 站点套餐是否支持源站防护，取值有：
<li>true ：支持 ；</li>
<li>false ：不支持。</li>
*/
PlanSupport: boolean;
/**
* 最新IP白名单与当前IP白名单的对比。
注意：此字段可能返回 null，表示取不到有效值。
*/
DiffIPWhitelist: DiffIPWhitelist;
}
/**
* DescribeOriginProtection返回参数结构体
*/
export interface DescribeOriginProtectionResponse {
/**
* 源站防护信息。
注意：此字段可能返回 null，表示取不到有效值。
*/
OriginProtectionInfo?: Array<OriginProtectionInfo>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* BindZoneToPlan返回参数结构体
*/
export interface BindZoneToPlanResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 例外规则，用于配置需要跳过特定场景的规则
*/
export interface ExceptConfig {
/**
* 配置开关，取值有：
<li>on：开启；</li>
<li>off：关闭。</li>
*/
Switch: string;
/**
* 例外规则详情。如果为null，默认使用历史配置。
注意：此字段可能返回 null，表示取不到有效值。
*/
ExceptUserRules?: Array<ExceptUserRule>;
}
/**
* DeleteOriginGroup请求参数结构体
*/
export interface DeleteOriginGroupRequest {
/**
* 站点ID。
*/
ZoneId: string;
/**
* 源站组ID，此参数必填。
*/
GroupId?: string;
}
/**
* 图片优化配置。
*/
export interface ImageOptimize {
/**
* 开关，取值有：
<li>on：开启；</li>
<li>off：关闭。</li>
*/
Switch: string;
}
/**
* 别称域名信息。
*/
export interface AliasDomain {
/**
* 别称域名名称。
*/
AliasName: string;
/**
* 站点 ID。
*/
ZoneId: string;
/**
* 目标域名名称。
*/
TargetName: string;
/**
* 别称域名状态，取值有：
<li> active：已生效； </li>
<li> pending：部署中；</li>
<li> conflict：被找回。 </li>
<li> stop：已停用；</li>
*/
Status: string;
/**
* 封禁模式，取值有：
<li> 0：未封禁； </li>
<li> 11：合规封禁；</li>
<li> 14：未备案封禁。</li>
*/
ForbidMode: number;
/**
* 别称域名创建时间。
*/
CreatedOn: string;
/**
* 别称域名修改时间。
*/
ModifiedOn: string;
}
/**
* WebSocket配置
*/
export interface WebSocket {
/**
* WebSocket 超时时间配置开关，取值有：
<li>on：使用Timeout作为WebSocket超时时间；</li>
<li>off：平台仍支持WebSocket连接，此时使用系统默认的15秒为超时时间。</li>
*/
Switch: string;
/**
* 超时时间，单位为秒，最大超时时间120秒。
*/
Timeout?: number;
}
/**
* ModifyAliasDomain请求参数结构体
*/
export interface ModifyAliasDomainRequest {
/**
* 站点 ID。
*/
ZoneId: string;
/**
* 别称域名名称。
*/
AliasName: string;
/**
* 目标域名名称。
*/
TargetName: string;
/**
* 证书配置，取值有：
<li> none：不配置；</li>
<li> hosting：SSL托管证书；</li>
<li> apply：申请免费证书。</li>不填写保持原有配置。
*/
CertType?: string;
/**
* 当 CertType 取值为 hosting 时填入相应证书 ID。
*/
CertId?: Array<string>;
}
/**
* 精准防护条件
*/
export interface AclCondition {
/**
* 匹配字段，取值有：
<li>host：请求域名；</li>
<li>sip：客户端IP；</li>
<li>ua：User-Agent；</li>
<li>cookie：会话 Cookie；</li>
<li>cgi：CGI 脚本；</li>
<li>xff：XFF 扩展头部；</li>
<li>url：请求 URL；</li>
<li>accept：请求内容类型；</li>
<li>method：请求方式；</li>
<li>header：请求头部；</li>
<li>app_proto：应用层协议；</li>
<li>sip_proto：网络层协议；</li>
<li>uabot：UA 特征规则，仅bot自定义规则可用；</li>
<li>idcid：IDC 规则，仅bot自定义规则可用；</li>
<li>sipbot：搜索引擎规则，仅bot自定义规则可用；</li>
<li>portrait：画像分析，仅bot自定义规则可用；</li>
<li>header_seq：请求头顺序，仅bot自定义规则可用；</li>
<li>hdr：请求正文，仅Web防护自定义规则可用。</li>
*/
MatchFrom: string;
/**
* 匹配字符串。当 MatchFrom 为 header 时，可以填入 header 的 key 作为参数。
*/
MatchParam: string;
/**
* 匹配关系，取值有：
<li>equal：字符串等于；</li>
<li>not_equal：数值不等于；</li>
<li>include：字符包含；</li>
<li>not_include：字符不包含；</li>
<li>match：ip匹配；</li>
<li>not_match：ip不匹配；</li>
<li>include_area：地域包含；</li>
<li>is_empty：存在字段但值为空；</li>
<li>not_exists：不存在关键字段；</li>
<li>regexp：正则匹配；</li>
<li>len_gt：数值大于；</li>
<li>len_lt：数值小于；</li>
<li>len_eq：数值等于；</li>
<li>match_prefix：前缀匹配；</li>
<li>match_suffix：后缀匹配；</li>
<li>wildcard：通配符。</li>
*/
Operator: string;
/**
* 匹配内容。
*/
MatchContent: string;
}
/**
* DescribeAliasDomains请求参数结构体
*/
export interface DescribeAliasDomainsRequest {
/**
* 站点 ID。
*/
ZoneId: string;
/**
* 分页查询偏移量。默认值：0。
*/
Offset?: number;
/**
* 分页查询限制数目。默认值：20，最大值：1000。
*/
Limit?: number;
/**
* 过滤条件，Filters.Values的上限为20。详细的过滤条件如下：
<li>target-name<br> 按照【<strong>目标域名名称</strong>】进行过滤。<br> 类型：String<br> 必选：否</li><li>alias-name<br> 按照【<strong>别称域名名称</strong>】进行过滤。<br> 类型：String<br> 必选：否</li>模糊查询时仅支持过滤字段名为alias-name。
*/
Filters?: Array<AdvancedFilter>;
}
/**
* 例外规则的跳过匹配条件，即在例外时根据本匹配条件，略过指定字段及内容。
*/
export interface SkipCondition {
/**
* 例外跳过类型，取值为：
<li>header_fields：HTTP请求Header；</li>
<li>cookie：HTTP请求Cookie；</li>
<li>query_string：HTTP请求URL中的Query参数；</li>
<li>uri：HTTP请求URI；</li>
<li>body_raw：HTTP请求Body；</li>
<li>body_json： JSON格式的HTTP Body。</li>
*/
Type: string;
/**
* 选择跳过的字段，取值为：
<li>args：uri 下选择 query 参数: ?name1=jack&age=12；</li>
<li>path：uri 下选择部分路径：/path/to/resource.jpg；</li>
<li>full：uri 下选择完整路径：example.com/path/to/resource.jpg?name1=jack&age=12；</li>
<li>upload_filename：分段文件名，即分段传输文件时；</li>
<li>keys：所有的Key；</li>
<li>values：匹配Key对应的值；</li>
<li>key_value：匹配Key及匹配Value。</li>
*/
Selector: string;
/**
* 匹配Key所使用的匹配方式，取值为：
<li>equal：精准匹配，等于；</li>
<li>wildcard：通配符匹配，支持 * 通配。</li>
*/
MatchFromType?: string;
/**
* 匹配Key的值。
注意：此字段可能返回 null，表示取不到有效值。
*/
MatchFrom?: Array<string>;
/**
* 匹配Content所使用的匹配方式，取值为：
<li>equal：精准匹配，等于；</li>
<li>wildcard：通配符匹配，支持 * 通配。</li>
*/
MatchContentType?: string;
/**
* 匹配Value的值。
注意：此字段可能返回 null，表示取不到有效值。
*/
MatchContent?: Array<string>;
}
/**
* IP黑白名单详细规则
*/
export interface IpTableRule {
/**
* 动作，取值有：
<li> drop：拦截；</li>
<li> trans：放行；</li>
<li> monitor：观察。</li>
*/
Action: string;
/**
* 根据类型匹配，取值有：
<li>ip：对ip进行匹配；</li>
<li>area：对ip所属地区匹配。</li>
*/
MatchFrom: string;
/**
* 规则的匹配方式，默认为空代表等于。
取值有：
<li> is_emty：配置为空；</li>
<li> not_exists：配置为不存在；</li>
<li> include：包含；</li>
<li> not_include：不包含；</li>
<li> equal：等于；</li>
<li> not_equal：不等于。</li>
注意：此字段可能返回 null，表示取不到有效值。
*/
Operator?: string;
/**
* 规则id。仅出参使用。
*/
RuleID?: number;
/**
* 更新时间。仅出参使用。
*/
UpdateTime?: string;
/**
* 规则启用状态，当返回为null时，为启用。取值有：
<li> on：启用；</li>
<li> off：未启用。</li>
注意：此字段可能返回 null，表示取不到有效值。
*/
Status?: string;
/**
* 规则名。
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleName?: string;
/**
* 匹配内容。当 Operator为is_emty 或not_exists时，此值允许为空。
*/
MatchContent?: string;
}
/**
* 七层离线日志详细信息。
*/
export interface L7OfflineLog {
/**
* 离线日志域名。
*/
Domain?: string;
/**
* 日志所属区域，取值有：
<li>mainland：中国大陆境内; </li>
<li>overseas：全球（不含中国大陆）。</li>
*/
Area?: string;
/**
* 离线日志数据包名。
*/
LogPacketName?: string;
/**
* 离线日志下载地址。
*/
Url?: string;
/**
* 日志打包时间，此参数已经废弃。
*/
LogTime?: number;
/**
* 日志打包开始时间。
*/
LogStartTime?: string;
/**
* 日志打包结束时间。
*/
LogEndTime?: string;
/**
* 日志原始大小，单位 Byte。
*/
Size?: number;
}
/**
* ModifyHostsCertificate请求参数结构体
*/
export interface ModifyHostsCertificateRequest {
/**
* 站点 ID。
*/
ZoneId: string;
/**
* 需要修改证书配置的加速域名。
*/
Hosts: Array<string>;
/**
* 配置证书的模式，取值有：
<li>disable：不配置证书；</li>
<li>eofreecert：配置 EdgeOne 免费证书；</li>
<li>sslcert：配置 SSL 证书。</li>不填时默认取值为 disable。
*/
Mode?: string;
/**
* SSL 证书配置，本参数仅在 mode = sslcert 时生效，传入对应证书的 CertId 即可。您可以前往 [SSL 证书列表](https://console.cloud.tencent.com/certoverview) 查看 CertId。
*/
ServerCertInfo?: Array<ServerCertInfo>;
/**
* 托管类型，取值有：
<li>none：不托管EO；</li>
<li>apply：托管EO</li>
不填，默认取值为none。
* @deprecated
*/
ApplyType?: string;
}
/**
* 应用代理规则
*/
export interface ApplicationProxyRule {
/**
* 协议，取值有：
<li>TCP：TCP协议；</li>
<li>UDP：UDP协议。</li>
*/
Proto: string;
/**
* 端口，支持格式：
<li>单个端口，如：80。</li>
<li>端口段，如：81-82。表示81，82两个端口。</li>
注意：一条规则最多可填写20个端口。
*/
Port: Array<string>;
/**
* 源站类型，取值有：
<li>custom：手动添加；</li>
<li>origins：源站组。</li>
*/
OriginType: string;
/**
* 源站信息：
<li>当 OriginType 为 custom 时，表示一个或多个源站，如`["8.8.8.8","9.9.9.9"]` 或 `OriginValue=["test.com"]`；</li>
<li>当 OriginType 为 origins 时，要求有且仅有一个元素，表示源站组ID，如`["origin-537f5b41-162a-11ed-abaa-525400c5da15"]`。</li>
*/
OriginValue: Array<string>;
/**
* 规则ID。
*/
RuleId?: string;
/**
* 状态，取值有：
<li>online：启用；</li>
<li>offline：停用；</li>
<li>progress：部署中；</li>
<li>stopping：停用中；</li>
<li>fail：部署失败/停用失败。</li>
*/
Status?: string;
/**
* 传递客户端IP，取值有：
<li>TOA：TOA（仅Proto=TCP时可选）；</li>
<li>PPV1：Proxy Protocol传递，协议版本V1（仅Proto=TCP时可选）；</li>
<li>PPV2：Proxy Protocol传递，协议版本V2；</li>
<li>OFF：不传递。</li>默认值：OFF。
*/
ForwardClientIp?: string;
/**
* 是否开启会话保持，取值有：
<li>true：开启；</li>
<li>false：关闭。</li>默认值：false。
*/
SessionPersist?: boolean;
/**
* 会话保持的时间，只有当SessionPersist为true时，该值才会生效。
注意：此字段可能返回 null，表示取不到有效值。
*/
SessionPersistTime?: number;
/**
* 源站端口，支持格式：
<li>单端口，如：80。</li>
<li>端口段：81-82，表示81，82两个端口。</li>
*/
OriginPort?: string;
/**
* 规则标签。
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleTag?: string;
}
/**
* 智能加速配置
*/
export interface SmartRouting {
/**
* 智能加速配置开关，取值有：
<li>on：开启；</li>
<li>off：关闭。</li>
*/
Switch: string;
}
/**
* ModifyApplicationProxy请求参数结构体
*/
export interface ModifyApplicationProxyRequest {
/**
* 站点 ID。
*/
ZoneId: string;
/**
* 代理 ID。
*/
ProxyId: string;
/**
* 当 ProxyType=hostname 时，表示域名或子域名；
当 ProxyType=instance 时，表示代理名称。
*/
ProxyName: string;
/**
* 会话保持时间，取值范围：30-3600，单位：秒。
不填写保持原有配置。
*/
SessionPersistTime?: number;
/**
* 四层代理模式，取值有：
<li>instance：表示实例模式。</li>不填写使用默认值instance。
*/
ProxyType?: string;
/**
* Ipv6 访问配置，不填写保持原有配置。
*/
Ipv6?: Ipv6;
/**
* 中国大陆加速优化配置。 不填写表示保持原有配置。
*/
AccelerateMainland?: AccelerateMainland;
}
/**
* ModifyAccelerationDomainStatuses返回参数结构体
*/
export interface ModifyAccelerationDomainStatusesResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 站点信息
*/
export interface Zone {
/**
* 站点 ID。
*/
ZoneId?: string;
/**
* 站点名称。
*/
ZoneName?: string;
/**
* 站点当前使用的 NS 列表。
*/
OriginalNameServers?: Array<string>;
/**
* 腾讯云分配的 NS 列表。
*/
NameServers?: Array<string>;
/**
* 站点状态，取值有：
<li> active：NS 已切换； </li>
<li> pending：NS 未切换；</li>
<li> moved：NS 已切走；</li>
<li> deactivated：被封禁。 </li>
<li> initializing：待绑定套餐。 </li>
*/
Status?: string;
/**
* 站点接入方式，取值有：
<li> full：NS 接入；</li>
<li> partial：CNAME 接入；</li>
<li> noDomainAccess：无域名接入；</li>
<li> vodeo：开启 VODEO 后默认接入。</li>
*/
Type?: string;
/**
* 站点是否关闭。
*/
Paused?: boolean;
/**
* 是否开启 CNAME 加速，取值有：
<li> enabled：开启；</li>
<li> disabled：关闭。</li>
*/
CnameSpeedUp?: string;
/**
* CNAME 接入状态，取值有：
<li> finished：站点已验证；</li>
<li> pending：站点验证中。</li>
*/
CnameStatus?: string;
/**
* 资源标签列表。
*/
Tags?: Array<Tag>;
/**
* 计费资源列表。
*/
Resources?: Array<Resource>;
/**
* 站点创建时间。
*/
CreatedOn?: string;
/**
* 站点修改时间。
*/
ModifiedOn?: string;
/**
* 站点接入地域，取值有：
<li> global：全球；</li>
<li> mainland：中国大陆；</li>
<li> overseas：境外区域。</li>
*/
Area?: string;
/**
* 用户自定义 NS 信息。
注意：此字段可能返回 null，表示取不到有效值。
*/
VanityNameServers?: VanityNameServers;
/**
* 用户自定义 NS IP 信息。
注意：此字段可能返回 null，表示取不到有效值。
*/
VanityNameServersIps?: Array<VanityNameServersIps>;
/**
* 展示状态，取值有：
<li> active：已启用；</li>
<li> inactive：未生效；</li>
<li> paused：已停用。</li>
*/
ActiveStatus?: string;
/**
* 站点别名。数字、英文、-和_组合，限制20个字符。
注意：此字段可能返回 null，表示取不到有效值。
*/
AliasZoneName?: string;
/**
* 是否伪站点，取值有：
<li> 0：非伪站点；</li>
<li> 1：伪站点。</li>
*/
IsFake?: number;
/**
* 锁定状态，取值有：<li> enable：正常，允许进行修改操作；</li><li> disable：锁定中，不允许进行修改操作；</li><li> plan_migrate：套餐迁移中，不允许进行修改操作。</li>
*/
LockStatus?: string;
/**
* 归属权验证信息。
注意：此字段可能返回 null，表示取不到有效值。
*/
OwnershipVerification?: OwnershipVerification;
}
/**
* DescribeRulesSetting返回参数结构体
*/
export interface DescribeRulesSettingResponse {
/**
* 规则引擎可应用匹配请求的设置列表及其详细建议配置信息。
*/
Actions: Array<RulesSettingAction>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* BindSecurityTemplateToEntity返回参数结构体
*/
export interface BindSecurityTemplateToEntityResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 规则引擎参数详情信息，特殊参数类型。
*/
export interface RuleExtraParameter {
/**
* 参数名，取值有：
<li> Action：修改 HTTP 头部所需参数，RuleAction 选择 RewirteAction；</li>
<li> StatusCode：状态码相关功能所需参数，RuleAction 选择 CodeAction。</li>
*/
Id: string;
/**
* 参数值类型。
<li> CHOICE：参数值只能在 Values 中选择； </li>
<li> CUSTOM_NUM：参数值用户自定义，整型类型；</li>
<li> CUSTOM_STRING：参数值用户自定义，字符串类型。</li>
*/
Type: string;
/**
* 可选参数值。
注意：当 Id 的值为 StatusCode 时数组中的值为整型，填写参数值时请填写字符串的整型数值。
*/
Choices: Array<string>;
}
/**
* 共享 CNAME 和接入域名的绑定关系
*/
export interface BindSharedCNAMEMap {
/**
* 需要绑定或解绑的共享 CNAME。
*/
SharedCNAME: string;
/**
* 加速域名，可传递多个，最多20个。
*/
DomainNames: Array<string>;
}
/**
* 规则引擎可应用于匹配请求的设置列表及其详细信息
*/
export interface RulesSettingAction {
/**
* 功能名称，取值有：
<li> 访问URL 重写（AccessUrlRedirect）；</li>
<li> 回源 URL 重写 （UpstreamUrlRedirect）；</li>
<li> 自定义错误页面
(ErrorPage)；</li>
<li> QUIC（QUIC）；</li>
<li> WebSocket （WebSocket）；</li>
<li> 视频拖拽（VideoSeek）；</li>
<li> Token 鉴权（Authentication）；</li>
<li> 自定义CacheKey（CacheKey）；</li>
<li> 节点缓存 TTL （Cache）；</li>
<li> 浏览器缓存 TTL（MaxAge）；</li>
<li> 离线缓存（OfflineCache）；</li>
<li> 智能加速（SmartRouting）；</li>
<li> 分片回源（RangeOriginPull）；</li>
<li> HTTP/2 回源（UpstreamHttp2）；</li>
<li> Host Header 重写（HostHeader）；</li>
<li> 强制 HTTPS（ForceRedirect）；</li>
<li> 回源 HTTPS（OriginPullProtocol）；</li>
<li> 缓存预刷新（CachePrefresh）；</li>
<li> 智能压缩（Compression）；</li>
<li> 修改 HTTP 请求头（RequestHeader）；</li>
<li> 修改HTTP响应头（ResponseHeader）;</li>
<li> 状态码缓存 TTL（StatusCodeCache）;</li>
<li> Hsts；</li>
<li> ClientIpHeader；</li>
<li> TlsVersion；</li>
<li> OcspStapling。</li>
*/
Action: string;
/**
* 参数信息。
*/
Properties: Array<RulesProperties>;
}
/**
* DDoS攻击事件对象
*/
export interface DDoSAttackEvent {
/**
* 事件ID。
*/
EventId: string;
/**
* 攻击类型(对应交互事件名称)。
*/
AttackType: string;
/**
* 攻击状态。
*/
AttackStatus: number;
/**
* 攻击最大带宽。
*/
AttackMaxBandWidth: number;
/**
* 攻击包速率峰值。
*/
AttackPacketMaxRate: number;
/**
* 攻击开始时间，单位为s。
*/
AttackStartTime: number;
/**
* 攻击结束时间，单位为s。
*/
AttackEndTime: number;
/**
* DDoS策略组ID。
注意：此字段可能返回 null，表示取不到有效值。
*/
PolicyId: number;
/**
* 站点ID。
注意：此字段可能返回 null，表示取不到有效值。
*/
ZoneId: string;
/**
* 攻击事件所属地区，取值有：
<li>overseas：全球（除中国大陆地区）数据；</li>
<li>mainland：中国大陆地区数据。</li>
注意：此字段可能返回 null，表示取不到有效值。
*/
Area: string;
/**
* 封禁解封信息。
注意：此字段可能返回 null，表示取不到有效值。
*/
DDoSBlockData: Array<DDoSBlockData>;
}
/**
* 存储客户端请求IP的头部信息配置
*/
export interface ClientIpHeader {
/**
* 配置开关，取值有：
<li>on：开启；</li>
<li>off：关闭。</li>
*/
Switch: string;
/**
* 回源时，存放客户端 IP 的请求头名称。
为空则使用默认值：X-Forwarded-IP。
注意：此字段可能返回 null，表示取不到有效值。
*/
HeaderName?: string;
}
/**
* DescribeDDoSAttackTopData请求参数结构体
*/
export interface DescribeDDoSAttackTopDataRequest {
/**
* 开始时间。
*/
StartTime: string;
/**
* 结束时间。
*/
EndTime: string;
/**
* 查询的统计指标，取值有：
<li>ddos_attackFlux_protocol：按各协议的攻击流量排行；</li>
<li>ddos_attackPackageNum_protocol：按各协议的攻击包量排行；</li>
<li>ddos_attackNum_attackType：按各攻击类型的攻击数量排行；</li>
<li>ddos_attackNum_sregion：按攻击源地区的攻击数量排行；</li>
<li>ddos_attackFlux_sip：按攻击源IP的攻击数量排行；</li>
<li>ddos_attackFlux_sregion：按攻击源地区的攻击数量排行。</li>
*/
MetricName: string;
/**
* 站点ID集合，不填默认选择全部站点。
*/
ZoneIds?: Array<string>;
/**
* DDoS策略组ID集合，不填默认选择全部策略ID。
*/
PolicyIds?: Array<number | bigint>;
/**
* 攻击类型，取值有：
<li>flood：洪泛攻击；</li>
<li>icmpFlood：icmp洪泛攻击；</li>
<li>all：所有的攻击类型。</li>不填默认为all，表示查询全部攻击类型。
*/
AttackType?: string;
/**
* 协议类型，取值有：
<li>tcp：tcp协议；</li>
<li>udp：udp协议；</li>
<li>all：所有的协议类型。</li>不填默认为all，表示查询所有协议。
*/
ProtocolType?: string;
/**
* 端口号。
*/
Port?: number;
/**
* 查询前多少个数据，不填默认默认为10， 表示查询前top 10的数据。
*/
Limit?: number;
/**
* 数据归属地区，取值有：
<li>overseas：全球（除中国大陆地区）数据；</li>
<li>mainland：中国大陆地区数据。</li>不填将根据用户所在地智能选择地区。
*/
Area?: string;
}
/**
* Quic配置项
*/
export interface Quic {
/**
* 是否开启 Quic 配置，取值有：
<li>on：开启；</li>
<li>off：关闭。</li>
*/
Switch: string;
}
/**
* DescribeConfigGroupVersionDetail请求参数结构体
*/
export interface DescribeConfigGroupVersionDetailRequest {
/**
* 站点 ID。
*/
ZoneId: string;
/**
* 版本 ID。
*/
VersionId: string;
}
/**
* DownloadL7Logs返回参数结构体
*/
export interface DownloadL7LogsResponse {
/**
* 查询结果的总条数。
*/
TotalCount?: number;
/**
* 七层离线日志数据列表。
*/
Data?: Array<L7OfflineLog>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyAccelerationDomain请求参数结构体
*/
export interface ModifyAccelerationDomainRequest {
/**
* 加速域名所属站点ID。
*/
ZoneId: string;
/**
* 加速域名名称。
*/
DomainName: string;
/**
* 源站信息。
*/
OriginInfo?: OriginInfo;
/**
* 回源协议，取值有：
<li>FOLLOW: 协议跟随；</li>
<li>HTTP: HTTP协议回源；</li>
<li>HTTPS: HTTPS协议回源。</li>
<li>不填保持原有配置。</li>
*/
OriginProtocol?: string;
/**
* HTTP回源端口，取值为1-65535，当OriginProtocol=FOLLOW/HTTP时生效, 不填保持原有配置。
*/
HttpOriginPort?: number;
/**
* HTTPS回源端口，取值为1-65535，当OriginProtocol=FOLLOW/HTTPS时生效，不填保持原有配置。
*/
HttpsOriginPort?: number;
/**
* IPv6状态，取值有：
<li>follow：遵循站点IPv6配置；</li>
<li>on：开启状态；</li>
<li>off：关闭状态。</li>
<li>不填保持原有配置。</li>
*/
IPv6Status?: string;
}
/**
* DescribeRules请求参数结构体
*/
export interface DescribeRulesRequest {
/**
* 站点 ID。
*/
ZoneId: string;
/**
* 过滤条件，Filters.Values的上限为20。详细的过滤条件如下：
<li>rule-id<br> 按照【<strong>规则ID</strong>】进行过滤。<br> 类型：string<br> 必选：否</li>
*/
Filters?: Array<Filter>;
}
/**
* DescribeContentQuota返回参数结构体
*/
export interface DescribeContentQuotaResponse {
/**
* 刷新相关配额。
注意：此字段可能返回 null，表示取不到有效值。
*/
PurgeQuota: Array<Quota>;
/**
* 预热相关配额。
注意：此字段可能返回 null，表示取不到有效值。
*/
PrefetchQuota: Array<Quota>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DownloadL7Logs请求参数结构体
*/
export interface DownloadL7LogsRequest {
/**
* 开始时间。
*/
StartTime: string;
/**
* 结束时间。
*/
EndTime: string;
/**
* 站点ID集合，此参数必填。
*/
ZoneIds?: Array<string>;
/**
* 子域名集合，不填默认选择全部子域名。
*/
Domains?: Array<string>;
/**
* 分页查询的限制数目，默认值为 20，最大查询条目为 300。
*/
Limit?: number;
/**
* 分页的偏移量，默认值为 0。
*/
Offset?: number;
}
/**
* ACL配置
*/
export interface AclConfig {
/**
* 开关，取值有：
<li> on：开启；</li>
<li> off：关闭。</li>