{ "name": "teo", "display_name": "边缘安全加速平台", "description": "通过 API 实现 DNS 解析、7 层动静态加速、4 层加速、安全防护等功能配置。", "domain": "network", "api_version": "2022-09-01", "endpoint": "teo.tencentcloudapi.com", "actions": [ { "name": "ApplyFreeCertificate", "description": "申请免费证书时，如果您需要通过使用 DNS 委派验证或者文件验证进行申请，您可以调用该接口来进行发起证书申请并根据申请方式来获取对应的验证内容。调用接口的顺序如下： 第一步：调用 ApplyFreeCertificate，指定申请免费证书的校验方式，获取验证内容； 第二步：为相应域名按照验证内容配置； 第三步：调用CheckFreeCertificateVerification 验证，验证通过后即完成免费证书申请...", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点ID。", "example": "zone-343vqcswn9zj" }, { "name": "Domain", "type": "string", "required": true, "description": "申请免费证书的目标域名。", "example": "www.test.com" }, { "name": "VerificationMethod", "type": "string", "required": true, "description": "申请免费证书的验证方式，详细验证方式说明参考[免费证书申请方式说明文档](https://cloud.tencent.com/document/product/1552/90437) ，相关取值有： http_challenge：HTTP 访问文件验证方式，通过 HTTP 访问域名指定 URL 获取文件信息以完成免费证书申请验证； dns_challenge：DNS 委派验证方式，通过添加指定的主机记录解析指向 EdgeOne 以完成免费证书申请验证。 注意：在触发本接口后，你需要根\ufffd\ufffd...", "example": "http_challenge" } ], "required": [ "ZoneId", "Domain", "VerificationMethod" ] }, { "name": "BindSecurityTemplateToEntity", "description": "操作安全策略模板，支持将域名绑定或换绑到指定的策略模板，或者从指定的策略模板解绑。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "需要绑定或解绑的策略模板所属站点 ID。", "example": "zone-2mz9k20k" }, { "name": "Entities", "type": "array", "required": true, "description": "绑定至策略模板（或者从策略模板解绑）的域名列表。", "example": "[\"a.test.com\"]", "item_type": "string" }, { "name": "Operate", "type": "string", "required": true, "description": "绑定或解绑操作选项，取值有： bind：绑定域名至策略模板。 unbind-keep-policy：将域名从策略模板解绑，解绑时保留当前策略。 unbind-use-default：将域名从策略模板解绑，并使用默认空白策略。注意：解绑操作当前仅支持单个域名解绑。即：当 Operate 参数取值为 unbind-keep-policy 或 unbind-use-default 时，Entities 参数列表仅支持填写一个域名。", "example": "bind" }, { "name": "TemplateId", "type": "string", "required": true, "description": "指定绑定或解绑的策略模板 ID 或站点全局策略 如需绑定至策略模板，或从策略模板解绑，请指定策略模板 ID。 如需绑定至站点全局策略，或从站点全局策略解绑，请使用 @ZoneLevel@domain 参数值。 注意：解绑后，域名将使用独立策略，并单独计算规则配额，请确保解绑前套餐规则配额充足。", "example": "temp-wj86oi2" }, { "name": "OverWrite", "type": "boolean", "required": false, "description": "传入域名如果已经绑定了策略模板（含站点级防护策略），通过设置该参数表示是否替换该模板，默认值为 true。支持下列取值：true： 替换域名当前绑定的模板。false：不替换域名当前绑定的模板。注意：当设置为 false 时，若传入域名已经绑定策略模板，API 将返回错误；站点级防护策略也为一种策略模板。", "example": "false" } ], "required": [ "ZoneId", "Entities", "Operate", "TemplateId" ] }, { "name": "BindSharedCNAME", "description": "用于加速域名绑定或解绑共享 CNAME，该功能白名单内测中。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "加速域名所属站点 ID。", "example": "zone-20hyebgyfsko" }, { "name": "BindType", "type": "string", "required": true, "description": "绑定类型，取值有： bind：绑定； unbind：解绑。", "example": "bind" }, { "name": "BindSharedCNAMEMaps", "type": "array", "required": true, "description": "接入域名与共享 CNAME 的绑定关系。", "example": "无", "item_type": "object", "children": [ { "name": "SharedCNAME", "type": "string", "required": true, "description": "需要绑定或解绑的共享 CNAME。", "example": "qq.com.sai2ig51kaa5.share.dnse5.com" }, { "name": "DomainNames", "type": "array", "required": true, "description": "加速域名，可传递多个，最多20个。", "example": "[\"a.qq.com\",\"b.qq.com\"]", "item_type": "string" } ] } ], "required": [ "ZoneId", "BindType", "BindSharedCNAMEMaps" ] }, { "name": "BindZoneToPlan", "description": "将未绑定套餐的站点绑定到已有套餐", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "未绑定套餐的站点ID。", "example": "zone-xxxyyyzzz" }, { "name": "PlanId", "type": "string", "required": true, "description": "待绑定的目标套餐ID。", "example": "edgeone-qqqwwweee" } ], "required": [ "ZoneId", "PlanId" ] }, { "name": "CheckCnameStatus", "description": "当站点接入类型为 CNAME 接入类型时，要求该站点下的所有接入域名必须按照 EdgeOne 分配的指定 CNAME 域名完成 CNAME 记录配置。 您可以通过本接口获取 EdgeOne 为接入域名分配的指定 CNAME 域名，并且可以通过本接口完成对接入域名的 CNAME 配置状态的校验。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-20hyebgyfsko" }, { "name": "RecordNames", "type": "array", "required": true, "description": "需要检测 CNAME 配置状态的域名列表，可以为：加速域名;别称域名。", "example": "[\"example.qq.com\"]", "item_type": "string" } ], "required": [ "ZoneId", "RecordNames" ] }, { "name": "CheckFreeCertificateVerification", "description": "该接口用于验证免费证书并获取免费证书申请结果。如果验证通过，可通过该接口查询到对应域名申请的免费证书信息，如果申请失败，该接口将返回对应的验证失败信息。 在触发[申请免费证书接口](https://cloud.tencent.com/document/product/1552/90437)后，您可以通过本接口检查免费证书申请结果。在免费证书申请成功后， 还需要通过[配置域名证书](https://cloud.tencent.com/document/product/1552/...", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-28v607hq8d3m" }, { "name": "Domain", "type": "string", "required": true, "description": "加速域名，该域名为[申请免费证书](https://cloud.tencent.com/document/product/1552/124807)时使用的域名。", "example": "qq.com" } ], "required": [ "ZoneId", "Domain" ] }, { "name": "ConfirmMultiPathGatewayOriginACL", "description": "本接口用于多通道安全加速网关回源 IP 网段发生变更时，确认已将最新回源 IP 网段更新至源站防火墙。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-27q0p0bal192" }, { "name": "GatewayId", "type": "string", "required": true, "description": "网关 ID。", "example": "mpgw-lbxuhk1oh" }, { "name": "OriginACLVersion", "type": "integer", "required": true, "description": "回源 IP 版本号。", "example": "1" } ], "required": [ "ZoneId", "GatewayId", "OriginACLVersion" ] }, { "name": "ConfirmOriginACLUpdate", "description": "本接口用于回源 IP 网段发生变更时，确认已将最新回源 IP 网段更新至源站防火墙。确认已更新至最新的回源 IP 网段后，相关变更通知将会停止推送。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "\"zone-276zs184g93m\"" } ], "required": [ "ZoneId" ] }, { "name": "CreateAccelerationDomain", "description": "在创建完站点之后，您可以通过本接口创建加速域名。 CNAME 模式接入时，若您未完成站点归属权校验，本接口将为您返回域名归属权验证信息，您可以单独对域名进行归属权验证，详情参考 [站点/域名归属权验证](https://cloud.tencent.com/document/product/1552/70789)。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "加速域名所属站点 ID。", "example": "zone-225qgrnvbi9w" }, { "name": "DomainName", "type": "string", "required": true, "description": "加速域名。", "example": "www.example.com" }, { "name": "OriginInfo", "type": "object", "required": true, "description": "源站信息。", "example": "无", "children": [ { "name": "OriginType", "type": "string", "required": true, "description": "源站类型，取值有： IP_DOMAIN：IPV4、IPV6 或域名类型源站； COS：腾讯云 COS 对象存储源站； AWS_S3：AWS S3 对象存储源站； ORIGIN_GROUP：源站组类型源站； VOD：云点播； SPACE：源站卸载，当前仅白名单开放； LB：负载均衡，当前仅白名单开放。", "example": "ip_domain" }, { "name": "Origin", "type": "string", "required": true, "description": "源站地址，根据 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 时，该参数为云\ufffd\ufffd...", "example": "qq.com" }, { "name": "BackupOrigin", "type": "string", "required": false, "description": "备用源站组 ID，该参数仅在 OriginType = ORIGIN_GROUP 时生效，该字段为旧版能力，调用后控制台无法进行配置修改，如需使用请提交工单咨询。", "example": "\"origin-07fa3f6c-4498-11ed-a368-5254006ca63d\"" }, { "name": "PrivateAccess", "type": "string", "required": false, "description": "指定是否允许访问私有对象存储源站，该参数仅当源站类型 OriginType = COS 或 AWS_S3 时会生效，取值有： on：使用私有鉴权； off：不使用私有鉴权。不填写时，默认值为off。", "example": "on" }, { "name": "PrivateParameters", "type": "array", "required": false, "description": "私有鉴权使用参数，该参数仅当源站类型 PrivateAccess = on 时会生效。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "私有鉴权参数名称，取值有： AccessKeyId：鉴权参数 Access Key ID； SecretAccessKey：鉴权参数 Secret Access Key； SignatureVersion：鉴权版本，v2 或者 v4； Region：存储桶地域。", "example": "AccessKeyId" }, { "name": "Value", "type": "string", "required": true, "description": "私有鉴权参数值。", "example": "AKID************" } ] }, { "name": "HostHeader", "type": "string", "required": false, "description": "自定义回源 HOST 头，该参数仅当 OriginType = IP_DOMAIN 时生效。当 OriginType 是其它类型源站时，不需要传入该参数，否则会报错。 当 OriginType = COS 或 AWS_S3 时，回源 HOST 头将与源站域名保持一致。 当 OriginType = ORIGIN_GROUP 时，回源 HOST 头遵循源站组内配置，如果没有配置则默认为加速域名。 当 OriginType = VOD 或 SPACE 时，无需配置该头部，按对应的回源域名生效。", "example": "www.tencentcloud.com" }, { "name": "VodOriginScope", "type": "string", "required": false, "description": "云点播回源范围，该参数当 OriginType = VOD 时生效。取值有：all：当前源站对应的云点播应用内所有文件；bucket：当前源站对应的云点播应用下指定某一个存储桶内的文件，通过参数 VodBucketId 来指定存储桶。不填写时，默认值为 all。", "example": "bucket" }, { "name": "VodBucketId", "type": "string", "required": false, "description": "VOD 存储桶 ID，该参数当 OriginType = VOD 且 VodOriginScope = bucket 时必填。数据来源：云点播专业版应用下存储桶的存储 ID 。", "example": "9lh4zav2ctts0ao" } ] }, { "name": "OriginProtocol", "type": "string", "required": false, "description": "回源协议，取值有： FOLLOW：协议跟随； HTTP：HTTP 协议回源； HTTPS：HTTPS 协议回源。不填默认为：FOLLOW。", "example": "FOLLOW" }, { "name": "HttpOriginPort", "type": "integer", "required": false, "description": "HTTP 回源端口，默认值80，取值：1～65535。 当 OriginProtocol = FOLLOW 或 HTTP 时生效。", "example": "80" }, { "name": "HttpsOriginPort", "type": "integer", "required": false, "description": "HTTPS 回源端口，默认值443，取值：1～65535。 当 OriginProtocol = FOLLOW 或 HTTPS 时生效。", "example": "443" }, { "name": "IPv6Status", "type": "string", "required": false, "description": "IPv6 状态，取值有： follow：遵循站点 IPv6 配置； on：开启状态； off：关闭状态。不填默认为：follow。", "example": "follow" }, { "name": "SharedCNAME", "type": "string", "required": false, "description": "指定域名绑定的共享 CNAME 地址，不传时使用默认 CNAME。 绑定共享 CNAME 要求所有域名的调度策略保持一致，以下配置将影响调度策略，在不一致时绑定共享 CNAME 将按照以下方式处理： - IPv6 访问：不允许创建域名，请修改 IPv6Status 已保持与共享 CNAME 绑定的其余域名配置一致； - DDoS 防护：如果选择的共享 CNAME 已启用 DDoS 防护，则创建域名时，将默认为该域名启用 DDoS 防护。 - \ufffd...", "example": "sharedcname.225qgrnvbi9w.share.dnse5.com" } ], "required": [ "ZoneId", "DomainName", "OriginInfo" ] }, { "name": "CreateAliasDomain", "description": "创建别称域名。 该功能仅企业版套餐支持，并且该功能当前仍在内测中，如需使用，请[联系我们](https://cloud.tencent.com/online-service?from=connect-us)。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-2fwet43nksza" }, { "name": "AliasName", "type": "string", "required": true, "description": "别称域名名称。", "example": "eo.tencent.com" }, { "name": "TargetName", "type": "string", "required": true, "description": "目标域名名称。", "example": "a.example.com" }, { "name": "CertType", "type": "string", "required": false, "description": "证书配置，取值有： none：不配置； hosting：SSL托管证书。默认取值为 none。", "example": "none" }, { "name": "CertId", "type": "array", "required": false, "description": "当 CertType 取值为 hosting 时需填入相应证书 ID。", "example": "LIeDuaN2", "item_type": "string" } ], "required": [ "ZoneId", "AliasName", "TargetName" ] }, { "name": "CreateApplicationProxy", "description": "本接口为旧版，如需调用请尽快迁移至新版 [创建四层代理实例](https://cloud.tencent.com/document/product/1552/103417) 。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-21xfqlh4qjee" }, { "name": "ProxyName", "type": "string", "required": true, "description": "当 ProxyType=hostname 时，表示域名或子域名； 当 ProxyType=instance 时，表示代理名称。", "example": "proxy-name" }, { "name": "PlatType", "type": "string", "required": true, "description": "调度模式，取值有： ip：表示Anycast IP调度； domain：表示CNAME调度。", "example": "cname" }, { "name": "SecurityType", "type": "integer", "required": true, "description": "是否开启安全，取值有： 0：关闭安全； 1：开启安全。", "example": "1" }, { "name": "AccelerateType", "type": "integer", "required": true, "description": "是否开启加速，取值有： 0：关闭加速； 1：开启加速。", "example": "1" }, { "name": "ProxyType", "type": "string", "required": false, "description": "四层代理模式，取值有： instance：表示实例模式。不填写使用默认值instance。", "example": "instance" }, { "name": "SessionPersistTime", "type": "integer", "required": false, "description": "会话保持时间，取值范围：30-3600，单位：秒。 不填写使用默认值600。", "example": "3600" }, { "name": "Ipv6", "type": "object", "required": false, "description": "Ipv6 访问配置。 不填写表示关闭 Ipv6 访问。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "Ipv6 访问功能配置，取值有： on：开启Ipv6访问功能； off：关闭Ipv6访问功能。", "example": "on" } ] }, { "name": "ApplicationProxyRules", "type": "array", "required": false, "description": "规则详细信息。 不填写则不创建规则。", "example": "无", "item_type": "object", "children": [ { "name": "Proto", "type": "string", "required": true, "description": "协议，取值有： TCP：TCP协议； UDP：UDP协议。", "example": "TCP" }, { "name": "Port", "type": "array", "required": true, "description": "端口，支持格式： 单个端口，如：80。 端口段，如：81-82。表示81，82两个端口。 注意：一条规则最多可填写20个端口。", "example": "80", "item_type": "string" }, { "name": "OriginType", "type": "string", "required": true, "description": "源站类型，取值有： custom：手动添加； loadbalancer：负载均衡； origins：源站组。", "example": "custom" }, { "name": "OriginValue", "type": "array", "required": true, "description": "源站信息： 当 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\"]`。", "example": "[\"1.1.1.1\",\"2.2.2.2\"]", "item_type": "string" }, { "name": "RuleId", "type": "string", "required": false, "description": "规则ID。", "example": "rule-xxx" }, { "name": "Status", "type": "string", "required": false, "description": "状态，取值有： online：启用； offline：停用； progress：部署中； stopping：停用中； fail：部署失败/停用失败。", "example": "online" }, { "name": "ForwardClientIp", "type": "string", "required": false, "description": "传递客户端IP，取值有： TOA：TOA（仅Proto=TCP时可选）； PPV1：Proxy Protocol传递，协议版本V1（仅Proto=TCP时可选）； PPV2：Proxy Protocol传递，协议版本V2； OFF：不传递。默认值：OFF。", "example": "TOA" }, { "name": "SessionPersist", "type": "boolean", "required": false, "description": "是否开启会话保持，取值有： true：开启； false：关闭。默认值：false。", "example": "false" }, { "name": "SessionPersistTime", "type": "integer", "required": false, "description": "会话保持的时间，只有当SessionPersist为true时，该值才会生效。", "example": "3600" }, { "name": "OriginPort", "type": "string", "required": false, "description": "源站端口，支持格式： 单端口，如：80。 端口段：81-82，表示81，82两个端口。", "example": "80-90" }, { "name": "RuleTag", "type": "string", "required": false, "description": "规则标签。", "example": "rule-service1" } ] }, { "name": "AccelerateMainland", "type": "object", "required": false, "description": "中国大陆加速优化配置。不填写表示关闭中国大陆加速优化。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "是否开启中国大陆加速优化配置，取值有： on：开启； off：关闭。", "example": "on" } ] } ], "required": [ "ZoneId", "ProxyName", "PlatType", "SecurityType", "AccelerateType" ] }, { "name": "CreateApplicationProxyRule", "description": "本接口为旧版，如需调用请尽快迁移至新版，详情请参考 [创建四层代理转发规则 ](https://cloud.tencent.com/document/product/1552/103416) 。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点ID。", "example": "zone-21xfqlh4qjee" }, { "name": "ProxyId", "type": "string", "required": true, "description": "代理ID。", "example": "proxy-19389e5dwwxfs" }, { "name": "Proto", "type": "string", "required": true, "description": "协议，取值有： TCP：TCP协议； UDP：UDP协议。", "example": "TCP" }, { "name": "Port", "type": "array", "required": true, "description": "端口，支持格式： 80：80端口； 81-90：81至90端口。", "example": "[\"80\"]", "item_type": "string" }, { "name": "OriginType", "type": "string", "required": true, "description": "源站类型，取值有： custom：手动添加； loadbalancer：负载均衡； origins：源站组。", "example": "custom" }, { "name": "OriginValue", "type": "array", "required": true, "description": "源站信息： 当 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\"]`。", "example": "[\"1.1.1.1:80\",\"2.2.2.2:80\"]", "item_type": "string" }, { "name": "ForwardClientIp", "type": "string", "required": false, "description": "传递客户端IP，取值有： TOA：TOA（仅Proto=TCP时可选）； PPV1：Proxy Protocol传递，协议版本V1（仅Proto=TCP时可选）； PPV2：Proxy Protocol传递，协议版本V2； OFF：不传递。默认值：OFF。", "example": "TOA" }, { "name": "SessionPersist", "type": "boolean", "required": false, "description": "是否开启会话保持，取值有： true：开启； false：关闭。默认值：false。", "example": "false" }, { "name": "SessionPersistTime", "type": "integer", "required": false, "description": "会话保持的时间，只有当SessionPersist为true时，该值才会生效。", "example": "3600" }, { "name": "OriginPort", "type": "string", "required": false, "description": "源站端口，支持格式： 单端口：80； 端口段：81-90，81至90端口。", "example": "80-90" }, { "name": "RuleTag", "type": "string", "required": false, "description": "规则标签。默认值为空字符串。", "example": "rule-service-1" } ], "required": [ "ZoneId", "ProxyId", "Proto", "Port", "OriginType", "OriginValue" ] }, { "name": "CreateCLSIndex", "description": "针对指定实时日志投递任务（task-id），在对应的腾讯云 CLS 日志主题中创建投递日志字段对应的键值索引。如果您在腾讯云 CLS 已经创建索引，本接口将采用合并的方式追加索引。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-2bu6nf2gzvms" }, { "name": "TaskId", "type": "string", "required": true, "description": "实时日志投递任务 ID。", "example": "7bf419a1-0e89-4304-89fa-6a21f27a1538" } ], "required": [ "ZoneId", "TaskId" ] }, { "name": "CreateConfigGroupVersion", "description": "在版本管理模式下，用于创建指定配置组的新版本。版本管理功能内测中，当前仅白名单开放。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-225qgrnvbi9w" }, { "name": "GroupId", "type": "string", "required": true, "description": "待新建版本的配置组 ID。", "example": "cg-245xgrhv2i9w" }, { "name": "Content", "type": "string", "required": true, "description": "待导入的配置内容。要求采用 JSON 格式，按照 UTF-8 方式进行编码。配置文件内容可参考下方示例。", "example": "{\"FormatVersion\": \"1.0\"***}" }, { "name": "Description", "type": "string", "required": false, "description": "版本描述，可输入最大长度为 50 个字符，可以通过本字段填写该版本的使用场景等。", "example": "create for test" } ], "required": [ "ZoneId", "GroupId", "Content" ] }, { "name": "CreateContentIdentifier", "description": "创建内容标识符，可以设置描述、标签等信息，同时需要绑定企业版套餐用于统计计费数据；一个内容标识符只能绑定一个计费套餐，一个计费套餐可以绑定多个内容标识符。该功能仅限白名单开放。", "status": "online", "parameters": [ { "name": "Description", "type": "string", "required": true, "description": "内容标识符的描述，长度限制不超过 20 个字符。", "example": "content-test" }, { "name": "PlanId", "type": "string", "required": true, "description": "待绑定的目标套餐 ID，仅限企业版可用。当您账号下已存在套餐时，需要先前往 [套餐管理](https://console.cloud.tencent.com/edgeone/package) 获取套餐 ID，直接将内容标识符绑定至该套餐；若您当前没有可绑定的套餐时，请先购买企业版套餐。", "example": "edgeone-2ycvr8ml4zpq" }, { "name": "Tags", "type": "array", "required": false, "description": "标签。该参数用于对内容标识符进行分权限管控。您需要先前往 [标签控制台](https://console.cloud.tencent.com/tag/taglist) 创建标签才可以在此处传入对应的标签键和标签值。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键。 注意：此字段可能返回 null，表示取不到有效值。", "example": "business" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "video" } ] } ], "required": [ "Description", "PlanId" ] }, { "name": "CreateCustomizeErrorPage", "description": "创建自定义错误页面。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-2kplomhisdcb" }, { "name": "Name", "type": "string", "required": true, "description": "自定义错误页名称，名称为 2-30 个字符。", "example": "错误定制页" }, { "name": "ContentType", "type": "string", "required": true, "description": "自定义错误页面类型，取值有：text/html； application/json；text/plain；text/xml。", "example": "application/json" }, { "name": "Description", "type": "string", "required": false, "description": "自定义错误页面描述，描述不超过 60 个字符。", "example": "web规则自定义错误页面" }, { "name": "Content", "type": "string", "required": false, "description": "自定义错误页面内容，内容不超过 2KB。", "example": "{\"title\":\"自定义错误页\", \"Content\":\"自定义错误页面内容\"}" } ], "required": [ "ZoneId", "Name", "ContentType" ] }, { "name": "CreateDnsRecord", "description": "在创建完站点后，并且站点为 NS 模式接入时，您可以通过本接口创建 DNS 记录。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-225qgrnvbi9w" }, { "name": "Name", "type": "string", "required": true, "description": "DNS 记录名，如果是中文、韩文、日文域名，需要转换为 punycode 后输入。", "example": "www.example.com" }, { "name": "Type", "type": "string", "required": true, "description": "DNS 记录类型，取值有：A：将域名指向一个外网 IPv4 地址，如 8.8.8.8；AAAA：将域名指向一个外网 IPv6 地址；MX：用于邮箱服务器。存在多条 MX 记录时，优先级越低越优先；CNAME：将域名指向另一个域名，再由该域名解析出最终 IP 地址；TXT：对域名进行标识和说明，常用于域名验证和 SPF 记录（反垃圾邮件）；NS：如果需要将子域名交给其他 DNS 服务商解析，则需要添加 NS 记录。\ufffd\ufffd...", "example": "A" }, { "name": "Content", "type": "string", "required": true, "description": "DNS 记录内容，根据 Type 值填入与之相对应的内容，如果是中文、韩文、日文域名，需要转换为 punycode 后输入。", "example": "1.2.3.4" }, { "name": "Location", "type": "string", "required": false, "description": "DNS 记录解析线路，不指定默认为 Default，表示默认解析线路，代表全部地域生效。 - 解析线路配置仅适用于当 Type（DNS 记录类型）为 A、AAAA、CNAME 时。 - 解析线路配置仅适用于标准版、企业版套餐使用，取值请参考：[解析线路及对应代码枚举](https://cloud.tencent.com/document/product/1552/112542)。", "example": "Default" }, { "name": "TTL", "type": "integer", "required": false, "description": "缓存时间，用户可指定值范围 60~86400，数值越小，修改记录各地生效时间越快，默认为 300，单位：秒。", "example": "60" }, { "name": "Weight", "type": "integer", "required": false, "description": "DNS 记录权重，用户可指定值范围 -1~100，设置为 0 时表示不解析，不指定默认为 -1，表示不设置权重。权重配置仅适用于当 Type（DNS 记录类型）为 A、AAAA、CNAME 时。注意：同一个子域名下，相同解析线路的不同 DNS 记录，应保持同时设置权重或者同时都不设置权重。", "example": "100" }, { "name": "Priority", "type": "integer", "required": false, "description": "MX 记录优先级，该参数仅在当 Type（DNS 记录类型）为 MX 时生效，值越小优先级越高，用户可指定值范围0~50，不指定默认为0。", "example": "10" } ], "required": [ "ZoneId", "Name", "Type", "Content" ] }, { "name": "CreateFunction", "description": "创建并部署边缘函数至 EdgeOne 的边缘节点。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-z2fc1fkl" }, { "name": "Name", "type": "string", "required": true, "description": "函数名称，只能包含小写字母、数字、连字符，以数字或字母开头，以数字或字母结尾，最大支持 30 个字符。", "example": "test-function" }, { "name": "Content", "type": "string", "required": true, "description": "函数内容，当前仅支持 JavaScript 代码，最大支持 5MB 大小。", "example": "addEventListener('fetch', e =\u003e { const response = new Response('Hello World!'); e.respondWith(response); });" }, { "name": "Remark", "type": "string", "required": false, "description": "函数描述，最大支持 60 个字符。", "example": "鉴权函数" } ], "required": [ "ZoneId", "Name", "Content" ] }, { "name": "CreateFunctionRule", "description": "创建边缘函数的触发规则。支持通过自定义过滤条件来决定是否需要执行函数，当需要执行函数时，提供了多种选择目标函数的方式，包括：直接指定，基于客户端归属地区选择和基于权重选择。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-292mnbdkdzo6" }, { "name": "FunctionRuleConditions", "type": "array", "required": true, "description": "规则条件列表，相同触发规则的不同条件匹配项之间为或关系。", "example": "无", "item_type": "object", "children": [ { "name": "RuleConditions", "type": "array", "required": true, "description": "边缘函数触发规则条件，该列表内所有项全部满足即判断该条件满足。", "example": "[]", "item_type": "object", "children": [ { "name": "Operator", "type": "string", "required": true, "description": "运算符，取值有： equal: 等于； notequal: 不等于； exist: 存在； notexist: 不存在。", "example": "equal" }, { "name": "Target", "type": "string", "required": true, "description": "匹配类型，取值有： 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...", "example": "url" }, { "name": "Values", "type": "array", "required": false, "description": "对应匹配类型的参数值，仅在匹配类型为查询字符串或HTTP请求头并且运算符取值为存在或不存在时允许传空数组，对应匹配类型有： 文件后缀：jpg、txt 等文件后缀； 文件名称：例如 foo.jpg 中的 foo； 全部（站点任意请求）：all； HOST：当前站点下的 host ，例如www.maxx55.com； URL Path：当前站点下 URL 路径的请求，例如：/example； URL Full：当前站点下完整 URL 请求，必须包含 HTTP 协\ufffd...", "example": "[\"www.maxx55.com\"]", "item_type": "string" }, { "name": "IgnoreCase", "type": "boolean", "required": false, "description": "是否忽略参数值的大小写，默认值为 false。", "example": "true" }, { "name": "Name", "type": "string", "required": false, "description": "对应匹配类型的参数名称，在 Target 值为以下取值时有效，有效时值不能为空： query_string（查询字符串）: 当前站点下URL请求中查询字符串的参数名称，例如lang=cn\u0026version=1中的lang和version； request_header（HTTP 请求头）: HTTP请求头部字段名，例如Accept-Language:zh-CN,zh;q=0.9中的Accept-Language。", "example": "Accept-Language" } ] } ] }, { "name": "TriggerType", "type": "string", "required": false, "description": "函数选择配置类型： direct：直接指定执行函数； weight：基于权重比选择函数； region：基于客户端 IP 的国家/地区选择函数。 不填时默认为 direct 。", "example": "direct" }, { "name": "FunctionId", "type": "string", "required": false, "description": "指定执行的函数 ID。当 TriggerType 为 direct 或 TriggerType 不填时生效。", "example": "ef-0agikbrr" }, { "name": "RegionMappingSelections", "type": "array", "required": false, "description": "基于客户端 IP 国家/地区的函数选择配置，当 TriggerType 为 region 时生效且 RegionMappingSelections 必填。RegionMappingSelections 中至少包含一项 Regions 为 Default 的配置。", "example": "无", "item_type": "object", "children": [ { "name": "FunctionId", "type": "string", "required": true, "description": "函数 ID 。", "example": "ef-0agikbrr" }, { "name": "Regions", "type": "array", "required": true, "description": "国家/地区列表。示例值：CN：中国，CN.GD：中国广东。取值请参考：[国家/地区及对应代码枚举](https://cloud.tencent.com/document/product/1552/112542)。", "example": "[\"CN\"]", "item_type": "string" } ] }, { "name": "WeightedSelections", "type": "array", "required": false, "description": "基于权重的函数选择配置，当 TriggerType 为 weight 时生效且 WeightedSelections 必填。WeightedSelections 中的所有权重之和需要为100。", "example": "无", "item_type": "object", "children": [ { "name": "FunctionId", "type": "string", "required": true, "description": "函数 ID 。", "example": "ef-0agikbrr" }, { "name": "Weight", "type": "integer", "required": true, "description": "选中权重。取值范围0-100，所有的权重之和需要为100。 选中概率计算方式为： weight/100。例如设置了两个函数 A 和 B ，其中 A 的权重为30，那么 B 的权重必须为70，最终选中 A 的概率为30%，选中 B 的概率为70%。", "example": "30" } ] }, { "name": "Remark", "type": "string", "required": false, "description": "规则描述，最大支持 60 个字符。", "example": "鉴权" } ], "required": [ "ZoneId", "FunctionRuleConditions" ] }, { "name": "CreateJustInTimeTranscodeTemplate", "description": "即时转码已经提供了预置转码模板，满足大部分的需求。如果有个性化的转码需求，可以通过本接口创建自定义的转码模板，最多可创建100个自定义转码模板。 为了确保即时转码效果的一致性，避免因 EO 缓存或 M3U8 分片处理过程中的模板变更导致视频输出异常，模板在创建后不可进行修改。 即时转码详细能力了解：[EdgeOne视频即时处理功能介绍](https://cloud.tencent.com/document/produ...", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点ID。", "example": "zone-djuqmq" }, { "name": "TemplateName", "type": "string", "required": true, "description": "即时转码模板名称，长度限制：64 个字符。", "example": "MyJustInTimeTranscodeTemplate" }, { "name": "Comment", "type": "string", "required": false, "description": "模板描述信息，长度限制：256 个字符。默认为空。", "example": "my just in time transcode template" }, { "name": "VideoStreamSwitch", "type": "string", "required": false, "description": "启用视频流开关，取值： on：开启； off：关闭。默认值：on。", "example": "on" }, { "name": "AudioStreamSwitch", "type": "string", "required": false, "description": "启用音频流开关，取值： on：开启； off：关闭。默认值：on。", "example": "on" }, { "name": "VideoTemplate", "type": "object", "required": false, "description": "视频流配置参数，当 VideoStreamSwitch 为 on，该字段必填。", "example": "无", "children": [ { "name": "Codec", "type": "string", "required": true, "description": "视频流的编码格式，可选值：H.264: 使用 H.264 编码；H.265: 使用 H.265 编码。", "example": "H.264" }, { "name": "Fps", "type": "float", "required": false, "description": "视频帧率，取值范围：[0, 30]，单位：Hz。 取值为 0，表示帧率和原始视频保持一致，但最大不超过 30。 默认值：0。", "example": "25.0" }, { "name": "Bitrate", "type": "integer", "required": false, "description": "视频流的码率，取值范围：0 和 [128, 10000]，单位：kbps。 取值为 0，表示自动根据视频画面和质量选择视频码率。 默认值：0。", "example": "500" }, { "name": "ResolutionAdaptive", "type": "string", "required": false, "description": "分辨率自适应，可选值：open：开启，此时，Width 代表视频的长边，Height 表示视频的短边；close：关闭，此时，Width 代表视频的宽度，Height 表示视频的高度。默认值：open。", "example": "open" }, { "name": "Width", "type": "integer", "required": false, "description": "视频流宽度（或长边）的最大值，取值范围：0 和 [128, 1920]，单位：px。当 Width、Height 均为 0，则分辨率同源；当 Width 为 0，Height 非 0，则 Width 按比例缩放；当 Width 非 0，Height 为 0，则 Height 按比例缩放；当 Width、Height 均非 0，则分辨率按用户指定。默认值：0。", "example": "0" }, { "name": "Height", "type": "integer", "required": false, "description": "视频流高度（或短边）的最大值，取值范围：0 和 [128, 1080]，单位：px。当 Width、Height 均为 0，则分辨率同源；当 Width 为 0，Height 非 0，则 Width 按比例缩放；当 Width 非 0，Height 为 0，则 Height 按比例缩放；当 Width、Height 均非 0，则分辨率按用户指定。默认值：0。", "example": "0" }, { "name": "FillType", "type": "string", "required": false, "description": "填充方式，当视频流配置宽高参数与原始视频的宽高比不一致时，对转码的处理方式，即为“填充”。可选填充方式： stretch：拉伸，对每一帧进行拉伸，填满整个画面，可能导致转码后的视频被“压扁”或者“拉长”。black：留黑，保持视频宽高比不变，边缘剩余部分使用黑色填充。white：留白，保持视频宽高比不变，边缘剩余部分使用白色填充。gauss：高斯模糊，保持视频宽...", "example": "stretch" } ] }, { "name": "AudioTemplate", "type": "object", "required": false, "description": "音频流配置参数，当 AudioStreamSwitch 为 on，该字段必填。", "example": "无", "children": [ { "name": "Codec", "type": "string", "required": true, "description": "音频流的编码格式。可选值为： libfdk_aac。", "example": "libfdk_aac" }, { "name": "AudioChannel", "type": "integer", "required": false, "description": "音频通道数，可选值：2：双通道。默认值：2。", "example": "2" } ] } ], "required": [ "ZoneId", "TemplateName" ] }, { "name": "CreateL4Proxy", "description": "用于创建四层代理实例。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-2gps1z8cx8y2" }, { "name": "ProxyName", "type": "string", "required": true, "description": "四层代理实例名称，可输入 1-50 个字符，允许的字符为 a-z、0-9、-，且 - 不能单独注册或连续使用，不能放在开头或结尾。创建完成后不支持修改。", "example": "proxy-name" }, { "name": "Area", "type": "string", "required": true, "description": "四层代理实例加速区域。 mainland：中国大陆可用区； overseas：全球可用区（不含中国大陆）； global：全球可用区。", "example": "mainland" }, { "name": "Ipv6", "type": "string", "required": false, "description": "是否开启 IPv6 访问，不填写时默认为 off。该配置仅在部分加速区域和安全防护配置下支持开启，详情请参考 [新建四层代理实例](https://cloud.tencent.com/document/product/1552/90025) 。取值为： on：开启； off：关闭。", "example": "on" }, { "name": "StaticIp", "type": "string", "required": false, "description": "是否开启固定 IP，不填写时默认为 off。该配置仅在部分加速区域和安全防护配置下支持开启，详情请参考 [新建四层代理实例](https://cloud.tencent.com/document/product/1552/90025) 。取值为： on：开启； off：关闭。", "example": "off" }, { "name": "AccelerateMainland", "type": "string", "required": false, "description": "是否开启中国大陆网络优化，不填写时默认为 off。该配置仅在部分加速区域和安全防护配置下支持开启，详情请参考 [新建四层代理实例](https://cloud.tencent.com/document/product/1552/90025) 。取值为： on：开启； off：关闭。", "example": "on" } ], "required": [ "ZoneId", "ProxyName", "Area" ] }, { "name": "CreateL4ProxyRules", "description": "用于创建四层代理实例规则，支持单条或者批量创建。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-67e6b1962" }, { "name": "ProxyId", "type": "string", "required": true, "description": "四层代理实例 ID。", "example": "proxy-19389e5dwwxfs" }, { "name": "L4ProxyRules", "type": "array", "required": true, "description": "转发规则列表。单次最多支持 200 条转发规则。 注意：L4ProxyRule 在此处使用时，Protocol、PortRange、OriginType、OriginValue、OriginPortRange 为必填字段；ClientIPPassThroughMode、SessionPersist、SessionPersistTime、RuleTag 均为选填字段；RuleId、Status 请勿填写。", "example": "无", "item_type": "object", "children": [ { "name": "RuleId", "type": "string", "required": false, "description": "转发规则 ID。 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数请勿填写；在 ModifyL4ProxyRules 作为入参使用时，该参数必填。", "example": "rule-xxx" }, { "name": "Protocol", "type": "string", "required": false, "description": "转发协议。取值有： TCP：TCP 协议； UDP：UDP 协议。 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。", "example": "TCP" }, { "name": "PortRange", "type": "array", "required": false, "description": "转发端口，支持按照以下形式填写： 单端口，如：80； 端口段，如：81-85。表示 81、82、83、84、85 五个端口。 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。", "example": "[\"80\"]", "item_type": "string" }, { "name": "OriginType", "type": "string", "required": false, "description": "源站类型，取值有： IP_DOMAIN：IP/域名源站； ORIGIN_GROUP：源站组； LB：负载均衡，当前仅白名单开放。 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。", "example": "IP_DOMAIN" }, { "name": "OriginValue", "type": "array", "required": false, "description": "源站地址： 当 OriginType 为 IP_DOMAIN 时，填写 IP 或域名，如 8.8.8.8 或 test.com ； 当 OriginType 为 ORIGIN_GROUP 时，填写源站组 ID，如 og-537y24vf5b41； 当 OriginType 为 LB 时，填写负载均衡实例 ID，如 lb-2qwk30xf7s9g。 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。", "example": "[\"1.1.1.1\"]", "item_type": "string" }, { "name": "OriginPortRange", "type": "string", "required": false, "description": "源站端口，支持按照以下形式填写： 单端口，如：80； 端口段，如：81-85，表示 81、82、83、84、85 五个端口。填写端口段时，则需要与转发端口段长度保持一致，例如转发端口：80-90，则转发端口：90-100。 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。", "example": "80-90" }, { "name": "ClientIPPassThroughMode", "type": "string", "required": false, "description": "传递客户端 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 作为入参使用时，该参数选填，\ufffd\ufffd...", "example": "TOA" }, { "name": "SessionPersist", "type": "string", "required": false, "description": "是否开启会话保持，取值有： on：开启； off：关闭。 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 off；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。", "example": "off" }, { "name": "SessionPersistTime", "type": "integer", "required": false, "description": "会话保持时间，取值范围为 30-3600，单位为秒。 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，仅当 SessionPersist = on 时，该值才会生效，且当 SessionPersist = on ，该值不填写默认为 3600；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。", "example": "3600" }, { "name": "RuleTag", "type": "string", "required": false, "description": "规则标签。可输入1-50 个任意字符。 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。", "example": "rule-service1" }, { "name": "Status", "type": "string", "required": false, "description": "规则状态，取值有： online：已启用； offline：已停用； progress：部署中； stopping：停用中； fail：部署失败/停用失败。 注意：L4ProxyRule 在 CreateL4ProxyRules、ModifyL4ProxyRules 作为入参使用时，该参数请勿填写。", "example": "online" }, { "name": "BuId", "type": "string", "required": false, "description": "BuID。", "example": "12948955" }, { "name": "RemoteAuth", "type": "object", "required": false, "description": "远程鉴权信息。 注意：RemoteAuth 在 CreateL4ProxyRules 或 ModifyL4ProxyRules 不可作为入参使用，如有传此参数，会忽略。在 DescribeL4ProxyRules 返回为空时，表示没有开启远程鉴权。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "四层远程鉴权开关，取值有： on：表示开启; off：表示关闭。", "example": "on" }, { "name": "Address", "type": "string", "required": true, "description": "远程鉴权服务地址，格式为: domain/ip:port。例：example.auth.com:8888", "example": "example.auth.com:8888" }, { "name": "ServerFaultyBehavior", "type": "string", "required": true, "description": "远程鉴权服务不可访问后，经过四层转发规则默认回源行为，取值有： reject：表示进行拦截，拒绝访问; allow：表示允许通过。", "example": "allow" } ] } ] } ], "required": [ "ZoneId", "ProxyId", "L4ProxyRules" ] }, { "name": "CreateL7AccRules", "description": "本接口用于在[规则引擎](https://cloud.tencent.com/document/product/1552/70901)中创建规则，支持批量创建。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-27q0p0bali16" }, { "name": "Rules", "type": "array", "required": true, "description": "规则内容。", "example": "无", "item_type": "object", "children": [ { "name": "Status", "type": "string", "required": false, "description": "规则状态。取值有： enable: 启用； disable: 未启用。", "example": "enable" }, { "name": "RuleId", "type": "string", "required": false, "description": "规则 ID。规则的唯一性标识，当调用 ModifyL7AccRules 时，该参数必填。", "example": "rule-30maftui9q4f" }, { "name": "RuleName", "type": "string", "required": false, "description": "规则名称。名称长度限制不超过 255 个字符。", "example": "rule test" }, { "name": "Description", "type": "array", "required": false, "description": "规则注释。可以填写多个注释。", "example": "[\"name1\"]", "item_type": "string" }, { "name": "Branches", "type": "array", "required": false, "description": "子规则分支。此列表当前只支持填写一项规则，多填无效。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Condition", "type": "string", "required": false, "description": "[匹配条件](https://cloud.tencent.com/document/product/1552/90438#33f65828-c6c6-4b66-a011-25a20b548d5d)。", "example": "\"${http.request.host} in ['test.test.com']\"" }, { "name": "Actions", "type": "array", "required": false, "description": "[操作](https://cloud.tencent.com/document/product/1552/90438#c7bd7e02-9247-4a72-b0e4-11c27cadb198)。注意：Actions 和 SubRules 不可同时为空。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "操作名称。名称需要与参数结构体对应，例如 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：智能加速； Range...", "example": "Cache" }, { "name": "CacheParameters", "type": "object", "required": false, "description": "节点缓存 TTL 配置参数，当 Name 取值为 Cache 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "CacheKeyParameters", "type": "object", "required": false, "description": "自定义 Cache Key 配置参数，当 Name 取值为 CacheKey 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "CachePrefreshParameters", "type": "object", "required": false, "description": "缓存预刷新配置参数，当 Name 取值为 CachePrefresh 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "AccessURLRedirectParameters", "type": "object", "required": false, "description": "访问 URL 重定向配置参数，当 Name 取值为 AccessURLRedirect 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "UpstreamURLRewriteParameters", "type": "object", "required": false, "description": "回源 URL 重写配置参数，当 Name 取值为 UpstreamURLRewrite 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "QUICParameters", "type": "object", "required": false, "description": "QUIC 配置参数，当 Name 取值为 QUIC 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "WebSocketParameters", "type": "object", "required": false, "description": "WebSocket 配置参数，当 Name 取值为 WebSocket 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "AuthenticationParameters", "type": "object", "required": false, "description": "Token 鉴权配置参数，当 Name 取值为 Authentication 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "MaxAgeParameters", "type": "object", "required": false, "description": "浏览器缓存 TTL 配置参数，当 Name 取值为 MaxAge 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "StatusCodeCacheParameters", "type": "object", "required": false, "description": "状态码缓存 TTL 配置参数，当 Name 取值为 StatusCodeCache 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "OfflineCacheParameters", "type": "object", "required": false, "description": "离线缓存配置参数，当 Name 取值为 OfflineCache 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "SmartRoutingParameters", "type": "object", "required": false, "description": "智能加速配置参数，当 Name 取值为 SmartRouting 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "RangeOriginPullParameters", "type": "object", "required": false, "description": "分片回源配置参数，当 Name 取值为 RangeOriginPull 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "UpstreamHTTP2Parameters", "type": "object", "required": false, "description": "HTTP2 回源配置参数，当 Name 取值为 UpstreamHTTP2 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "HostHeaderParameters", "type": "object", "required": false, "description": "Host Header 重写配置参数，当 Name 取值为 HostHeader 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ForceRedirectHTTPSParameters", "type": "object", "required": false, "description": "访问协议强制 HTTPS 跳转配置，当 Name 取值为 ForceRedirectHTTPS 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "OriginPullProtocolParameters", "type": "object", "required": false, "description": "回源 HTTPS 配置参数，当 Name 取值为 OriginPullProtocol 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "CompressionParameters", "type": "object", "required": false, "description": "智能压缩配置，当 Name 取值为 Compression 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "HSTSParameters", "type": "object", "required": false, "description": "HSTS 配置参数，当 Name 取值为 HSTS 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ClientIPHeaderParameters", "type": "object", "required": false, "description": "存储客户端请求 IP 的头部信息配置，当 Name 取值为 ClientIPHeader 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "OCSPStaplingParameters", "type": "object", "required": false, "description": "OCSP 装订配置参数，当 Name 取值为 OCSPStapling 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "HTTP2Parameters", "type": "object", "required": false, "description": "HTTP2 接入配置参数，当 Name 取值为 HTTP2 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "PostMaxSizeParameters", "type": "object", "required": false, "description": "POST 请求上传文件流式传输最大限制配置，当 Name 取值为 PostMaxSize 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ClientIPCountryParameters", "type": "object", "required": false, "description": "回源时携带客户端 IP 所属地域信息配置参数，当 Name 取值为 ClientIPCountry 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "UpstreamFollowRedirectParameters", "type": "object", "required": false, "description": "回源跟随重定向参数配置，当 Name 取值为 UpstreamFollowRedirect 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "UpstreamRequestParameters", "type": "object", "required": false, "description": "回源请求参数配置参数，当 Name 取值为 UpstreamRequest 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "TLSConfigParameters", "type": "object", "required": false, "description": "SSL/TLS 安全配置参数，当 Name 取值为 TLSConfig 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ModifyOriginParameters", "type": "object", "required": false, "description": "修改源站配置参数，当 Name 取值为 ModifyOrigin 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "HTTPUpstreamTimeoutParameters", "type": "object", "required": false, "description": "七层回源超时配置，当 Name 取值为 HTTPUpstreamTimeout 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "HttpResponseParameters", "type": "object", "required": false, "description": "HTTP 应答配置参数，当 Name 取值为 HttpResponse 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ErrorPageParameters", "type": "object", "required": false, "description": "自定义错误页面配置参数，当 Name 取值为 ErrorPage 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ModifyResponseHeaderParameters", "type": "object", "required": false, "description": "修改 HTTP 节点响应头配置参数，当 Name 取值为 ModifyResponseHeader 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ModifyRequestHeaderParameters", "type": "object", "required": false, "description": "修改 HTTP 节点请求头配置参数，当 Name 取值为 ModifyRequestHeader 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ResponseSpeedLimitParameters", "type": "object", "required": false, "description": "单连接下载限速配置参数，当 Name 取值为 ResponseSpeedLimit 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "SetContentIdentifierParameters", "type": "object", "required": false, "description": "内容标识配置参数，当 Name 取值为 SetContentIdentifier 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "VaryParameters", "type": "object", "required": false, "description": "Vary 特性配置参数，当 Name 取值为 Vary 时，该参数必填。", "example": "无" }, { "name": "ContentCompressionParameters", "type": "object", "required": false, "description": "内容压缩配置参数，当 Name 取值为 ContentCompression 时，该参数必填。该参数为白名单功能，如有需要，请联系腾讯云工程师处理。", "example": "无" }, { "name": "OriginAuthenticationParameters", "type": "object", "required": false, "description": "回源鉴权配置参数，当 Name 取值为 OriginAuthentication 时，该参数必填。该参数为白名单功能，如有需要，请联系腾讯云工程师处理。", "example": "无" } ] }, { "name": "SubRules", "type": "array", "required": false, "description": "子规则列表。此列表中时存在多条规则，按照从上往下的顺序依次执行。注意：SubRules 和 Actions 不可同时为空。且当前只支持填写一层 SubRules。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Branches", "type": "array", "required": false, "description": "子规则分支 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "Description", "type": "array", "required": false, "description": "规则注释。", "example": "[\"tag1\", \"tag2\"]", "item_type": "string" } ] } ] }, { "name": "RulePriority", "type": "integer", "required": false, "description": "规则优先级。仅作为出参使用。", "example": "1" } ] } ], "required": [ "ZoneId", "Rules" ] }, { "name": "CreateLoadBalancer", "description": "创建负载均衡实例。详情请参考 [快速创建负载均衡实例](https://cloud.tencent.com/document/product/1552/104223)。负载均衡功能内测中，如您需要使用请 [联系我们](https://cloud.tencent.com/online-service)。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-27q0p0bali16\t" }, { "name": "Name", "type": "string", "required": true, "description": "实例名称，可输入 1-200 个字符，允许字符为 a-z，A-Z，0-9，_，-。", "example": "lb-1" }, { "name": "Type", "type": "string", "required": true, "description": "实例类型，取值有： HTTP：HTTP 专用型，支持添加 HTTP 专用型和通用型源站组，仅支持被站点加速相关服务引用（如域名服务和规则引擎）； GENERAL：通用型，仅支持添加通用型源站组，能被站点加速服务（如域名服务和规则引擎）和四层代理引用。", "example": "HTTP" }, { "name": "OriginGroups", "type": "array", "required": true, "description": "源站组列表及其对应的容灾调度优先级。详情请参考 [快速创建负载均衡实例](https://cloud.tencent.com/document/product/1552/104223) 中的示例场景。", "example": "[{\"Priority\": \"proiority_1\", \"OriginGroupId\": \"origin-1\"}, {\"Priority\": \"proiority_2\", \"OriginGroupId\": \"origin-2\"}]", "item_type": "object", "children": [ { "name": "Priority", "type": "string", "required": true, "description": "优先级，填写格式为 \"priority_\" + \"数字\"，最高优先级为 \"priority_1\"。参考取值有： priority_1：第一优先级； priority_2：第二优先级； priority_3：第三优先级。其他优先级可以将数字递增，最多可以递增至 \"priority_10\"。", "example": "priority_1" }, { "name": "OriginGroupId", "type": "string", "required": true, "description": "源站组 ID。", "example": "orgin-2ccgtb24-7dc5-46s2-9r3e-95825d53dwe3a\t" } ] }, { "name": "HealthChecker", "type": "object", "required": false, "description": "健康检查策略。详情请参考 [健康检查策略介绍](https://cloud.tencent.com/document/product/1552/104228)。不填写时，默认为不启用健康检查。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "健康检查策略，取值有： HTTP； HTTPS； TCP； UDP； ICMP Ping； NoCheck。 注意：NoCheck 表示不启用健康检查策略。", "example": "HTTP" }, { "name": "Port", "type": "integer", "required": false, "description": "检查端口。当 Type=HTTP 或 Type=HTTPS 或 Type=TCP 或 Type=UDP 时为必填。", "example": "80" }, { "name": "Interval", "type": "integer", "required": false, "description": "检查频率，表示多久发起一次健康检查任务，单位为秒。可取值有：30，60，180，300 或 600。", "example": "30" }, { "name": "Timeout", "type": "integer", "required": false, "description": "每一次健康检查的超时时间，若健康检查消耗时间大于此值，则检查结果判定为”不健康“， 单位为秒，默认值为 5s，取值必须小于 Interval。", "example": "5" }, { "name": "HealthThreshold", "type": "integer", "required": false, "description": "健康阈值，表示连续几次健康检查结果为\"健康\"，则判断源站为\"健康\"，单位为次，默认 3 次，最小取值 1 次。", "example": "3" }, { "name": "CriticalThreshold", "type": "integer", "required": false, "description": "不健康阈值，表示连续几次健康检查结果为\"不健康\"，则判断源站为\"不健康\"，单位为次，默认 2 次。", "example": "5" }, { "name": "Path", "type": "string", "required": false, "description": "该参数仅当 Type=HTTP 或 Type=HTTPS 时有效，表示探测路径，需要填写完整的 host/path，不包含协议部分，例如：www.example.com/test。", "example": "www.example.com/test" }, { "name": "Method", "type": "string", "required": false, "description": "该参数仅当 Type=HTTP 或 Type=HTTPS 时有效，表示请求方法，取值有： GET； HEAD。", "example": "HEAD" }, { "name": "ExpectedCodes", "type": "array", "required": false, "description": "该参数仅当 Type=HTTP 或 Type=HTTPS 时有效，表示探测节点向源站发起健康检查时，响应哪些状态码可用于认定探测结果为健康。", "example": "[\"200\", \"500\"]", "item_type": "string" }, { "name": "Headers", "type": "array", "required": false, "description": "该参数仅当 Type=HTTP 或 Type=HTTPS 时有效，表示探测请求携带的自定义 HTTP 请求头，至多可配置 10 个。", "example": "[{ \"Key\": \"host\", \"Value\": \"www.example.com\" }]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "自定义头部 Key。", "example": "host" }, { "name": "Value", "type": "string", "required": true, "description": "自定义头部 Value。", "example": "www.example.com" } ] }, { "name": "FollowRedirect", "type": "string", "required": false, "description": "该参数仅当 Type=HTTP 或 Type=HTTPS 时有效，表示是否启用遵循 301/302 重定向。启用后，301/302 默认为\"健康\"的状态码，默认跳转 3 次。", "example": "true" }, { "name": "SendContext", "type": "string", "required": false, "description": "该参数仅当 Type=UDP 时有效，表示健康检查发送的内容。只允许 ASCII 可见字符，最大长度限制 500 个字符。", "example": "send_payload" }, { "name": "RecvContext", "type": "string", "required": false, "description": "该参数仅当 Type=UDP 时有效，表示健康检查期望源站返回结果。只允许 ASCII 可见字符，最大长度限制 500 个字符。", "example": "recv_context" } ] }, { "name": "SteeringPolicy", "type": "string", "required": false, "description": "源站组间的流量调度策略，取值有： Pritory：按优先级顺序进行故障转移。默认值为 Pritory。", "example": "Pritory" }, { "name": "FailoverPolicy", "type": "string", "required": false, "description": "实际访问某源站失败时的请求重试策略，详情请参考 [请求重试策略介绍](https://cloud.tencent.com/document/product/1552/104227)，取值有： OtherOriginGroup：单次请求失败后，请求优先重试下一优先级源站组； OtherRecordInOriginGroup：单次请求失败后，请求优先重试同源站组内的其他源站。默认值为 OtherRecordInOriginGroup。", "example": "OtherRecordInOriginGroup" } ], "required": [ "ZoneId", "Name", "Type", "OriginGroups" ] }, { "name": "CreateMultiPathGateway", "description": "通过本接口创建多通道安全加速网关，包括云上网关（腾讯云创建和管理的网关）和自有网关（用户部署的私有网关），需要通过接口 DescribeMultiPathGateway，查询状态为 online 即创建成功。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-27q0p0bal192" }, { "name": "GatewayType", "type": "string", "required": true, "description": "网关类型，取值有： cloud：云上网关，腾讯云创建和管理的网关； private：自有网关，用户部署的私有网关。", "example": "cloud" }, { "name": "GatewayName", "type": "string", "required": true, "description": "网关名称，16 个字符以内，可用字符（a-z,A-Z,0-9,-,_）。", "example": "EOMPGW-1" }, { "name": "GatewayPort", "type": "integer", "required": true, "description": "网关端口，范围 1～65535（除去 8888 ）。", "example": "8080" }, { "name": "RegionId", "type": "string", "required": false, "description": "网关地域，GatewayType 取值为 cloud（云上网关）必填。可以从接口 DescribeMultiPathGatewayRegions 获取 RegionId 列表。", "example": "ap-shanghai" }, { "name": "GatewayIP", "type": "string", "required": false, "description": "网关地址，GatewayType 取值为 private（自有网关）必填，使用该地址时，请确保该地址已录入腾讯云多通道安全加速网关系统。如未录入，需要在本接口调用前通过工单或者联系架构师把网关 IP 地址提前录入腾讯云多通道安全加速网关系统。", "example": "120.53.95.20" } ], "required": [ "ZoneId", "GatewayType", "GatewayName", "GatewayPort" ] }, { "name": "CreateMultiPathGatewayLine", "description": "通过本接口创建接入多通道安全加速网关的线路。包括 EdgeOne 四层代理线路、自定义线路。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID 。", "example": "zone-27q0p0bal192" }, { "name": "GatewayId", "type": "string", "required": true, "description": "多通道安全网关 ID 。", "example": "mpgw-lbxuhk1oh" }, { "name": "LineType", "type": "string", "required": true, "description": "线路类型，取值有： direct ：直连线路，不支持修改和删除。 proxy ：EdgeOne 四层代理线路，支持修改实例 ID 和规则 ID，不支持删除。 custom ：自定义线路，支持修改、删除实例 ID 和规则 ID。", "example": "proxy" }, { "name": "LineAddress", "type": "string", "required": true, "description": "线路地址，格式为 ip:port。", "example": "120.53.91.10:8080" }, { "name": "ProxyId", "type": "string", "required": false, "description": "四层代理实例 ID，当线路类型 LineType 取值为 proxy（EdgeOne 四层代理）必传，可由接口 [DescribeL4Proxy](https://cloud.tencent.com/document/api/1552/103413) 获取。", "example": "sid-2gpv1z8cx8y2" }, { "name": "RuleId", "type": "string", "required": false, "description": "转发规则 ID ，当线路类型 LineType 取值为 proxy（EdgeOne 四层代理）必传，可以从接口 [DescribeL4ProxyRules](https://cloud.tencent.com/document/api/1552/103412) 获取。", "example": "rule-33ik84rw3nuu" } ], "required": [ "ZoneId", "GatewayId", "LineType", "LineAddress" ] }, { "name": "CreateMultiPathGatewaySecretKey", "description": "通过本接口创建接入多通道安全加速网关的密钥，客户基于接入密钥签名接入多通道安全加速网关。每个站点下只有一个密钥，可用于接入该站点下的所有网关，可通过接口 DescribeMultiPathGatewaySecretKey 查询。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-27q0p0bal192" }, { "name": "SecretKey", "type": "string", "required": false, "description": "多通道安全加速网关接入密钥，base64字符串，编码前字符串长度为 32-48 个字符，非必填，不填系统自动生成，可通过接口 DescribeMultiPathGatewaySecretKey 查询。", "example": "b8sfnemqzF5TNCwwtshVmG/gyCJVi/rP+7A+jsBwqGY=" } ], "required": [ "ZoneId" ] }, { "name": "CreateOriginGroup", "description": "创建源站组，以源站组的方式管理业务源站。此处配置的源站组可于**添加加速域名**和**四层代理**等功能中引用。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID", "example": "zone-27q0p0bali16" }, { "name": "Records", "type": "array", "required": true, "description": "源站记录信息，此参数必填。", "example": "无", "item_type": "object", "children": [ { "name": "Record", "type": "string", "required": true, "description": "源站记录值，不包含端口信息，可以为：IPv4，IPv6，域名格式。", "example": "8.8.8.8" }, { "name": "Type", "type": "string", "required": false, "description": "源站类型，取值有： IP_DOMAIN：IPV4、IPV6、域名类型源站； COS：COS源。 AWS_S3：AWS S3对象存储源站。", "example": "IP_DOMAIN" }, { "name": "RecordId", "type": "string", "required": false, "description": "源站记录ID。", "example": "record-27q0p0bali16" }, { "name": "Weight", "type": "integer", "required": false, "description": "【源站权重】：用于控制流量分配优先级的参数，取值范围：0-100（整数）：空值：不设置权重，系统按默认策略调度；0 值：明确设置权重为0，流量将不会分配到该源站，注意事项：必须确保至少有一个源站的权重值大于0；正常值：数值越大分配流量越多 ； 注意：此字段可能返回 null，表示取不到有效值。", "example": "100" }, { "name": "Private", "type": "boolean", "required": false, "description": "是否私有鉴权，当源站类型 RecordType=COS/AWS_S3 时生效，取值有： true：使用私有鉴权； false：不使用私有鉴权。不填写，默认值为：false。", "example": "false" }, { "name": "PrivateParameters", "type": "array", "required": false, "description": "私有鉴权参数，当源站类型Private=true时有效。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "私有鉴权参数名称，取值有： AccessKeyId：鉴权参数 Access Key ID； SecretAccessKey：鉴权参数 Secret Access Key； SignatureVersion：鉴权版本，v2 或者 v4； Region：存储桶地域。", "example": "AccessKeyId" }, { "name": "Value", "type": "string", "required": true, "description": "私有鉴权参数值。", "example": "AKID************" } ] } ] }, { "name": "Name", "type": "string", "required": false, "description": "源站组名称，可输入1 - 200个字符，允许的字符为 a - z, A - Z, 0 - 9, _, - 。", "example": "name" }, { "name": "Type", "type": "string", "required": false, "description": "源站组类型，此参数必填，取值有： GENERAL：通用型源站组，仅支持添加 IP/域名 源站，可以被域名服务、规则引擎、四层代理、通用型负载均衡、HTTP 专用型负载均衡引用； HTTP： HTTP 专用型源站组，支持添加 IP/域名、对象存储源站作为源站，无法被四层代理引用，仅支持被添加加速域名、规则引擎-修改源站、HTTP 专用型负载均衡引用。", "example": "HTTP" }, { "name": "HostHeader", "type": "string", "required": false, "description": "回源 Host Header，仅 Type = HTTP 时传入生效，规则引擎修改 Host Header 配置优先级高于源站组的 Host Header。", "example": "www.tencent.com" } ], "required": [ "ZoneId", "Records" ] }, { "name": "CreatePlan", "description": "若您需要使用 Edgeone 产品，您需要通过此接口创建计费套餐。 \u003e 创建套餐后，您需要通过 [CreateZone](https://cloud.tencent.com/document/product/1552/80719) 完成创建站点，绑定套餐的流程，Edgeone 才能正常提供服务。", "status": "online", "parameters": [ { "name": "PlanType", "type": "string", "required": true, "description": "订阅的套餐类型，取值有： personal：个人版套餐，预付费套餐； basic：基础版套餐，预付费套餐； standard：标准版套餐，预付费套餐； enterprise：企业版套餐，后付费套餐。订阅预付费套餐时，请确保账号内有足够余额，余额不足会产生一个待支付的订单。 计费概述参考 [Edgeone计费概述](https://cloud.tencent.com/document/product/1552/94156) 不同套餐区别参考 [Edgeone计费套餐选型对比](https:...", "example": "无" }, { "name": "AutoUseVoucher", "type": "string", "required": false, "description": "是否自动使用代金券，取值有： true：是； false：否。该参数仅在 PlanType 为 personal, basic, standard 时有效。 不填写使用默认值 false。", "example": "无" }, { "name": "PrepaidPlanParam", "type": "object", "required": false, "description": "订阅预付费套餐参数，PlanType 为 personal, basic, standard 时，可以选填该参数，用于传入套餐的订阅时长和是否开启自动续费。 不填该参数时，默认开通套餐时长为 1 个月，不开启自动续费。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": false, "description": "订阅预付费套餐的周期，单位：月，取值有：1，2，3，4，5，6，7，8，9，10，11，12，24，36。 不填写使用默认值 1。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "预付费套餐的自动续费标志，取值有： on：开启自动续费； off：不开启自动续费。 不填写使用默认值 off，自动续费时，默认续费1个月。", "example": "on" } ] } ], "required": [ "PlanType" ] }, { "name": "CreatePlanForZone", "description": "为未购买套餐的站点购买套餐", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点ID。", "example": "zone-25z65bfb4414" }, { "name": "PlanType", "type": "string", "required": true, "description": "所要购买套餐的类型，取值有： sta: 全球内容分发网络（不包括中国大陆）标准版套餐； sta_with_bot: 全球内容分发网络（不包括中国大陆）标准版套餐附带bot管理； sta_cm: 中国大陆内容分发网络标准版套餐； sta_cm_with_bot: 中国大陆内容分发网络标准版套餐附带bot管理； sta_global ：全球内容分发网络（包括中国大陆）标准版套餐； sta_global_with_bot ：全球内容分发网络（包括中国\ufffd\ufffd...", "example": "sta" } ], "required": [ "ZoneId", "PlanType" ] }, { "name": "CreatePrefetchTask", "description": "创建预热任务", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。 若您希望快速提交不同站点下的 Targets Url，可以将其填写为 *，但前提是调用该 API 的账号必须具备主账号下全部站点资源的权限。", "example": "zone-d37f2kvre2cd" }, { "name": "Targets", "type": "array", "required": false, "description": "要预热的资源列表，必填。每个元素格式类似如下: http://www.example.com/example.txt。 注意：提交任务数受计费套餐配额限制，请查看 [EO计费套餐](https://cloud.tencent.com/document/product/1552/77380)。", "example": "[\"http://www.qq.com/1.txt\"]", "item_type": "string" }, { "name": "Mode", "type": "string", "required": false, "description": "预热模式，取值有： default：默认模式，即预热到中间层； edge：边缘预热模式，即预热到边缘和中间层。不填写时，默认值为 default。 注意事项： 1.预热至边缘产生的边缘层流量，会计入计费流量； 2.边缘预热默认分配单独的预热额度 1000 条/天，不消费常规预热额度。 说明： 该参数为白名单功能，如有需要，请联系腾讯云工程师处理。", "example": "default" }, { "name": "Headers", "type": "array", "required": false, "description": "若需要携带 HTTP 头部信息预热，可入参该参数，否则放空即可。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "HTTP头部名称。", "example": "User-Agent" }, { "name": "Value", "type": "string", "required": true, "description": "HTTP头部值。", "example": "TencentEdgeOne" } ] }, { "name": "PrefetchMediaSegments", "type": "string", "required": false, "description": "媒体分片预热控制，取值有： on：开启分片预热，预热描述文件，并递归解析描述文件分片进行预热； off：仅预热提交的描述文件；不填写时，默认值为 off。 注意事项： 1. 支持的描述文件为 M3U8，对应分片为 TS； 2. 要求描述文件能正常请求，并按行业标准描述分片路径； 3. 递归解析深度不超过 3 层； 4. 解析获取的分片会正常累加每日预热用量，当用量超出配额时，会静默\ufffd\ufffd...", "example": "off" } ], "required": [ "ZoneId" ] }, { "name": "CreatePurgeTask", "description": "当源站资源更新，但节点缓存 TTL 未过期时，用户仍会访问到旧的资源，此时可以通过该接口实现节点资源更新。触发更新的方法有以下两种：直接删除：不做任何校验，直接删除节点缓存，用户请求时触发回源拉取；标记过期：将节点资源置为过期，用户请求时触发回源校验，即发送带有 If-None-Match 和 If-Modified-Since 头部的 HTTP 条件请求。若源站响应 200，则节点会回源拉取新\ufffd...", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。 若您希望快速提交不同站点下的 Targets Url，可以将其填写为 *，但前提是调用该 API 的账号必须具备主账号下全部站点资源的权限。", "example": "zone-8afj24jzg9" }, { "name": "Type", "type": "string", "required": true, "description": "节点缓存清除类型，取值有： purge_url：URL刷新； purge_prefix：目录刷新； purge_host：Hostname 刷新； purge_all：站点下全部缓存刷新； purge_cache_tag：cache-tag 刷新。缓存清除类型详情请查看[清除缓存](https://cloud.tencent.com/document/product/1552/70759)。", "example": "purge_url" }, { "name": "Method", "type": "string", "required": false, "description": "节点缓存清除方法，针对目录刷新、Hostname 刷新以及刷新全部缓存类型有效，取值有： invalidate：仅刷新目录下产生了更新的资源； delete：无论目录下资源是否更新都刷新节点资源。默认值： invalidate。", "example": "invalidate" }, { "name": "Targets", "type": "array", "required": false, "description": "需清除缓存的资源列表，如 https://www.example.com/example.jpg，必须携带协议信息。更多元素格式依据清除缓存类型而定，可参考下方接口调用示例。单次提交的任务数受计费套餐配额限制，请查看 [EO 计费套餐](https://cloud.tencent.com/document/product/1552/77380)。", "example": "[\"http://www.qq.com/1.txt\"]", "item_type": "string" }, { "name": "CacheTag", "type": "object", "required": false, "description": "节点缓存清除类型取值为 purge_cache_tag 时附带的信息。", "example": "无", "children": [ { "name": "Domains", "type": "array", "required": true, "description": "待清除缓存的域名列表。", "example": "[\"www.qq.com\"]", "item_type": "string" } ] } ], "required": [ "ZoneId", "Type" ] }, { "name": "CreateRealtimeLogDeliveryTask", "description": "本接口用于创建实时日志投递任务。本接口有如下限制： - 当数据投递类型（LogType）为站点加速日志（七层访问日志）、四层代理日志、边缘函数运行日志时，同一个实体（七层域名、四层代理实例、边缘函数实例）在同种数据投递类型（LogType）和数据投递区域（Area）的组合下，只能被添加到如下实时日志投递任务类型（TaskType）组合中： - 一个推送至腾讯云 CLS 的任务，加\ufffd...", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-xxxxx" }, { "name": "TaskName", "type": "string", "required": true, "description": "实时日志投递任务的名称，格式为数字、英文、-和_组合，最多 200 个字符。", "example": "test_log_task" }, { "name": "TaskType", "type": "string", "required": true, "description": "实时日志投递任务类型，取值有： cls: 推送到腾讯云 CLS； custom_endpoint：推送到自定义 HTTP(S) 地址； s3：推送到 AWS S3 兼容存储桶地址； log_analysis：推送到 EdgeOne 日志分析，该任务类型仅支持“站点加速日志”这一数据投递类型。", "example": "cls" }, { "name": "EntityList", "type": "array", "required": true, "description": "实时日志投递任务对应的实体列表。取值示例如下： 七层域名：domain.example.com 四层代理实例：sid-2s69eb5wcms7 边缘函数实例：test-zone-2mxigizoh9l9-1257626257", "example": "[\"domain.example.com\"]", "item_type": "string" }, { "name": "LogType", "type": "string", "required": true, "description": "数据投递类型，取值有： domain：站点加速日志； application：四层代理日志； function：边缘函数运行日志； web-rateLiming：速率限制和 CC 攻击防护日志； web-attack：托管规则日志； web-rule：自定义规则日志； web-bot：Bot管理日志。", "example": "domain" }, { "name": "Area", "type": "string", "required": true, "description": "数据投递区域，取值有： mainland：中国大陆境内； overseas：全球（不含中国大陆）。", "example": "mainland" }, { "name": "Fields", "type": "array", "required": true, "description": "投递的预设字段列表。取值参考： [站点加速日志（七层访问日志）](https://cloud.tencent.com/document/product/1552/105791) [四层代理日志](https://cloud.tencent.com/document/product/1552/105792) [边缘函数运行日志](https://cloud.tencent.com/document/product/1552/115585)", "example": "[\"RequestID\",\"ClientIP\",\"RequestTime\"]", "item_type": "string" }, { "name": "CustomFields", "type": "array", "required": false, "description": "投递的自定义字段列表，支持在 HTTP 请求头、响应头、Cookie、请求正文中提取指定内容。自定义字段名称不能重复，且最多不能超过 200 个字段。单个实时日志推送任务最多添加 5 个请求正文类型的自定义字段。目前仅站点加速日志（LogType=domain）支持添加自定义字段。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "自定义日志字段类型。从 HTTP 请求和响应中的指定位置提取数据，取值有： ReqHeader：从 HTTP 请求头中提取指定字段值； RspHeader：从 HTTP 响应头中提取指定字段值； Cookie: 从 Cookie 中提取指定字段值； ReqBody: 从 HTTP 请求正文中通过 Google RE2 正则表达式提取指定内容。", "example": "ReqHeader" }, { "name": "Value", "type": "string", "required": true, "description": "根据字段类型（Name）填入字段值的定义。需要区分大小写。 当字段类型为 ReqHeader、RspHeader、Cookie 时，填入需要提取值的参数名称，例如：Accept-Language。可输入 1-100 个字符，允许的字符开头为字母，中间为字母、数字、-，结尾为字母、数字； 当字段类型为 ReqBody 时，填入 Google RE2 正则表达式，正则表达式长度上限为 4KB。", "example": "Accept-Language" }, { "name": "Enabled", "type": "boolean", "required": false, "description": "是否投递该字段，不填表示不投递此字段。", "example": "true" } ] }, { "name": "DeliveryConditions", "type": "array", "required": false, "description": "日志投递的过滤条件，不填表示投递全量日志。", "example": "无", "item_type": "object", "children": [ { "name": "Conditions", "type": "array", "required": false, "description": "日志过滤条件，详细的过滤条件如下： EdgeResponseStatusCode：按照 EdgeOne 节点响应返回给客户端的状态码进行过滤。   支持运算符：equal、great、less、great_equal、less_equal   取值范围：任意大于等于 0 的整数 OriginResponseStatusCode：按照源站响应状态码进行过滤。   支持运算符：equal、great、less、great_equal、less_equal   取值范围：任意大于等于 -1 的整数 SecurityAction：按照请求\ufffd\ufffd...", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "筛选条件的key。", "example": "查询键" }, { "name": "Operator", "type": "string", "required": true, "description": "查询条件操作符，操作类型有： equals: 等于； notEquals: 不等于； include: 包含； notInclude: 不包含; startWith: 开始的值是value； notStartWith: 不以value的值开始； endWith: 结尾是value值； notEndWith: 不以value的值结尾。", "example": "equals" }, { "name": "Value", "type": "array", "required": true, "description": "筛选条件的值。", "example": "查询值", "item_type": "string" } ] } ] }, { "name": "Sample", "type": "integer", "required": false, "description": "采样比例，采用千分制，取值范围为1-1000，例如：填写 605 表示采样比例为 60.5%。不填表示采样比例为 100%。", "example": "605" }, { "name": "LogFormat", "type": "object", "required": false, "description": "日志投递的输出格式。不填表示为默认格式，默认格式逻辑如下： 当 TaskType 取值为 custom_endpoint 时，默认格式为多个 JSON 对象组成的数组，每个 JSON 对象为一条日志； 当 TaskType 取值为 s3 时，默认格式为 JSON Lines；特别地，当 TaskType 取值为 cls 或 log_analysis 时，LogFormat.FormatType 的值只能为 json，且 LogFormat 中其他参数将被忽略，建议不传 LogFormat。", "example": "无", "children": [ { "name": "FormatType", "type": "string", "required": true, "description": "日志投递的预设输出格式类型，取值有： json：使用预设日志输出格式 JSON Lines，单条日志中的字段以键值对方式呈现； csv：使用预设日志输出格式 csv，单条日志中仅呈现字段值，不呈现字段名称。", "example": "json" }, { "name": "BatchPrefix", "type": "string", "required": false, "description": "在每个日志投递批次之前添加的字符串。每个日志投递批次可能包含多条日志记录。", "example": "{\"events\":[" }, { "name": "BatchSuffix", "type": "string", "required": false, "description": "在每个日志投递批次后附加的字符串。", "example": "]}" }, { "name": "RecordPrefix", "type": "string", "required": false, "description": "在每条日志记录之前添加的字符串。", "example": "{" }, { "name": "RecordSuffix", "type": "string", "required": false, "description": "在每条日志记录后附加的字符串。", "example": "}" }, { "name": "RecordDelimiter", "type": "string", "required": false, "description": "插入日志记录之间作为分隔符的字符串，取值有： \\n：换行符； \\t：制表符； ，：半角逗号。", "example": "," }, { "name": "FieldDelimiter", "type": "string", "required": false, "description": "单条日志记录内，插入字段之间作为分隔符的字符串，取值有： \\t：制表符； ，：半角逗号； ;：半角分号。", "example": "," } ] }, { "name": "CLS", "type": "object", "required": false, "description": "CLS 的配置信息。当 TaskType 取值为 cls 时，该参数必填。", "example": "无", "children": [ { "name": "LogSetId", "type": "string", "required": true, "description": "腾讯云 CLS 日志集 ID。", "example": "1a6efff1-0e40-4d37-a4ed-02c92513406b" }, { "name": "TopicId", "type": "string", "required": true, "description": "腾讯云 CLS 日志主题 ID。", "example": "0b3a07c0-5cf6-4017-8a75-cd4459aea588" }, { "name": "LogSetRegion", "type": "string", "required": true, "description": "腾讯云 CLS 日志集所在的地域。", "example": "ap-guangzhou" } ] }, { "name": "CustomEndpoint", "type": "object", "required": false, "description": "自定义 HTTP 服务的配置信息。当 TaskType 取值为 custom_endpoint 时，该参数必填。", "example": "无", "children": [ { "name": "Url", "type": "string", "required": true, "description": "实时日志投递的自定义 HTTP 接口地址，暂仅支持 HTTP/HTTPS 协议。", "example": "http://custom.edgeone.com/post/log" }, { "name": "AccessId", "type": "string", "required": false, "description": "填写自定义的 SecretId 用于生成加密签名，如果源站需要鉴权此参数必填。", "example": "your-access-id" }, { "name": "AccessKey", "type": "string", "required": false, "description": "填写自定义的 SecretKey 用于生成加密签名，如果源站需要鉴权此参数必填。", "example": "your-access-key" }, { "name": "CompressType", "type": "string", "required": false, "description": "数据压缩类型，取值有: gzip：使用 gzip 方式压缩。不填表示不启用压缩。", "example": "gzip" }, { "name": "Protocol", "type": "string", "required": false, "description": "POST 请求投递日志时，使用的应用层协议类型，取值有： http：HTTP 协议； https：HTTPS 协议。如果不填默认根据填写的 URL 地址解析出协议类型。", "example": "https" }, { "name": "Headers", "type": "array", "required": false, "description": "投递日志时携带的自定义请求头。若您填写的头部名称为 Content-Type 等 EdgeOne 日志推送默认携带的头部，那么您填写的头部值将覆盖默认值。头部值引用单个变量${batchSize}，以获取每次 POST 请求中包含的日志条数。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "HTTP头部名称。", "example": "User-Agent" }, { "name": "Value", "type": "string", "required": true, "description": "HTTP头部值。", "example": "TencentEdgeOne" } ] } ] }, { "name": "S3", "type": "object", "required": false, "description": "AWS S3 兼容存储桶的配置信息。当 TaskType 取值为 s3 时，该参数必填。", "example": "无", "children": [ { "name": "Endpoint", "type": "string", "required": true, "description": "不包含存储桶名称或路径的 URL，例如：`https://storage.googleapis.com`、`https://s3.ap-northeast-2.amazonaws.com`、`https://cos.ap-nanjing.myqcloud.com`。", "example": "https://cos.ap-beijing.myqcloud.com" }, { "name": "Region", "type": "string", "required": true, "description": "存储桶所在的地域，例如：`ap-northeast-2`。", "example": "ap-beijing" }, { "name": "Bucket", "type": "string", "required": true, "description": "存储桶名称和日志存储目录，例如：`your_bucket_name/EO-logs/`。如果存储桶中无此目录则会自动创建。", "example": "test-s3-1310708577/hello/world" }, { "name": "AccessId", "type": "string", "required": true, "description": "访问存储桶使用的 Access Key ID。", "example": "TeAI8Ye2MkUAWoNJCk" }, { "name": "AccessKey", "type": "string", "required": true, "description": "访问存储桶使用的 secret key。", "example": "MsiAACHihAAXuH83Ayd7j0VRJ9SYNCOSxwe" }, { "name": "CompressType", "type": "string", "required": false, "description": "数据压缩类型，取值有: gzip：gzip压缩。不填表示不启用压缩。", "example": "gzip" } ] } ], "required": [ "ZoneId", "TaskName", "TaskType", "EntityList", "LogType", "Area", "Fields" ] }, { "name": "CreateRule", "description": "本接口为旧版本创建规则引擎接口，EdgeOne 于 2025 年 1 月 21 日已对规则引擎相关接口全面升级，新版本创建七层加速规则接口详情请参考 [CreateL7AccRules](https://cloud.tencent.com/document/product/1552/115822)。 注意：自 2025 年 1 月 21 日起，旧版接口停止更新迭代，后续新增功能将仅在新版接口中提供，旧版接口支持的原有能力将不受影响。为避免在使用旧版接口时出现数据字段冲突，建议...", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-27q0p0bali16" }, { "name": "RuleName", "type": "string", "required": true, "description": "规则名称，名称字符串长度 1～255。", "example": "rule test" }, { "name": "Status", "type": "string", "required": true, "description": "规则状态，取值有： enable: 启用； disable: 未启用。", "example": "enable" }, { "name": "Rules", "type": "array", "required": true, "description": "规则内容。", "example": "无", "item_type": "object", "children": [ { "name": "Conditions", "type": "array", "required": true, "description": "执行功能判断条件。 注意：满足该数组内任意一项条件，功能即可执行。", "example": "[]", "item_type": "object", "children": [ { "name": "Conditions", "type": "array", "required": true, "description": "规则引擎条件，该数组内所有项全部满足即判断该条件满足。", "example": "[]", "item_type": "object", "children": [ { "name": "Operator", "type": "string", "required": true, "description": "运算符，取值有： equal: 等于； notequal: 不等于； exist: 存在； notexist: 不存在。", "example": "equal" }, { "name": "Target", "type": "string", "required": true, "description": "匹配类型，取值有： 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...", "example": "url" }, { "name": "Values", "type": "array", "required": false, "description": "对应匹配类型的参数值，仅在匹配类型为查询字符串或HTTP请求头并且运算符取值为存在或不存在时允许传空数组，对应匹配类型有： 文件后缀：jpg、txt 等文件后缀； 文件名称：例如 foo.jpg 中的 foo； 全部（站点任意请求）：all； HOST：当前站点下的 host ，例如www.maxx55.com； URL Path：当前站点下 URL 路径的请求，例如：/example； URL Full：当前站点下完整 URL 请求，必须包含 HTTP 协\ufffd...", "example": "[\"www.maxx55.com\"]", "item_type": "string" }, { "name": "IgnoreCase", "type": "boolean", "required": false, "description": "是否忽略参数值的大小写，默认值为 false。", "example": "true" }, { "name": "Name", "type": "string", "required": false, "description": "对应匹配类型的参数名称，在 Target 值为以下取值时有效，有效时值不能为空： query_string（查询字符串）: 当前站点下URL请求中查询字符串的参数名称，例如lang=cn\u0026version=1中的lang和version； request_header（HTTP 请求头）: HTTP请求头部字段名，例如Accept-Language:zh-CN,zh;q=0.9中的Accept-Language。", "example": "Accept-Language" } ] } ] }, { "name": "Actions", "type": "array", "required": false, "description": "执行的功能。注意：Actions 和 SubRules 不可都为空", "example": "[]", "item_type": "object", "children": [ { "name": "NormalAction", "type": "object", "required": false, "description": "常规功能操作，选择该类型的功能项有： 访问URL 重写（AccessUrlRedirect）； 回源 URL 重写 （UpstreamUrlRedirect）； QUIC（QUIC）； WebSocket （WebSocket）； 视频拖拽（VideoSeek）； Token 鉴权（Authentication）； 自定义CacheKey（CacheKey）； 节点缓存 TTL （Cache）； 浏览器缓存 TTL（MaxAge）； 离线缓存（OfflineCache）； 智能加速（SmartRouting）； 分片回源（RangeOriginPull）； HTTP/2 回源（UpstreamHttp2）\ufffd\ufffd...", "example": "无", "children": [ { "name": "Action", "type": "string", "required": true, "description": "功能名称，功能名称填写规范可调用接口 [查询规则引擎的设置参数](https://cloud.tencent.com/document/product/1552/80618) 查看。", "example": "AccessUrlRedirect" }, { "name": "Parameters", "type": "array", "required": true, "description": "参数。", "example": "[]", "item_type": "string" } ] }, { "name": "RewriteAction", "type": "object", "required": false, "description": "带有请求头/响应头的功能操作，选择该类型的功能项有： 修改 HTTP 请求头（RequestHeader）； 修改HTTP响应头（ResponseHeader）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Action", "type": "string", "required": true, "description": "功能名称，功能名称填写规范可调用接口 [查询规则引擎的设置参数](https://cloud.tencent.com/document/product/1552/80618) 查看。", "example": "ResponseHeader" }, { "name": "Parameters", "type": "array", "required": true, "description": "参数。", "example": "[]", "item_type": "string" } ] }, { "name": "CodeAction", "type": "object", "required": false, "description": "带有状态码的功能操作，选择该类型的功能项有： 自定义错误页面（ErrorPage）； 状态码缓存 TTL（StatusCodeCache）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Action", "type": "string", "required": true, "description": "功能名称，功能名称填写规范可调用接口 [查询规则引擎的设置参数](https://cloud.tencent.com/document/product/1552/80618) 查看。", "example": "StatusCodeCache" }, { "name": "Parameters", "type": "array", "required": true, "description": "操作参数。", "example": "[]", "item_type": "string" } ] } ] }, { "name": "SubRules", "type": "array", "required": false, "description": "嵌套规则。注意：SubRules 和 Actions 不可都为空", "example": "[]", "item_type": "object", "children": [ { "name": "Rules", "type": "array", "required": true, "description": "嵌套规则信息。", "example": "无", "item_type": "object", "children": [ { "name": "Conditions", "type": "array", "required": true, "description": "执行功能判断条件。 注意：满足该数组内任意一项条件，功能即可执行。", "example": "[]", "item_type": "string" }, { "name": "Actions", "type": "array", "required": true, "description": "执行的功能。", "example": "[]", "item_type": "string" } ] }, { "name": "Tags", "type": "array", "required": false, "description": "规则标签。", "example": "[\"cache\"]", "item_type": "string" } ] } ] }, { "name": "Tags", "type": "array", "required": false, "description": "规则标签。", "example": "[\"Cache Key Configuration\"]", "item_type": "string" } ], "required": [ "ZoneId", "RuleName", "Status", "Rules" ] }, { "name": "CreateSecurityAPIResource", "description": "用于创建 API 资源。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "\"zone-nqicqhasui\"\t" }, { "name": "APIResources", "type": "array", "required": false, "description": "API 资源列表。", "example": "无", "item_type": "object", "children": [ { "name": "Id", "type": "string", "required": false, "description": "资源 ID。", "example": "\"eoapi-2184008405\"" }, { "name": "Name", "type": "string", "required": false, "description": "资源名称。", "example": "\"test\"" }, { "name": "APIServiceIds", "type": "array", "required": false, "description": "API 资源关联的 API 服务 ID 列表。", "example": "\"fekafe\"", "item_type": "string" }, { "name": "Path", "type": "string", "required": false, "description": "资源路径。", "example": "\"/resource\"" }, { "name": "Methods", "type": "array", "required": false, "description": "请求方法列表。支持以下取值：GET, POST, PUT, HEAD, PATCH, OPTIONS, DELETE。", "example": "\"PUT\"", "item_type": "string" }, { "name": "RequestConstraint", "type": "string", "required": false, "description": "请求内容匹配规则的具体内容，需符合表达式语法，详细规范参见产品文档。", "example": "无" } ] } ], "required": [ "ZoneId" ] }, { "name": "CreateSecurityAPIService", "description": "用于创建 API 服务。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "\"zone-nqicqhasui\"\t" }, { "name": "APIServices", "type": "array", "required": false, "description": "API 服务列表。", "example": "无", "item_type": "object", "children": [ { "name": "Id", "type": "string", "required": false, "description": "API 服务 ID。", "example": "\"eoapi-2184008405\"" }, { "name": "Name", "type": "string", "required": false, "description": "API 服务名称。", "example": "“test”" }, { "name": "BasePath", "type": "string", "required": false, "description": "基础路径。", "example": "\"aef\"" } ] } ], "required": [ "ZoneId" ] }, { "name": "CreateSecurityClientAttester", "description": "创建客户端认证选项。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "\"zone-nqicqhasui\"\t" }, { "name": "ClientAttesters", "type": "array", "required": false, "description": "认证选项列表。", "example": "无", "item_type": "object", "children": [ { "name": "Id", "type": "string", "required": false, "description": "认证选项 ID。", "example": "\"challenge-21820202\"" }, { "name": "Name", "type": "string", "required": false, "description": "认证选项名称。", "example": "\"test\"" }, { "name": "Type", "type": "string", "required": false, "description": "认证规则类型。仅出参返回，取值有： PRESET: 系统预置规则，仅允许修改 AttesterDuration； CUSTOM: 用户自定义规则。", "example": "\"customer\"" }, { "name": "AttesterSource", "type": "string", "required": false, "description": "认证方法。取值有： TC-RCE: 使用风险识别 RCE 进行认证； TC-CAPTCHA: 使用天御验证码进行认证。", "example": "\"turing-rce\"" }, { "name": "AttesterDuration", "type": "string", "required": false, "description": "认证有效时间。默认为 60s，支持的单位有： s：秒，取值范围 60～43200； m：分，取值范围 1～720； h：小时，取值范围 1～12。", "example": "300s" }, { "name": "TCRCEOption", "type": "object", "required": false, "description": "TC-RCE 认证的配置信息。 当 AttesterSource 参数值为 TC-RCE 时，此字段必填。", "example": "无", "children": [ { "name": "Channel", "type": "string", "required": true, "description": "Channel 信息。", "example": "\"21332123\"" }, { "name": "Region", "type": "string", "required": false, "description": "RCE Channel 的开通地域，目前可选的取值范围：ap-beijing：华北地区（北京）；ap-jakarta：亚太东南（雅加达）；ap-singapore：亚太东南（新加坡）；eu-frankfurt：欧洲地区（法兰克福）；na-siliconvalley：美国西部（硅谷）。", "example": "\"ap-beijing\"" } ] }, { "name": "TCCaptchaOption", "type": "object", "required": false, "description": "TC-CAPTCHA 认证的配置信息。 当 AttesterSource 参数值为 TC-CAPTCHA 时，此字段必填。", "example": "无", "children": [ { "name": "CaptchaAppId", "type": "string", "required": true, "description": "CaptchaAppId 信息。", "example": "无" }, { "name": "AppSecretKey", "type": "string", "required": true, "description": "AppSecretKey 信息。", "example": "无" } ] } ] } ], "required": [ "ZoneId" ] }, { "name": "CreateSecurityIPGroup", "description": "创建安全 IP 组", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 Id。", "example": "zone-j94jf0a1" }, { "name": "IPGroup", "type": "object", "required": true, "description": "IP 组信息。", "example": "无", "children": [ { "name": "GroupId", "type": "integer", "required": true, "description": "组 Id，创建时填 0 即可。", "example": "11" }, { "name": "Name", "type": "string", "required": true, "description": "组名称。", "example": "group1" }, { "name": "Content", "type": "array", "required": true, "description": "IP 组内容，仅支持 IP 及 IP 网段。", "example": "[\"1.1.1.1\", \"2.2.2.2\"]", "item_type": "string" }, { "name": "IPTotalCount", "type": "integer", "required": false, "description": "IP 组中正在生效的 IP 或网段个数。作为出参时有效，作为入参时无需填写该字段。", "example": "100" }, { "name": "IPExpireInfo", "type": "array", "required": false, "description": "IP 定时过期信息。 作为入参，用于为指定的 IP 地址或网段配置定时过期时间。 作为出参，包含以下两类信息： 当前未到期的定时过期信息：尚未触发的过期配置。 一周内已到期的定时过期信息：已触发的过期配置。", "example": "[ { \"Time\": \"2022-01-01T00:00:00+08:00\", \"IP\": [ \"1.1.1.1\", \"2.2.2.2\" ] }, { \"Time\": \"2022-01-02T00:00:00+08:00\", \"IP\": [ \"3.3.3.3\" ] } ]", "item_type": "object", "children": [ { "name": "ExpireTime", "type": "string", "required": false, "description": "定时过期时间，遵循 ISO 8601 标准的日期和时间格式。例如 \"2022-01-01T00:00:00+08:00\"。", "example": "\"2022-01-01T00:00:00+08:00\"" }, { "name": "IPList", "type": "array", "required": false, "description": "IP 列表。仅支持 IP 及 IP 网段。", "example": "[\"1.1.1.1\",\"2.2.2.2\"]", "item_type": "string" } ] } ] } ], "required": [ "ZoneId", "IPGroup" ] }, { "name": "CreateSecurityJSInjectionRule", "description": "创建 JavaScript 注入规则。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "\"zone-nqicqhasui\"\t" }, { "name": "JSInjectionRules", "type": "array", "required": false, "description": "JavaScript 注入规则列表。", "example": "无", "item_type": "object", "children": [ { "name": "RuleId", "type": "string", "required": false, "description": "规则 ID。", "example": "\"ch-12133123\"" }, { "name": "Name", "type": "string", "required": false, "description": "规则名称。", "example": "\"test\"" }, { "name": "Priority", "type": "integer", "required": false, "description": "规则优先级，数值越小越优先执行，范围是 0 ~ 100，默认为 0。", "example": "1" }, { "name": "Condition", "type": "string", "required": false, "description": "匹配条件内容。需符合表达式语法，详细规范参见产品文档。", "example": "\"a\"" }, { "name": "InjectJS", "type": "string", "required": false, "description": "JavaScript 注入选项。默认值为 run-attestations，取值有： no-injection: 不注入 JavaScript; inject-sdk-only: 注入当前支持的所有认证方式的 SDK，当前支持：TC-RCE 和 TC-CAPTCHA。注意：若需执行认证检测，请配置挑战规则。", "example": "\"on\"" } ] } ], "required": [ "ZoneId" ] }, { "name": "CreateSharedCNAME", "description": "用于创建共享 CNAME，该功能白名单内测中。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "共享 CNAME 所属站点的 ID。", "example": "zone-2drvsif25rt7" }, { "name": "SharedCNAMEPrefix", "type": "string", "required": true, "description": "共享 CNAME 前缀。请输入合法的域名前缀，例如\"test-api\"、\"test-api.com\"，限制输入 50 个字符。 共享 CNAME 完整格式为：`++share.dnse[0-5].com`。 例如前缀传入 example.com，EO 会为您创建共享 CNAME：example.com.sai2ig51kaa5.share.dnse2.com。", "example": "example.com" }, { "name": "Description", "type": "string", "required": false, "description": "描述。可输入 1-50 个任意字符。", "example": "用于业务 A 场景" } ], "required": [ "ZoneId", "SharedCNAMEPrefix" ] }, { "name": "CreateWebSecurityTemplate", "description": "创建安全策略配置模板", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。该参数明确策略模板在访问权限上归属的站点。", "example": "zone-2wkpkd5gzvms" }, { "name": "TemplateName", "type": "string", "required": true, "description": "策略模板名称。由中文、英文、数字和下划线组成，不能以下划线开头，且长度不能超过 32 个字符。", "example": "大促活动护航" }, { "name": "SecurityPolicy", "type": "object", "required": false, "description": "安全策略模板配置内容，字段为空时生成默认配置。目前支持 Web 防护模块中的例外规则、自定义规则、速率限制规则和托管规则配置，通过表达式语法对安全策略进行配置。 Bot 管理规则配置暂不支持，正在开发中。", "example": "无", "children": [ { "name": "CustomRules", "type": "object", "required": false, "description": "自定义规则配置。", "example": "无", "children": [ { "name": "Rules", "type": "array", "required": false, "description": "自定义规则的定义列表。使用 ModifySecurityPolicy 修改 Web 防护配置时: - 若未指定 Rules 参数，或 Rules 参数长度为零：清空所有自定义规则配置。 - 若 SecurityPolicy 参数中，未指定 CustomRules 参数值：保持已有自定义规则配置，不做修改。", "example": "参考 CustomRule 结构", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "自定义规则的名称。", "example": "SampleBasicACLRule" }, { "name": "Condition", "type": "string", "required": true, "description": "自定义规则的具体内容，需符合表达式语法，详细规范参见产品文档。", "example": "${http.request.ip} in ['1.1.1.1', '10.10.10.0/24', ${security.ip_group['123'@'zone-2xsnpvkhdjes']} ]" }, { "name": "Action", "type": "object", "required": true, "description": "自定义规则的执行动作。 SecurityAction 的 Name 取值支持：Deny：拦截；Monitor：观察；ReturnCustomPage：使用指定页面拦截；Redirect：重定向至 URL；BlockIP：IP 封禁；JSChallenge：JavaScript 挑战；ManagedChallenge：托管挑战；Allow：放行。", "example": "参考SecurityAction结构" }, { "name": "Enabled", "type": "string", "required": true, "description": "自定义规则是否开启。取值有：on：开启off：关闭", "example": "on" }, { "name": "Id", "type": "string", "required": false, "description": "自定义规则的 ID。通过规则 ID 可支持不同的规则配置操作： - 增加新规则：ID 为空或不指定 ID 参数； - 修改已有规则：指定需要更新/修改的规则 ID； - 删除已有规则：CustomRules 参数中，Rules 列表中未包含的已有规则将被删除。", "example": "1492837231" }, { "name": "RuleType", "type": "string", "required": false, "description": "自定义规则的类型。取值有：BasicAccessRule：基础访问管控；PreciseMatchRule：精准匹配规则，默认；ManagedAccessRule：专家定制规则，仅出参。默认为PreciseMatchRule。", "example": "PreciseMatchRule" }, { "name": "Priority", "type": "integer", "required": false, "description": "自定义规则的优先级，范围是 0 ~ 100，默认为 0，仅支持精准匹配规则（PreciseMatchRule）。", "example": "10" } ] } ] }, { "name": "ManagedRules", "type": "object", "required": false, "description": "托管规则配置。", "example": "无", "children": [ { "name": "Enabled", "type": "string", "required": true, "description": "托管规则是否开启。取值有：on：开启，所有托管规则按配置生效；off：关闭，所有托管规则不生效。", "example": "on" }, { "name": "DetectionOnly", "type": "string", "required": true, "description": "评估模式是否开启，仅在 Enabled 参数为 on 时有效。取值有：on：开启，表示所有托管规则以观察模式生效；off：关闭，表示所有托管规则以实际配置生效。", "example": "on" }, { "name": "SemanticAnalysis", "type": "string", "required": false, "description": "托管规则语义分析选项是否开启，仅在 Enabled 参数为 on 时有效。取值有：on：开启，对请求进行语义分析后进行处理；off：关闭，对请求不进行语义分析，直接进行处理。 默认为 off。", "example": "on" }, { "name": "AutoUpdate", "type": "object", "required": false, "description": "托管规则自动更新选项。", "example": "无", "children": [ { "name": "AutoUpdateToLatestVersion", "type": "string", "required": true, "description": "是否开启自动更新至最新版本。取值有：on：开启off：关闭", "example": "on" }, { "name": "RulesetVersion", "type": "string", "required": false, "description": "当前使用的版本，格式符合ISO 8601标准，如2023-12-21T12:00:32Z，默认为空，仅出参。", "example": "2023-12-21T12:00:32Z" } ] }, { "name": "ManagedRuleGroups", "type": "array", "required": false, "description": "托管规则组的配置。如果此结构传空数组或 GroupId 未包含在列表内将按照默认方式处理。", "example": "无", "item_type": "object", "children": [ { "name": "GroupId", "type": "string", "required": true, "description": "托管规则的组名称，未指定配置的规则分组将按照默认配置处理，GroupId 的具体取值参考产品文档。", "example": "wafmanagedrulegroup-file-upload-attacks" }, { "name": "SensitivityLevel", "type": "string", "required": true, "description": "托管规则组的防护级别。取值有：loose：宽松，只包含超高风险规则，此时需配置Action，且RuleActions配置无效；normal：正常，包含超高风险和高风险规则，此时需配置Action，且RuleActions配置无效；strict：严格，包含超高风险、高风险和中风险规则，此时需配置Action，且RuleActions配置无效；extreme：超严格，包含超高风险、高风险、中风险和低风险规则，此时需配置Action，且RuleActions...", "example": "loose" }, { "name": "Action", "type": "object", "required": true, "description": "托管规则组的处置动作。SecurityAction 的 Name 取值支持：Deny：拦截，响应拦截页面；Monitor：观察，不处理请求记录安全事件到日志中；Disabled：未启用，不扫描请求跳过该规则。", "example": "参考 SecurityAction 结构。" }, { "name": "RuleActions", "type": "array", "required": false, "description": "托管规则组下规则项的具体配置，仅在 SensitivityLevel 为 custom 时配置生效。", "example": "参考 ManagedRuleAction 结构。", "item_type": "string" }, { "name": "MetaData", "type": "object", "required": false, "description": "托管规则组信息，仅出参。", "example": "参考 ManagedRuleGroupMeta 结构。" } ] }, { "name": "FrequentScanningProtection", "type": "object", "required": false, "description": "高频扫描防护配置选项，当某一访客的请求频繁命中「配置为拦截」的托管规则时，在一段时间内封禁该访客所有请求。", "example": "无", "children": [ { "name": "Enabled", "type": "string", "required": false, "description": "高频扫描防护规则是否开启。取值有：on：开启，高频扫描防护规则生效；off：关闭，高频扫描防护规则不生效。", "example": "on" }, { "name": "Action", "type": "object", "required": false, "description": "高频扫描防护的处置动作。 当 Enabled 为 on 时，此字段必填。SecurityAction 的 Name 取值支持：Deny：拦截，响应拦截页面；Monitor：观察，不处理请求记录安全事件到日志中；JSChallenge：JavaScript 挑战，响应 JavaScript 挑战页面。", "example": "无" }, { "name": "CountBy", "type": "string", "required": false, "description": "请求统计的匹配方式，当 Enabled 为 on 时，此字段必填。取值有：http.request.xff_header_ip：客户端 IP（优先匹配 XFF 头部）；http.request.ip：客户端 IP。", "example": "http.request.ip" }, { "name": "BlockThreshold", "type": "integer", "required": false, "description": "此参数指定高频扫描防护的阈值，即在 CountingPeriod 所设置时间范围内命中「配置为拦截」的托管规则时的累计拦截次数，取值范围 1 ~ 4294967294，例如 100，当超过此统计值时，后续请求将触发 Action 所设置的处置动作。当 Enabled 为 on 时，此字段必填。", "example": "100" }, { "name": "CountingPeriod", "type": "string", "required": false, "description": "此参数指定高频扫描防护所统计的时间窗口，即命中「配置为拦截」的托管规则的请求的统计时间窗口，取值 5 ~ 1800，单位仅支持秒（s），例如 5s。 当 Enabled 为 on 时，此字段必填。", "example": "10s" }, { "name": "ActionDuration", "type": "string", "required": false, "description": "此参数指定高频扫描防护 Action 参数所设置处置动作的持续时长，取值范围 60 ~ 86400，单位仅支持秒（s），例如 60s。当 Enabled 为 on 时，此字段必填。", "example": "60s" } ] } ] }, { "name": "HttpDDoSProtection", "type": "object", "required": false, "description": "HTTP DDOS 防护配置。", "example": "无", "children": [ { "name": "AdaptiveFrequencyControl", "type": "object", "required": false, "description": "自适应频控的具体配置。", "example": "无", "children": [ { "name": "Enabled", "type": "string", "required": true, "description": "自适应频控是否开启。取值有：on：开启；off：关闭。", "example": "on" }, { "name": "Sensitivity", "type": "string", "required": false, "description": "自适应频控的限制等级，当 Enabled 为 on 时，此字段必填。取值有：Loose：宽松；Moderate：适中；Strict：严格。", "example": "Loose" }, { "name": "Action", "type": "object", "required": false, "description": "自适应频控的处置方式，当 Enabled 为 on 时，此字段必填。SecurityAction 的 Name 取值支持：Monitor：观察；Deny：拦截；Challenge：挑战，其中ChallengeActionParameters.Name仅支持JSChallenge。", "example": "无" } ] }, { "name": "ClientFiltering", "type": "object", "required": false, "description": "智能客户端过滤的具体配置。", "example": "无", "children": [ { "name": "Enabled", "type": "string", "required": true, "description": "智能客户端过滤是否开启。取值有：on：开启；off：关闭。", "example": "on" }, { "name": "Action", "type": "object", "required": false, "description": "智能客户端过滤的处置方式，当 Enabled 为 on 时，此字段必填。SecurityAction 的 Name 取值支持：Monitor：观察；Deny：拦截；Challenge：挑战，其中ChallengeActionParameters.Name仅支持JSChallenge。", "example": "无" } ] }, { "name": "BandwidthAbuseDefense", "type": "object", "required": false, "description": "流量防盗刷的具体配置。", "example": "无", "children": [ { "name": "Enabled", "type": "string", "required": true, "description": "流量防盗刷（仅适用中国大陆地区）是否开启。取值有：on：开启；off：关闭。", "example": "on" }, { "name": "Action", "type": "object", "required": false, "description": "流量防盗刷（仅适用中国大陆地区）的处置方式，当 Enabled 为 on 时，此字段必填。SecurityAction 的 Name 取值支持：Monitor：观察；Deny：拦截；Challenge：挑战，其中ChallengeActionParameters.Name仅支持JSChallenge。", "example": "参考 SecurityAction 结构" } ] }, { "name": "SlowAttackDefense", "type": "object", "required": false, "description": "慢速攻击防护的具体配置。", "example": "无", "children": [ { "name": "Enabled", "type": "string", "required": true, "description": "慢速攻击防护是否开启。取值有：on：开启；off：关闭。", "example": "on" }, { "name": "Action", "type": "object", "required": false, "description": "慢速攻击防护的处置方式，当 Enabled 为 on 时，此字段必填。SecurityAction 的 Name 取值支持：Monitor：观察；Deny：拦截；", "example": "无" }, { "name": "MinimalRequestBodyTransferRate", "type": "object", "required": false, "description": "正文传输最小速率阈值的具体配置，当 Enabled 为 on 时，此字段必填。", "example": "无" }, { "name": "RequestBodyTransferTimeout", "type": "object", "required": false, "description": "正文传输超时时长的具体配置，当 Enabled 为 on 时，此字段必填。", "example": "无" } ] } ] }, { "name": "RateLimitingRules", "type": "object", "required": false, "description": "速率限制规则配置。", "example": "无", "children": [ { "name": "Rules", "type": "array", "required": false, "description": "精准速率限制的定义列表。使用 ModifySecurityPolicy 修改 Web 防护配置时: 若未指定 Rules 参数，或 Rules 参数长度为零：清空所有精准速率限制配置。 若 SecurityPolicy 参数中，未指定 RateLimitingRules 参数值：保持已有自定义规则配置，不做修改。", "example": "无", "item_type": "object", "children": [ { "name": "Id", "type": "string", "required": false, "description": "精准速率限制的 ID。通过规则 ID 可支持不同的规则配置操作： 增加新规则：ID 为空或不指定 ID 参数；修改已有规则：指定需要更新/修改的规则 ID；删除已有规则：RateLimitingRules 参数中，Rules 列表中未包含的已有规则将被删除。", "example": "2181399690" }, { "name": "Name", "type": "string", "required": false, "description": "精准速率限制的名称。", "example": "SampleHttpDdosRule" }, { "name": "Condition", "type": "string", "required": false, "description": "精准速率限制的具体内容，需符合表达式语法，详细规范参见[产品文档](https://cloud.tencent.com/document/product/1552/125343)。", "example": "${http.request.uri.path} in ['/api/v3/test','/api/v3/submit']" }, { "name": "CountBy", "type": "array", "required": false, "description": "速率阈值请求特征的匹配方式， 当 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-ag...", "example": "http.request.ip", "item_type": "string" }, { "name": "MaxRequestThreshold", "type": "integer", "required": false, "description": "精准速率限制在时间范围内的累计拦截次数，取值范围 1 ~ 100000。", "example": "100" }, { "name": "CountingPeriod", "type": "string", "required": false, "description": "统计的时间窗口，取值有：1s：1秒；5s：5秒；10s：10秒；20s：20秒；30s：30秒；40s：40秒；50s：50秒；1m：1分钟；2m：2分钟；5m：5分钟；10m：10分钟；1h：1小时。", "example": "10s" }, { "name": "ActionDuration", "type": "string", "required": false, "description": "Action 动作的持续时长，单位仅支持：s：秒，取值 1 ~ 120；m：分钟，取值 1 ~ 120；h：小时，取值 1 ~ 48；d：天，取值 1 ~ 30。", "example": "60s" }, { "name": "Action", "type": "object", "required": false, "description": "精准速率限制的处置方式。取值有：Monitor：观察；Deny：拦截，其中DenyActionParameters.Name支持Deny和ReturnCustomPage；Challenge：挑战，其中ChallengeActionParameters.Name支持JSChallenge和ManagedChallenge；Redirect：重定向至URL；", "example": "无" }, { "name": "Priority", "type": "integer", "required": false, "description": "精准速率限制的优先级，范围是 0 ~ 100，默认为 0。", "example": "50" }, { "name": "Enabled", "type": "string", "required": false, "description": "精准速率限制规则是否开启。取值有：on：开启；off：关闭。", "example": "on" } ] } ] }, { "name": "ExceptionRules", "type": "object", "required": false, "description": "例外规则配置。", "example": "无", "children": [ { "name": "Rules", "type": "array", "required": false, "description": "例外规则的定义列表。使用 ModifySecurityPolicy 修改 Web 防护配置时: 若未指定 Rules 参数，或 Rules 参数长度为零：清空所有例外规则配置。若 SecurityPolicy 参数中，未指定 ExceptionRules 参数值：保持已有例外规则配置，不做修改。", "example": "参考 ExceptionRule 结构", "item_type": "object", "children": [ { "name": "Id", "type": "string", "required": false, "description": "例外规则的 ID。通过规则 ID 可支持不同的规则配置操作： 增加新规则：ID 为空或不指定 ID 参数； 修改已有规则：指定需要更新/修改的规则 ID； 删除已有规则：ExceptionRules 参数中，Rules 列表中未包含的已有规则将被删除。", "example": "2181399686" }, { "name": "Name", "type": "string", "required": false, "description": "例外规则的名称。", "example": "SampleBasicExceptionRule" }, { "name": "Condition", "type": "string", "required": false, "description": "例外规则的具体内容，需符合表达式语法，详细规范参见产品文档。", "example": "${http.request.uri.path} in ['/api/v3/test','/api/v3/submit'] and ${http.request.method} in ['POST']" }, { "name": "SkipScope", "type": "string", "required": false, "description": "例外规则执行选项，取值有：WebSecurityModules: 指定例外规则的安全防护模块。ManagedRules：指定托管规则。", "example": "WebSecurityModules" }, { "name": "SkipOption", "type": "string", "required": false, "description": "跳过请求的具体类型，取值有：SkipOnAllRequestFields: 跳过所有请求；SkipOnSpecifiedRequestFields: 跳过指定请求字段。仅当 SkipScope 为 ManagedRules 时有效。", "example": "SkipOnSpecifiedRequestFields" }, { "name": "WebSecurityModulesForException", "type": "array", "required": false, "description": "指定例外规则的安全防护模块，仅当 SkipScope 为 WebSecurityModules 时有效。取值有：websec-mod-managed-rules：托管规则；websec-mod-rate-limiting：速率限制；websec-mod-custom-rules：自定义规则；websec-mod-adaptive-control：自适应频控、智能客户端过滤、慢速攻击防护、流量盗刷防护；websec-mod-bot：Bot管理。", "example": "[\"websec-mod-custom-rules\",\"websec-mod-rate-limiting\"]", "item_type": "string" }, { "name": "ManagedRulesForException", "type": "array", "required": false, "description": "指定例外规则的具体托管规则，仅当 SkipScope 为 ManagedRules 时有效，且此时不能指定 ManagedRuleGroupsForException 。", "example": "[\"4401215074\",\"4368124487\"]", "item_type": "string" }, { "name": "ManagedRuleGroupsForException", "type": "array", "required": false, "description": "指定例外规则的托管规则组，仅当 SkipScope 为 ManagedRules 时有效，且此时不能指定 ManagedRulesForException 。", "example": "[\"wafgroup-sql-injection-attacks\"]", "item_type": "string" }, { "name": "RequestFieldsForException", "type": "array", "required": false, "description": "指定例外规则跳过指定请求字段的具体配置，仅当 SkipScope 为 ManagedRules 并且 SkipOption 为 SkipOnSpecifiedRequestFields 时有效。", "example": "参考 RequestFieldsForException 结构", "item_type": "string" }, { "name": "Enabled", "type": "string", "required": false, "description": "例外规则是否开启。取值有：on：开启off：关闭", "example": "on" } ] } ] }, { "name": "BotManagement", "type": "object", "required": false, "description": "Bot 管理配置。", "example": "无", "children": [ { "name": "Enabled", "type": "string", "required": false, "description": "Bot 管理是否开启。取值有：on：开启；off：关闭。", "example": "on" }, { "name": "CustomRules", "type": "object", "required": false, "description": "Bot 管理的自定义规则，组合各类爬虫和请求行为特征，精准定义 Bot 并配置定制化处置方式。", "example": "无", "children": [ { "name": "Rules", "type": "array", "required": false, "description": "Bot 自定义规则的列表。使用 ModifySecurityPolicy 修改 Web 防护配置时： 若未指定 SecurityPolicy.BotManagement.CustomRules 中的 Rules 参数，或 Rules 参数长度为零：清空所有 Bot 自定义规则配置。 若 SecurityPolicy.BotManagement 参数中，未指定 CustomRules 参数值：保持已有 Bot 自定义规则配置，不做修改。", "example": "无", "item_type": "string" } ] }, { "name": "BasicBotSettings", "type": "object", "required": false, "description": "Bot 管理的基础配置，对策略关联的所有域名生效。可以通过 CustomRules 进行精细化定制。", "example": "无", "children": [ { "name": "SourceIDC", "type": "object", "required": false, "description": "客户端 IP 的来源 IDC 配置，用于处置来自 IDC（数据中心） 的客户端 IP 的访问请求。此类来源请求不是由移动端或浏览器端直接访问。", "example": "无" }, { "name": "SearchEngineBots", "type": "object", "required": false, "description": "搜索引擎爬虫配置，用于处置来自搜索引擎爬虫的请求。此类请求的 IP、User-Agent 或 rDNS 结果匹配已知搜索引擎爬虫。", "example": "无" }, { "name": "KnownBotCategories", "type": "object", "required": false, "description": "商业或开源工具 UA 特征配置（原 UA 特征规则），用于处置来自已知商业工具或开源工具的访问请求。此类请求的 User-Agent 头部符合已知商业或开源工具特征。", "example": "无" }, { "name": "IPReputation", "type": "object", "required": false, "description": "IP 威胁情报库（原客户端画像分析）配置，用于处置近期访问行为具有特定风险特征的客户端 IP。", "example": "无" }, { "name": "BotIntelligence", "type": "object", "required": false, "description": "Bot 智能分析的具体配置。", "example": "无" } ] }, { "name": "ClientAttestationRules", "type": "object", "required": false, "description": "客户端认证规则的定义列表。该功能内测中，如需使用，请提工单。", "example": "无", "children": [ { "name": "Rules", "type": "array", "required": false, "description": "客户端认证的列表。使用 ModifySecurityPolicy 修改 Web 防护配置时： 若未指定 SecurityPolicy.BotManagement.ClientAttestationRules 中的 Rules 参数，或 Rules 参数长度为零：清空所有客户端认证规则配置。 若 SecurityPolicy.BotManagement 参数中，未指定 ClientAttestationRules 参数值：保持已有客户端认证规则配置，不做修改。", "example": "无", "item_type": "string" } ] }, { "name": "BrowserImpersonationDetection", "type": "object", "required": false, "description": "配置浏览器伪造识别规则（原主动特征识别规则）。设置注入 JavaScript 的响应页面范围，浏览器校验选项，以及对非浏览器客户端的处置方式。", "example": "无", "children": [ { "name": "Rules", "type": "array", "required": false, "description": "浏览器伪造识别规则的列表。使用 ModifySecurityPolicy 修改 Web 防护配置时： 若未指定 SecurityPolicy.BotManagement.BrowserImpersonationDetection 中的 Rules 参数，或 Rules 参数长度为零： 清空所有浏览器伪造识别规则配置。 若 SecurityPolicy.BotManagement 参数中，未指定 BrowserImpersonationDetection 参数值： 保持已有浏览器伪造识别规则配置，不做修改。", "example": "无", "item_type": "string" } ] } ] }, { "name": "BotManagementLite", "type": "object", "required": false, "description": "基础 Bot 管理配置。", "example": "无", "children": [ { "name": "CAPTCHAPageChallenge", "type": "object", "required": false, "description": "人机校验页的具体配置。", "example": "无", "children": [ { "name": "Enabled", "type": "string", "required": false, "description": "人机校验页是否开启，取值有：on：开启；off：关闭。", "example": "on" } ] }, { "name": "AICrawlerDetection", "type": "object", "required": false, "description": "AI爬虫检测的具体配置。", "example": "无", "children": [ { "name": "Enabled", "type": "string", "required": false, "description": "AI 爬虫检测是否开启。取值有： on：开启； off：关闭。", "example": "on" }, { "name": "Action", "type": "object", "required": false, "description": "AI 爬虫检测的执行动作，当 Enabled 为 on 时，此字段必填。SecurityAction 的 Name 取值仅支持： Deny：拦截； Monitor：观察； Allow：放行； Challenge：挑战，其中 ChallengeActionParameters 中的 ChallengeOption 仅支持 JSChallenge 和 ManagedChallenge。", "example": "无" } ] } ] } ] } ], "required": [ "ZoneId", "TemplateName" ] }, { "name": "CreateZone", "description": "EdgeOne 为您提供 CNAME、NS 和无域名接入三种接入方式，您需要先通过此接口完成站点创建。CNAME 和 NS 接入站点的场景可参考 [从零开始快速接入 EdgeOne](https://cloud.tencent.com/document/product/1552/87601); 无域名接入的场景可参考 [快速启用四层代理服务](https://cloud.tencent.com/document/product/1552/96051)。 \u003e 建议您在账号下已存在套餐时调用本接口创建站点，请在入参时传入 PlanId ，直接将站点绑...", "status": "online", "parameters": [ { "name": "Type", "type": "string", "required": false, "description": "站点接入类型。该参数取值如下，不填写时默认为 partial： partial：CNAME 接入； full：NS 接入； noDomainAccess：无域名接入； dnsPodAccess：DNSPod 托管接入，该接入模式要求您的域名已托管在 DNSPod 内； ai：边缘推理接入。", "example": "full" }, { "name": "ZoneName", "type": "string", "required": false, "description": "站点名称。CNAME/NS 接入的时，请传入二级域名（example.com）作为站点名称；无域名接入时，该值请保留为空。", "example": "test.com" }, { "name": "Area", "type": "string", "required": false, "description": "Type 取值为 partial/full 时，七层域名的加速区域。以下为该参数取值，不填写时该值默认为 overseas。Type 取值为 noDomainAccess 时该值请保留为空： global: 全球可用区； mainland: 中国大陆可用区； overseas: 全球可用区（不含中国大陆）。", "example": "mainland" }, { "name": "PlanId", "type": "string", "required": false, "description": "待绑定的目标套餐 ID。当您账号下已存在套餐时，可以填写此参数，直接将站点绑定至该套餐。若您当前没有可绑定的套餐时，可通过 [CreatePlan](https://cloud.tencent.com/document/product/1552/105771) 购买套餐。 注意：如果不填写此参数，将创建一个处于“init”状态的站点，该站点为未激活状态，并不会显示在控制台上。您可以通过访问 [BindZoneToPlan](https://cloud.tencent.com/document/product/1552/83...", "example": "edgeone-qqqwwweee" }, { "name": "AliasZoneName", "type": "string", "required": false, "description": "同名站点标识。限制输入数字、英文、\".\" 、\"-\" 和 \"_\"，长度 200 个字符以内。详情参考 [同名站点标识](https://cloud.tencent.com/document/product/1552/70202)，无此使用场景时，该字段保留为空即可。", "example": "zone-example" }, { "name": "Tags", "type": "array", "required": false, "description": "标签。该参数用于对站点进行分权限管控、分账。需要先前往 [标签控制台](https://console.cloud.tencent.com/tag/taglist) 创建对应的标签才可以在此处传入对应的标签键和标签值。", "example": "[a]", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键。 注意：此字段可能返回 null，表示取不到有效值。", "example": "business" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "video" } ] } ], "required": [] }, { "name": "DeleteAccelerationDomains", "description": "批量删除加速域名", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "加速域名所属站点ID。", "example": "zone-225qgrnvbi9w" }, { "name": "DomainNames", "type": "array", "required": true, "description": "需要删除的加速域名ID列表。", "example": "[\"qq.com\"]", "item_type": "string" }, { "name": "Force", "type": "boolean", "required": false, "description": "是否强制删除。当域名存在关联资源（如马甲域名、流量调度功能）时，是否强制删除该域名，取值有： true：删除该域名及所有关联资源； false：当该加速域名存在关联资源时，不允许删除。不填写，默认值为：false。", "example": "true" } ], "required": [ "ZoneId", "DomainNames" ] }, { "name": "DeleteAliasDomain", "description": "删除别称域名。 该功能仅企业版套餐支持，并且该功能当前仍在内测中，如需使用，请[联系我们](https://cloud.tencent.com/online-service?from=connect-us)。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-321dsafuux5x" }, { "name": "AliasNames", "type": "array", "required": false, "description": "待删除别称域名名称。如果为空，则不执行删除操作。", "example": "www.qq.com", "item_type": "string" } ], "required": [ "ZoneId" ] }, { "name": "DeleteApplicationProxy", "description": "本接口为旧版，如需调用请尽快迁移至新版，详情请参考 [删除四层代理实例 ](https://cloud.tencent.com/document/product/1552/103415) 。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点ID。", "example": "zone-67e6b1962" }, { "name": "ProxyId", "type": "string", "required": true, "description": "代理ID。", "example": "proxy-19389e5dwwxfs" } ], "required": [ "ZoneId", "ProxyId" ] }, { "name": "DeleteApplicationProxyRule", "description": "本接口为旧版，如需调用请尽快迁移至新版，详情请参考 [删除四层代理转发规则](https://cloud.tencent.com/document/product/1552/103414) 。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点ID。", "example": "zone-67e6b1962" }, { "name": "ProxyId", "type": "string", "required": true, "description": "代理ID。", "example": "proxy-19389e5dwwxfs" }, { "name": "RuleId", "type": "string", "required": true, "description": "规则ID。", "example": "rule-sdacd" } ], "required": [ "ZoneId", "ProxyId", "RuleId" ] }, { "name": "DeleteContentIdentifier", "description": "删除指定的内容标识符。该功能仅白名单开放。", "status": "online", "parameters": [ { "name": "ContentId", "type": "string", "required": true, "description": "内容标识符 ID。", "example": "eocontent-27q0p0bali16" } ], "required": [ "ContentId" ] }, { "name": "DeleteCustomErrorPage", "description": "删除自定义错误页面。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-2kplomhisdcb" }, { "name": "PageId", "type": "string", "required": true, "description": "自定义页面 ID。", "example": "p-2kplomhisdcb" } ], "required": [ "ZoneId", "PageId" ] }, { "name": "DeleteDnsRecords", "description": "您可以用本接口批量删除 DNS 记录。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-25ryyvog1qih" }, { "name": "RecordIds", "type": "array", "required": true, "description": "待删除的 DNS 记录 ID 列表，上限：1000。", "example": "[\"record-25ryzh92h8\"]\t", "item_type": "string" } ], "required": [ "ZoneId", "RecordIds" ] }, { "name": "DeleteFunction", "description": "删除边缘函数，删除后函数无法恢复，关联的触发规则会一并删除。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-2gqxim9jstab" }, { "name": "FunctionId", "type": "string", "required": true, "description": "函数 ID。", "example": "ef-0agikbrr" } ], "required": [ "ZoneId", "FunctionId" ] }, { "name": "DeleteFunctionRules", "description": "删除边缘函数触发规则。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-2gqxim9jstab" }, { "name": "RuleIds", "type": "array", "required": true, "description": "规则 ID 列表。", "example": "[\"rule-02y3grbu\"]", "item_type": "string" } ], "required": [ "ZoneId", "RuleIds" ] }, { "name": "DeleteJustInTimeTranscodeTemplates", "description": "根据站点 id 下唯一的模板标识，删除相应的即时转码模板。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点ID。", "example": "zone-djuqmq" }, { "name": "TemplateIds", "type": "array", "required": true, "description": "需删除的即时转码模板唯一标识数组，长度限制：100。", "example": "[\"C1LZ7982VgTpYhJ7M\"]", "item_type": "string" } ], "required": [ "ZoneId", "TemplateIds" ] }, { "name": "DeleteL4Proxy", "description": "用于删除四层代理实例。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-67e6b1962" }, { "name": "ProxyId", "type": "string", "required": true, "description": "四层代理实例 ID。", "example": "proxy-19389e5dwwxfs" } ], "required": [ "ZoneId", "ProxyId" ] }, { "name": "DeleteL4ProxyRules", "description": "用于删除四层代理转发规则，支持单条或者批量操作。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-67e6b1962" }, { "name": "ProxyId", "type": "string", "required": true, "description": "四层代理实例 ID。", "example": "proxy-19389e5dwwxfs" }, { "name": "RuleIds", "type": "array", "required": true, "description": "转发规则 ID 列表。单次最多支持 200 条转发规则。", "example": "[\"rule-sdacd\"]", "item_type": "string" } ], "required": [ "ZoneId", "ProxyId", "RuleIds" ] }, { "name": "DeleteL7AccRules", "description": "本接口用于删除[规则引擎](https://cloud.tencent.com/document/product/1552/70901)的规则，支持批量删除。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-26r78x31ny86" }, { "name": "RuleIds", "type": "array", "required": true, "description": "需要删除的规则 ID 列表。您可以通过 DescribeL7AccRules 获取 Ruleid。", "example": "[\"rule-bx3zke8q\"]", "item_type": "string" } ], "required": [ "ZoneId", "RuleIds" ] }, { "name": "DeleteLoadBalancer", "description": "删除负载均衡实例，若负载均衡示例被其他服务（例如：四层代理等）引用的时候，示例无法被删除，需要先解除引用关系。负载均衡功能内测中，如您需要使用请 [联系我们](https://cloud.tencent.com/online-service)。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-27q0p0bali16\t" }, { "name": "InstanceId", "type": "string", "required": true, "description": "负载均衡实例 ID。", "example": "lb-jolaksjdfa" } ], "required": [ "ZoneId", "InstanceId" ] }, { "name": "DeleteMultiPathGateway", "description": "通过本接口删除多通道安全加速网关，包括自有网关和云上网关。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-27q0p0bal192" }, { "name": "GatewayId", "type": "string", "required": true, "description": "网关 ID。", "example": "mpgw-lbxuhk1oh" } ], "required": [ "ZoneId", "GatewayId" ] }, { "name": "DeleteMultiPathGatewayLine", "description": "通过本接口删除接入多通道安全加速网关的线路，仅自定义线路支持删除。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-27q0p0bal192" }, { "name": "GatewayId", "type": "string", "required": true, "description": "网关 ID。", "example": "mpgw-lbxuhk1oh" }, { "name": "LineId", "type": "string", "required": true, "description": "线路 ID。", "example": "line-2" } ], "required": [ "ZoneId", "GatewayId", "LineId" ] }, { "name": "DeleteOriginGroup", "description": "删除源站组，若源站组仍然被服务（例如：四层代理，域名服务，负载均衡，规则引起）引用，将不允许删除。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID", "example": "zone-27q0p0bali16" }, { "name": "GroupId", "type": "string", "required": true, "description": "源站组 ID，此参数必填。", "example": "orgin-2ccgtb24-7dc5-46s2-9r3e-95825d53dwe3a" } ], "required": [ "ZoneId", "GroupId" ] }, { "name": "DeleteRealtimeLogDeliveryTask", "description": "通过本接口删除实时日志投递任务。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-xxxxx" }, { "name": "TaskId", "type": "string", "required": true, "description": "实时日志投递任务 ID。", "example": "ace8680b-55b9-498b-a113-056ab68d1da1" } ], "required": [ "ZoneId", "TaskId" ] }, { "name": "DeleteRules", "description": "本接口为旧版本删除规则引擎接口，EdgeOne 于 2025 年 1 月 21 日已对规则引擎相关接口全面升级，新版本删除七层加速规则接口详情请参考 [DeleteL7AccRules](https://cloud.tencent.com/document/product/1552/115821)。 注意：自 2025 年 1 月 21 日起，旧版接口停止更新迭代，后续新增功能将仅在新版接口中提供，旧版接口支持的原有能力将不受影响。为避免在使用旧版接口时出现数据字段冲突，建议...", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-26r78x31ny86" }, { "name": "RuleIds", "type": "array", "required": true, "description": "指定删除的规则 ID 列表。", "example": "[\"rule-bx3zke8q\"]", "item_type": "string" } ], "required": [ "ZoneId", "RuleIds" ] }, { "name": "DeleteSecurityAPIResource", "description": "用于删除 API 资源。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "\"zone-nqicqhasui\"\t" }, { "name": "APIResourceIds", "type": "array", "required": false, "description": "需要删除的 API 资源 ID 列表。", "example": "[\"eoapi-1230001001\"]", "item_type": "string" } ], "required": [ "ZoneId" ] }, { "name": "DeleteSecurityAPIService", "description": "用于删除 API 服务。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "\"zone-nqicqhasui\"\t" }, { "name": "APIServiceIds", "type": "array", "required": false, "description": "API 服务 ID 列表。", "example": "[\"eoapi-1230001001\"]", "item_type": "string" } ], "required": [ "ZoneId" ] }, { "name": "DeleteSecurityClientAttester", "description": "删除客户端认证选项。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "\"zone-nqicqhasui\"" }, { "name": "ClientAttesterIds", "type": "array", "required": false, "description": "客户端认证选项 ID。", "example": "[\"attest-1233\"]", "item_type": "string" } ], "required": [ "ZoneId" ] }, { "name": "DeleteSecurityIPGroup", "description": "删除指定 IP 组，如果有规则引用了 IP 组情况，则不允许删除。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 Id。", "example": "\"zone-qdwibsa\"" }, { "name": "GroupId", "type": "integer", "required": true, "description": "IP 组 Id。", "example": "1" } ], "required": [ "ZoneId", "GroupId" ] }, { "name": "DeleteSecurityJSInjectionRule", "description": "删除 JavaScript 注入规则。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "\"zone-nqicqhasui\"" }, { "name": "JSInjectionRuleIds", "type": "array", "required": true, "description": "JavaScript 注入规则 ID 列表。", "example": "[\"attest-1233\"]", "item_type": "string" } ], "required": [ "ZoneId", "JSInjectionRuleIds" ] }, { "name": "DeleteSharedCNAME", "description": "用于删除共享 CNAME，该功能白名单内测中。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "共享 CNAME 所属站点 ID。", "example": "zone-2drvsif25rt7" }, { "name": "SharedCNAME", "type": "string", "required": true, "description": "需要删除的共享 CNAME。", "example": "qq.com.sai2ig51kaa5.share.dns2.com" } ], "required": [ "ZoneId", "SharedCNAME" ] }, { "name": "DeleteWebSecurityTemplate", "description": "删除安全策略配置模板", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。需要传入目标策略模板在访问权限上归属的站点，可使用 DescribeWebSecurityTemplates 接口查询策略模板归属的站点。", "example": "zone-2wkpkd52pku8" }, { "name": "TemplateId", "type": "string", "required": true, "description": "策略模板 ID。", "example": "temp-o3xctdd2" } ], "required": [ "ZoneId", "TemplateId" ] }, { "name": "DeleteZone", "description": "删除站点。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-xxxxx" } ], "required": [ "ZoneId" ] }, { "name": "DeployConfigGroupVersion", "description": "在版本管理模式下，用于版本发布，可通过 EnvId 将版本发布至测试环境或生产环境。版本管理功能内测中，当前仅白名单开放。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-yoaan091nx" }, { "name": "EnvId", "type": "string", "required": true, "description": "环境 ID。请填写版本需要发布到的环境 ID。", "example": "env-13aan091nx" }, { "name": "ConfigGroupVersionInfos", "type": "array", "required": true, "description": "需要发布的版本信息。可以同时变更多个不同配置组的版本，每个配置组一次仅支持变更一个版本。", "example": "ver-khasdj345r", "item_type": "object", "children": [ { "name": "VersionId", "type": "string", "required": true, "description": "版本 ID。", "example": "ver-2kplomhisdcb" }, { "name": "VersionNumber", "type": "string", "required": false, "description": "版本号。", "example": "1.0" }, { "name": "GroupId", "type": "string", "required": false, "description": "配置组 ID。", "example": "cg-2kplomhisdcb" }, { "name": "GroupType", "type": "string", "required": false, "description": "配置组类型。取值有： l7_acceleration ：七层加速配置组。 edge_functions ：边缘函数配置组。", "example": "l7_acceleration" }, { "name": "Description", "type": "string", "required": false, "description": "版本描述。", "example": "这是个测试版本" }, { "name": "Status", "type": "string", "required": false, "description": "版本状态，取值有： creating：创建中； inactive：未生效； active：已生效。", "example": "creating " }, { "name": "CreateTime", "type": "string", "required": false, "description": "版本创建时间。时间为世界标准时间（UTC）， 遵循 ISO 8601 标准的日期和时间格式。", "example": "2023-06-30T17:37:56+0800" } ] }, { "name": "Description", "type": "string", "required": true, "description": "变更说明。用于描述此次变更的内容、原因，最大支持 100 个字符。", "example": "变更说明：新增IPV6、CN2等功能" } ], "required": [ "ZoneId", "EnvId", "ConfigGroupVersionInfos", "Description" ] }, { "name": "DescribeAccelerationDomains", "description": "您可以通过本接口查看站点下的域名信息，包括加速域名、源站以及域名状态等信息。您可以查看站点下全部域名的信息，也可以指定过滤条件查询对应的域名信息。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "加速域名所属站点 ID。", "example": "zone-20hyebgyfsko" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量，默认为 0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询限制数目，默认值：20，上限：200。", "example": "10" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，Filters.Values 的上限为 20。该参数不填写时，返回当前 zone-id 下所有域名信息。详细的过滤条件如下： domain-name：按照加速域名进行过滤； origin-type：按照源站类型进行过滤； origin：按照主源站地址进行过滤； backup-origin： 按照备用源站地址进行过滤； domain-cname：按照 CNAME 进行过滤； share-cname：按照共享 CNAME 进行过滤；", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone-name" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"www.qq.com\",\"www.baidu.com\"]", "item_type": "string" }, { "name": "Fuzzy", "type": "boolean", "required": false, "description": "是否启用模糊查询。", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "可根据该字段对返回结果进行排序，取值有： created_on：加速域名创建时间； domain-name：加速域名。不填写时，默认对返回结果按照 domain-name 排序。", "example": "domain-name" }, { "name": "Direction", "type": "string", "required": false, "description": "排序方向，如果是字段值为数字，则根据数字大小排序；如果字段值为文本，则根据 ascill 码的大小排序。取值有： asc：升序排列； desc：降序排列。不填写使用默认值 asc。", "example": "asc" }, { "name": "Match", "type": "string", "required": false, "description": "匹配方式，取值有： all：返回匹配所有查询条件的加速域名； any：返回匹配任意一个查询条件的加速域名。不填写时默认值为 all。", "example": "all" } ], "required": [ "ZoneId" ] }, { "name": "DescribeAliasDomains", "description": "查询别称域名信息列表。 该功能仅企业版套餐支持，并且该功能当前仍在内测中，如需使用，请[联系我们](https://cloud.tencent.com/online-service?from=connect-us)。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-xxx" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量。默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询限制数目。默认值：20，最大值：1000。", "example": "1000" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，Filters.Values的上限为20。详细的过滤条件如下： target-name：目标域名名称进行过滤； alias-name：按照别称域名名称进行过滤。模糊查询时仅支持过滤字段名为 alias-name。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone-name" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"www.qq.com\",\"www.baidu.com\"]", "item_type": "string" }, { "name": "Fuzzy", "type": "boolean", "required": false, "description": "是否启用模糊查询。", "example": "false" } ] } ], "required": [ "ZoneId" ] }, { "name": "DescribeApplicationProxies", "description": "本接口为旧版，如需调用请尽快迁移至新版，新版接口中将四层代理实例列表的查询和四层转发规则的查询拆分成两个接口，详情请参考 [查询四层代理实例列表](https://cloud.tencent.com/document/product/1552/103413) 和 [查询四层代理转发规则列表](https://cloud.tencent.com/document/product/1552/103412)。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": false, "description": "站点ID。该参数必填。", "example": "zone-vawer2vadg" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，Filters.Values的上限为20。详细的过滤条件如下：proxy-id   按照【代理ID】进行过滤。代理ID形如：proxy-ev2sawbwfd。   类型：String   必选：否zone-id   按照【站点ID】进行过滤。站点ID形如：zone-vawer2vadg。   类型：String   必选：否rule-tag   按照【规则标签】对应用代理下的规则进行过滤。规则标签形如：rule-service-1。   类型：String   必选：否", "example": "[{\"Name\": \"proxy-id\", [\"proxy-124521xfqlh4qjee\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone-name" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"qq.com\",\"baidu.com\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量。默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询限制数目。默认值：20，最大值：1000。", "example": "10" } ], "required": [] }, { "name": "DescribeAvailablePlans", "description": "查询当前账户可用套餐信息列表", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeBillingData", "description": "通过本接口查询计费数据。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "起始时间。", "example": "2014-08-03T12:00:00+08:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间。查询时间范围（`EndTime` - `StartTime`）需小于等于 31 天。", "example": "2014-08-03T12:00:00+08:00" }, { "name": "ZoneIds", "type": "array", "required": true, "description": "站点 ID 集合，此参数必填。最多传入 100 个站点 ID。若需查询腾讯云主账号下所有站点数据，请用 `*` 代替，查询账号级别数据需具备本接口全部站点资源权限。", "example": "zone-2siulp074dz3", "item_type": "string" }, { "name": "MetricName", "type": "string", "required": true, "description": "指标列表，取值如下： 四/七层加速流量：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...", "example": "acc_flux" }, { "name": "Interval", "type": "string", "required": true, "description": "查询时间粒度，取值有： 5min：5 分钟粒度； hour：1 小时粒度； day：1 天粒度。", "example": "hour" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，详细的过滤条件取值如下： host：按照域名进行过滤。示例值：test.example.com。 proxy-id：按照四层代理实例 ID 进行过滤。示例值：sid-2rugn89bkla9。 region-id：按照计费大区进行过滤。可选项如下：  CH：中国大陆境内  AF：非洲  AS1：亚太一区  AS2：亚太二区  AS3：亚太三区  EU：欧洲  MidEast：中东  NA：北美  SA：南美 说明：相同 `Type` 的 `BillingDataFilter` 之间为“...", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "参数名称。", "example": "host" }, { "name": "Value", "type": "string", "required": true, "description": "参数值。", "example": "test.example.com" } ] }, { "name": "GroupBy", "type": "array", "required": false, "description": "分组聚合维度。最多允许同时按照两种维度进行分组。取值如下： zone-id：按照站点 ID 进行分组，若使用了内容标识符功能，则优先按照内容标识符分组；host：按照域名进行分组； proxy-id：按照四层代理实例 ID 进行分组； region-id：按照计费大区进行分组。", "example": "zone-id", "item_type": "string" } ], "required": [ "StartTime", "EndTime", "ZoneIds", "MetricName", "Interval" ] }, { "name": "DescribeConfigGroupVersionDetail", "description": "在版本管理模式下，用于获取版本的详细信息，包括版本 ID、描述、状态、创建时间、所属配置组信息以及版本配置文件的内容。版本管理功能内测中，当前仅白名单开放。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-2jwahzkd4cn0" }, { "name": "VersionId", "type": "string", "required": true, "description": "版本 ID。", "example": "ver-2jwahzkd4cn0" } ], "required": [ "ZoneId", "VersionId" ] }, { "name": "DescribeConfigGroupVersions", "description": "在版本管理模式下，用于查询指定配置组的版本列表。版本管理功能内测中，当前仅白名单开放。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-2jwahzkd4cn0" }, { "name": "GroupId", "type": "string", "required": true, "description": "配置组 ID。", "example": "confgroup-27fil18zp2v1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，Filters.Values 的上限为 20，该参数不填写时，返回所选配置组下的所有版本信息。详细的过滤条件如下： version-id：按照版本 ID 进行过滤；", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone-name" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"www.qq.com\",\"www.baidu.com\"]", "item_type": "string" }, { "name": "Fuzzy", "type": "boolean", "required": false, "description": "是否启用模糊查询。", "example": "false" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量。默认值为 0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询限制数目。默认值为 20，最大值为 100。", "example": "20" } ], "required": [ "ZoneId", "GroupId" ] }, { "name": "DescribeContentIdentifiers", "description": "批量查询内容标识符，可以根据 ID、描述、状态或者标签过滤。按照状态查询被删除的内容标识符仅保留三个月。该功能仅白名单开放。", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量。默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询限制数目。默认值：20，最大值：100。", "example": "100" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，Filters 的上限为 20，Filters.Values 的上限为 20。该参数不填写时，默认返回当前 AppId 下有权限的内容标识符。详细的过滤条件如下：description：按照内容标识符描述批量进行过滤；例如：test；content-id：按照内容标识符 ID 批量进行过滤；例如：eocontent-2noz78a8ev6k；tag-key：按照标签键进行过滤； tag-value： 按照标签值进行过滤；status：按照内容标识符状态进行过滤，取值\ufffd\ufffd...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone-name" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"www.qq.com\",\"www.baidu.com\"]", "item_type": "string" }, { "name": "Fuzzy", "type": "boolean", "required": false, "description": "是否启用模糊查询。", "example": "false" } ] } ], "required": [] }, { "name": "DescribeContentQuota", "description": "查询内容管理接口配额", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "8afj24jzg9" } ], "required": [ "ZoneId" ] }, { "name": "DescribeCustomErrorPages", "description": "查询自定义错误页列表。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-2kplomhisdcb" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，Filters.Values 的上限为20，详细的过滤条件Name值如下： page-id： 按照页面 ID 进行过滤； name： 按照页面名称进行过滤； description：按照页面描述过滤； content-type：按照页面类型过滤。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone-name" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"www.qq.com\",\"www.baidu.com\"]", "item_type": "string" }, { "name": "Fuzzy", "type": "boolean", "required": false, "description": "是否启用模糊查询。", "example": "false" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量。默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询限制数目。默认值：20，最大值：1000。", "example": "20" } ], "required": [ "ZoneId" ] }, { "name": "DescribeDDoSAttackData", "description": "本接口（DescribeDDoSAttackData）用于查询DDoS攻击时序数据。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "开始时间。", "example": "2020-04-29T00:00:00Z" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间。查询时间范围（`EndTime` - `StartTime`）需小于等于 31 天。", "example": "2020-04-30T00:00:00Z" }, { "name": "MetricNames", "type": "array", "required": true, "description": "统计指标列表，取值有： ddos_attackMaxBandwidth：攻击带宽峰值； ddos_attackMaxPackageRate：攻击包速率峰值 ； ddos_attackBandwidth：攻击带宽曲线； ddos_attackPackageRate：攻击包速率曲线。", "example": "[\"ddos_attackFlowBandwidth\"]", "item_type": "string" }, { "name": "ZoneIds", "type": "array", "required": false, "description": "站点 ID 集合，此参数将于2024年05月30日后由可选改为必填，详见公告：[【腾讯云 EdgeOne】云 API 变更通知](https://cloud.tencent.com/document/product/1552/104902)。最多传入 100 个站点 ID。若需查询腾讯云主账号下所有站点数据，请用 `*` 代替，查询账号级别数据需具备本接口全部站点资源权限。", "example": "[\"zoneId1\",\"zoneId2\"]", "item_type": "string" }, { "name": "PolicyIds", "type": "array", "required": false, "description": "DDoS策略组ID列表，不填默认选择全部策略ID。", "example": "[123,456]", "item_type": "integer" }, { "name": "Interval", "type": "string", "required": false, "description": "查询时间粒度，取值有： min：1分钟； 5min：5分钟； hour：1小时； day：1天。不填将根据开始时间与结束时间的间隔自动推算粒度，具体为：1小时范围内以min粒度查询，2天范围内以5min粒度查询，7天范围内以hour粒度查询，超过7天以day粒度查询。", "example": "“min”" }, { "name": "Area", "type": "string", "required": false, "description": "数据归属地区，取值有： overseas：全球（除中国大陆地区）数据； mainland：中国大陆地区数据； global：全球数据。不填默认取值为global。", "example": "\"overseas\"" } ], "required": [ "StartTime", "EndTime", "MetricNames" ] }, { "name": "DescribeDDoSAttackEvent", "description": "本接口（DescribeDDoSAttackEvent）用于查询DDoS攻击事件列表。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，时间范围为 30 天。", "example": "2020-04-29T00:00:00Z" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间。查询时间范围（`EndTime` - `StartTime`）需小于等于 31 天。", "example": "2020-04-30T00:00:00Z" }, { "name": "PolicyIds", "type": "array", "required": false, "description": "ddos策略组集合，不填默认选择全部策略。", "example": "[123,456]", "item_type": "integer" }, { "name": "ZoneIds", "type": "array", "required": false, "description": "站点 ID 集合，此参数将于2024年05月30日后由可选改为必填，详见公告：[【腾讯云 EdgeOne】云 API 变更通知](https://cloud.tencent.com/document/product/1552/104902)。最多传入 100 个站点 ID。若需查询腾讯云主账号下所有站点数据，请用 `*` 代替，查询账号级别数据需具备本接口全部站点资源权限。", "example": "[\"zoneId1\",\"zoneId2\"]", "item_type": "string" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询的限制数目，默认值为20，最大查询条目为1000。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量，默认值为0。", "example": "1" }, { "name": "ShowDetail", "type": "boolean", "required": false, "description": "展示攻击详情的参数，若填false，默认只返回攻击次数，不返回攻击详情；若填true，返回攻击详情。", "example": "true" }, { "name": "Area", "type": "string", "required": false, "description": "数据归属地区，取值有： overseas：全球（除中国大陆地区）数据； mainland：中国大陆地区数据； global：全球数据；不填默认取值为global。", "example": "overseas" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段，取值有： MaxBandWidth：带宽峰值； AttackStartTime：攻击开始时间。不填默认值为：AttackStartTime。", "example": "startTime" }, { "name": "OrderType", "type": "string", "required": false, "description": "排序方式，取值有： asc：升序方式； desc：降序方式。不填默认值为：desc。", "example": "asc" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeDDoSAttackTopData", "description": "本接口（DescribeDDoSAttackTopData）用于查询DDoS攻击Top数据。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "开始时间。", "example": "2020-04-29T00:00:00Z" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间。查询时间范围（`EndTime` - `StartTime`）需小于等于 31 天。", "example": "2020-04-30T00:00:00Z" }, { "name": "MetricName", "type": "string", "required": true, "description": "查询的统计指标，取值有： ddos_attackFlux_protocol：按各协议的攻击流量排行； ddos_attackPackageNum_protocol：按各协议的攻击包量排行； ddos_attackNum_attackType：按各攻击类型的攻击数量排行； ddos_attackNum_sregion：按攻击源地区的攻击数量排行； ddos_attackFlux_sip：按攻击源IP的攻击数量排行； ddos_attackFlux_sregion：按攻击源地区的攻击数量排行。", "example": "ddos_attackSource_region" }, { "name": "ZoneIds", "type": "array", "required": false, "description": "站点 ID 集合，此参数将于2024年05月30日后由可选改为必填，详见公告：[【腾讯云 EdgeOne】云 API 变更通知](https://cloud.tencent.com/document/product/1552/104902)。最多传入 100 个站点 ID。若需查询腾讯云主账号下所有站点数据，请用 `*` 代替，查询账号级别数据需具备本接口全部站点资源权限。", "example": "[\"zoneId1\",\"zoneId2\"]", "item_type": "string" }, { "name": "PolicyIds", "type": "array", "required": false, "description": "DDoS策略组ID集合，不填默认选择全部策略ID。", "example": "[123,456]", "item_type": "integer" }, { "name": "AttackType", "type": "string", "required": false, "description": "攻击类型，取值有： flood：洪泛攻击； icmpFlood：icmp洪泛攻击； all：所有的攻击类型。不填默认为all，表示查询全部攻击类型。", "example": "icmp" }, { "name": "ProtocolType", "type": "string", "required": false, "description": "协议类型，取值有： tcp：tcp协议； udp：udp协议； all：所有的协议类型。不填默认为all，表示查询所有协议。", "example": "udp" }, { "name": "Port", "type": "integer", "required": false, "description": "端口号。", "example": "8080" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询前多少个数据，不填默认默认为10， 表示查询前top 10的数据。", "example": "100" }, { "name": "Area", "type": "string", "required": false, "description": "数据归属地区，取值有： overseas：全球（除中国大陆地区）数据； mainland：中国大陆地区数据。不填将根据用户所在地智能选择地区。", "example": "overseas" } ], "required": [ "StartTime", "EndTime", "MetricName" ] }, { "name": "DescribeDDoSProtection", "description": "获取站点的独立 DDoS 防护信息。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-25ryyvog1qih" } ], "required": [ "ZoneId" ] }, { "name": "DescribeDefaultCertificates", "description": "查询默认证书列表", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": false, "description": "站点 ID。", "example": "zone-xxx" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，Filters.Values的上限为5。详细的过滤条件如下： zone-id   按照【站点ID】进行过滤。站点ID形如：zone-xxx。   类型：String   必选：是", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone-name" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"qq.com\",\"baidu.com\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量。默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询限制数目。默认值：20，最大值：100。", "example": "20" } ], "required": [] }, { "name": "DescribeDeployHistory", "description": "在版本管理模式下，用于查询生产/测试环境的版本发布历史。版本管理功能内测中，当前仅白名单开放。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-2jwahzkd4cn0" }, { "name": "EnvId", "type": "string", "required": true, "description": "环境 ID。", "example": "env-2jwahzkd4cn0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，Filters.Values 的上限为 20，详细的过滤条件如下： record-id：按照发布记录 ID 进行过滤进行过滤。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone-name" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"www.qq.com\",\"www.baidu.com\"]", "item_type": "string" }, { "name": "Fuzzy", "type": "boolean", "required": false, "description": "是否启用模糊查询。", "example": "false" } ] } ], "required": [ "ZoneId", "EnvId" ] }, { "name": "DescribeDnsRecords", "description": "您可以用过本接口查看站点下的 DNS 记录信息，包括 DNS 记录名、记录类型以及记录内容等信息，支持指定过滤条件查询对应的 DNS 记录信息。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-20hyebgyfsko" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量，默认为 0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询限制数目，默认值：20，上限：1000。", "example": "10" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，Filters.Values 的上限为20。详细的过滤条件如下：id： 按照 DNS 记录 ID 进行过滤，支持模糊查询；name：按照 DNS 记录名称进行过滤，支持模糊查询；content：按照 DNS 记录内容进行过滤，支持模糊查询；type：按照 DNS 记录类型进行过滤，不支持模糊查询。可选项：   A：将域名指向一个外网 IPv4 地址，如 8.8.8.8；   AAAA：将域名指向一个外网 IPv6 地址；   CNAME：将域...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone-name" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"www.qq.com\",\"www.baidu.com\"]", "item_type": "string" }, { "name": "Fuzzy", "type": "boolean", "required": false, "description": "是否启用模糊查询。", "example": "false" } ] }, { "name": "SortBy", "type": "string", "required": false, "description": "排序依据，取值有：content：DNS 记录内容；created-on：DNS 记录创建时间；name：DNS 记录名称；ttl：缓存时间；type：DNS 记录类型。默认根据 type, name 属性组合排序。", "example": "recordName" }, { "name": "SortOrder", "type": "string", "required": false, "description": "列表排序方式，取值有：asc：升序排列；desc：降序排列。默认值为 asc。", "example": "asc" }, { "name": "Match", "type": "string", "required": false, "description": "匹配方式，取值有：all：返回匹配所有查询条件的记录；any：返回匹配任意一个查询条件的记录。默认值为 all。", "example": "all" } ], "required": [ "ZoneId" ] }, { "name": "DescribeEnvironments", "description": "在版本管理模式下，用于查询环境信息，可获取环境 ID、类型、当前生效版本等。版本管理功能内测中，当前仅白名单开放。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-2jwahzkd4cn0" } ], "required": [ "ZoneId" ] }, { "name": "DescribeFunctionRules", "description": "查询边缘函数触发规则列表，支持按照规则 ID、函数 ID、规则描述等条件进行过滤。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-293e7s5jne1i" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件列表，多个条件为且关系，Filters.Values 的上限为 20。详细的过滤条件如下： rule-id：按照【规则 ID】进行精确匹配。 function-id：按照【函数 ID】进行精确匹配。 remark：按照【规则描述】进行模糊匹配。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone-name" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"qq.com\",\"baidu.com\"]", "item_type": "string" } ] } ], "required": [ "ZoneId" ] }, { "name": "DescribeFunctionRuntimeEnvironment", "description": "查询边缘函数运行环境，包括环境变量。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-293e7s5jne1i" }, { "name": "FunctionId", "type": "string", "required": true, "description": "函数 ID。", "example": "ef-jjhvk7ec" } ], "required": [ "ZoneId", "FunctionId" ] }, { "name": "DescribeFunctions", "description": "查询边缘函数列表，支持函数 ID、函数名称、描述等条件的过滤。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-293e7s5jne1i" }, { "name": "FunctionIds", "type": "array", "required": false, "description": "按照函数 ID 列表过滤。", "example": "[\"ef-jjhvk7ec\", \"ef-vwbhac60\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件列表，多个条件为且关系，Filters.Values 的上限为 20。详细的过滤条件如下： name：按照【函数名称】进行模糊匹配。 remark：按照【函数描述】进行模糊匹配。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone-name" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"qq.com\",\"baidu.com\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量。默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询限制数目。默认值：20，最大值：200。", "example": "10" } ], "required": [ "ZoneId" ] }, { "name": "DescribeHostsSetting", "description": "本接口为旧版，EdgeOne 已对规则引擎相关接口全面升级，可通过 [DescribeL7AccSetting](https://cloud.tencent.com/document/product/1552/115819) 和 [DescribeL7AccRules](https://cloud.tencent.com/document/product/1552/115820) 来获取域名的详细配置。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点ID。", "example": "zone-27q0p0bali16" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量。默认值： 0，最小值：0。", "example": "100" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询限制数目。默认值： 100，最大值：1000。", "example": "10" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，Filters.Values的上限为20。详细的过滤条件如下： host：按照域名进行过滤。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone-name" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"qq.com\",\"baidu.com\"]", "item_type": "string" } ] } ], "required": [ "ZoneId" ] }, { "name": "DescribeIPRegion", "description": "该接口可用于查询 IP 是否为 EdgeOne IP。", "status": "online", "parameters": [ { "name": "IPs", "type": "array", "required": true, "description": "待查询的 IP 列表，支持 IPV4 和 IPV6，最大可查询 100 条。", "example": "[\"1.1.1.1\",\"2402:4e00:1403:eb00:0:9440:b55a:39a8\"]", "item_type": "string" } ], "required": [ "IPs" ] }, { "name": "DescribeIdentifications", "description": "查询站点的验证信息。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": true, "description": "过滤条件，Filters.Values的上限为20。详细的过滤条件如下： zone-name：按照站点名称进行过滤。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone-name" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"qq.com\",\"baidu.com\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量。默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询限制数目。默认值：20，最大值：1000。", "example": "1000" } ], "required": [ "Filters" ] }, { "name": "DescribeJustInTimeTranscodeTemplates", "description": "根据即时转码模板名字、模板类型或唯一标识，获取即时转码模板详情列表。返回结果包含符合条件的所有用户自定义模板及预置模板。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点ID。", "example": "zone-djuqmq" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，Filters 的上限为 20，Filters.Values 的上限为 20。该参数不填写时，默认返回当前 ZoneId 下有权限的即时转码模板。详细的过滤条件如下：template-name：按照模板名批量进行过滤。例如：mytemplate；template-type：按照模板类型批量进行过滤。例如：preset 或 custom。template-id：按照模板 ID 批量进行过滤。例如：C1LZ7982VgTpYhJ7M。默认为空。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone-name" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"qq.com\",\"baidu.com\"]", "item_type": "string" } ] }, { "name": "SortBy", "type": "string", "required": false, "description": "排序字段，取值有：createTime：模板创建时间。默认值为：createTime。", "example": "createTime" }, { "name": "SortOrder", "type": "string", "required": false, "description": "排序方式，取值有：asc：升序方式；desc：降序方式。默认值为：desc。", "example": "asc" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回记录条数，默认值：20，最大值：1000。", "example": "100" } ], "required": [ "ZoneId" ] }, { "name": "DescribeL4Proxy", "description": "用于查询四层代理实例列表。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "四层代理实例所属站点的 ID。", "example": "zone-24wjy25v1cwi" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量，不填写时默认为 0。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询限制数目。默认值：20，最大值：1000。", "example": "100" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，Filters.Values 的上限为 20。该参数不填写时，返回当前 zone-id 下所有四层代理实例信息。详细的过滤条件如下： proxy-id：按照四层代理实例 ID 进行过滤； ddos-protection-type：按照安全防护类型进行过滤。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone-name" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"qq.com\",\"baidu.com\"]", "item_type": "string" } ] } ], "required": [ "ZoneId" ] }, { "name": "DescribeL4ProxyRules", "description": "查询四层代理实例下的转发规则列表。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-2q79r12251hk" }, { "name": "ProxyId", "type": "string", "required": true, "description": "四层代理实例 ID。", "example": "sid-2q79r12251hk" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页查询偏移量，不填写时默认为 0。", "example": "1" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页查询限制数目。默认值：20，最大值：1000。", "example": "20" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，Filters.Values的上限为20。不填写时返回当前四层实例下所有的规则信息，详细的过滤条件如下： rule-id：按照规则 ID 对四层代理实例下的规则进行过滤。规则 ID 形如：rule-31vv7qig0vjy； rule-tag：按照规则标签对四层代理实例下的规则进行过滤。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone-name" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"qq.com\",\"baidu.com\"]", "item_type": "string" } ] } ], "required": [ "ZoneId", "ProxyId", "Offset", "Limit" ] }, { "name": "DescribeL7AccRules", "description": "本接口用于查询[规则引擎](https://cloud.tencent.com/document/product/1552/70901)的规则列表。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-qbjifysd" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，Filters.Values 的上限为 20，不填写此参数时默认按顺序返回站点下的规则。详细的过滤条件如下： rule-id：按照规则 ID 进行过滤。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone-name" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"qq.com\",\"baidu.com\"]", "item_type": "string" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询限制数目，默认值：20，上限：1000。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量，默认为 0。", "example": "0" } ], "required": [ "ZoneId" ] }, { "name": "DescribeL7AccSetting", "description": "本接口用于查询[站点加速](https://cloud.tencent.com/document/product/1552/96193)全局配置。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-21xfqlh4qjee" } ], "required": [ "ZoneId" ] }, { "name": "DescribeLoadBalancerList", "description": "查询负载均衡实例列表。负载均衡功能内测中，如您需要使用请 [联系我们](https://cloud.tencent.com/online-service)。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-vawer2vadg\t" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量，默认为 0。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询限制数目，默认值：20，最大值：100。", "example": "20" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，Filters.Values 的上限为 20。该参数不填写时，返回当前 zone-id 下所有负载均衡实例信息。详细的过滤条件如下： InstanceName：按照负载均衡实例名称进行过滤； InstanceId：按照负载均衡实例 ID 进行过滤。", "example": "[{\"Name\": \"InstanceId\", [\"lb-xfqlh4qjee\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone-name" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"qq.com\",\"baidu.com\"]", "item_type": "string" } ] } ], "required": [ "ZoneId" ] }, { "name": "DescribeMultiPathGateway", "description": "通过本接口查询多通道安全加速网关详情。如名称、网关 ID、IP、端口、类型等。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-27q0p0bal192" }, { "name": "GatewayId", "type": "string", "required": true, "description": "网关 ID。", "example": "mpgw-lbxuhk1oh" } ], "required": [ "ZoneId", "GatewayId" ] }, { "name": "DescribeMultiPathGatewayLine", "description": "通过本接口查询接入多通道安全加速网关的线路。包括直连、EdgeOne 四层代理线路、自定义线路。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-27q0p0bal192" }, { "name": "GatewayId", "type": "string", "required": true, "description": "网关 ID。", "example": "mpgw-lbxuhk1oh" }, { "name": "LineId", "type": "string", "required": true, "description": "线路 ID。", "example": "line-2" } ], "required": [ "ZoneId", "GatewayId", "LineId" ] }, { "name": "DescribeMultiPathGatewayOriginACL", "description": "本接口用于查询多通道安全加速网关实例与回源 IP 网段的绑定关系，以及回源 IP 网段详情。若 MultiPathGatewayNextOriginACL 字段有返回值，则需要将最新的回源 IP 网段同步到源站防火墙配置中。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "\"zone-276zs184g93m\"" }, { "name": "GatewayId", "type": "string", "required": true, "description": "网关 ID。", "example": "\"mpgw-lbxuhk1oh\"" } ], "required": [ "ZoneId", "GatewayId" ] }, { "name": "DescribeMultiPathGatewayRegions", "description": "通过本接口查询用户创建的多通道安全加速网关（云上网关）的可用地域列表。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-27q0p0bal192" } ], "required": [ "ZoneId" ] }, { "name": "DescribeMultiPathGatewaySecretKey", "description": "通过本接口查询接入多通道安全加速网关的密钥，客户基于接入密钥签名接入多通道安全加速网关。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-27q0p0bal192" } ], "required": [ "ZoneId" ] }, { "name": "DescribeMultiPathGateways", "description": "通过本接口查询用户创建的多通道安全加速网关列表。支持翻页。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-27q0p0bal192" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量。默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询限制数目。默认值：20，最大值：1000。", "example": "10" }, { "name": "Filters", "type": "array", "required": false, "description": "网关列表的过滤字段，该参数不填写时，返回当前 appid 下所有网关信息，详细的过滤条件如下： gateway-type：按照网关类型进行过滤，支持取值 cloud 和 private，分别代表过滤云上网关和自由网关； keyword：按照网关名的关键字进行过滤。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone-name" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"qq.com\",\"baidu.com\"]", "item_type": "string" } ] } ], "required": [ "ZoneId" ] }, { "name": "DescribeOriginACL", "description": "本接口用于查询站点下的七层加速域名/四层代理实例与回源 IP 网段的绑定关系，以及回源 IP 网段详情。如果您想通过自动化脚本定期获取回源 IP 网段的最新版本，可以较低频率（建议每三天一次）轮询本接口，若 NextOriginACL 字段有返回值，则将最新的回源 IP 网段同步到源站防火墙配置中。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "\"zone-276zs184g93m\"" } ], "required": [ "ZoneId" ] }, { "name": "DescribeOriginGroup", "description": "获取源站组列表", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": false, "description": "站点ID，此参数必填。", "example": "zone-123456" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量，不填默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询限制数目，不填默认为20，取值：1-1000。", "example": "10" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，Filters.Values的上限为20。详细的过滤条件如下： origin-group-id：按照源站组 ID 进行过滤，不支持模糊查询。源站组 ID 形如：origin-2ccgtb24-7dc5-46s2-9r3e-95825d53dwe3a；origin-group-name： 按照源站组名称进行过滤，使用模糊查询时，仅支持填写一个源站组名称。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone-name" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"www.qq.com\",\"www.baidu.com\"]", "item_type": "string" }, { "name": "Fuzzy", "type": "boolean", "required": false, "description": "是否启用模糊查询。", "example": "false" } ] } ], "required": [] }, { "name": "DescribeOriginGroupHealthStatus", "description": "查询负载均衡实例下源站组健康状态。负载均衡功能内测中，如您需要使用请 [联系我们](https://cloud.tencent.com/online-service)。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-jhlaslkdjf" }, { "name": "LBInstanceId", "type": "string", "required": true, "description": "负载均衡实例 ID。", "example": "lb-asdf22442" }, { "name": "OriginGroupIds", "type": "array", "required": false, "description": "源站组 ID。不填写时默认获取负载均衡下所有源站组的健康状态。", "example": "orgin-2ccgtb24-7dc5-46s2-9r3e-95825d53dwe3a\t", "item_type": "string" } ], "required": [ "ZoneId", "LBInstanceId" ] }, { "name": "DescribeOriginProtection", "description": "本接口为旧版本查询源站防护接口，EdgeOne 于 2025 年 6 月 27 日已对源站防护相关接口全面升级，新版本查询源站防护接口详情请参考 [DescribeOriginACL](https://cloud.tencent.com/document/product/1552/120408)。 注意：自 2025 年 6 月 27 日起，旧版接口停止更新迭代，后续新增功能将仅在新版接口中提供。为避免在使用旧版接口时出现数据字段冲突，建议您尽早迁移到新版源站防护接口。", "status": "online", "parameters": [ { "name": "ZoneIds", "type": "array", "required": false, "description": "查询的站点ID集合。该参数必填。", "example": "[\"zone-276zs184g93m\",\"zone-27fil18zp2v1\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，Filters.Values的上限为20。详细的过滤条件如下： need-update   按照【站点是否需要更新源站防护IP白名单】进行过滤。   类型：String   必选：否   可选项：   true：需要更新   false：无需更新 plan-support   按照【站点套餐是否支持源站防护】进行过滤。   类型：String   必选：否   可选项：   true：支持   false：不支持", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone-name" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"qq.com\",\"baidu.com\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询限制数目。默认值：20，最大值：1000。", "example": "10" } ], "required": [] }, { "name": "DescribeOverviewL7Data", "description": "本接口（DescribeOverviewL7Data）用于查询七层监控类时序流量数据。此接口待废弃，请使用 DescribeTimingL7AnalysisData 接口。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "开始时间。", "example": "2020-04-20T00:00:00Z" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间。", "example": "2020-04-30T00:00:00Z" }, { "name": "MetricNames", "type": "array", "required": true, "description": "查询的指标，取值有： l7Flow_outFlux: Edegone响应流量； l7Flow_inFlux: Edgeone请求流量； l7Flow_outBandwidth: Edegone响应带宽； l7Flow_inBandwidth: Edegone请求带宽； l7Flow_hit_outFlux: 缓存命中流量； l7Flow_request: 访问请求数； l7Flow_flux: 访问请求上行+下行流量； l7Flow_bandwidth：访问请求上行+下行带宽。", "example": "[\"l7Flow_outFlux\"]", "item_type": "string" }, { "name": "ZoneIds", "type": "array", "required": false, "description": "站点 ID 集合，此参数必填。", "example": "[\"zone-2mzegj4vln5f\"]", "item_type": "string" }, { "name": "Domains", "type": "array", "required": false, "description": "查询的域名集合，此参数已经废弃。", "example": "[\"www.baidu.com\",\"www.google.com\"]", "item_type": "string" }, { "name": "Protocol", "type": "string", "required": false, "description": "查询的协议类型，取值有： http: http协议； https: https协议； http2: http2协议； all: 所有协议。不填默认为all，此参数暂未生效。", "example": "http" }, { "name": "Interval", "type": "string", "required": false, "description": "查询时间粒度，取值有： min：1分钟； 5min：5分钟； hour：1小时； day：1天。不填将根据开始时间跟结束时间的间距自动推算粒度，具体为：1小时范围内以min粒度查询，2天范围内以5min粒度查询，7天范围内以hour粒度查询，超过7天以day粒度查询。", "example": "min" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，详细的过滤条件Key值如下： socket   按照【HTTP协议类型】进行过滤。   对应的Value可选项如下：   HTTP：HTTP 协议；   HTTPS：HTTPS协议；   QUIC：QUIC协议。 domain   按照【域名】进行过滤。 tagKey   按照【标签Key】进行过滤。 tagValue   按照【标签Value】进行过滤。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "筛选条件的key。", "example": "查询键" }, { "name": "Operator", "type": "string", "required": true, "description": "查询条件操作符，操作类型有： equals: 等于； notEquals: 不等于； include: 包含； notInclude: 不包含; startWith: 开始的值是value； notStartWith: 不以value的值开始； endWith: 结尾是value值； notEndWith: 不以value的值结尾。", "example": "equals" }, { "name": "Value", "type": "array", "required": true, "description": "筛选条件的值。", "example": "查询值", "item_type": "string" } ] }, { "name": "Area", "type": "string", "required": false, "description": "数据归属地区，取值有： overseas：全球（除中国大陆地区）数据； mainland：中国大陆地区数据； global：全球数据。不填默认取值为global。", "example": "mainland" } ], "required": [ "StartTime", "EndTime", "MetricNames" ] }, { "name": "DescribePlans", "description": "查询套餐信息列表，支持分页。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，Filters.Values 的上限为 20。详细的过滤条件如下：plan-type  按照【套餐类型】进行过滤。  可选的类型有：  plan-trial：试用版套餐；  plan-personal：个人版套餐；  plan-basic：基础版套餐；   plan-standard：标准版套餐；   plan-enterprise：企业版套餐。 plan-id  按照【套餐 ID】进行过滤。套餐 ID 形如：edgeone-268z103ob0sx。area  按照【套餐加速地域】进行过...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone-name" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"qq.com\",\"baidu.com\"]", "item_type": "string" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序字段，取值有： enable-time：生效时间； expire-time：过期时间。不填写使用默认值 enable-time。", "example": "enable-time" }, { "name": "Direction", "type": "string", "required": false, "description": "排序方向，取值有： asc：从小到大排序； desc：从大到小排序。不填写使用默认值 desc。", "example": "desc" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询限制数目。默认值：20，最大值：200。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量。默认值：0。", "example": "0" } ], "required": [] }, { "name": "DescribePrefetchOriginLimit", "description": "本接口用于查询回源限速限制，该功能白名单内测中。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点ID。", "example": "zone-3***j8tqd" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量，默认为 0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询限制数目，默认值：20，上限：100。", "example": "10" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，Filters.Values 的上限为 20。详细的过滤条件如下： domain-name：按照域名过滤。domain-name 形如：www.qq.com，不支持模糊查询； area：按照限制加速区域过滤，不支持模糊查询。可选项： Overseas：全球可用区（不含中国大陆）； MainlandChina：中国大陆可用区。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone-name" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"qq.com\",\"baidu.com\"]", "item_type": "string" } ] } ], "required": [ "ZoneId" ] }, { "name": "DescribePrefetchTasks", "description": "DescribePrefetchTasks 用于查询预热任务提交历史记录及执行进度，通过 CreatePrefetchTasks 接口提交的任务可通过此接口进行查询。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": false, "description": "站点ID。此参数将于2024年05月30日后由可选改为必填，详见公告：[【腾讯云 EdgeOne】云 API 变更通知](https://cloud.tencent.com/document/product/1552/104902)。", "example": "zone-xxx" }, { "name": "StartTime", "type": "string", "required": false, "description": "查询起始时间，时间与 job-id 必填一个。", "example": "2022-02-09T02:35:00Z" }, { "name": "EndTime", "type": "string", "required": false, "description": "查询结束时间，时间与 job-id 必填一个。", "example": "2022-02-09T02:35:00Z" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量，默认为 0。", "example": "7" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询限制数目，默认值：20，上限：1000。", "example": "100" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，Filters.Values 的上限为 20。详细的过滤条件如下：job-id：按照任务 ID 进行过滤。job-id 形如：1379afjk91u32h，暂不支持多值，不支持模糊查询；target：按照目标资源信息进行过滤。target 形如：http://www.qq.com/1.txt，暂不支持多值，不支持模糊查询；domains：按照域名行过滤。domains 形如：www.qq.com，不支持模糊查询；statuses：按照任务状态进行过滤，不支持模糊查询。可选项：\ufffd...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone-name" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"www.qq.com\",\"www.baidu.com\"]", "item_type": "string" }, { "name": "Fuzzy", "type": "boolean", "required": false, "description": "是否启用模糊查询。", "example": "false" } ] } ], "required": [] }, { "name": "DescribePurgeTasks", "description": "DescribePurgeTasks 用于查询提交的 URL 刷新、目录刷新记录及执行进度，通过 CreatePurgeTasks 接口提交的任务均可通过此接口进行查询。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": false, "description": "站点 ID。此参数将于2024年05月30日后由可选改为必填，详见公告：[【腾讯云 EdgeOne】云 API 变更通知](https://cloud.tencent.com/document/product/1552/104902)。", "example": "zone-xxxxxx" }, { "name": "StartTime", "type": "string", "required": false, "description": "查询起始时间，时间与 job-id 必填一个。", "example": "2022-02-09T02:35:00Z" }, { "name": "EndTime", "type": "string", "required": false, "description": "查询结束时间，时间与 job-id 必填一个。", "example": "2022-02-09T02:35:00Z" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量，默认为 0。", "example": "7" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询限制数目，默认值：20，最大值：1000。", "example": "100" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，Filters.Values的上限为20。详细的过滤条件如下： job-id：按照任务 ID 进行过滤。job-id 形如：1379afjk91u32h，暂不支持多值，不支持模糊查询； target：按照目标资源信息进行过滤，target 形如：http://www.qq.com/1.txt 或者 tag1，暂不支持多值，支持模糊查询； domains：按照域名进行过滤，形如：www.qq.com，不支持模糊查询； statuses：按照任务状态进行过滤，不支持模糊查询。可选\ufffd...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone-name" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"www.qq.com\",\"www.baidu.com\"]", "item_type": "string" }, { "name": "Fuzzy", "type": "boolean", "required": false, "description": "是否启用模糊查询。", "example": "false" } ] } ], "required": [] }, { "name": "DescribeRealtimeLogDeliveryTasks", "description": "通过本接口查询实时日志投递任务列表。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-21xfqlh4qjee" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量。默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询限制数目。默认值：20，最大值：1000。", "example": "20" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，Filters.Values 的上限为 20。该参数不填写时，返回当前 zone-id 下所有实时日志投递任务信息。详细的过滤条件如下： task-id：按照实时日志投递任务 ID进行过滤。不支持模糊查询。 task-name：按照实时日志投递任务名称进行过滤。支持模糊查询，使用模糊查询时，仅支持填写一个实时日志投递任务名称。 entity-list：按照实时日志投递任务对应的实体进行过滤。不支持模\ufffd\ufffd...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone-name" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"www.qq.com\",\"www.baidu.com\"]", "item_type": "string" }, { "name": "Fuzzy", "type": "boolean", "required": false, "description": "是否启用模糊查询。", "example": "false" } ] } ], "required": [ "ZoneId" ] }, { "name": "DescribeRules", "description": "本接口为旧版本查询规则引擎规则接口，EdgeOne 于 2025 年 1 月 21 日已对规则引擎相关接口全面升级，新版本查询七层加速规则接口详情请参考 [DescribeL7AccRules](https://cloud.tencent.com/document/product/1552/115820)。 注意：自 2025 年 1 月 21 日起，旧版接口停止更新迭代，后续新增功能将仅在新版接口中提供，旧版接口支持的原有能力将不受影响。为避免在使用旧版接口时出现数据字段冲突\ufffd...", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-qbjifysd" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，Filters.Values的上限为20。详细的过滤条件如下： rule-id：按照规则 ID 进行过滤。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone-name" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"qq.com\",\"baidu.com\"]", "item_type": "string" } ] } ], "required": [ "ZoneId" ] }, { "name": "DescribeRulesSetting", "description": "本接口为旧版，EdgeOne 已对规则引擎相关接口全面升级，详情请参考 [RuleEngineAction](https://cloud.tencent.com/document/product/1552/80721#RuleEngineAction)。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeSecurityAPIResource", "description": "查询站点下的 API 资源。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "\"zone-nqicqhasui\"\t" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询限制数目。默认值：20，最大值：100。", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量。默认值：0。", "example": "1" } ], "required": [ "ZoneId" ] }, { "name": "DescribeSecurityAPIService", "description": "查询站点下的 API 服务。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "\"zone-nqicqhasui\"\t" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询限制数目。默认值：20，最大值：100。", "example": "0" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量。默认值：0。", "example": "0" } ], "required": [ "ZoneId" ] }, { "name": "DescribeSecurityClientAttester", "description": "查询客户端认证选项配置。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "\"zone-nqicqhasui\"" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询限制数目。默认值：20，最大值：100。", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量。默认值：0。", "example": "1" } ], "required": [ "ZoneId" ] }, { "name": "DescribeSecurityIPGroup", "description": "查询安全 IP 组的配置信息，包括安全 IP 组的 ID、名称和内容。本接口的查询结果中，每个 IP 组最多只返回 2000 个 IP / 网段。如果存在超过 2000 个 IP / 网段的超大 IP 组，请调用 DescribeSecurityIPGroupContent 进行分页查询。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID ，用于指定查询的站点范围。", "example": "\"zone-nqicqhasui\"" }, { "name": "GroupIds", "type": "array", "required": false, "description": "指定安全 IP 组 ID。 提供该参数时，仅查询指定 ID 的安全 IP 组配置； 不传递参数时，返回站点下所有安全 IP 组信息。", "example": "97", "item_type": "integer" } ], "required": [ "ZoneId" ] }, { "name": "DescribeSecurityIPGroupContent", "description": "该接口用于分页查询指定 IP 组中的 IP 地址列表。当 IP 组中的 IP 地址数量超过 2000 个时，可以使用此接口进行分页查询，以获取完整的 IP 地址列表。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-5a6y19cacf9u" }, { "name": "GroupId", "type": "integer", "required": true, "description": "IP 组 ID。", "example": "100121" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询限制数目。默认值：2000，最大值：100000。", "example": "2000" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量。默认值：0。", "example": "0" } ], "required": [ "ZoneId", "GroupId" ] }, { "name": "DescribeSecurityIPGroupInfo", "description": "接口已废弃，将于 2024 年 6 月 30 日停止服务。请使用 [查询安全 IP 组 ](https://cloud.tencent.com/document/product/1552/105866) 接口。 查询 IP 组的配置信息，包括 IP 组名称、 IP 组内容、 IP 组归属站点。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点的 ID ，用于指定查询的站点范围。", "example": "[\"zone-21xfqlh4qjee\"]" }, { "name": "Limit", "type": "integer", "required": false, "description": "单次返回的最大条目数。默认值为 20 ，最大查询条目为 1000 。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页查询的起始条目偏移量。默认值为 0 。", "example": "0" } ], "required": [ "ZoneId" ] }, { "name": "DescribeSecurityJSInjectionRule", "description": "查询 JavaScript 注入规则。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "\"zone-nqicqhasui\"" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询限制数目。默认值：20，最大值：100。", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量。默认值：0。", "example": "1" } ], "required": [ "ZoneId" ] }, { "name": "DescribeSecurityPolicy", "description": "查询安全防护配置详情。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "test.com" }, { "name": "Entity", "type": "string", "required": false, "description": "安全策略类型，可使用以下参数值进行查询： ZoneDefaultPolicy：用于指定查询站点级策略；Template：用于指定查询策略模板，需要同时指定 TemplateId 参数；Host：用于指定查询域名级策略（注意：当使用域名来指定域名服务策略时，仅支持已经应用了域名级策略的域名服务或者策略模板）。", "example": "Host" }, { "name": "TemplateId", "type": "string", "required": false, "description": "指定策略模板 ID。当 Entity 参数值为 Template 时，使用本参数指定策略模板的 ID 查询模板配置。", "example": "temp-wj86oi2" }, { "name": "Host", "type": "string", "required": false, "description": "指定域名。当 Entity 参数值为 Host 时，使用本参数指定的域名级策略查询域名配置，例如：使用 www.example.com ，配置该域名的域名级策略。", "example": "www.example.com" } ], "required": [ "ZoneId" ] }, { "name": "DescribeSecurityTemplateBindings", "description": "查询指定策略模板的绑定关系列表。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "要查询的站点 ID。", "example": "zone-j9j09au1" }, { "name": "TemplateId", "type": "array", "required": true, "description": "要查询的策略模板 ID。", "example": "temp-n23na0", "item_type": "string" } ], "required": [ "ZoneId", "TemplateId" ] }, { "name": "DescribeTimingL4Data", "description": "本接口（DescribeTimingL4Data）用于查询四层时序数据列表。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "开始时间。", "example": "2020-04-29T00:00:00Z" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间。查询时间范围（`EndTime` - `StartTime`）需小于等于 31 天。", "example": "2020-04-30T00:00:00Z" }, { "name": "MetricNames", "type": "array", "required": true, "description": "查询指标，取值有： **l4Flow_flux**: 访问总流量，单位：Byte，指标值类型：Integer； **l4Flow_inFlux**: 访问入流量，单位：Byte，指标值类型：Integer； **l4Flow_outFlux**: 访问出流量，单位：Byte，指标值类型：Integer； **l4Flow_inBandwidth**: 访问入向带宽峰值，单位：bps，指标值类型：Integer； **l4Flow_outBandwidth**: 访问出向带宽峰值，单位：bps，指标值类型：Integer； **l4Flow_connections**: 访问并发...", "example": "[\"l4Flow_connections\"]", "item_type": "string" }, { "name": "ZoneIds", "type": "array", "required": true, "description": "站点ID，此参数将于2024年05月30日后由可选改为必填，详见公告：[【腾讯云 EdgeOne】云 API 变更通知](https://cloud.tencent.com/document/product/1552/104902)。 最多传入 100 个站点 ID。若需查询腾讯云主账号下所有站点数据，请用 `*` 代替，查询账号级别数据需具备本接口全部站点资源权限。", "example": "[\"zone-2rntun0a1z6t\",\"zone-323urc8a9j0q\"]", "item_type": "string" }, { "name": "ProxyIds", "type": "array", "required": false, "description": "四层实例列表, 不填表示选择全部实例。", "example": "[\"sid-39562waf3raa\"]", "item_type": "string" }, { "name": "Interval", "type": "string", "required": false, "description": "查询时间粒度，取值有： **min**: 1分钟 ； **5min**: 5分钟 ； **hour**: 1小时 ； **day**: 1天 。不填将根据开始时间跟结束时间的间距自动推算粒度，具体为：1小时范围内以 min 粒度查询，2天范围内以 5min 粒度查询，7天范围内以 hour 粒度查询，超过7天以 day 粒度查询。", "example": "hour" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，详细的过滤条件Key值如下： **ruleId**：按照转发规则 ID 进行过滤。 **proxyId**：按照四层代理实例 ID 进行过滤。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "筛选条件的key。", "example": "查询键" }, { "name": "Operator", "type": "string", "required": true, "description": "查询条件操作符，操作类型有： equals: 等于； notEquals: 不等于； include: 包含； notInclude: 不包含; startWith: 开始的值是value； notStartWith: 不以value的值开始； endWith: 结尾是value值； notEndWith: 不以value的值结尾。", "example": "equals" }, { "name": "Value", "type": "array", "required": true, "description": "筛选条件的值。", "example": "查询值", "item_type": "string" } ] } ], "required": [ "StartTime", "EndTime", "MetricNames", "ZoneIds" ] }, { "name": "DescribeTimingL7AnalysisData", "description": "本接口用于查询七层域名业务的时序数据。 注意： 1. 本接口查询数据有 10 分钟左右延迟，建议拉取当前时间 10 分钟以前的数据。 2. 本接口默认返回防护后的流量请求数据，用户可在 `Filters.mitigatedByWebSecurity` 中自定义查询已防护缓释的数据。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "开始时间。", "example": "2020-04-29T00:00:00Z" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间。查询时间范围（`EndTime` - `StartTime`）需小于等于 31 天。", "example": "2020-04-30T00:00:00Z" }, { "name": "MetricNames", "type": "array", "required": true, "description": "指标列表，取值有: 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 访问请求数，单位：次\ufffd...", "example": "[\"l7Flow_outFlux\"]", "item_type": "string" }, { "name": "ZoneIds", "type": "array", "required": false, "description": "站点 ID 集合，此参数将于2024年05月30日后由可选改为必填，详见公告：[【腾讯云 EdgeOne】云 API 变更通知](https://cloud.tencent.com/document/product/1552/104902)。最多传入 100 个站点 ID。若需查询腾讯云主账号下所有站点数据，请用 `*` 代替，查询账号级别数据需具备本接口全部站点资源权限。", "example": "[\"*\"]", "item_type": "string" }, { "name": "Interval", "type": "string", "required": false, "description": "查询时间粒度，取值有： min: 1分钟； 5min: 5分钟； hour: 1小时； day: 1天。不填将根据开始时间跟结束时间的间距自动推算粒度，具体为：2 小时范围内以 min 粒度查询，2 天范围内以 5min 粒度查询，7 天范围内以 hour 粒度查询，超过 7 天以 day 粒度查询。", "example": "hour" }, { "name": "Filters", "type": "array", "required": false, "description": "筛选数据时使用的过滤条件，取值参考 [指标分析筛选条件说明](https://cloud.tencent.com/document/product/1552/98219#1aaf1150-55a4-4b4d-b103-3a8317ac7945) 中针对 L7 访问流量、带宽、请求数的可用筛选项。 如需限定站点或内容标识符，请在 `ZoneIds.N` 参数中另行传入对应的值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "筛选条件的key。", "example": "查询键" }, { "name": "Operator", "type": "string", "required": true, "description": "查询条件操作符，操作类型有： equals: 等于； notEquals: 不等于； include: 包含； notInclude: 不包含; startWith: 开始的值是value； notStartWith: 不以value的值开始； endWith: 结尾是value值； notEndWith: 不以value的值结尾。", "example": "equals" }, { "name": "Value", "type": "array", "required": true, "description": "筛选条件的值。", "example": "查询值", "item_type": "string" } ] }, { "name": "Area", "type": "string", "required": false, "description": "数据归属地区。该参数已废弃。请在 `Filters.country` 中按客户端地域过滤数据。", "example": "mainland" } ], "required": [ "StartTime", "EndTime", "MetricNames" ] }, { "name": "DescribeTimingL7CacheData", "description": "本接口用于查询七层缓存分析时序类流量数据。此接口待废弃，请使用 DescribeTimingL7AnalysisData 接口。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "开始时间。", "example": "2020-04-29T00:00:00Z" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间。", "example": "2020-04-30T00:00:00Z" }, { "name": "MetricNames", "type": "array", "required": true, "description": "查询的指标，取值有： l7Cache_outFlux：响应流量； l7Cache_request：响应请求数； l7Cache_outBandwidth：响应带宽。", "example": "l7Flow_flow", "item_type": "string" }, { "name": "ZoneIds", "type": "array", "required": false, "description": "站点 ID 集合，此参数必填。", "example": "[\"zone-2mzegj4vln5f\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，详细的过滤条件如下： domain   按照【子域名】进行过滤，子域名形如： test.example.com。   类型：String   必选：否 url   按照【URL】进行过滤，此参数只支持30天的时间范围，URL形如：/content。   类型：String   必选：否 resourceType   按照【资源类型】进行过滤，此参数只支持30天的时间范围，资源类型形如：jpg，png。   类型：String   必选：否 cache...", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "筛选条件的key。", "example": "查询键" }, { "name": "Operator", "type": "string", "required": true, "description": "查询条件操作符，操作类型有： equals: 等于； notEquals: 不等于； include: 包含； notInclude: 不包含; startWith: 开始的值是value； notStartWith: 不以value的值开始； endWith: 结尾是value值； notEndWith: 不以value的值结尾。", "example": "equals" }, { "name": "Value", "type": "array", "required": true, "description": "筛选条件的值。", "example": "查询值", "item_type": "string" } ] }, { "name": "Interval", "type": "string", "required": false, "description": "查询时间粒度，可选的值有： min：1分钟的时间粒度； 5min：5分钟的时间粒度； hour：1小时的时间粒度； day：1天的时间粒度。不填将根据开始时间跟结束时间的间距自动推算粒度，具体为：一小时范围内以min粒度查询，两天范围内以5min粒度查询，七天范围内以hour粒度查询，超过七天以day粒度查询。", "example": "hour" }, { "name": "Area", "type": "string", "required": false, "description": "数据归属地区，取值有： overseas：全球（除中国大陆地区）数据； mainland：中国大陆地区数据； global：全球数据。不填默认取值为global。", "example": "mainland" } ], "required": [ "StartTime", "EndTime", "MetricNames" ] }, { "name": "DescribeTimingL7OriginPullData", "description": "本接口用以查询七层域名业务的回源时序数据，可以通过指定查询维度 DimensionName 进行分组查询，返回多组时序数据。 单次请求最多返回 50,000 个数据项 TimingDataItem 。数据项总数的计算规则如下： 指标个数 * 时间点个数 * 维度值个数 = 数据项总数 指标个数：MetricNames 的列表长度。 时间点个数：(EndTime - StartTime) / Interval。 维度值个数： 当未指定 DimensionName 时，默认按账号维度...", "status": "online", "parameters": [ { "name": "ZoneIds", "type": "array", "required": true, "description": "站点 ID 集合，此参数必填。最多传入 100 个站点 ID。若需查询腾讯云主账号下所有站点数据，请用 `*` 代替，查询账号级别数据需具备本接口全部站点资源权限。", "example": "[\"*\"]", "item_type": "string" }, { "name": "MetricNames", "type": "array", "required": true, "description": "指标列表，取值有: l7Flow_outFlux_hy: EdgeOne 节点至源站方向的请求流量，单位：Byte； l7Flow_outBandwidth_hy: EdgeOne 节点至源站方向的请求带宽，单位：bps； l7Flow_request_hy: EdgeOne 节点至源站方向的请求数，单位：次。 l7Flow_inFlux_hy: 源站至 EdgeOne 节点方向的响应流量，单位：Byte； l7Flow_inBandwidth_hy: 源站至 EdgeOne 节点方向的响应带宽，单位：bps。", "example": "[\"l7Flow_outFlux_hy\"]", "item_type": "string" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间。", "example": "2020-04-29T00:00:00Z" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间。查询时间范围（`EndTime` - `StartTime`）需小于等于 31 天。", "example": "2020-04-30T00:00:00Z" }, { "name": "Interval", "type": "string", "required": false, "description": "查询时间粒度，取值有： min: 1分钟；5min: 5分钟；hour: 1小时；day: 1天。不填将根据开始时间跟结束时间的间距自动推算粒度，具体为：2 小时范围内以 min 粒度查询，2 天范围内以 5min 粒度查询，7 天范围内以 hour 粒度查询，超过 7 天以 day 粒度查询。", "example": "hour" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，详细的过滤条件如下： domain：客户端请求的域名。若按泛域名接入 EdgeOne，则数据中记录为泛域名，而不是具体域名。originStatusCode：回源状态码，仅当 MetricNames = [\"l7Flow_request_hy\"] 时支持本过滤项。对应的 Value 可选项如下：1xx：1xx 类型的状态码；2xx：2xx 类型的状态码；3xx：3xx 类型的状态码；4xx：4xx 类型的状态码；5xx：5xx 类型的状态码；在 [0, 600) 范围内的整数（\ufffd\ufffd...", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "筛选条件的key。", "example": "查询键" }, { "name": "Operator", "type": "string", "required": true, "description": "查询条件操作符，操作类型有： equals: 等于； notEquals: 不等于； include: 包含； notInclude: 不包含; startWith: 开始的值是value； notStartWith: 不以value的值开始； endWith: 结尾是value值； notEndWith: 不以value的值结尾。", "example": "equals" }, { "name": "Value", "type": "array", "required": true, "description": "筛选条件的值。", "example": "查询值", "item_type": "string" } ] }, { "name": "DimensionName", "type": "string", "required": false, "description": "查询维度名称，取值有：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\"] 时支...", "example": "domain" } ], "required": [ "ZoneIds", "MetricNames", "StartTime", "EndTime" ] }, { "name": "DescribeTopL7AnalysisData", "description": "本接口用于查询七层域名业务按照指定维度的 topN 数据。 注意： 1. 本接口查询数据有 10 分钟左右延迟，建议拉取当前时间 10 分钟以前的数据。 2. 本接口默认返回防护后的流量请求数据，用户可在 `Filters.mitigatedByWebSecurity` 中自定义查询已防护缓释的数据。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "开始时间。", "example": "2020-04-20T00:00:00Z" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间。查询时间范围（`EndTime` - `StartTime`）需小于等于 31 天。", "example": "2020-04-30T00:00:00Z" }, { "name": "MetricName", "type": "string", "required": true, "description": "查询的指标，取值有： 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：按资源\ufffd...", "example": "l7Flow_outFlux_country" }, { "name": "ZoneIds", "type": "array", "required": true, "description": "站点 ID 集合，此参数将于2024年05月30日后由可选改为必填，详见公告：[【腾讯云 EdgeOne】云 API 变更通知](https://cloud.tencent.com/document/product/1552/104902)。最多传入 100 个站点 ID。若需查询腾讯云主账号下所有站点数据，请用 `*` 代替，查询账号级别数据需具备本接口全部站点资源权限。", "example": "[\"*\"]", "item_type": "string" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询前多少个 top 数据，最大值为1000。不填默认为10，表示查询 top10 的数据。", "example": "3" }, { "name": "Filters", "type": "array", "required": false, "description": "筛选数据时使用的过滤条件，取值参考 [指标分析筛选条件说明](https://cloud.tencent.com/document/product/1552/98219#1aaf1150-55a4-4b4d-b103-3a8317ac7945) 中针对 L7 访问流量、带宽、请求数的可用筛选项。 如需限定站点或内容标识符，请在 `ZoneIds.N` 参数中另行传入对应的值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "筛选条件的key。", "example": "查询键" }, { "name": "Operator", "type": "string", "required": true, "description": "查询条件操作符，操作类型有： equals: 等于； notEquals: 不等于； include: 包含； notInclude: 不包含; startWith: 开始的值是value； notStartWith: 不以value的值开始； endWith: 结尾是value值； notEndWith: 不以value的值结尾。", "example": "equals" }, { "name": "Value", "type": "array", "required": true, "description": "筛选条件的值。", "example": "查询值", "item_type": "string" } ] }, { "name": "Interval", "type": "string", "required": false, "description": "查询时间粒度，该参数无效，待废弃。", "example": "min" }, { "name": "Area", "type": "string", "required": false, "description": "数据归属地区。该参数已废弃。请在 `Filters.country` 中按客户端地域过滤数据。", "example": "mainland" } ], "required": [ "StartTime", "EndTime", "MetricName", "ZoneIds" ] }, { "name": "DescribeTopL7CacheData", "description": "本接口用于查询七层缓存分析 topN 数据。此接口待废弃，请使用 DescribeTopL7AnalysisData 接口。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "开始时间。", "example": "2020-04-20T00:00:00Z" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间。", "example": "2020-04-30T00:00:00Z" }, { "name": "MetricName", "type": "string", "required": true, "description": "查询的指标，取值有： l7Cache_outFlux_domain：host/域名； l7Cache_outFlux_url：url地址； l7Cache_outFlux_resourceType：资源类型； l7Cache_outFlux_statusCode：状态码。", "example": "l7Cache_outFlux_domain" }, { "name": "ZoneIds", "type": "array", "required": true, "description": "站点 ID 集合，此参数必填。", "example": "[\"zone-2ju9lrnpaxol\"]", "item_type": "string" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询前多少个数据，最大值为1000，不填默认为10， 表示查询前top 10的数据。", "example": "10" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，详细的过滤条件如下： domain   按照【子域名】进行过滤，子域名形如： test.example.com。   类型：String   必选：否 url   按照【URL】进行过滤，此参数只支持30天的时间范围，URL形如：/content。   类型：String   必选：否 resourceType   按照【资源类型】进行过滤，此参数只支持30天的时间范围，资源类型形如：jpg，png。   类型：String   必选：否 cache...", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "筛选条件的key。", "example": "查询键" }, { "name": "Operator", "type": "string", "required": true, "description": "查询条件操作符，操作类型有： equals: 等于； notEquals: 不等于； include: 包含； notInclude: 不包含; startWith: 开始的值是value； notStartWith: 不以value的值开始； endWith: 结尾是value值； notEndWith: 不以value的值结尾。", "example": "equals" }, { "name": "Value", "type": "array", "required": true, "description": "筛选条件的值。", "example": "查询值", "item_type": "string" } ] }, { "name": "Interval", "type": "string", "required": false, "description": "查询时间粒度，取值有： min: 1分钟； 5min: 5分钟； hour: 1小时； day: 1天。不填将根据开始时间跟结束时间的间距自动推算粒度，具体为：一小时范围内以min粒度查询，两天范围内以5min粒度查询，七天范围内以hour粒度查询，超过七天以day粒度查询。", "example": "min" }, { "name": "Area", "type": "string", "required": false, "description": "数据归属地区，取值有： overseas：全球（除中国大陆地区）数据； mainland：中国大陆地区数据； global：全球数据。不填默认取值为global。", "example": "mainland" } ], "required": [ "StartTime", "EndTime", "MetricName", "ZoneIds" ] }, { "name": "DescribeWebSecurityTemplate", "description": "查询安全策略配置模板详情", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。需要传入目标策略模板在访问权限上归属的站点，可使用 DescribeWebSecurityTemplates 接口查询策略模板归属的站点。", "example": "zone-2wkpkd52pku8" }, { "name": "TemplateId", "type": "string", "required": true, "description": "策略模板 ID。", "example": "temp-o3xctdd2" } ], "required": [ "ZoneId", "TemplateId" ] }, { "name": "DescribeWebSecurityTemplates", "description": "查询安全策略配置模板列表", "status": "online", "parameters": [ { "name": "ZoneIds", "type": "array", "required": true, "description": "站点 ID 列表。单次查询最多传入 100 个站点。", "example": "[\"zone-2bu6nf2gwsax\", \"zone-6wkpkd5gzvms\"]", "item_type": "string" } ], "required": [ "ZoneIds" ] }, { "name": "DescribeZoneConfigImportResult", "description": "查询站点配置项导入结果接口，本接口用于站点配置导入接口（ImportZoneConfig）的结果查询。该功能仅支持标准版或企业版套餐的站点使用。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-2zpqp7qztest" }, { "name": "TaskId", "type": "string", "required": true, "description": "表示需要查询结果的导入配置任务 Id，导入任务 Id 仅支持查询最近 7 天的导入任务。", "example": "33mz68e4gwka" } ], "required": [ "ZoneId", "TaskId" ] }, { "name": "DescribeZoneSetting", "description": "本接口为旧版，EdgeOne 已对规则引擎相关接口全面升级，详情请参考 [DescribeL7AccSetting](https://cloud.tencent.com/document/product/1552/115819)。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点ID。", "example": "zone-21xfqlh4qjee" } ], "required": [ "ZoneId" ] }, { "name": "DescribeZones", "description": "该接口用于查询您有权限的站点信息。可根据不同查询条件筛选站点。", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量。默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询限制数目。默认值：20，最大值：100。", "example": "100" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，Filters.Values 的上限为 20。该参数不填写时，返回当前 appid 下有权限的所有站点信息。详细的过滤条件如下：zone-name：按照站点名称进行过滤；zone-type：按照站点类型进行过滤。可选项：   full：NS 接入类型；   partial：CNAME 接入类型；   partialComposite：无域名接入类型；   dnsPodAccess：DNSPod 托管接入类型；   pages：Pages 接入类型；   ai：边缘推理接入类\ufffd\ufffd...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone-name" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"www.qq.com\",\"www.baidu.com\"]", "item_type": "string" }, { "name": "Fuzzy", "type": "boolean", "required": false, "description": "是否启用模糊查询。", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "可根据该字段对返回结果进行排序，取值有： type：接入类型； area：加速区域； create-time：创建时间； zone-name：站点名称； use-time：最近使用时间； active-status：生效状态。不填写时对返回结果默认按照 create-time 排序。", "example": "\"status\"" }, { "name": "Direction", "type": "string", "required": false, "description": "排序方向，如果是字段值为数字，则根据数字大小排序；如果字段值为文本，则根据 ascill 码的大小排序。取值有： asc：从小到大排序； desc：从大到小排序。不填写使用默认值 desc。", "example": "\"desc\"" } ], "required": [] }, { "name": "DestroyPlan", "description": "当您需要停止 Edgeone 套餐的计费，可以通过该接口销毁计费套餐。 \u003e 销毁计费套餐需要满足以下条件： 1.套餐已过期（企业版套餐除外）； 2.套餐下所有站点均已关闭或删除。 \u003e 站点状态可以通过 [查询站点列表](https://cloud.tencent.com/document/product/1552/80713) 接口进行查询 停用站点可以通过 [切换站点状态](https://cloud.tencent.com/document/product/1552/80707) 接口将站点切换至关闭状态 删除\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "PlanId", "type": "string", "required": true, "description": "套餐 ID，形如 edgeone-2wdo315m2y4c。", "example": "edgeone-edgeone-2unuvzjmmn2q" } ], "required": [ "PlanId" ] }, { "name": "DisableOriginACL", "description": "本接口用于关闭站点的源站防护功能。停用后，相关资源不再仅使用「源站防护」提供的回源 IP 网段请求您的源站，同时停止发送回源 IP 网段更新通知。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "\"zone-276zs184g93m\"" } ], "required": [ "ZoneId" ] }, { "name": "DownloadL4Logs", "description": "本接口（DownloadL4Logs）用于下载四层离线日志。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "开始时间。", "example": "2022-05-04T03:27:00+08:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间。", "example": "2022-05-10T23:59:00+08:00" }, { "name": "ZoneIds", "type": "array", "required": false, "description": "站点 ID 集合，此参数将于2024年05月30日后由可选改为必填，详见公告：[【腾讯云 EdgeOne】云 API 变更通知](https://cloud.tencent.com/document/product/1552/104902)。", "example": "[\"zone-2m6jx63f6k3x\"]", "item_type": "string" }, { "name": "ProxyIds", "type": "array", "required": false, "description": "四层实例 ID 集合。", "example": "[\"proxy-xx\"]", "item_type": "string" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询的限制数目，默认值为 20，最大查询条目为 300。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量，默认值为 0。", "example": "1" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DownloadL7Logs", "description": "本接口（DownloadL7Logs）下载七层离线日志。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "开始时间。", "example": "2022-05-04T03:27:00+08:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间。", "example": "2022-05-10T23:59:00+08:00" }, { "name": "ZoneIds", "type": "array", "required": false, "description": "站点ID集合，此参数将于2024年05月30日后由可选改为必填，详见公告：[【腾讯云 EdgeOne】云 API 变更通知](https://cloud.tencent.com/document/product/1552/104902)。", "example": "[\"zone-2nepupfjtjlf\"]", "item_type": "string" }, { "name": "Domains", "type": "array", "required": false, "description": "子域名集合，不填默认选择全部子域名。", "example": "[\"www.baidu.com\"]", "item_type": "string" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询的限制数目，默认值为 20，最大查询条目为 300。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量，默认值为 0。", "example": "0" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "EnableOriginACL", "description": "本接口用于站点首次开启源站防护，启用后 EdgeOne 将会使用特定的回源 IP 网段为七层加速域名/四层代理实例回源。单次支持提交的七层加速域名的数量最大为 200，四层代理实例的数量最大为 100，支持七层加速域名/四层代理实例混合提交，总实例个数最大为 200。如需要启用超过 200 个资源，可先通过指定资源的方式以最大数量启用，剩余资源通过 ModifyOriginACL 接口启用。后续\ufffd...", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "\"zone-276zs184g93m\"" }, { "name": "L7EnableMode", "type": "string", "required": false, "description": "站点首次开启源站防护时，为七层加速域名配置特定回源 IP 网段的模式。 all：针对当前站点下的所有七层加速域名开启，当域名数量超过 200 时，请先通过 specific 模式启用 200 个域名，剩余资源通过 ModifyOriginACL 接口启用。 specific：针对站点下指定的七层加速域名开启。注意：当参数为空时，默认为 specific。后续新增七层加速域名/四层代理实例均请通过 ModifyOriginACL 接口配置\ufffd\ufffd...", "example": "\"specific\"" }, { "name": "L7Hosts", "type": "array", "required": false, "description": "开启源站防护的七层加速域名列表，仅当参数 L7EnableMode 为 specific 时生效。L7EnableMode 为 all 时，请保留此参数为空。单次最大仅支持填写 200 个七层加速域名。", "example": "[\"www.qq.com\"]", "item_type": "string" }, { "name": "L4EnableMode", "type": "string", "required": false, "description": "站点首次开启源站防护时，为四层代理实例配置特定回源 IP 网段的模式。 all：针对当前站点下的所有四层代理实例开启，当实例数量超过 100 时，请先通过 specific 模式启用 100 个域名，剩余资源通过 ModifyOriginACL 接口启用。 specific：针对站点下指定的四层代理实例开启。注意：当参数为空时，默认为 specific。后续新增七层加速域名/四层代理实例均请通过 ModifyOriginACL 接口配置\ufffd\ufffd...", "example": "\"specific\"" }, { "name": "L4ProxyIds", "type": "array", "required": false, "description": "开启源站防护的四层代理实例列表，仅当参数 L4EnableMode 为 specific 时生效。L4EnableMode 为 all 时，请保留此参数为空。单次最大仅支持填写 100 个四层代理实例。", "example": "[\"proxy-19389e5dwwxfs\"]", "item_type": "string" }, { "name": "OriginACLFamily", "type": "string", "required": false, "description": "源站防护回源ACL控制域，不填则默认用标准全球控制域；可用控制域信息可以通过DescribeAvailableOriginACLFamily接口查询获得。 具体取值说明如下： gaz：标准全球可用区控制域； mlc：标准中国大陆可用区控制域； emc：标准全球(不含中国大陆)可用区控制域； plat-gaz：精简全球可用区控制域； plat-mlc：精简中国大陆可用区控制域； plat-emc：精简全球(不含中国大陆)可用区控制域；", "example": "gaz" } ], "required": [ "ZoneId" ] }, { "name": "ExportZoneConfig", "description": "导出站点配置接口，本接口支持用户根据需要的配置项进行配置导出，导出的配置用于导入站点配置接口（ImportZoneConfig）进行配置导入。该功能仅支持标准版和企业版套餐站点使用。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-2zpqp7qztest" }, { "name": "Types", "type": "array", "required": false, "description": "导出配置项的类型列表，不填表示导出所有类型的配置，当前支持的取值有：L7AccelerationConfig：表示导出七层加速配置，对应控制台「站点加速-全局加速配置」和「站点加速-规则引擎」。 需注意：后续支持导出的类型会随着迭代增加，导出所有类型时需要注意导出文件大小，建议使用时指定需要导出的配置类型，以便控制请求响应包负载大小。", "example": "L7AccelerationConfig", "item_type": "string" } ], "required": [ "ZoneId" ] }, { "name": "HandleFunctionRuntimeEnvironment", "description": "操作边缘函数运行环境，支持环境变量的相关设置。 设置环境变量后，可在函数代码中使用，具体参考 [边缘函数引入环境变量](https://cloud.tencent.com/document/product/1552/109151#0151fd9a-8b0e-407b-ae37-54553a60ded6)。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-2gqxim9jstab" }, { "name": "FunctionId", "type": "string", "required": true, "description": "函数 ID。", "example": "ef-jjhvk7ec" }, { "name": "Operation", "type": "string", "required": true, "description": "操作类型，取值有： setEnvironmentVariable：设置环境变量，当环境变量存在时为修改行为，否则为添加行为； deleteEnvironmentVariable：删除环境变量变量； clearEnvironmentVariable：清空环境变量变量； resetEnvironmentVariable：重置环境变量变量。", "example": "setEnvironmentVariable" }, { "name": "EnvironmentVariables", "type": "array", "required": false, "description": "环境变量列表，函数运行环境最多支持 64 个变量。当 Operation 取值为 setEnvironmentVariable、deleteEnvironmentVariable、resetEnvironmentVariable 时必填。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "变量的名称，限制只能包含大小写字母、数字，特殊字符仅支持 @ . - _ ，最大 64 个字节，不支持重复。", "example": "color" }, { "name": "Value", "type": "string", "required": false, "description": "变量的值，限制最大 5000 字节，默认值为空。", "example": "red" }, { "name": "Type", "type": "string", "required": false, "description": "变量的类型，取值有： string：字符串类型； json：json 对象类型。默认值为：string。", "example": "string" } ] } ], "required": [ "ZoneId", "FunctionId", "Operation" ] }, { "name": "IdentifyZone", "description": "用于验证站点所有权。", "status": "online", "parameters": [ { "name": "ZoneName", "type": "string", "required": true, "description": "站点名称。", "example": "test.com" }, { "name": "Domain", "type": "string", "required": false, "description": "站点下的子域名。如果验证站点下的子域名，则传该值，否则为空。", "example": "a.test.com" } ], "required": [ "ZoneName" ] }, { "name": "ImportZoneConfig", "description": "导入站点配置接口，本接口支持站点配置文件的快速导入，发起导入后接口会返回对应的任务 ID（TaskId），用户需通过查询站点配置导入结果接口（DescribeZoneConfigImportResult）获取本次导入任务执行的结果。该功能仅支持标准版和企业版套餐站点使用。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-2zpqp7qztest" }, { "name": "Content", "type": "string", "required": true, "description": "待导入的配置内容。要求采用 JSON 格式，按照 UTF-8 方式进行编码。配置内容可通过站点配置导出接口（ExportZoneConfig）获取。您可以单独导入「站点加速-全局加速配置」或「站点加速-规则引擎」，传入对应的字段即可，详情可以参考下方示例。", "example": "{\"FormatVersion\": \"1.0\"***}" } ], "required": [ "ZoneId", "Content" ] }, { "name": "IncreasePlanQuota", "description": "当您的套餐绑定的站点数，或配置的 Web 防护 - 自定义规则 - 精准匹配策略的规则数，或 Web 防护 - 速率限制 - 精准速率限制模块的规则数达到套餐允许的配额上限，可以通过该接口增购对应配额。 \u003e 该接口该仅支持企业版套餐。", "status": "online", "parameters": [ { "name": "PlanId", "type": "string", "required": true, "description": "套餐 ID, 形如 edgeone-2unuvzjmmn2q。", "example": "edgeone-2unuvzjmmn2q" }, { "name": "QuotaType", "type": "string", "required": true, "description": "新增的套餐配额类型，取值有： site：站点数； precise_access_control_rule：Web 防护 - 自定义规则 - 精准匹配策略的规则配额； rate_limiting_rule：Web 防护 - 速率限制 - 精准速率限制模块的规则配额。", "example": "zone" }, { "name": "QuotaNumber", "type": "integer", "required": true, "description": "新增的配额个数。单次新增的配额个数上限为 100。", "example": "1" } ], "required": [ "PlanId", "QuotaType", "QuotaNumber" ] }, { "name": "ModifyAccelerationDomain", "description": "修改加速域名信息", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "加速域名所属站点ID。", "example": "zone-225qgrnvbi9w" }, { "name": "DomainName", "type": "string", "required": true, "description": "加速域名名称。", "example": "qq.com" }, { "name": "OriginInfo", "type": "object", "required": false, "description": "源站信息。", "example": "无", "children": [ { "name": "OriginType", "type": "string", "required": true, "description": "源站类型，取值有： IP_DOMAIN：IPV4、IPV6 或域名类型源站； COS：腾讯云 COS 对象存储源站； AWS_S3：AWS S3 对象存储源站； ORIGIN_GROUP：源站组类型源站； VOD：云点播； SPACE：源站卸载，当前仅白名单开放； LB：负载均衡，当前仅白名单开放。", "example": "ip_domain" }, { "name": "Origin", "type": "string", "required": true, "description": "源站地址，根据 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 时，该参数为云\ufffd\ufffd...", "example": "qq.com" }, { "name": "BackupOrigin", "type": "string", "required": false, "description": "备用源站组 ID，该参数仅在 OriginType = ORIGIN_GROUP 时生效，该字段为旧版能力，调用后控制台无法进行配置修改，如需使用请提交工单咨询。", "example": "\"origin-07fa3f6c-4498-11ed-a368-5254006ca63d\"" }, { "name": "PrivateAccess", "type": "string", "required": false, "description": "指定是否允许访问私有对象存储源站，该参数仅当源站类型 OriginType = COS 或 AWS_S3 时会生效，取值有： on：使用私有鉴权； off：不使用私有鉴权。不填写时，默认值为off。", "example": "on" }, { "name": "PrivateParameters", "type": "array", "required": false, "description": "私有鉴权使用参数，该参数仅当源站类型 PrivateAccess = on 时会生效。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "私有鉴权参数名称，取值有： AccessKeyId：鉴权参数 Access Key ID； SecretAccessKey：鉴权参数 Secret Access Key； SignatureVersion：鉴权版本，v2 或者 v4； Region：存储桶地域。", "example": "AccessKeyId" }, { "name": "Value", "type": "string", "required": true, "description": "私有鉴权参数值。", "example": "AKID************" } ] }, { "name": "HostHeader", "type": "string", "required": false, "description": "自定义回源 HOST 头，该参数仅当 OriginType = IP_DOMAIN 时生效。当 OriginType 是其它类型源站时，不需要传入该参数，否则会报错。 当 OriginType = COS 或 AWS_S3 时，回源 HOST 头将与源站域名保持一致。 当 OriginType = ORIGIN_GROUP 时，回源 HOST 头遵循源站组内配置，如果没有配置则默认为加速域名。 当 OriginType = VOD 或 SPACE 时，无需配置该头部，按对应的回源域名生效。", "example": "www.tencentcloud.com" }, { "name": "VodOriginScope", "type": "string", "required": false, "description": "云点播回源范围，该参数当 OriginType = VOD 时生效。取值有：all：当前源站对应的云点播应用内所有文件；bucket：当前源站对应的云点播应用下指定某一个存储桶内的文件，通过参数 VodBucketId 来指定存储桶。不填写时，默认值为 all。", "example": "bucket" }, { "name": "VodBucketId", "type": "string", "required": false, "description": "VOD 存储桶 ID，该参数当 OriginType = VOD 且 VodOriginScope = bucket 时必填。数据来源：云点播专业版应用下存储桶的存储 ID 。", "example": "9lh4zav2ctts0ao" } ] }, { "name": "OriginProtocol", "type": "string", "required": false, "description": "回源协议，取值有： FOLLOW: 协议跟随； HTTP: HTTP协议回源； HTTPS: HTTPS协议回源。 不填保持原有配置。", "example": "FOLLOW" }, { "name": "HttpOriginPort", "type": "integer", "required": false, "description": "HTTP回源端口，取值为1-65535，当OriginProtocol=FOLLOW/HTTP时生效, 不填保持原有配置。", "example": "80" }, { "name": "HttpsOriginPort", "type": "integer", "required": false, "description": "HTTPS回源端口，取值为1-65535，当OriginProtocol=FOLLOW/HTTPS时生效，不填保持原有配置。", "example": "443" }, { "name": "IPv6Status", "type": "string", "required": false, "description": "IPv6状态，取值有： follow：遵循站点IPv6配置； on：开启状态； off：关闭状态。 不填保持原有配置。", "example": "follow" } ], "required": [ "ZoneId", "DomainName" ] }, { "name": "ModifyAccelerationDomainStatuses", "description": "批量修改加速域名状态", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "加速域名所属站点ID。", "example": "zone-225qgrnvbi9w" }, { "name": "DomainNames", "type": "array", "required": true, "description": "要执行状态变更的加速域名列表。", "example": "[\"qq.com\"]", "item_type": "string" }, { "name": "Status", "type": "string", "required": true, "description": "加速域名状态，取值有： online：启用； offline：停用。", "example": "online" }, { "name": "Force", "type": "boolean", "required": false, "description": "是否强制停用。当域名存在关联资源（如马甲域名、流量调度功能）时，是否强制停用该域名，取值有： true：停用该域名及所有关联资源； false：当该加速域名存在关联资源时，不允许停用。不填写，默认值为：false。", "example": "false" } ], "required": [ "ZoneId", "DomainNames", "Status" ] }, { "name": "ModifyAliasDomain", "description": "修改别称域名。 该功能仅企业版套餐支持，并且该功能当前仍在内测中，如需使用，请[联系我们](https://cloud.tencent.com/online-service?from=connect-us)。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-xxx" }, { "name": "AliasName", "type": "string", "required": true, "description": "别称域名名称。", "example": "eo.tencent.com" }, { "name": "TargetName", "type": "string", "required": true, "description": "目标域名名称。", "example": "a.example.com" }, { "name": "CertType", "type": "string", "required": false, "description": "证书配置，取值有： none：不配置； hosting：SSL托管证书； apply：申请免费证书。不填写保持原有配置。", "example": "none" }, { "name": "CertId", "type": "array", "required": false, "description": "当 CertType 取值为 hosting 时填入相应证书 ID。", "example": "LIeDuaN2", "item_type": "string" } ], "required": [ "ZoneId", "AliasName", "TargetName" ] }, { "name": "ModifyAliasDomainStatus", "description": "修改别称域名状态。 该功能仅企业版套餐支持，并且该功能当前仍在内测中，如需使用，请[联系我们](https://cloud.tencent.com/online-service?from=connect-us)。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-321dsafuux5x" }, { "name": "Paused", "type": "boolean", "required": true, "description": "别称域名状态，取值有： false：开启别称域名； true：关闭别称域名。", "example": "true" }, { "name": "AliasNames", "type": "array", "required": false, "description": "待修改状态的别称域名名称。如果为空，则不执行修改状态操作。", "example": "www.qq.com", "item_type": "string" } ], "required": [ "ZoneId", "Paused" ] }, { "name": "ModifyApplicationProxy", "description": "本接口为旧版，如需调用请尽快迁移至新版，详情请参考 [修改四层代理实例 ](https://cloud.tencent.com/document/product/1552/103411) 。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-21xfqlh4qjee" }, { "name": "ProxyId", "type": "string", "required": true, "description": "代理 ID。", "example": "proxy-19389e5dwwxfs" }, { "name": "ProxyName", "type": "string", "required": true, "description": "当 ProxyType=hostname 时，表示域名或子域名； 当 ProxyType=instance 时，表示代理名称。", "example": "proxy-name" }, { "name": "SessionPersistTime", "type": "integer", "required": false, "description": "会话保持时间，取值范围：30-3600，单位：秒。 不填写保持原有配置。", "example": "3600" }, { "name": "ProxyType", "type": "string", "required": false, "description": "四层代理模式，取值有： instance：表示实例模式。不填写使用默认值instance。", "example": "instance" }, { "name": "Ipv6", "type": "object", "required": false, "description": "Ipv6 访问配置，不填写保持原有配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "Ipv6 访问功能配置，取值有： on：开启Ipv6访问功能； off：关闭Ipv6访问功能。", "example": "on" } ] }, { "name": "AccelerateMainland", "type": "object", "required": false, "description": "中国大陆加速优化配置。 不填写表示保持原有配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "是否开启中国大陆加速优化配置，取值有： on：开启； off：关闭。", "example": "on" } ] } ], "required": [ "ZoneId", "ProxyId", "ProxyName" ] }, { "name": "ModifyApplicationProxyRule", "description": "本接口为旧版，如需调用请尽快迁移至新版，详情请参考 [修改四层代理转发规则 ](https://cloud.tencent.com/document/product/1552/103410) 。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点ID。", "example": "zone-21xfqlh4qjee" }, { "name": "ProxyId", "type": "string", "required": true, "description": "代理ID。", "example": "proxy-00dde48321vd" }, { "name": "RuleId", "type": "string", "required": true, "description": "规则ID。", "example": "rule-19389e5a-118b-11ed-9951-525400655ede" }, { "name": "OriginType", "type": "string", "required": true, "description": "源站类型，取值有： custom：手动添加； origins：源站组。", "example": "custom" }, { "name": "Port", "type": "array", "required": true, "description": "端口，支持格式： 80：80端口； 81-90：81至90端口。", "example": "[\"90\"]", "item_type": "string" }, { "name": "Proto", "type": "string", "required": false, "description": "协议，取值有： TCP：TCP协议； UDP：UDP协议。不填保持原有值。", "example": "TCP" }, { "name": "OriginValue", "type": "array", "required": false, "description": "源站信息： 当 OriginType 为 custom 时，表示一个或多个源站，如`[\"8.8.8.8\",\"9.9.9.9\"]` 或 `OriginValue=[\"test.com\"]`； 当 OriginType 为 origins 时，要求有且仅有一个元素，表示源站组ID，如`[\"origin-537f5b41-162a-11ed-abaa-525400c5da15\"]`。 不填保持原有值。", "example": "[\"1.1.1.1:80\",\"2.2.2.2:80\"]", "item_type": "string" }, { "name": "ForwardClientIp", "type": "string", "required": false, "description": "传递客户端IP，取值有： TOA：TOA（仅Proto=TCP时可选）； PPV1：Proxy Protocol传递，协议版本V1（仅Proto=TCP时可选）； PPV2：Proxy Protocol传递，协议版本V2； OFF：不传递。不填保持原有值。", "example": "TOA" }, { "name": "SessionPersist", "type": "boolean", "required": false, "description": "是否开启会话保持，取值有： true：开启； false：关闭。不填为false。", "example": "false" }, { "name": "SessionPersistTime", "type": "integer", "required": false, "description": "会话保持的时间，只有当SessionPersist为true时，该值才会生效。", "example": "3600" }, { "name": "OriginPort", "type": "string", "required": false, "description": "源站端口，支持格式： 单端口：80； 端口段：81-90，81至90端口。", "example": "80-90" }, { "name": "RuleTag", "type": "string", "required": false, "description": "规则标签。不填保持原有值。", "example": "rule-service-1" } ], "required": [ "ZoneId", "ProxyId", "RuleId", "OriginType", "Port" ] }, { "name": "ModifyApplicationProxyRuleStatus", "description": "本接口为旧版，如需调用请尽快迁移至新版，详情请参考 [修改四层代理转发规则状态 ](https://cloud.tencent.com/document/product/1552/103409) 。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点ID。", "example": "zone-21xfqlh4qjee" }, { "name": "ProxyId", "type": "string", "required": true, "description": "代理ID。", "example": "proxy-00dde483-9a2b-11ec-bcb0" }, { "name": "RuleId", "type": "string", "required": true, "description": "规则ID。", "example": "rule-xxx" }, { "name": "Status", "type": "string", "required": true, "description": "状态，取值有： offline: 停用； online: 启用。", "example": "online" } ], "required": [ "ZoneId", "ProxyId", "RuleId", "Status" ] }, { "name": "ModifyApplicationProxyStatus", "description": "本接口为旧版，如需调用请尽快迁移至新版，详情请参考 [修改四层代理实例状态](https://cloud.tencent.com/document/product/1552/103408) 。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点ID。", "example": "zone-67e6b19620" }, { "name": "ProxyId", "type": "string", "required": true, "description": "代理ID。", "example": "proxy-00dde41vdfs214" }, { "name": "Status", "type": "string", "required": true, "description": "状态，取值有： offline: 停用； online: 启用。", "example": "online" } ], "required": [ "ZoneId", "ProxyId", "Status" ] }, { "name": "ModifyContentIdentifier", "description": "修改内容标识符，仅支持修改描述。该功能仅白名单开放。", "status": "online", "parameters": [ { "name": "ContentId", "type": "string", "required": true, "description": "内容标识符 ID。", "example": "eocontent-27q0p0bali16" }, { "name": "Description", "type": "string", "required": true, "description": "内容标识符描述，长度限制不超过 20 个字符。", "example": "identifier-test" } ], "required": [ "ContentId", "Description" ] }, { "name": "ModifyCustomErrorPage", "description": "修改自定义错误页面。", "status": "online", "parameters": [ { "name": "PageId", "type": "string", "required": true, "description": "自定义错误页面 ID。", "example": "p-2kplomhisdcb" }, { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-2kplomhisdcb" }, { "name": "Name", "type": "string", "required": false, "description": "自定义错误页名称，名称为2 - 60个字符。", "example": "web防护自定义错误页" }, { "name": "Description", "type": "string", "required": false, "description": "自定义错误页描述，描述内容不超过60个字符。", "example": "web规则自定义错误页面" }, { "name": "ContentType", "type": "string", "required": false, "description": "自定义错误页面类型，取值有：text/html。 application/json。plain/text。text/xml。", "example": "application/json" }, { "name": "Content", "type": "string", "required": false, "description": "自定义错误页面内容。内容不超过 2KB。", "example": "{\"title\":\"自定义错误页\", \"Content\":\"自定义错误页面内容\"}" } ], "required": [ "PageId", "ZoneId" ] }, { "name": "ModifyDDoSProtection", "description": "修改站点的独立 DDoS 防护。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-25ryyvog1qih" }, { "name": "DDoSProtection", "type": "object", "required": true, "description": "独立 DDoS 防护配置。", "example": "无", "children": [ { "name": "ProtectionOption", "type": "string", "required": true, "description": "指定独立 DDoS 的防护范围。取值为： protect_all_domains：独立 DDoS 防护对站点内全部域名生效，新接入域名自动开启独立 DDoS 防护，入参为 protect_all_domains 时，入参 DomainDDoSProtections 不作处理； protect_specified_domains：仅对指定域名生效，具体范围可通过 DomainDDoSProtection 参数指定。", "example": "protect_all_domains" }, { "name": "DomainDDoSProtections", "type": "array", "required": false, "description": "域名的独立 DDoS 防护配置。在入参场景中： 当 ProtectionOption 保持为 protect_specified_domains 时：未填写的域名维持原有独立 DDoS 防护配置不变，显式指定的域名​按传入参数更新； 当 ProtectionOption 由 protect_all_domains 切换为 protect_specified_domains 时：若 DomainDDoSProtections 传空，停用站点下全部域名的独立 DDoS 防护；若 DomainDDoSProtections 不为空，参数中指定的域名停用或保持独立 DDoS 防\ufffd\ufffd...", "example": "无", "item_type": "object", "children": [ { "name": "Domain", "type": "string", "required": true, "description": "域名。", "example": "www.qq.com" }, { "name": "Switch", "type": "string", "required": true, "description": "域名的独立 DDoS 开关，取值为： on：已开启； off：已关闭。", "example": "off" } ] }, { "name": "SharedCNAMEDDoSProtections", "type": "array", "required": false, "description": "共享 CNAME 的独立 DDoS 防护配置。仅作为出参使用。", "example": "无", "item_type": "object", "children": [ { "name": "Domain", "type": "string", "required": true, "description": "域名。", "example": "www.qq.com" }, { "name": "Switch", "type": "string", "required": true, "description": "域名的独立 DDoS 开关，取值为： on：已开启； off：已关闭。", "example": "off" } ] } ] } ], "required": [ "ZoneId", "DDoSProtection" ] }, { "name": "ModifyDnsRecords", "description": "您可以通过本接口批量修改 DNS 记录。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID 。", "example": "zone-2psss4drfg29" }, { "name": "DnsRecords", "type": "array", "required": false, "description": "DNS 记录修改数据列表，一次最多修改100条。", "example": "无", "item_type": "object", "children": [ { "name": "ZoneId", "type": "string", "required": false, "description": "站点 ID。注意：ZoneId 仅做出参使用，在 ModifyDnsRecords 不可作为入参使用，如有传此参数，会忽略。", "example": "zone-20hyebgyfsko" }, { "name": "RecordId", "type": "string", "required": false, "description": "DNS 记录 ID。", "example": "record-3d5dg39c" }, { "name": "Name", "type": "string", "required": false, "description": "DNS 记录名。", "example": "www.a.com" }, { "name": "Type", "type": "string", "required": false, "description": "DNS 记录类型，取值有： A：将域名指向一个外网 IPv4 地址，如 8.8.8.8； AAAA：将域名指向一个外网 IPv6 地址； MX：用于邮箱服务器。存在多条 MX 记录时，优先级越低越优先； CNAME：将域名指向另一个域名，再由该域名解析出最终 IP 地址； TXT：对域名进行标识和说明，常用于域名验证和 SPF 记录（反垃圾邮件）； NS：如果需要将子域名交给其他 DNS 服务商解析，则需要添加 NS 记\ufffd\ufffd...", "example": "A" }, { "name": "Location", "type": "string", "required": false, "description": "DNS 记录解析线路，不指定默认为 Default，表示默认解析线路，代表全部地域生效。解析线路配置仅适用于当 Type（DNS 记录类型）为 A、AAAA、CNAME 时。取值请参考：[解析线路及对应代码枚举](https://cloud.tencent.com/document/product/1552/112542)。", "example": "Default" }, { "name": "Content", "type": "string", "required": false, "description": "DNS 记录内容。根据 Type 值填入与之相对应的内容。", "example": "1.1.1.1" }, { "name": "TTL", "type": "integer", "required": false, "description": "缓存时间，取值范围 60~86400，数值越小，修改记录各地生效时间越快，单位：秒。", "example": "60" }, { "name": "Weight", "type": "integer", "required": false, "description": "DNS 记录权重，取值范围 -1~100，为 -1 时表示不分配权重，为 0 时表示不解析。权重配置仅适用于当 Type（DNS 记录类型）为 A、AAAA、CNAME 时。", "example": "100" }, { "name": "Priority", "type": "integer", "required": false, "description": "MX 记录优先级，取值范围 0~50，数值越小越优先。", "example": "10" }, { "name": "Status", "type": "string", "required": false, "description": "DNS 记录解析状态，取值有：enable：已生效；disable：已停用。注意：Status 仅做出参使用，在 ModifyDnsRecords 不可作为入参使用，如有传此参数，会忽略。", "example": "enable" }, { "name": "CreatedOn", "type": "string", "required": false, "description": "创建时间。注意：CreatedOn 仅做出参使用，在 ModifyDnsRecords 不可作为入参使用，如有传此参数，会忽略。", "example": "2020-09-22T00:00:00Z" }, { "name": "ModifiedOn", "type": "string", "required": false, "description": "修改时间。注意：ModifiedOn 仅做出参使用，在 ModifyDnsRecords 不可作为入参使用，如有传此参数，会忽略。", "example": "2020-09-22T00:00:00Z" } ] } ], "required": [ "ZoneId" ] }, { "name": "ModifyDnsRecordsStatus", "description": "您可以通过本接口批量修改 DNS 记录的状态，批量对记录进行开启和停用。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-25ryyvog1qih" }, { "name": "RecordsToEnable", "type": "array", "required": false, "description": "待启用的 DNS 记录 ID 列表，上限：200。注意：同个 DNS 记录 ID 不能同时存在于 RecordsToEnable 和 RecordsToDisable。", "example": "[“record-25ryzh92h8qh”]", "item_type": "string" }, { "name": "RecordsToDisable", "type": "array", "required": false, "description": "待停用的 DNS 记录 ID 列表，上限：200。注意：同个 DNS 记录 ID 不能同时存在于 RecordsToEnable 和 RecordsToDisable。", "example": "[“record-25ryzh92h8qh”]", "item_type": "string" } ], "required": [ "ZoneId" ] }, { "name": "ModifyFunction", "description": "修改边缘函数，支持修改函数的内容及描述信息，修改且重新部署后，函数立刻生效。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-2gqxim9jstab" }, { "name": "FunctionId", "type": "string", "required": true, "description": "函数 ID。", "example": "ef-jjhvk7ec" }, { "name": "Remark", "type": "string", "required": false, "description": "函数描述，最大支持 60 个字符，不填写保持原有配置。", "example": "鉴权函数" }, { "name": "Content", "type": "string", "required": false, "description": "函数内容，当前仅支持 JavaScript 代码，最大支持 5MB 大小，不填写保持原有配置。", "example": "addEventListener('fetch', e =\u003e { const response = new Response('Hello World!'); e.respondWith(response); });" } ], "required": [ "ZoneId", "FunctionId" ] }, { "name": "ModifyFunctionRule", "description": "修改边缘函数触发规则，支持修改规则条件、执行函数以及描述信息。您可以先通过 DescribeFunctionRules 接口来获取需要修改的规则的 RuleId，然后传入修改后的规则内容，原规则内容会被覆盖式更新。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-2gqxim9jstab" }, { "name": "RuleId", "type": "string", "required": true, "description": "规则 ID。您可以先通过 DescribeFunctionRules 接口来获取需要修改的规则的 RuleId，然后传入修改后的规则内容，原规则内容会被覆盖式更新。", "example": "rule-02y3grbu" }, { "name": "FunctionRuleConditions", "type": "array", "required": false, "description": "规则条件列表，相同触发规则的不同条件匹配项之间为或关系，不填写保持原有配置。", "example": "无", "item_type": "object", "children": [ { "name": "RuleConditions", "type": "array", "required": true, "description": "边缘函数触发规则条件，该列表内所有项全部满足即判断该条件满足。", "example": "[]", "item_type": "object", "children": [ { "name": "Operator", "type": "string", "required": true, "description": "运算符，取值有： equal: 等于； notequal: 不等于； exist: 存在； notexist: 不存在。", "example": "equal" }, { "name": "Target", "type": "string", "required": true, "description": "匹配类型，取值有： 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...", "example": "url" }, { "name": "Values", "type": "array", "required": false, "description": "对应匹配类型的参数值，仅在匹配类型为查询字符串或HTTP请求头并且运算符取值为存在或不存在时允许传空数组，对应匹配类型有： 文件后缀：jpg、txt 等文件后缀； 文件名称：例如 foo.jpg 中的 foo； 全部（站点任意请求）：all； HOST：当前站点下的 host ，例如www.maxx55.com； URL Path：当前站点下 URL 路径的请求，例如：/example； URL Full：当前站点下完整 URL 请求，必须包含 HTTP 协\ufffd...", "example": "[\"www.maxx55.com\"]", "item_type": "string" }, { "name": "IgnoreCase", "type": "boolean", "required": false, "description": "是否忽略参数值的大小写，默认值为 false。", "example": "true" }, { "name": "Name", "type": "string", "required": false, "description": "对应匹配类型的参数名称，在 Target 值为以下取值时有效，有效时值不能为空： query_string（查询字符串）: 当前站点下URL请求中查询字符串的参数名称，例如lang=cn\u0026version=1中的lang和version； request_header（HTTP 请求头）: HTTP请求头部字段名，例如Accept-Language:zh-CN,zh;q=0.9中的Accept-Language。", "example": "Accept-Language" } ] } ] }, { "name": "TriggerType", "type": "string", "required": false, "description": "函数选择配置类型： direct：直接指定执行函数； weight：基于权重比选择函数； region：基于客户端 IP 的国家/地区选择函数。 不填时默认为 direct 。", "example": "direct" }, { "name": "FunctionId", "type": "string", "required": false, "description": "指定执行的函数 ID。当 TriggerType 为 direct 或 TriggerType 不填时生效。", "example": "ef-jjhvk7ec" }, { "name": "RegionMappingSelections", "type": "array", "required": false, "description": "基于客户端 IP 国家/地区的函数选择配置，当 TriggerType 为 region 时生效且 RegionMappingSelections 必填。RegionMappingSelections 中至少包含一项 Regions 为 Default 的配置。", "example": "无", "item_type": "object", "children": [ { "name": "FunctionId", "type": "string", "required": true, "description": "函数 ID 。", "example": "ef-0agikbrr" }, { "name": "Regions", "type": "array", "required": true, "description": "国家/地区列表。示例值：CN：中国，CN.GD：中国广东。取值请参考：[国家/地区及对应代码枚举](https://cloud.tencent.com/document/product/1552/112542)。", "example": "[\"CN\"]", "item_type": "string" } ] }, { "name": "WeightedSelections", "type": "array", "required": false, "description": "基于权重的函数选择配置，当 TriggerType 为 weight 时生效且 WeightedSelections 必填。WeightedSelections 中的所有权重之和需要为100。", "example": "无", "item_type": "object", "children": [ { "name": "FunctionId", "type": "string", "required": true, "description": "函数 ID 。", "example": "ef-0agikbrr" }, { "name": "Weight", "type": "integer", "required": true, "description": "选中权重。取值范围0-100，所有的权重之和需要为100。 选中概率计算方式为： weight/100。例如设置了两个函数 A 和 B ，其中 A 的权重为30，那么 B 的权重必须为70，最终选中 A 的概率为30%，选中 B 的概率为70%。", "example": "30" } ] }, { "name": "Remark", "type": "string", "required": false, "description": "规则描述，最大支持 60 个字符，不填写保持原有配置。", "example": "鉴权规则" } ], "required": [ "ZoneId", "RuleId" ] }, { "name": "ModifyFunctionRulePriority", "description": "修改边缘函数触发规则的优先级。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-293e7s5jne1i" }, { "name": "RuleIds", "type": "array", "required": true, "description": "规则 ID 列表，必须填入调整优先级后的所有规则 ID，多条规则执行顺序依次从上往下，不填写保持原优先级顺序。", "example": "[\"rule-02y3grbu\", \"rule-02sfmvlw\"]", "item_type": "string" } ], "required": [ "ZoneId", "RuleIds" ] }, { "name": "ModifyHostsCertificate", "description": "完成域名创建之后，您可以为域名配置自有证书，也可以使用 EdgeOne 为您提供的 [免费证书](https://cloud.tencent.com/document/product/1552/90437)。 如果您需要配置自有证书，请先将证书上传至 [SSL证书控制台](https://console.cloud.tencent.com/certoverview)，然后在本接口中传入对应的证书 ID。详情参考 [部署自有证书至 EdgeOne 域名 ](https://cloud.tencent.com/document/product/1552/88874)。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-343vqcswn9zj" }, { "name": "Hosts", "type": "array", "required": true, "description": "需要修改证书配置的加速域名。", "example": "[\"www.test.com\"]", "item_type": "string" }, { "name": "Mode", "type": "string", "required": false, "description": "配置服务端证书的模式，取值有： disable：不配置服务端证书； eofreecert：通过自动验证申请免费证书并部署。验证方式详见：[申请免费证书支持的验证方式](https://cloud.tencent.com/document/product/1552/90437) - 在 NS 或者 DNSPod 托管接入模式下，仅支持自动验证的方式申请免费证书。 - 当免费证书申请失败时会导致证书部署失败，您可以通过检查免费证书申请结果接口获取申请失败原因\ufffd...", "example": "eofreecert" }, { "name": "ServerCertInfo", "type": "array", "required": false, "description": "SSL 证书配置，本参数仅在 mode 为 sslcert 时生效，传入对应证书的 CertId 即可。您可以前往 [SSL 证书列表](https://console.cloud.tencent.com/ssl) 查看 CertId。", "example": "无", "item_type": "object", "children": [ { "name": "CertId", "type": "string", "required": true, "description": "服务器证书 ID。来源于 SSL 侧，您可以前往 [SSL 证书列表](https://console.cloud.tencent.com/ssl) 查看 CertId。", "example": "EO-dsfdsf" }, { "name": "Alias", "type": "string", "required": false, "description": "证书备注名。", "example": "默认证书" }, { "name": "Type", "type": "string", "required": false, "description": "证书类型，取值有： default：默认证书； upload：用户上传； managed：腾讯云托管。", "example": "default" }, { "name": "ExpireTime", "type": "string", "required": false, "description": "证书过期时间。", "example": "2014-08-03T12:00:00+08:00" }, { "name": "DeployTime", "type": "string", "required": false, "description": "证书部署时间。", "example": "2014-08-03T12:00:00+08:00" }, { "name": "SignAlgo", "type": "string", "required": false, "description": "签名算法。", "example": "RSA" }, { "name": "CommonName", "type": "string", "required": false, "description": "证书归属域名名称。", "example": "tencent.cloud" } ] }, { "name": "ClientCertInfo", "type": "object", "required": false, "description": "在边缘双向认证场景下，该字段为客户端的 CA 证书，部署在 EO 节点内，用于客户端对 EO 节点进行认证。默认关闭，不填写表示保持原有配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "双向认证配置开关，取值有： on：开启； off：关闭。", "example": "on/off" }, { "name": "CertInfos", "type": "array", "required": false, "description": "双向认证证书列表。 注意：MutualTLS 在 ModifyHostsCertificate 作为入参使用时，该参数传入对应证书的 CertId 即可。您可以前往 [SSL 证书列表](https://console.cloud.tencent.com/ssl) 查看 CertId。", "example": "无", "item_type": "object", "children": [ { "name": "CertId", "type": "string", "required": true, "description": "证书 ID。来源于 SSL 侧，您可以前往 [SSL 证书列表](https://console.cloud.tencent.com/ssl) 查看 CertId。", "example": "EO-dsfdsf" }, { "name": "Alias", "type": "string", "required": false, "description": "证书备注名。", "example": "默认证书" }, { "name": "Type", "type": "string", "required": false, "description": "证书类型，取值有： default：默认证书； upload：用户上传； managed：腾讯云托管。", "example": "default" }, { "name": "ExpireTime", "type": "string", "required": false, "description": "证书过期时间。", "example": "2014-08-03T12:00:00+08:00" }, { "name": "DeployTime", "type": "string", "required": false, "description": "证书部署时间。", "example": "2014-08-03T12:00:00+08:00" }, { "name": "SignAlgo", "type": "string", "required": false, "description": "签名算法。", "example": "RSA" }, { "name": "Status", "type": "string", "required": false, "description": "证书状态，取值有： deployed：已部署； processing：部署中； applying：申请中； failed：申请失败； issued：绑定失败。", "example": "deployed" } ] } ] }, { "name": "UpstreamCertInfo", "type": "object", "required": false, "description": "用于分别开启/关闭回源双向认证和源站证书校验。默认关闭，不填写表示保持原有配置。回源双向认证配置当前为白名单内侧中，如需使用，请[联系我们](https://cloud.tencent.com/online-service)。", "example": "无", "children": [ { "name": "UpstreamMutualTLS", "type": "object", "required": false, "description": "在回源双向认证场景下，该字段为 EO 节点回源时携带的证书（包含公钥、私钥即可），部署在 EO 节点，用于源站对 EO 节点进行认证。在作为入参使用时，不填写表示保持原有配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "双向认证配置开关，取值有： on：开启； off：关闭。", "example": "on/off" }, { "name": "CertInfos", "type": "array", "required": false, "description": "双向认证证书列表。 注意：MutualTLS 在 ModifyHostsCertificate 作为入参使用时，该参数传入对应证书的 CertId 即可。您可以前往 [SSL 证书列表](https://console.cloud.tencent.com/ssl) 查看 CertId。", "example": "无", "item_type": "object", "children": [ { "name": "CertId", "type": "string", "required": true, "description": "证书 ID。来源于 SSL 侧，您可以前往 [SSL 证书列表](https://console.cloud.tencent.com/ssl) 查看 CertId。", "example": "EO-dsfdsf" }, { "name": "Alias", "type": "string", "required": false, "description": "证书备注名。", "example": "默认证书" }, { "name": "Type", "type": "string", "required": false, "description": "证书类型，取值有： default：默认证书； upload：用户上传； managed：腾讯云托管。", "example": "default" }, { "name": "ExpireTime", "type": "string", "required": false, "description": "证书过期时间。", "example": "2014-08-03T12:00:00+08:00" }, { "name": "DeployTime", "type": "string", "required": false, "description": "证书部署时间。", "example": "2014-08-03T12:00:00+08:00" }, { "name": "SignAlgo", "type": "string", "required": false, "description": "签名算法。", "example": "RSA" }, { "name": "Status", "type": "string", "required": false, "description": "证书状态，取值有： deployed：已部署； processing：部署中； applying：申请中； failed：申请失败； issued：绑定失败。", "example": "deployed" } ] } ] }, { "name": "UpstreamCertificateVerify", "type": "object", "required": false, "description": "在源站证书校验场景下，该字段为 EO 节点回源时用于验证的 CA 证书，部署在 EO 节点，用于 EO 节点对服务端证书进行认证。在作为入参使用时，不填写表示保持原有配置。", "example": "无", "children": [ { "name": "VerificationMode", "type": "string", "required": true, "description": "源站证书校验模式。取值有：disable:禁用源站证书校验。custom_ca:使用指定受信任 CA 证书校验。", "example": "custom_ca" }, { "name": "CustomCACerts", "type": "array", "required": false, "description": "指定受信任的 CA 证书列表，源站证书需要由该 CA 签发才能校验通过。 注意：仅当 VerificationMode 为 custom_ca 时，需要传入该参数，指定受信任的CA证书信息。 OriginCertificateVerify 在 ModifyHostsCertificate 作为入参使用时，该参数传入对应证书的 CertId 即可。您可以前往 [SSL 证书列表](https://console.cloud.tencent.com/ssl) 查看 CertId。", "example": "无", "item_type": "object", "children": [ { "name": "CertId", "type": "string", "required": true, "description": "证书 ID。来源于 SSL 侧，您可以前往 [SSL 证书列表](https://console.cloud.tencent.com/ssl) 查看 CertId。", "example": "EO-dsfdsf" }, { "name": "Alias", "type": "string", "required": false, "description": "证书备注名。", "example": "默认证书" }, { "name": "Type", "type": "string", "required": false, "description": "证书类型，取值有： default：默认证书； upload：用户上传； managed：腾讯云托管。", "example": "default" }, { "name": "ExpireTime", "type": "string", "required": false, "description": "证书过期时间。", "example": "2014-08-03T12:00:00+08:00" }, { "name": "DeployTime", "type": "string", "required": false, "description": "证书部署时间。", "example": "2014-08-03T12:00:00+08:00" }, { "name": "SignAlgo", "type": "string", "required": false, "description": "签名算法。", "example": "RSA" }, { "name": "Status", "type": "string", "required": false, "description": "证书状态，取值有： deployed：已部署； processing：部署中； applying：申请中； failed：申请失败； issued：绑定失败。", "example": "deployed" } ] } ] } ] } ], "required": [ "ZoneId", "Hosts" ] }, { "name": "ModifyL4Proxy", "description": "用于修改四层代理实例的配置。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-2gpv1z8cx8y2" }, { "name": "ProxyId", "type": "string", "required": true, "description": "应用 ID。", "example": "sid-2gpv1z8sx8y2" }, { "name": "Ipv6", "type": "string", "required": false, "description": "是否开启 IPv6 访问。 不填该参数时，表示不修改该配置。该配置仅在部分加速区域和安全防护配置下支持开启，详情请参考 [新建四层代理实例](https://cloud.tencent.com/document/product/1552/90025) 。取值为： on：开启； off：关闭。", "example": "off" }, { "name": "AccelerateMainland", "type": "string", "required": false, "description": "是否开启中国大陆网络优化。不填该参数时，表示不修改该配置。该配置仅在部分加速区域和安全防护配置下支持开启，详情请参考 [新建四层代理实例](https://cloud.tencent.com/document/product/1552/90025) 。取值为： on：开启； off：关闭。", "example": "on" } ], "required": [ "ZoneId", "ProxyId" ] }, { "name": "ModifyL4ProxyRules", "description": "用于修改四层代理转发规则，支持单条或者批量修改。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-21xfqlh4qjee" }, { "name": "ProxyId", "type": "string", "required": true, "description": "四层代理实例 ID。", "example": "proxy-00dde48321vd" }, { "name": "L4ProxyRules", "type": "array", "required": true, "description": "转发规则列表。单次最多支持 200 条转发规则。 注意：L4ProxyRule 在此处使用时，RuleId 为必填字段；Protocol、PortRange、OriginType、OriginValue、OriginPortRange、ClientIPPassThroughMode、SessionPersist、SessionPersistTime、RuleTag 均为选填字段，不填写表示不修改；Status 请勿填写。", "example": "无", "item_type": "object", "children": [ { "name": "RuleId", "type": "string", "required": false, "description": "转发规则 ID。 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数请勿填写；在 ModifyL4ProxyRules 作为入参使用时，该参数必填。", "example": "rule-xxx" }, { "name": "Protocol", "type": "string", "required": false, "description": "转发协议。取值有： TCP：TCP 协议； UDP：UDP 协议。 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。", "example": "TCP" }, { "name": "PortRange", "type": "array", "required": false, "description": "转发端口，支持按照以下形式填写： 单端口，如：80； 端口段，如：81-85。表示 81、82、83、84、85 五个端口。 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。", "example": "[\"80\"]", "item_type": "string" }, { "name": "OriginType", "type": "string", "required": false, "description": "源站类型，取值有： IP_DOMAIN：IP/域名源站； ORIGIN_GROUP：源站组； LB：负载均衡，当前仅白名单开放。 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。", "example": "IP_DOMAIN" }, { "name": "OriginValue", "type": "array", "required": false, "description": "源站地址： 当 OriginType 为 IP_DOMAIN 时，填写 IP 或域名，如 8.8.8.8 或 test.com ； 当 OriginType 为 ORIGIN_GROUP 时，填写源站组 ID，如 og-537y24vf5b41； 当 OriginType 为 LB 时，填写负载均衡实例 ID，如 lb-2qwk30xf7s9g。 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。", "example": "[\"1.1.1.1\"]", "item_type": "string" }, { "name": "OriginPortRange", "type": "string", "required": false, "description": "源站端口，支持按照以下形式填写： 单端口，如：80； 端口段，如：81-85，表示 81、82、83、84、85 五个端口。填写端口段时，则需要与转发端口段长度保持一致，例如转发端口：80-90，则转发端口：90-100。 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。", "example": "80-90" }, { "name": "ClientIPPassThroughMode", "type": "string", "required": false, "description": "传递客户端 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 作为入参使用时，该参数选填，\ufffd\ufffd...", "example": "TOA" }, { "name": "SessionPersist", "type": "string", "required": false, "description": "是否开启会话保持，取值有： on：开启； off：关闭。 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 off；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。", "example": "off" }, { "name": "SessionPersistTime", "type": "integer", "required": false, "description": "会话保持时间，取值范围为 30-3600，单位为秒。 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，仅当 SessionPersist = on 时，该值才会生效，且当 SessionPersist = on ，该值不填写默认为 3600；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。", "example": "3600" }, { "name": "RuleTag", "type": "string", "required": false, "description": "规则标签。可输入1-50 个任意字符。 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。", "example": "rule-service1" }, { "name": "Status", "type": "string", "required": false, "description": "规则状态，取值有： online：已启用； offline：已停用； progress：部署中； stopping：停用中； fail：部署失败/停用失败。 注意：L4ProxyRule 在 CreateL4ProxyRules、ModifyL4ProxyRules 作为入参使用时，该参数请勿填写。", "example": "online" }, { "name": "BuId", "type": "string", "required": false, "description": "BuID。", "example": "12948955" }, { "name": "RemoteAuth", "type": "object", "required": false, "description": "远程鉴权信息。 注意：RemoteAuth 在 CreateL4ProxyRules 或 ModifyL4ProxyRules 不可作为入参使用，如有传此参数，会忽略。在 DescribeL4ProxyRules 返回为空时，表示没有开启远程鉴权。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "四层远程鉴权开关，取值有： on：表示开启; off：表示关闭。", "example": "on" }, { "name": "Address", "type": "string", "required": true, "description": "远程鉴权服务地址，格式为: domain/ip:port。例：example.auth.com:8888", "example": "example.auth.com:8888" }, { "name": "ServerFaultyBehavior", "type": "string", "required": true, "description": "远程鉴权服务不可访问后，经过四层转发规则默认回源行为，取值有： reject：表示进行拦截，拒绝访问; allow：表示允许通过。", "example": "allow" } ] } ] } ], "required": [ "ZoneId", "ProxyId", "L4ProxyRules" ] }, { "name": "ModifyL4ProxyRulesStatus", "description": "用于启用/停用四层代理转发规则状态，支持单条或者批量操作。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-21xfqlh4qjee" }, { "name": "ProxyId", "type": "string", "required": true, "description": "四层代理实例 ID。", "example": "proxy-00dde483-9a2b-11ec-bcb0" }, { "name": "RuleIds", "type": "array", "required": true, "description": "转发规则 ID 列表。单次最多支持 200 条转发规则。", "example": "[\"rule-xxx\"]", "item_type": "string" }, { "name": "Status", "type": "string", "required": true, "description": "转发规则状态，取值有： online：启用； offline：停用。", "example": "online" } ], "required": [ "ZoneId", "ProxyId", "RuleIds", "Status" ] }, { "name": "ModifyL4ProxyStatus", "description": "用于启用/停用四层代理实例。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-67e6b19620" }, { "name": "ProxyId", "type": "string", "required": true, "description": "四层代理实例 ID。", "example": "sid-2nvaw7ab73kc" }, { "name": "Status", "type": "string", "required": true, "description": "四层代理实例状态，取值有： online：启用； offline：停用。", "example": "online" } ], "required": [ "ZoneId", "ProxyId", "Status" ] }, { "name": "ModifyL7AccRule", "description": "本接口用于修改[规则引擎](https://cloud.tencent.com/document/product/1552/70901)中的规则，单次仅支持修改单条规则。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-djuqmq" }, { "name": "Rule", "type": "object", "required": true, "description": "需要修改的规则。您可以先通过 DescribeL7AccRules 接口来获取需要修改的规则的 Ruleid，然后传入修改后的规则内容，原规则内容会被覆盖式更新。", "example": "无", "children": [ { "name": "Status", "type": "string", "required": false, "description": "规则状态。取值有： enable: 启用； disable: 未启用。", "example": "enable" }, { "name": "RuleId", "type": "string", "required": false, "description": "规则 ID。规则的唯一性标识，当调用 ModifyL7AccRules 时，该参数必填。", "example": "rule-30maftui9q4f" }, { "name": "RuleName", "type": "string", "required": false, "description": "规则名称。名称长度限制不超过 255 个字符。", "example": "rule test" }, { "name": "Description", "type": "array", "required": false, "description": "规则注释。可以填写多个注释。", "example": "[\"name1\"]", "item_type": "string" }, { "name": "Branches", "type": "array", "required": false, "description": "子规则分支。此列表当前只支持填写一项规则，多填无效。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Condition", "type": "string", "required": false, "description": "[匹配条件](https://cloud.tencent.com/document/product/1552/90438#33f65828-c6c6-4b66-a011-25a20b548d5d)。", "example": "\"${http.request.host} in ['test.test.com']\"" }, { "name": "Actions", "type": "array", "required": false, "description": "[操作](https://cloud.tencent.com/document/product/1552/90438#c7bd7e02-9247-4a72-b0e4-11c27cadb198)。注意：Actions 和 SubRules 不可同时为空。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "操作名称。名称需要与参数结构体对应，例如 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：智能加速； Range...", "example": "Cache" }, { "name": "CacheParameters", "type": "object", "required": false, "description": "节点缓存 TTL 配置参数，当 Name 取值为 Cache 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "CacheKeyParameters", "type": "object", "required": false, "description": "自定义 Cache Key 配置参数，当 Name 取值为 CacheKey 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "CachePrefreshParameters", "type": "object", "required": false, "description": "缓存预刷新配置参数，当 Name 取值为 CachePrefresh 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "AccessURLRedirectParameters", "type": "object", "required": false, "description": "访问 URL 重定向配置参数，当 Name 取值为 AccessURLRedirect 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "UpstreamURLRewriteParameters", "type": "object", "required": false, "description": "回源 URL 重写配置参数，当 Name 取值为 UpstreamURLRewrite 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "QUICParameters", "type": "object", "required": false, "description": "QUIC 配置参数，当 Name 取值为 QUIC 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "WebSocketParameters", "type": "object", "required": false, "description": "WebSocket 配置参数，当 Name 取值为 WebSocket 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "AuthenticationParameters", "type": "object", "required": false, "description": "Token 鉴权配置参数，当 Name 取值为 Authentication 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "MaxAgeParameters", "type": "object", "required": false, "description": "浏览器缓存 TTL 配置参数，当 Name 取值为 MaxAge 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "StatusCodeCacheParameters", "type": "object", "required": false, "description": "状态码缓存 TTL 配置参数，当 Name 取值为 StatusCodeCache 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "OfflineCacheParameters", "type": "object", "required": false, "description": "离线缓存配置参数，当 Name 取值为 OfflineCache 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "SmartRoutingParameters", "type": "object", "required": false, "description": "智能加速配置参数，当 Name 取值为 SmartRouting 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "RangeOriginPullParameters", "type": "object", "required": false, "description": "分片回源配置参数，当 Name 取值为 RangeOriginPull 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "UpstreamHTTP2Parameters", "type": "object", "required": false, "description": "HTTP2 回源配置参数，当 Name 取值为 UpstreamHTTP2 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "HostHeaderParameters", "type": "object", "required": false, "description": "Host Header 重写配置参数，当 Name 取值为 HostHeader 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ForceRedirectHTTPSParameters", "type": "object", "required": false, "description": "访问协议强制 HTTPS 跳转配置，当 Name 取值为 ForceRedirectHTTPS 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "OriginPullProtocolParameters", "type": "object", "required": false, "description": "回源 HTTPS 配置参数，当 Name 取值为 OriginPullProtocol 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "CompressionParameters", "type": "object", "required": false, "description": "智能压缩配置，当 Name 取值为 Compression 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "HSTSParameters", "type": "object", "required": false, "description": "HSTS 配置参数，当 Name 取值为 HSTS 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ClientIPHeaderParameters", "type": "object", "required": false, "description": "存储客户端请求 IP 的头部信息配置，当 Name 取值为 ClientIPHeader 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "OCSPStaplingParameters", "type": "object", "required": false, "description": "OCSP 装订配置参数，当 Name 取值为 OCSPStapling 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "HTTP2Parameters", "type": "object", "required": false, "description": "HTTP2 接入配置参数，当 Name 取值为 HTTP2 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "PostMaxSizeParameters", "type": "object", "required": false, "description": "POST 请求上传文件流式传输最大限制配置，当 Name 取值为 PostMaxSize 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ClientIPCountryParameters", "type": "object", "required": false, "description": "回源时携带客户端 IP 所属地域信息配置参数，当 Name 取值为 ClientIPCountry 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "UpstreamFollowRedirectParameters", "type": "object", "required": false, "description": "回源跟随重定向参数配置，当 Name 取值为 UpstreamFollowRedirect 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "UpstreamRequestParameters", "type": "object", "required": false, "description": "回源请求参数配置参数，当 Name 取值为 UpstreamRequest 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "TLSConfigParameters", "type": "object", "required": false, "description": "SSL/TLS 安全配置参数，当 Name 取值为 TLSConfig 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ModifyOriginParameters", "type": "object", "required": false, "description": "修改源站配置参数，当 Name 取值为 ModifyOrigin 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "HTTPUpstreamTimeoutParameters", "type": "object", "required": false, "description": "七层回源超时配置，当 Name 取值为 HTTPUpstreamTimeout 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "HttpResponseParameters", "type": "object", "required": false, "description": "HTTP 应答配置参数，当 Name 取值为 HttpResponse 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ErrorPageParameters", "type": "object", "required": false, "description": "自定义错误页面配置参数，当 Name 取值为 ErrorPage 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ModifyResponseHeaderParameters", "type": "object", "required": false, "description": "修改 HTTP 节点响应头配置参数，当 Name 取值为 ModifyResponseHeader 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ModifyRequestHeaderParameters", "type": "object", "required": false, "description": "修改 HTTP 节点请求头配置参数，当 Name 取值为 ModifyRequestHeader 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ResponseSpeedLimitParameters", "type": "object", "required": false, "description": "单连接下载限速配置参数，当 Name 取值为 ResponseSpeedLimit 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "SetContentIdentifierParameters", "type": "object", "required": false, "description": "内容标识配置参数，当 Name 取值为 SetContentIdentifier 时，该参数必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "VaryParameters", "type": "object", "required": false, "description": "Vary 特性配置参数，当 Name 取值为 Vary 时，该参数必填。", "example": "无" }, { "name": "ContentCompressionParameters", "type": "object", "required": false, "description": "内容压缩配置参数，当 Name 取值为 ContentCompression 时，该参数必填。该参数为白名单功能，如有需要，请联系腾讯云工程师处理。", "example": "无" }, { "name": "OriginAuthenticationParameters", "type": "object", "required": false, "description": "回源鉴权配置参数，当 Name 取值为 OriginAuthentication 时，该参数必填。该参数为白名单功能，如有需要，请联系腾讯云工程师处理。", "example": "无" } ] }, { "name": "SubRules", "type": "array", "required": false, "description": "子规则列表。此列表中时存在多条规则，按照从上往下的顺序依次执行。注意：SubRules 和 Actions 不可同时为空。且当前只支持填写一层 SubRules。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Branches", "type": "array", "required": false, "description": "子规则分支 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "Description", "type": "array", "required": false, "description": "规则注释。", "example": "[\"tag1\", \"tag2\"]", "item_type": "string" } ] } ] }, { "name": "RulePriority", "type": "integer", "required": false, "description": "规则优先级。仅作为出参使用。", "example": "1" } ] } ], "required": [ "ZoneId", "Rule" ] }, { "name": "ModifyL7AccRulePriority", "description": "本接口用于修改[规则引擎](https://cloud.tencent.com/document/product/1552/70901)中规则列表的优先级，本接口需要传入站点 ID 下完整的规则 ID 列表，规则 ID 列表可以通过[查询七层加速规则](https://cloud.tencent.com/document/product/1552/115820)接口获取，最终优先级顺序将调整成规则 ID 列表的顺序，从前往后执行。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-example" }, { "name": "RuleIds", "type": "array", "required": true, "description": "站点 ID 下完整的规则 ID 列表，规则 ID 列表可以通过 [查询七层加速规则](https://cloud.tencent.com/document/product/1552/115820) 获取，最终优先级顺序将调整成规则 ID 列表的顺序，从前往后依次执行。", "example": "[\"rule-example1\", \"rule-example2\"]", "item_type": "string" } ], "required": [ "ZoneId", "RuleIds" ] }, { "name": "ModifyL7AccSetting", "description": "本接口用于修改[站点加速](https://cloud.tencent.com/document/product/1552/96193)全局配置。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-21xfqlh4qjee" }, { "name": "ZoneConfig", "type": "object", "required": true, "description": "站点加速全局配置，该参数中的配置会对站点下的所有域名生效。您只需直接修改所需的配置，未传入的其他配置将保持原有状态。", "example": "无", "children": [ { "name": "SmartRouting", "type": "object", "required": false, "description": "智能加速配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "智能加速配置开关，取值有： on：开启； off：关闭。", "example": "on" } ] }, { "name": "Cache", "type": "object", "required": false, "description": "缓存过期时间配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "FollowOrigin", "type": "object", "required": false, "description": "遵循源站缓存配置。FollowOrigin、NoCache、CustomTime 最多只能配置一个 Switch 为 on。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "遵循源站配置开关，取值有： on：开启； off：关闭。", "example": "on" }, { "name": "DefaultCache", "type": "string", "required": false, "description": "源站未返回 Cache-Control 头时，缓存/不缓存开关。当 Switch 为 on 时，此字段必填，当 Switch 为 off 时，无需填写此字段，若填写则不生效。取值有： on：缓存； off：不缓存。", "example": "on" }, { "name": "DefaultCacheStrategy", "type": "string", "required": false, "description": "源站未返回 Cache-Control 头时，使用/不使用默认缓存策略开关。当 DefaultCache 为 on 时，此字段必填，否则此字段不生效；当 DefaultCacheTime 不为 0 时，此字段必须为 off。取值有： on：使用默认缓存策略； off：不使用默认缓存策略。", "example": "on" }, { "name": "DefaultCacheTime", "type": "integer", "required": false, "description": "源站未返回 Cache-Control 头时，表示默认的缓存时间，单位为秒，取值：0-315360000。当 DefaultCache 为 on 时，此字段必填，否则此字段不生效；当 DefaultCacheStrategy 为 on 时， 此字段必须为 0。", "example": "0" } ] }, { "name": "NoCache", "type": "object", "required": false, "description": "不缓存配置。FollowOrigin、NoCache、CustomTime 最多只能配置一个 Switch 为 on。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "不缓存配置开关，取值有： on：开启； off：关闭。", "example": "on/off" } ] }, { "name": "CustomTime", "type": "object", "required": false, "description": "自定义缓存时间配置。FollowOrigin、NoCache、CustomTime 最多只能配置一个 Switch 为 on。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "自定义缓存时间开关，取值有： on：开启； off：关闭。", "example": "on" }, { "name": "CacheTime", "type": "integer", "required": false, "description": "自定义缓存时间数值，单位为秒，取值：0-315360000。注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。", "example": "10800" } ] } ] }, { "name": "MaxAge", "type": "object", "required": false, "description": "浏览器缓存配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "FollowOrigin", "type": "string", "required": false, "description": "遵循源站 Cache-Control 开关，取值有： on：遵循源站，忽略 CacheTime 时间设置； off：不遵循源站，使用 CacheTime 时间设置。", "example": "on" }, { "name": "CacheTime", "type": "integer", "required": false, "description": "自定义缓存时间数值，单位为秒，取值：0～315360000。注意：当 FollowOrigin 为 off 时，表示不遵循源站，使用 CacheTime 设置缓存时间，否则此字段不生效。", "example": "100" } ] }, { "name": "CacheKey", "type": "object", "required": false, "description": "节点缓存键配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "FullURLCache", "type": "string", "required": false, "description": "是否开启全路径缓存，取值有： on：开启全路径缓存（即关闭参数忽略）； off：关闭全路径缓存（即开启参数忽略）。", "example": "on" }, { "name": "IgnoreCase", "type": "string", "required": false, "description": "是否忽略大小写缓存，取值有： on：忽略； off：不忽略。", "example": "on" }, { "name": "QueryString", "type": "object", "required": false, "description": "查询字符串保留配置参数。此字段和 FullURLCache 必须同时设置，但不能同为 on。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "查询字符串保留/忽略指定参数开关，取值有： on：开启； off：关闭。", "example": "on" }, { "name": "Action", "type": "string", "required": false, "description": "查询字符串保留/忽略指定参数动作。取值有： includeCustom：表示保留部分参数； excludeCustom：表示忽略部分参数。注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。", "example": "includeCustom" }, { "name": "Values", "type": "array", "required": false, "description": "查询字符串中需保留/忽略的参数名列表。注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。", "example": "[\"\"]", "item_type": "string" } ] } ] }, { "name": "CachePrefresh", "type": "object", "required": false, "description": "缓存预刷新配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "缓存预刷新开关，取值有： on：开启； off：关闭。", "example": "on" }, { "name": "CacheTimePercent", "type": "integer", "required": false, "description": "预刷新时间设置为节点缓存时间的百分比数值，取值：1～99。注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。", "example": "80" } ] }, { "name": "OfflineCache", "type": "object", "required": false, "description": "离线缓存配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "离线缓存开关，取值有： on：开启； off：关闭。", "example": "on" } ] }, { "name": "Compression", "type": "object", "required": false, "description": "智能压缩配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "智能压缩配置开关，取值有： on：开启； off：关闭。", "example": "on" }, { "name": "Algorithms", "type": "array", "required": false, "description": "支持的压缩算法列表。当 Switch 为 on 时，此字段必填，否则此字段不生效。取值有： brotli：brotli 算法； gzip：gzip 算法。", "example": "[\"brotli\",\"gzip\"]", "item_type": "string" } ] }, { "name": "ForceRedirectHTTPS", "type": "object", "required": false, "description": "访问协议强制 HTTPS 跳转配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "访问强制跳转配置开关，取值有： on：开启； off：关闭。", "example": "on/off" }, { "name": "RedirectStatusCode", "type": "integer", "required": false, "description": "重定向状态码。当 Switch 为 on 时，此字段必填，否则此字段不生效。取值有： 301：301跳转； 302：302跳转。", "example": "302" } ] }, { "name": "HSTS", "type": "object", "required": false, "description": "HSTS 相关配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "HSTS 配置开关，取值有： on：开启； off：关闭。", "example": "on" }, { "name": "Timeout", "type": "integer", "required": false, "description": "缓存 HSTS 头部时间，单位为秒，取值：1-31536000。注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。", "example": "10800" }, { "name": "IncludeSubDomains", "type": "string", "required": false, "description": "是否允许其他子域名继承相同的 HSTS 头部，取值有： on：允许其他子域名继承相同的 HSTS 头部； off：不允许其他子域名继承相同的 HSTS 头部。注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。", "example": "on" }, { "name": "Preload", "type": "string", "required": false, "description": "是否允许浏览器预加载 HSTS 头部，取值有： on：允许浏览器预加载 HSTS 头部； off：不允许浏览器预加载 HSTS 头部。注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。", "example": "on" } ] }, { "name": "TLSConfig", "type": "object", "required": false, "description": "TLS 相关配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Version", "type": "array", "required": false, "description": "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 版本。", "example": "[\"TLSv1\", \"TLSv1.1\", \"TLSv1.2\", \"TLSv1.3\"]", "item_type": "string" }, { "name": "CipherSuite", "type": "string", "required": false, "description": "密码套件。详细介绍请参考 [TLS 版本及密码套件说明](https://cloud.tencent.com/document/product/1552/86545)。取值有：loose-v2023：loose-v2023 密码套件；general-v2023：general-v2023 密码套件；strict-v2023：strict-v2023 密码套件。", "example": "loose-v2023" } ] }, { "name": "OCSPStapling", "type": "object", "required": false, "description": "OCSP 装订配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "OCSP 装订配置开关，取值有： on：开启； off：关闭。", "example": "on" } ] }, { "name": "HTTP2", "type": "object", "required": false, "description": "HTTP2 相关配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "HTTP2 接入配置开关，取值有： on：开启； off：关闭。", "example": "on" } ] }, { "name": "QUIC", "type": "object", "required": false, "description": "QUIC 访问配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "QUIC 配置开关，取值有： on：开启； off：关闭。", "example": "on" } ] }, { "name": "UpstreamHTTP2", "type": "object", "required": false, "description": "HTTP2 回源配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "HTTP2 回源配置开关，取值有： on：开启； off：关闭。", "example": "on" } ] }, { "name": "IPv6", "type": "object", "required": false, "description": "IPv6 访问配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "IPv6 访问功能配置，取值有： on：开启 IPv6 访问功能； off：关闭 IPv6 访问功能。", "example": "on" } ] }, { "name": "WebSocket", "type": "object", "required": false, "description": "WebSocket 配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "WebSocket 超时时间配置开关，取值有： on：使用 Timeout 作为 WebSocket 超时时间； off：平台仍支持 WebSocket 连接，此时使用系统默认的 15 秒为超时时间。", "example": "off" }, { "name": "Timeout", "type": "integer", "required": false, "description": "超时时间，单位为秒，最大超时时间 120 秒。注意：当 Switch 为 on 时，此字段必填，否则此字段不生效。", "example": "10" } ] }, { "name": "PostMaxSize", "type": "object", "required": false, "description": "POST 请求传输配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "是否开启 POST 请求上传文件限制，单位为 Byte，平台默认为限制为 32 * 220 Byte，取值有：on：开启限制；off：关闭限制。", "example": "on/off" }, { "name": "MaxSize", "type": "integer", "required": false, "description": "POST 请求上传文件流式传输最大限制，该字段仅在 Switch 为 on 时生效，取值在 1MB 和 800MB 之间，单位字节。", "example": "10000000" } ] }, { "name": "ClientIPHeader", "type": "object", "required": false, "description": "客户端 IP 回源请求头配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "配置开关，取值有： on：开启； off：关闭。", "example": "on" }, { "name": "HeaderName", "type": "string", "required": false, "description": "回源时，存放客户端 IP 的请求头名称。当 Switch 为 on 时，该参数必填。该参数不允许填写 X-Forwarded-For。", "example": "X-ClientIp" } ] }, { "name": "ClientIPCountry", "type": "object", "required": false, "description": "回源时是否携带客户端 IP 所属地域信息的配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "配置开关，取值有： on：开启； off：关闭。", "example": "on" }, { "name": "HeaderName", "type": "string", "required": false, "description": "存放客户端 IP 所属地域信息的请求头名称，当 Switch=on 时有效。为空则使用默认值：EO-Client-IPCountry。", "example": "EO-Client-IPCountry" } ] }, { "name": "Grpc", "type": "object", "required": false, "description": "gRPC 协议支持配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "gRPC 配置开关，取值有： on：开启； off：关闭。", "example": "on" } ] }, { "name": "NetworkErrorLogging", "type": "object", "required": false, "description": "网络错误日志记录配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "网络错误日志记录配置开关，取值有： on：开启； off：关闭。", "example": "on" } ] }, { "name": "AccelerateMainland", "type": "object", "required": false, "description": "中国大陆加速优化配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "中国大陆加速优化配置开关，取值有： on：开启； off：关闭。", "example": "on" } ] }, { "name": "StandardDebug", "type": "object", "required": false, "description": "标准 Debug 配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "Debug 功能开关，取值有： on：开启； off：关闭。", "example": "on" }, { "name": "AllowClientIPList", "type": "array", "required": false, "description": "允许的客户端来源。支持填写 IPv4 以及 IPv6 的 IP 网段。0.0.0.0/0 表示允许所有 IPv4 客户端进行调试；::/0 表示允许所有 IPv6 客户端进行调试；不能填写 127.0.0.1。注意：当 Switch 字段为 on 时，此字段必填，且填写个数为 1～100；当 Switch 为 off 时，无需填写此字段，若填写则不生效。", "example": "[\"9.142.236.194\", \"43.154.226.0/24\"]", "item_type": "string" }, { "name": "Expires", "type": "string", "required": false, "description": "Debug 功能到期时间。超出设置的时间，则功能失效。注意：当 Switch 为 on 时，此字段必填；当 Switch 为 off 时，无需填写此字段，若填写则不生效。", "example": "2023-06-30T17:37:56+0800" } ] } ] } ], "required": [ "ZoneId", "ZoneConfig" ] }, { "name": "ModifyLoadBalancer", "description": "修改负载均衡实例配置。负载均衡功能内测中，如您需要使用请 [联系我们](https://cloud.tencent.com/online-service)。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-27q0p0bali16\t" }, { "name": "InstanceId", "type": "string", "required": true, "description": "负载均衡实例 ID。", "example": "lb-jolaksjdfa" }, { "name": "Name", "type": "string", "required": false, "description": "实例名称，可输入 1-200 个字符，允许字符为 a-z，A-Z，0-9，_，-。不填写表示维持原有配置。", "example": "general_load_balancer" }, { "name": "OriginGroups", "type": "array", "required": false, "description": "源站组列表及其对应的容灾调度优先级。详情请参考 [快速创建负载均衡实例](https://cloud.tencent.com/document/product/1552/104223) 中的示例场景。不填写表示维持原有配置。", "example": "[{\"Priority\": \"proiority_1\", \"OriginGroupId\": \"origin-1\"}, {\"Priority\": \"proiority_2\", \"OriginGroupId\": \"origin-2\"}]", "item_type": "object", "children": [ { "name": "Priority", "type": "string", "required": true, "description": "优先级，填写格式为 \"priority_\" + \"数字\"，最高优先级为 \"priority_1\"。参考取值有： priority_1：第一优先级； priority_2：第二优先级； priority_3：第三优先级。其他优先级可以将数字递增，最多可以递增至 \"priority_10\"。", "example": "priority_1" }, { "name": "OriginGroupId", "type": "string", "required": true, "description": "源站组 ID。", "example": "orgin-2ccgtb24-7dc5-46s2-9r3e-95825d53dwe3a\t" } ] }, { "name": "HealthChecker", "type": "object", "required": false, "description": "健康检查策略。详情请参考 [健康检查策略介绍](https://cloud.tencent.com/document/product/1552/104228)。不填写表示维持原有配置。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "健康检查策略，取值有： HTTP； HTTPS； TCP； UDP； ICMP Ping； NoCheck。 注意：NoCheck 表示不启用健康检查策略。", "example": "HTTP" }, { "name": "Port", "type": "integer", "required": false, "description": "检查端口。当 Type=HTTP 或 Type=HTTPS 或 Type=TCP 或 Type=UDP 时为必填。", "example": "80" }, { "name": "Interval", "type": "integer", "required": false, "description": "检查频率，表示多久发起一次健康检查任务，单位为秒。可取值有：30，60，180，300 或 600。", "example": "30" }, { "name": "Timeout", "type": "integer", "required": false, "description": "每一次健康检查的超时时间，若健康检查消耗时间大于此值，则检查结果判定为”不健康“， 单位为秒，默认值为 5s，取值必须小于 Interval。", "example": "5" }, { "name": "HealthThreshold", "type": "integer", "required": false, "description": "健康阈值，表示连续几次健康检查结果为\"健康\"，则判断源站为\"健康\"，单位为次，默认 3 次，最小取值 1 次。", "example": "3" }, { "name": "CriticalThreshold", "type": "integer", "required": false, "description": "不健康阈值，表示连续几次健康检查结果为\"不健康\"，则判断源站为\"不健康\"，单位为次，默认 2 次。", "example": "5" }, { "name": "Path", "type": "string", "required": false, "description": "该参数仅当 Type=HTTP 或 Type=HTTPS 时有效，表示探测路径，需要填写完整的 host/path，不包含协议部分，例如：www.example.com/test。", "example": "www.example.com/test" }, { "name": "Method", "type": "string", "required": false, "description": "该参数仅当 Type=HTTP 或 Type=HTTPS 时有效，表示请求方法，取值有： GET； HEAD。", "example": "HEAD" }, { "name": "ExpectedCodes", "type": "array", "required": false, "description": "该参数仅当 Type=HTTP 或 Type=HTTPS 时有效，表示探测节点向源站发起健康检查时，响应哪些状态码可用于认定探测结果为健康。", "example": "[\"200\", \"500\"]", "item_type": "string" }, { "name": "Headers", "type": "array", "required": false, "description": "该参数仅当 Type=HTTP 或 Type=HTTPS 时有效，表示探测请求携带的自定义 HTTP 请求头，至多可配置 10 个。", "example": "[{ \"Key\": \"host\", \"Value\": \"www.example.com\" }]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "自定义头部 Key。", "example": "host" }, { "name": "Value", "type": "string", "required": true, "description": "自定义头部 Value。", "example": "www.example.com" } ] }, { "name": "FollowRedirect", "type": "string", "required": false, "description": "该参数仅当 Type=HTTP 或 Type=HTTPS 时有效，表示是否启用遵循 301/302 重定向。启用后，301/302 默认为\"健康\"的状态码，默认跳转 3 次。", "example": "true" }, { "name": "SendContext", "type": "string", "required": false, "description": "该参数仅当 Type=UDP 时有效，表示健康检查发送的内容。只允许 ASCII 可见字符，最大长度限制 500 个字符。", "example": "send_payload" }, { "name": "RecvContext", "type": "string", "required": false, "description": "该参数仅当 Type=UDP 时有效，表示健康检查期望源站返回结果。只允许 ASCII 可见字符，最大长度限制 500 个字符。", "example": "recv_context" } ] }, { "name": "SteeringPolicy", "type": "string", "required": false, "description": "源站组间的流量调度策略，取值有： Pritory：按优先级顺序进行故障转移 。不填写表示维持原有配置。", "example": "Pritory" }, { "name": "FailoverPolicy", "type": "string", "required": false, "description": "实际访问某源站失败时的请求重试策略，详情请参考 [请求重试策略介绍](https://cloud.tencent.com/document/product/1552/104227)，取值有： OtherOriginGroup：单次请求失败后，请求优先重试下一优先级源站组； OtherRecordInOriginGroup：单次请求失败后，请求优先重试同源站组内的其他源站。不填写表示维持原有配置。", "example": "OtherRecordInOriginGroup" } ], "required": [ "ZoneId", "InstanceId" ] }, { "name": "ModifyMultiPathGateway", "description": "通过本接口修改多通道安全加速网关信息，如名称、网关 ID、IP、端口等。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-27q0p0bal192" }, { "name": "GatewayId", "type": "string", "required": true, "description": "网关 ID。", "example": "mpgw-lbxuhk1oh" }, { "name": "GatewayName", "type": "string", "required": false, "description": "网关名称，16 个字符以内，可用字符（a-z,A-Z,0-9,-,_）。", "example": "mpgw" }, { "name": "GatewayIP", "type": "string", "required": false, "description": "网关地址，GatewayType 取值为 private（自有网关）可填入进行修改，使用该地址时，请确保该地址已录入腾讯云多通道安全加速网关系统。如未录入，需要在本接口调用前通过工单或者联系架构师把网关 IP 地址提前录入腾讯云多通道安全加速网关系统。", "example": "101.23.451.11" }, { "name": "GatewayPort", "type": "integer", "required": false, "description": "网关端口，范围 1～65535（除去 8888 ），只支持修改 GatewayType 取值为 private 的自有网关。", "example": "8089" } ], "required": [ "ZoneId", "GatewayId" ] }, { "name": "ModifyMultiPathGatewayLine", "description": "通过本接口修改接入多通道安全加速网关的线路，包括 EdgeOne 四层代理线路、自定义线路。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-27q0p0bal192" }, { "name": "GatewayId", "type": "string", "required": true, "description": "多通道安全加速网关 ID 。", "example": "mpgw-lbxuhk1oh" }, { "name": "LineId", "type": "string", "required": true, "description": "线路 ID ， 取值有: line-1： EdgeOne 四层代理线路，支持修改实例和规则，不支持删除； line-2 及以上：EdgeOne 四层代理线路或者自定义线路，支持修改、删除实例和规则。", "example": "line-2" }, { "name": "LineType", "type": "string", "required": false, "description": "线路类型，取值有： proxy ：EdgeOne 四层代理线路，支持修改实例和规则，不支持删除； custom ：自定义线路，支持编辑、删除实例和规则。", "example": "proxy" }, { "name": "LineAddress", "type": "string", "required": false, "description": "线路地址，格式为 host:port，直连线路（ LineType 取值为 direct ）不允许修改，其余类型支持修改。", "example": "120.53.91.10:8080" }, { "name": "ProxyId", "type": "string", "required": false, "description": "四层代理实例 ID ，当线路类型 LineType 取值为 proxy（EdgeOne 四层代理）可传入，进行修改。", "example": "sid-2gpv1z8cx8y2" }, { "name": "RuleId", "type": "string", "required": false, "description": "转发规则 ID ，当线路类型 LineType 取值为 proxy（EdgeOne 四层代理）可传入，进行修改。", "example": "rule-33ik84rw3nuu" } ], "required": [ "ZoneId", "GatewayId", "LineId" ] }, { "name": "ModifyMultiPathGatewaySecretKey", "description": "通过本接口修改接入多通道安全加速网关的密钥，客户基于接入密钥签名接入多通道安全加速网关，修改后原密钥失效。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-27q0p0bal192" }, { "name": "SecretKey", "type": "string", "required": true, "description": "多通道安全加速网关接入密钥，base64 字符串，编码前字符串长度为 32-48 个字符。", "example": "b8sfnemqzF5TNCwwtshVmG/gyCJVi/rP+7A+jsBwqGY=" } ], "required": [ "ZoneId", "SecretKey" ] }, { "name": "ModifyMultiPathGatewayStatus", "description": "更新多通道安全网关状态。", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关 ID。", "example": "eo-gw-lb-ahk1js" }, { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-27q0p0bal192" }, { "name": "GatewayStatus", "type": "string", "required": false, "description": "修改网关的启用停用状态，取值有： offline：停用； online：启用。", "example": "offline" } ], "required": [ "GatewayId", "ZoneId" ] }, { "name": "ModifyOriginACL", "description": "本接口用于对七层加速域名/四层代理实例启用/关闭特定回源 IP 网段回源。单次支持提交的七层加速域名的数量最大为 200，四层代理实例的数量最大为 100，支持七层加速域名/四层代理实例混合提交，总实例个数最大为 200。如需变更超过 200 个实例，请通过本接口分批提交。同时对于开白的客户支持切换到其他可用的源站防护 IP 网段版本，例如精简版，可以减少回源 IP 网段。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "\"zone-276zs184g93m\"" }, { "name": "OriginACLEntities", "type": "array", "required": false, "description": "需要启用/关闭特定回源 IP 网段回源的实例。", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "实例类型，取值有： - l7：七层加速域名； - l4：四层代理实例。", "example": "l7" }, { "name": "Instances", "type": "array", "required": true, "description": "实例详情，取值有： - 当 Type = l7 时，请填写七层加速域名； - 当 Type = l4 时，请填写四层代理实例 ID。", "example": "['www.example.com']", "item_type": "string" }, { "name": "OperationMode", "type": "string", "required": true, "description": "操作模式，取值有： enable：启用； disable：停用。", "example": "enable" } ] }, { "name": "OriginACLFamily", "type": "string", "required": false, "description": "源站防护回源ACL控制域，不填则默认不变；控制域信息可以通过DescribeAvailableOriginACLFamily接口查询获得。 具体取值说明如下： gaz：标准全球可用区控制域； mlc：标准中国大陆可用区控制域； emc：标准全球(不含中国大陆)可用区控制域； plat-gaz：精简全球可用区控制域； plat-mlc：精简中国大陆可用区控制域； plat-emc：精简全球(不含中国大陆)可用区控制域；", "example": "plat-emc" } ], "required": [ "ZoneId" ] }, { "name": "ModifyOriginGroup", "description": "修改源站组配置，新提交的源站记录将会覆盖原有源站组中的源站记录。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID", "example": "zone-27q0p0bali16" }, { "name": "GroupId", "type": "string", "required": true, "description": "源站组 ID，此参数必填。", "example": "origin-2ccgtb24-7dc5-46s2-9r3e-95825d53dwe3a" }, { "name": "Name", "type": "string", "required": false, "description": "源站组名称，不填保持原有配置，可输入1 - 200个字符，允许的字符为 a - z, A - Z, 0 - 9, _, - 。", "example": "origin-group-api" }, { "name": "Type", "type": "string", "required": false, "description": "源站组类型，取值有： GENERAL：通用型源站组，仅支持添加 IP/域名 源站，可以被域名服务、规则引擎、四层代理、通用型负载均衡引用； HTTP： HTTP专用型源站组，支持添加 IP/域名、对象存储源站，无法被四层代理引用。不填保持原有配置。", "example": "HTTP" }, { "name": "Records", "type": "array", "required": false, "description": "源站记录信息，不填保持原有配置。", "example": "无", "item_type": "object", "children": [ { "name": "Record", "type": "string", "required": true, "description": "源站记录值，不包含端口信息，可以为：IPv4，IPv6，域名格式。", "example": "8.8.8.8" }, { "name": "Type", "type": "string", "required": false, "description": "源站类型，取值有： IP_DOMAIN：IPV4、IPV6、域名类型源站； COS：COS源。 AWS_S3：AWS S3对象存储源站。", "example": "IP_DOMAIN" }, { "name": "RecordId", "type": "string", "required": false, "description": "源站记录ID。", "example": "record-27q0p0bali16" }, { "name": "Weight", "type": "integer", "required": false, "description": "【源站权重】：用于控制流量分配优先级的参数，取值范围：0-100（整数）：空值：不设置权重，系统按默认策略调度；0 值：明确设置权重为0，流量将不会分配到该源站，注意事项：必须确保至少有一个源站的权重值大于0；正常值：数值越大分配流量越多 ； 注意：此字段可能返回 null，表示取不到有效值。", "example": "100" }, { "name": "Private", "type": "boolean", "required": false, "description": "是否私有鉴权，当源站类型 RecordType=COS/AWS_S3 时生效，取值有： true：使用私有鉴权； false：不使用私有鉴权。不填写，默认值为：false。", "example": "false" }, { "name": "PrivateParameters", "type": "array", "required": false, "description": "私有鉴权参数，当源站类型Private=true时有效。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "私有鉴权参数名称，取值有： AccessKeyId：鉴权参数 Access Key ID； SecretAccessKey：鉴权参数 Secret Access Key； SignatureVersion：鉴权版本，v2 或者 v4； Region：存储桶地域。", "example": "AccessKeyId" }, { "name": "Value", "type": "string", "required": true, "description": "私有鉴权参数值。", "example": "AKID************" } ] } ] }, { "name": "HostHeader", "type": "string", "required": false, "description": "回源 Host Header，仅 Type = HTTP 时生效， 不填或者填空表示不配置回源Host，规则引擎修改 Host Header 配置优先级高于源站组的 Host Header。", "example": "www.tencent.com" } ], "required": [ "ZoneId", "GroupId" ] }, { "name": "ModifyPlan", "description": "修改套餐配置。目前仅支持修改预付费套餐的自动续费开关。", "status": "online", "parameters": [ { "name": "PlanId", "type": "string", "required": true, "description": "套餐 ID，形如 edgeone-2unuvzjmmn2q。", "example": "edgeone-2unuvzjmmn2q" }, { "name": "RenewFlag", "type": "object", "required": false, "description": "预付费套餐自动续费配置。若开启了自动续费，则会在套餐到期前一天自动续费，仅支持个人版，基础版，标准版套餐。不填写表示保持原有配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "预付费套餐的自动续费标志，取值有： on：开启自动续费； off：不开启自动续费。", "example": "on" } ] } ], "required": [ "PlanId" ] }, { "name": "ModifyPrefetchOriginLimit", "description": "本接口用于配置回源限速限制，该功能白名单内测中。 可通过此接口创建、修改与删除预热回源限速限制，每个账号最多支持 100 条限制。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-3***j8tqd" }, { "name": "DomainName", "type": "string", "required": true, "description": "加速域名。", "example": "cn2.test-***a.online" }, { "name": "Area", "type": "string", "required": true, "description": "回源限速限制的加速区域。 预热时，该加速区域将会受到配置的Bandwidth值限制。取值有： Overseas：全球可用区（不含中国大陆）； MainlandChina：中国大陆可用区。", "example": "Overseas" }, { "name": "Bandwidth", "type": "integer", "required": true, "description": "回源限速带宽。 预热时回到源站的带宽上限值，取值范围 100 - 100,000，单位 Mbps。", "example": "100" }, { "name": "Enabled", "type": "string", "required": true, "description": "回源限速限制控制开关。 用于启用/删除本条回源限速限制，取值有： on：启用限制； off：删除限制。", "example": "on" } ], "required": [ "ZoneId", "DomainName", "Area", "Bandwidth", "Enabled" ] }, { "name": "ModifyRealtimeLogDeliveryTask", "description": "通过本接口修改实时日志投递任务配置。本接口有如下限制：不支持修改实时日志投递任务目的地类型（TaskType）；不支持修改数据投递类型（LogType）不支持修改数据投递区域（Area）当原实时日志投递任务的目的地为腾讯云 CLS 时，不支持修改目的地详细配置，如日志集、日志主题。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-xxxxx" }, { "name": "TaskId", "type": "string", "required": true, "description": "实时日志投递任务 ID。", "example": "cdda4cbc-a83e-4a54-be68-82339e80bb2f" }, { "name": "TaskName", "type": "string", "required": false, "description": "实时日志投递任务的名称，格式为数字、英文、-和_组合，最多 200 个字符。不填保持原有配置。", "example": "test_log_task" }, { "name": "DeliveryStatus", "type": "string", "required": false, "description": "实时日志投递任务的状态，取值有： enabled: 启用； disabled: 停用。不填保持原有配置。", "example": "enabled" }, { "name": "EntityList", "type": "array", "required": false, "description": "实时日志投递任务对应的实体（七层域名或者四层代理实例）列表。取值示例如下： 七层域名：domain.example.com； 四层代理实例：sid-2s69eb5wcms7。不填保持原有配置。", "example": "[\"domain.example.com\"]", "item_type": "string" }, { "name": "Fields", "type": "array", "required": false, "description": "投递的预设字段列表。不填保持原有配置。", "example": "[\"RequestID\",\"ClientIP\",\"RequestTime\"]", "item_type": "string" }, { "name": "CustomFields", "type": "array", "required": false, "description": "投递的自定义字段列表，支持在 HTTP 请求头、响应头、Cookie、请求正文中提取指定内容。不填保持原有配置。自定义字段名称不能重复，且最多不能超过 200 个字段。单个实时日志推送任务最多添加 5 个请求正文类型的自定义字段。目前仅站点加速日志（LogType=domain）支持添加自定义字段。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "自定义日志字段类型。从 HTTP 请求和响应中的指定位置提取数据，取值有： ReqHeader：从 HTTP 请求头中提取指定字段值； RspHeader：从 HTTP 响应头中提取指定字段值； Cookie: 从 Cookie 中提取指定字段值； ReqBody: 从 HTTP 请求正文中通过 Google RE2 正则表达式提取指定内容。", "example": "ReqHeader" }, { "name": "Value", "type": "string", "required": true, "description": "根据字段类型（Name）填入字段值的定义。需要区分大小写。 当字段类型为 ReqHeader、RspHeader、Cookie 时，填入需要提取值的参数名称，例如：Accept-Language。可输入 1-100 个字符，允许的字符开头为字母，中间为字母、数字、-，结尾为字母、数字； 当字段类型为 ReqBody 时，填入 Google RE2 正则表达式，正则表达式长度上限为 4KB。", "example": "Accept-Language" }, { "name": "Enabled", "type": "boolean", "required": false, "description": "是否投递该字段，不填表示不投递此字段。", "example": "true" } ] }, { "name": "DeliveryConditions", "type": "array", "required": false, "description": "日志投递的过滤条件。不填表示投递全量日志。", "example": "无", "item_type": "object", "children": [ { "name": "Conditions", "type": "array", "required": false, "description": "日志过滤条件，详细的过滤条件如下： EdgeResponseStatusCode：按照 EdgeOne 节点响应返回给客户端的状态码进行过滤。   支持运算符：equal、great、less、great_equal、less_equal   取值范围：任意大于等于 0 的整数 OriginResponseStatusCode：按照源站响应状态码进行过滤。   支持运算符：equal、great、less、great_equal、less_equal   取值范围：任意大于等于 -1 的整数 SecurityAction：按照请求\ufffd\ufffd...", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "筛选条件的key。", "example": "查询键" }, { "name": "Operator", "type": "string", "required": true, "description": "查询条件操作符，操作类型有： equals: 等于； notEquals: 不等于； include: 包含； notInclude: 不包含; startWith: 开始的值是value； notStartWith: 不以value的值开始； endWith: 结尾是value值； notEndWith: 不以value的值结尾。", "example": "equals" }, { "name": "Value", "type": "array", "required": true, "description": "筛选条件的值。", "example": "查询值", "item_type": "string" } ] } ] }, { "name": "Sample", "type": "integer", "required": false, "description": "采样比例，采用千分制，取值范围为1-1000，例如：填写 605 表示采样比例为 60.5%。不填保持原有配置。", "example": "605" }, { "name": "LogFormat", "type": "object", "required": false, "description": "日志投递的输出格式。不填保持原有配置。 特别地，当 TaskType 取值为 cls 时，LogFormat.FormatType 的值只能为 json，且 LogFormat 中其他参数将被忽略，建议不传 LogFormat。", "example": "无", "children": [ { "name": "FormatType", "type": "string", "required": true, "description": "日志投递的预设输出格式类型，取值有： json：使用预设日志输出格式 JSON Lines，单条日志中的字段以键值对方式呈现； csv：使用预设日志输出格式 csv，单条日志中仅呈现字段值，不呈现字段名称。", "example": "json" }, { "name": "BatchPrefix", "type": "string", "required": false, "description": "在每个日志投递批次之前添加的字符串。每个日志投递批次可能包含多条日志记录。", "example": "{\"events\":[" }, { "name": "BatchSuffix", "type": "string", "required": false, "description": "在每个日志投递批次后附加的字符串。", "example": "]}" }, { "name": "RecordPrefix", "type": "string", "required": false, "description": "在每条日志记录之前添加的字符串。", "example": "{" }, { "name": "RecordSuffix", "type": "string", "required": false, "description": "在每条日志记录后附加的字符串。", "example": "}" }, { "name": "RecordDelimiter", "type": "string", "required": false, "description": "插入日志记录之间作为分隔符的字符串，取值有： \\n：换行符； \\t：制表符； ，：半角逗号。", "example": "," }, { "name": "FieldDelimiter", "type": "string", "required": false, "description": "单条日志记录内，插入字段之间作为分隔符的字符串，取值有： \\t：制表符； ，：半角逗号； ;：半角分号。", "example": "," } ] }, { "name": "CustomEndpoint", "type": "object", "required": false, "description": "自定义 HTTP 服务的配置信息，不填保持原有配置。", "example": "无", "children": [ { "name": "Url", "type": "string", "required": true, "description": "实时日志投递的自定义 HTTP 接口地址，暂仅支持 HTTP/HTTPS 协议。", "example": "http://custom.edgeone.com/post/log" }, { "name": "AccessId", "type": "string", "required": false, "description": "填写自定义的 SecretId 用于生成加密签名，如果源站需要鉴权此参数必填。", "example": "your-access-id" }, { "name": "AccessKey", "type": "string", "required": false, "description": "填写自定义的 SecretKey 用于生成加密签名，如果源站需要鉴权此参数必填。", "example": "your-access-key" }, { "name": "CompressType", "type": "string", "required": false, "description": "数据压缩类型，取值有: gzip：使用 gzip 方式压缩。不填表示不启用压缩。", "example": "gzip" }, { "name": "Protocol", "type": "string", "required": false, "description": "POST 请求投递日志时，使用的应用层协议类型，取值有： http：HTTP 协议； https：HTTPS 协议。如果不填默认根据填写的 URL 地址解析出协议类型。", "example": "https" }, { "name": "Headers", "type": "array", "required": false, "description": "投递日志时携带的自定义请求头。若您填写的头部名称为 Content-Type 等 EdgeOne 日志推送默认携带的头部，那么您填写的头部值将覆盖默认值。头部值引用单个变量${batchSize}，以获取每次 POST 请求中包含的日志条数。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "HTTP头部名称。", "example": "User-Agent" }, { "name": "Value", "type": "string", "required": true, "description": "HTTP头部值。", "example": "TencentEdgeOne" } ] } ] }, { "name": "S3", "type": "object", "required": false, "description": "AWS S3 兼容存储桶的配置信息，不填保持原有配置。", "example": "无", "children": [ { "name": "Endpoint", "type": "string", "required": true, "description": "不包含存储桶名称或路径的 URL，例如：`https://storage.googleapis.com`、`https://s3.ap-northeast-2.amazonaws.com`、`https://cos.ap-nanjing.myqcloud.com`。", "example": "https://cos.ap-beijing.myqcloud.com" }, { "name": "Region", "type": "string", "required": true, "description": "存储桶所在的地域，例如：`ap-northeast-2`。", "example": "ap-beijing" }, { "name": "Bucket", "type": "string", "required": true, "description": "存储桶名称和日志存储目录，例如：`your_bucket_name/EO-logs/`。如果存储桶中无此目录则会自动创建。", "example": "test-s3-1310708577/hello/world" }, { "name": "AccessId", "type": "string", "required": true, "description": "访问存储桶使用的 Access Key ID。", "example": "TeAI8Ye2MkUAWoNJCk" }, { "name": "AccessKey", "type": "string", "required": true, "description": "访问存储桶使用的 secret key。", "example": "MsiAACHihAAXuH83Ayd7j0VRJ9SYNCOSxwe" }, { "name": "CompressType", "type": "string", "required": false, "description": "数据压缩类型，取值有: gzip：gzip压缩。不填表示不启用压缩。", "example": "gzip" } ] } ], "required": [ "ZoneId", "TaskId" ] }, { "name": "ModifyRule", "description": "本接口为旧版本修改规则引擎接口，EdgeOne 于 2025 年 1 月 21 日已对规则引擎相关接口全面升级，新版本修改七层加速规则接口详情请参考 [ModifyL7AccRule](https://cloud.tencent.com/document/product/1552/115818)。 注意：自 2025 年 1 月 21 日起，旧版接口停止更新迭代，后续新增功能将仅在新版接口中提供，旧版接口支持的原有能力将不受影响。为避免在使用旧版接口时出现数据字段冲突，建议\ufffd...", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-djuqmq" }, { "name": "RuleName", "type": "string", "required": true, "description": "规则名称，字符串名称长度 1~255。", "example": "rule test" }, { "name": "Rules", "type": "array", "required": true, "description": "规则内容。", "example": "无", "item_type": "object", "children": [ { "name": "Conditions", "type": "array", "required": true, "description": "执行功能判断条件。 注意：满足该数组内任意一项条件，功能即可执行。", "example": "[]", "item_type": "object", "children": [ { "name": "Conditions", "type": "array", "required": true, "description": "规则引擎条件，该数组内所有项全部满足即判断该条件满足。", "example": "[]", "item_type": "object", "children": [ { "name": "Operator", "type": "string", "required": true, "description": "运算符，取值有： equal: 等于； notequal: 不等于； exist: 存在； notexist: 不存在。", "example": "equal" }, { "name": "Target", "type": "string", "required": true, "description": "匹配类型，取值有： 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...", "example": "url" }, { "name": "Values", "type": "array", "required": false, "description": "对应匹配类型的参数值，仅在匹配类型为查询字符串或HTTP请求头并且运算符取值为存在或不存在时允许传空数组，对应匹配类型有： 文件后缀：jpg、txt 等文件后缀； 文件名称：例如 foo.jpg 中的 foo； 全部（站点任意请求）：all； HOST：当前站点下的 host ，例如www.maxx55.com； URL Path：当前站点下 URL 路径的请求，例如：/example； URL Full：当前站点下完整 URL 请求，必须包含 HTTP 协\ufffd...", "example": "[\"www.maxx55.com\"]", "item_type": "string" }, { "name": "IgnoreCase", "type": "boolean", "required": false, "description": "是否忽略参数值的大小写，默认值为 false。", "example": "true" }, { "name": "Name", "type": "string", "required": false, "description": "对应匹配类型的参数名称，在 Target 值为以下取值时有效，有效时值不能为空： query_string（查询字符串）: 当前站点下URL请求中查询字符串的参数名称，例如lang=cn\u0026version=1中的lang和version； request_header（HTTP 请求头）: HTTP请求头部字段名，例如Accept-Language:zh-CN,zh;q=0.9中的Accept-Language。", "example": "Accept-Language" } ] } ] }, { "name": "Actions", "type": "array", "required": false, "description": "执行的功能。注意：Actions 和 SubRules 不可都为空", "example": "[]", "item_type": "object", "children": [ { "name": "NormalAction", "type": "object", "required": false, "description": "常规功能操作，选择该类型的功能项有： 访问URL 重写（AccessUrlRedirect）； 回源 URL 重写 （UpstreamUrlRedirect）； QUIC（QUIC）； WebSocket （WebSocket）； 视频拖拽（VideoSeek）； Token 鉴权（Authentication）； 自定义CacheKey（CacheKey）； 节点缓存 TTL （Cache）； 浏览器缓存 TTL（MaxAge）； 离线缓存（OfflineCache）； 智能加速（SmartRouting）； 分片回源（RangeOriginPull）； HTTP/2 回源（UpstreamHttp2）\ufffd\ufffd...", "example": "无", "children": [ { "name": "Action", "type": "string", "required": true, "description": "功能名称，功能名称填写规范可调用接口 [查询规则引擎的设置参数](https://cloud.tencent.com/document/product/1552/80618) 查看。", "example": "AccessUrlRedirect" }, { "name": "Parameters", "type": "array", "required": true, "description": "参数。", "example": "[]", "item_type": "string" } ] }, { "name": "RewriteAction", "type": "object", "required": false, "description": "带有请求头/响应头的功能操作，选择该类型的功能项有： 修改 HTTP 请求头（RequestHeader）； 修改HTTP响应头（ResponseHeader）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Action", "type": "string", "required": true, "description": "功能名称，功能名称填写规范可调用接口 [查询规则引擎的设置参数](https://cloud.tencent.com/document/product/1552/80618) 查看。", "example": "ResponseHeader" }, { "name": "Parameters", "type": "array", "required": true, "description": "参数。", "example": "[]", "item_type": "string" } ] }, { "name": "CodeAction", "type": "object", "required": false, "description": "带有状态码的功能操作，选择该类型的功能项有： 自定义错误页面（ErrorPage）； 状态码缓存 TTL（StatusCodeCache）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Action", "type": "string", "required": true, "description": "功能名称，功能名称填写规范可调用接口 [查询规则引擎的设置参数](https://cloud.tencent.com/document/product/1552/80618) 查看。", "example": "StatusCodeCache" }, { "name": "Parameters", "type": "array", "required": true, "description": "操作参数。", "example": "[]", "item_type": "string" } ] } ] }, { "name": "SubRules", "type": "array", "required": false, "description": "嵌套规则。注意：SubRules 和 Actions 不可都为空", "example": "[]", "item_type": "object", "children": [ { "name": "Rules", "type": "array", "required": true, "description": "嵌套规则信息。", "example": "无", "item_type": "object", "children": [ { "name": "Conditions", "type": "array", "required": true, "description": "执行功能判断条件。 注意：满足该数组内任意一项条件，功能即可执行。", "example": "[]", "item_type": "string" }, { "name": "Actions", "type": "array", "required": true, "description": "执行的功能。", "example": "[]", "item_type": "string" } ] }, { "name": "Tags", "type": "array", "required": false, "description": "规则标签。", "example": "[\"cache\"]", "item_type": "string" } ] } ] }, { "name": "RuleId", "type": "string", "required": true, "description": "规则 ID。", "example": "rule-duxamq" }, { "name": "Status", "type": "string", "required": true, "description": "规则状态，取值有： enable: 启用； disable: 未启用。", "example": "enable" }, { "name": "Tags", "type": "array", "required": false, "description": "规则标签。", "example": "[\"Cache Key Configuration\"]", "item_type": "string" } ], "required": [ "ZoneId", "RuleName", "Rules", "RuleId", "Status" ] }, { "name": "ModifySecurityAPIResource", "description": "该接口用于修改 API 资源。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "\"zone-nqicqhasui\"\t" }, { "name": "APIResources", "type": "array", "required": false, "description": "API 资源列表。", "example": "无", "item_type": "object", "children": [ { "name": "Id", "type": "string", "required": false, "description": "资源 ID。", "example": "\"eoapi-2184008405\"" }, { "name": "Name", "type": "string", "required": false, "description": "资源名称。", "example": "\"test\"" }, { "name": "APIServiceIds", "type": "array", "required": false, "description": "API 资源关联的 API 服务 ID 列表。", "example": "\"fekafe\"", "item_type": "string" }, { "name": "Path", "type": "string", "required": false, "description": "资源路径。", "example": "\"/resource\"" }, { "name": "Methods", "type": "array", "required": false, "description": "请求方法列表。支持以下取值：GET, POST, PUT, HEAD, PATCH, OPTIONS, DELETE。", "example": "\"PUT\"", "item_type": "string" }, { "name": "RequestConstraint", "type": "string", "required": false, "description": "请求内容匹配规则的具体内容，需符合表达式语法，详细规范参见产品文档。", "example": "无" } ] } ], "required": [ "ZoneId" ] }, { "name": "ModifySecurityAPIService", "description": "该接口用于修改 API 服务。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "\"zone-nqicqhasui\"\t" }, { "name": "APIServices", "type": "array", "required": false, "description": "API 服务列表。", "example": "无", "item_type": "object", "children": [ { "name": "Id", "type": "string", "required": false, "description": "API 服务 ID。", "example": "\"eoapi-2184008405\"" }, { "name": "Name", "type": "string", "required": false, "description": "API 服务名称。", "example": "“test”" }, { "name": "BasePath", "type": "string", "required": false, "description": "基础路径。", "example": "\"aef\"" } ] } ], "required": [ "ZoneId" ] }, { "name": "ModifySecurityClientAttester", "description": "修改客户端认证选项。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "\"zone-nqicqhasui\"" }, { "name": "ClientAttesters", "type": "array", "required": false, "description": "认证选项列表。", "example": "无", "item_type": "object", "children": [ { "name": "Id", "type": "string", "required": false, "description": "认证选项 ID。", "example": "\"challenge-21820202\"" }, { "name": "Name", "type": "string", "required": false, "description": "认证选项名称。", "example": "\"test\"" }, { "name": "Type", "type": "string", "required": false, "description": "认证规则类型。仅出参返回，取值有： PRESET: 系统预置规则，仅允许修改 AttesterDuration； CUSTOM: 用户自定义规则。", "example": "\"customer\"" }, { "name": "AttesterSource", "type": "string", "required": false, "description": "认证方法。取值有： TC-RCE: 使用风险识别 RCE 进行认证； TC-CAPTCHA: 使用天御验证码进行认证。", "example": "\"turing-rce\"" }, { "name": "AttesterDuration", "type": "string", "required": false, "description": "认证有效时间。默认为 60s，支持的单位有： s：秒，取值范围 60～43200； m：分，取值范围 1～720； h：小时，取值范围 1～12。", "example": "300s" }, { "name": "TCRCEOption", "type": "object", "required": false, "description": "TC-RCE 认证的配置信息。 当 AttesterSource 参数值为 TC-RCE 时，此字段必填。", "example": "无", "children": [ { "name": "Channel", "type": "string", "required": true, "description": "Channel 信息。", "example": "\"21332123\"" }, { "name": "Region", "type": "string", "required": false, "description": "RCE Channel 的开通地域，目前可选的取值范围：ap-beijing：华北地区（北京）；ap-jakarta：亚太东南（雅加达）；ap-singapore：亚太东南（新加坡）；eu-frankfurt：欧洲地区（法兰克福）；na-siliconvalley：美国西部（硅谷）。", "example": "\"ap-beijing\"" } ] }, { "name": "TCCaptchaOption", "type": "object", "required": false, "description": "TC-CAPTCHA 认证的配置信息。 当 AttesterSource 参数值为 TC-CAPTCHA 时，此字段必填。", "example": "无", "children": [ { "name": "CaptchaAppId", "type": "string", "required": true, "description": "CaptchaAppId 信息。", "example": "无" }, { "name": "AppSecretKey", "type": "string", "required": true, "description": "AppSecretKey 信息。", "example": "无" } ] } ] } ], "required": [ "ZoneId" ] }, { "name": "ModifySecurityIPGroup", "description": "修改安全 IP 组。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 Id。", "example": "\"zone-hduqwh\"" }, { "name": "IPGroup", "type": "object", "required": true, "description": "IP 组配置。", "example": "无", "children": [ { "name": "GroupId", "type": "integer", "required": true, "description": "组 Id，创建时填 0 即可。", "example": "11" }, { "name": "Name", "type": "string", "required": true, "description": "组名称。", "example": "group1" }, { "name": "Content", "type": "array", "required": true, "description": "IP 组内容，仅支持 IP 及 IP 网段。", "example": "[\"1.1.1.1\", \"2.2.2.2\"]", "item_type": "string" }, { "name": "IPTotalCount", "type": "integer", "required": false, "description": "IP 组中正在生效的 IP 或网段个数。作为出参时有效，作为入参时无需填写该字段。", "example": "100" }, { "name": "IPExpireInfo", "type": "array", "required": false, "description": "IP 定时过期信息。 作为入参，用于为指定的 IP 地址或网段配置定时过期时间。 作为出参，包含以下两类信息： 当前未到期的定时过期信息：尚未触发的过期配置。 一周内已到期的定时过期信息：已触发的过期配置。", "example": "[ { \"Time\": \"2022-01-01T00:00:00+08:00\", \"IP\": [ \"1.1.1.1\", \"2.2.2.2\" ] }, { \"Time\": \"2022-01-02T00:00:00+08:00\", \"IP\": [ \"3.3.3.3\" ] } ]", "item_type": "object", "children": [ { "name": "ExpireTime", "type": "string", "required": false, "description": "定时过期时间，遵循 ISO 8601 标准的日期和时间格式。例如 \"2022-01-01T00:00:00+08:00\"。", "example": "\"2022-01-01T00:00:00+08:00\"" }, { "name": "IPList", "type": "array", "required": false, "description": "IP 列表。仅支持 IP 及 IP 网段。", "example": "[\"1.1.1.1\",\"2.2.2.2\"]", "item_type": "string" } ] } ] }, { "name": "Mode", "type": "string", "required": true, "description": "操作类型，取值有： append: 向 IPGroup 中添加新的 IP 地址或设置定时过期时间； remove: 从 IPGroup 中删除指定的 IP 地址或其定时过期时间； update: 完全替换 IPGroup 中 Content 或 ExpireInfo 的内容，并且可以修改 IPGroup 的名称。 使用 append 操作时注意： 为 IP 或网段添加定时过期时间时，必须晚于当前时间。如果该 IP 或网段在组中不存在，必须同时在 Content 参数中添加该 IP 或网段。若\ufffd\ufffd...", "example": "\"update\"" } ], "required": [ "ZoneId", "IPGroup", "Mode" ] }, { "name": "ModifySecurityJSInjectionRule", "description": "修改 JavaScript 注入规则。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "\"zone-nqicqhasui\"" }, { "name": "JSInjectionRules", "type": "array", "required": false, "description": "JavaScript 注入规则列表。", "example": "无", "item_type": "object", "children": [ { "name": "RuleId", "type": "string", "required": false, "description": "规则 ID。", "example": "\"ch-12133123\"" }, { "name": "Name", "type": "string", "required": false, "description": "规则名称。", "example": "\"test\"" }, { "name": "Priority", "type": "integer", "required": false, "description": "规则优先级，数值越小越优先执行，范围是 0 ~ 100，默认为 0。", "example": "1" }, { "name": "Condition", "type": "string", "required": false, "description": "匹配条件内容。需符合表达式语法，详细规范参见产品文档。", "example": "\"a\"" }, { "name": "InjectJS", "type": "string", "required": false, "description": "JavaScript 注入选项。默认值为 run-attestations，取值有： no-injection: 不注入 JavaScript; inject-sdk-only: 注入当前支持的所有认证方式的 SDK，当前支持：TC-RCE 和 TC-CAPTCHA。注意：若需执行认证检测，请配置挑战规则。", "example": "\"on\"" } ] } ], "required": [ "ZoneId" ] }, { "name": "ModifySecurityPolicy", "description": "修改Web\u0026Bot安全配置。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-225qgrnvbi9w" }, { "name": "SecurityConfig", "type": "object", "required": true, "description": "安全策略配置。当 SecurityPolicy 参数中的 ExceptionRules 被设置时，SecurityConfig 参数中的 ExceptConfig 将被忽略；当 SecurityPolicy 参数中的 CustomRules 被设置时，SecurityConfig 参数中的 AclConfig、 IpTableConfig 将被忽略；当 SecurityPolicy 参数中的 HttpDDoSProtection 和 RateLimitingRules 被设置时，SecurityConfig 参数中的 RateLimitConfig 将被忽略；当 SecurityPolicy 参数中的 ManagedRule 被设置时，SecurityConfig 参数中\ufffd\ufffd...", "example": "无", "children": [ { "name": "WafConfig", "type": "object", "required": false, "description": "托管规则。如果入参为空或不填，默认使用历史配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "WafConfig开关，取值有： on：开启； off：关闭。开关仅与配置是否生效有关，即使为off（关闭），也可以正常修改配置的内容。", "example": "off" }, { "name": "Level", "type": "string", "required": true, "description": "上一次设置的防护级别，取值有： loose：宽松； normal：正常； strict：严格； stricter：超严格； custom：自定义。", "example": "strict" }, { "name": "Mode", "type": "string", "required": true, "description": "全局WAF模式，取值有： block：阻断（全局阻断，但可对详细规则配置观察）； observe：观察（无论详细规则配置什么，都为观察）。", "example": "block" }, { "name": "WafRule", "type": "object", "required": false, "description": "托管规则详细配置。如果为null，默认使用历史配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "托管规则开关，取值有： on：开启； off：关闭。", "example": "on" }, { "name": "BlockRuleIDs", "type": "array", "required": true, "description": "黑名单ID列表，将规则ID加入本参数列表中代表该ID关闭，即该规则ID不再生效。", "example": "[0,1]", "item_type": "integer" }, { "name": "ObserveRuleIDs", "type": "array", "required": true, "description": "观察模式ID列表，将规则ID加入本参数列表中代表该ID使用观察模式生效，即该规则ID进入观察模式。", "example": "[4,5]", "item_type": "integer" } ] }, { "name": "AiRule", "type": "object", "required": false, "description": "AI规则引擎防护配置。如果为null，默认使用历史配置。", "example": "无", "children": [ { "name": "Mode", "type": "string", "required": true, "description": "AI规则引擎状态，取值有： smart_status_close：关闭； smart_status_open：拦截处置； smart_status_observe：观察处置。", "example": "smart_status_close" } ] } ] }, { "name": "RateLimitConfig", "type": "object", "required": false, "description": "速率限制。如果入参为空或不填，默认使用历史配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "开关，取值有： on：开启； off：关闭。", "example": "off" }, { "name": "RateLimitUserRules", "type": "array", "required": false, "description": "速率限制-用户规则列表。如果为null，默认使用历史配置。", "example": "无", "item_type": "object", "children": [ { "name": "Threshold", "type": "integer", "required": true, "description": "速率限制统计阈值，单位是次，取值范围0-4294967294。", "example": "1" }, { "name": "Period", "type": "integer", "required": true, "description": "速率限制统计时间，取值范围 10/20/30/40/50/60 单位是秒。", "example": "1" }, { "name": "RuleName", "type": "string", "required": true, "description": "规则名，只能以英文字符，数字，下划线组合，且不能以下划线开头。", "example": "rule" }, { "name": "Action", "type": "string", "required": true, "description": "处置动作，取值有： monitor：观察； drop：拦截； redirect：重定向； page：指定页面；alg：JavaScript 挑战。", "example": "drop" }, { "name": "PunishTime", "type": "integer", "required": true, "description": "惩罚时长，0-2天。", "example": "11" }, { "name": "PunishTimeUnit", "type": "string", "required": true, "description": "处罚时长单位，取值有： second：秒； minutes：分钟； hour：小时。", "example": "second" }, { "name": "RuleStatus", "type": "string", "required": true, "description": "规则状态，取值有： on：生效； off：不生效。默认 on 生效。", "example": "on" }, { "name": "AclConditions", "type": "array", "required": true, "description": "规则详情。", "example": "无", "item_type": "string" }, { "name": "RulePriority", "type": "integer", "required": true, "description": "规则权重，取值范围0-100。", "example": "1" }, { "name": "RuleID", "type": "integer", "required": false, "description": "规则 Id。仅出参使用。", "example": "1" }, { "name": "FreqFields", "type": "array", "required": false, "description": "过滤词，取值有： sip：客户端 ip。 默认为空字符串。", "example": "\"sip\"", "item_type": "string" }, { "name": "UpdateTime", "type": "string", "required": false, "description": "更新时间。仅出参使用。修改时默认为当前时间。", "example": "2024-07-15T00:00:00+08:00" }, { "name": "FreqScope", "type": "array", "required": false, "description": "统计范围。取值有： source_to_eo：（响应）源站到 EdgeOne； client_to_eo：（请求）客户端到 EdgeOne。 默认为 source_to_eo。", "example": "source_to_eo", "item_type": "string" }, { "name": "Name", "type": "string", "required": false, "description": "自定义返回页面的名称。Action 是 page 时必填，且不能为空。", "example": "error.html\t" }, { "name": "CustomResponseId", "type": "string", "required": false, "description": "自定义响应 Id。该 Id 可通过查询自定义错误页列表接口获取。默认值为default，使用系统默认页面。Action 是 page 时必填，且不能为空。", "example": "p-xxx\t" }, { "name": "ResponseCode", "type": "integer", "required": false, "description": "自定义返回页面的响应码。Action 是 page 时必填，且不能为空，取值: 100~600，不支持 3xx 响应码。默认值：567。", "example": "567" }, { "name": "RedirectUrl", "type": "string", "required": false, "description": "重定向时候的地址。Action 是 redirect 时必填，且不能为空。", "example": "http%3A%2F%2Fexample.com%2Fpath%2Ferror.html" } ] }, { "name": "RateLimitTemplate", "type": "object", "required": false, "description": "速率限制模板功能。如果为null，默认使用历史配置。", "example": "无", "children": [ { "name": "Mode", "type": "string", "required": true, "description": "模板等级名称，取值有： sup_loose：超级宽松； loose：宽松； emergency：紧急； normal：适中； strict：严格； close：关闭，仅精准速率限制生效。", "example": "loose" }, { "name": "Action", "type": "string", "required": false, "description": "模板处置方式，取值有： alg：JavaScript挑战； monitor：观察。不填写默认取alg。", "example": "alg" }, { "name": "RateLimitTemplateDetail", "type": "object", "required": false, "description": "模板值详情。仅出参返回。", "example": "无" } ] }, { "name": "RateLimitIntelligence", "type": "object", "required": false, "description": "智能客户端过滤。如果为null，默认使用历史配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "功能开关，取值有： on：开启； off：关闭。", "example": "off" }, { "name": "Action", "type": "string", "required": true, "description": "执行动作，取值有： monitor：观察； alg：挑战。", "example": "monitor" }, { "name": "RuleId", "type": "integer", "required": false, "description": "规则id，仅出参使用。", "example": "1" } ] }, { "name": "RateLimitCustomizes", "type": "array", "required": false, "description": "速率限制-托管定制规则。如果为null，默认使用历史配置。", "example": "无", "item_type": "object", "children": [ { "name": "Threshold", "type": "integer", "required": true, "description": "速率限制统计阈值，单位是次，取值范围0-4294967294。", "example": "1" }, { "name": "Period", "type": "integer", "required": true, "description": "速率限制统计时间，取值范围 10/20/30/40/50/60 单位是秒。", "example": "1" }, { "name": "RuleName", "type": "string", "required": true, "description": "规则名，只能以英文字符，数字，下划线组合，且不能以下划线开头。", "example": "rule" }, { "name": "Action", "type": "string", "required": true, "description": "处置动作，取值有： monitor：观察； drop：拦截； redirect：重定向； page：指定页面；alg：JavaScript 挑战。", "example": "drop" }, { "name": "PunishTime", "type": "integer", "required": true, "description": "惩罚时长，0-2天。", "example": "11" }, { "name": "PunishTimeUnit", "type": "string", "required": true, "description": "处罚时长单位，取值有： second：秒； minutes：分钟； hour：小时。", "example": "second" }, { "name": "RuleStatus", "type": "string", "required": true, "description": "规则状态，取值有： on：生效； off：不生效。默认 on 生效。", "example": "on" }, { "name": "AclConditions", "type": "array", "required": true, "description": "规则详情。", "example": "无", "item_type": "string" }, { "name": "RulePriority", "type": "integer", "required": true, "description": "规则权重，取值范围0-100。", "example": "1" }, { "name": "RuleID", "type": "integer", "required": false, "description": "规则 Id。仅出参使用。", "example": "1" }, { "name": "FreqFields", "type": "array", "required": false, "description": "过滤词，取值有： sip：客户端 ip。 默认为空字符串。", "example": "\"sip\"", "item_type": "string" }, { "name": "UpdateTime", "type": "string", "required": false, "description": "更新时间。仅出参使用。修改时默认为当前时间。", "example": "2024-07-15T00:00:00+08:00" }, { "name": "FreqScope", "type": "array", "required": false, "description": "统计范围。取值有： source_to_eo：（响应）源站到 EdgeOne； client_to_eo：（请求）客户端到 EdgeOne。 默认为 source_to_eo。", "example": "source_to_eo", "item_type": "string" }, { "name": "Name", "type": "string", "required": false, "description": "自定义返回页面的名称。Action 是 page 时必填，且不能为空。", "example": "error.html\t" }, { "name": "CustomResponseId", "type": "string", "required": false, "description": "自定义响应 Id。该 Id 可通过查询自定义错误页列表接口获取。默认值为default，使用系统默认页面。Action 是 page 时必填，且不能为空。", "example": "p-xxx\t" }, { "name": "ResponseCode", "type": "integer", "required": false, "description": "自定义返回页面的响应码。Action 是 page 时必填，且不能为空，取值: 100~600，不支持 3xx 响应码。默认值：567。", "example": "567" }, { "name": "RedirectUrl", "type": "string", "required": false, "description": "重定向时候的地址。Action 是 redirect 时必填，且不能为空。", "example": "http%3A%2F%2Fexample.com%2Fpath%2Ferror.html" } ] } ] }, { "name": "AclConfig", "type": "object", "required": false, "description": "自定义规则。如果入参为空或不填，默认使用历史配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "开关，取值有： on：开启； off：关闭。", "example": "on" }, { "name": "AclUserRules", "type": "array", "required": true, "description": "用户自定义规则。", "example": "无", "item_type": "object", "children": [ { "name": "RuleName", "type": "string", "required": true, "description": "规则名。", "example": "rule1" }, { "name": "Action", "type": "string", "required": true, "description": "处罚动作，取值有： trans：放行； drop：拦截； monitor：观察； ban：IP 封禁； redirect：重定向； page：指定页面； alg：JavaScript 挑战。", "example": "drop" }, { "name": "RuleStatus", "type": "string", "required": true, "description": "规则状态，取值有： on：生效； off：失效。", "example": "on" }, { "name": "AclConditions", "type": "array", "required": true, "description": "自定义规则。", "example": "无", "item_type": "string" }, { "name": "RulePriority", "type": "integer", "required": true, "description": "规则优先级，取值范围0-100。", "example": "50" }, { "name": "RuleID", "type": "integer", "required": false, "description": "规则 Id。仅出参使用。", "example": "1" }, { "name": "UpdateTime", "type": "string", "required": false, "description": "更新时间。仅出参使用。", "example": "2024-12-16T07:47:28Z" }, { "name": "PunishTime", "type": "integer", "required": false, "description": "ip 封禁的惩罚时间。Action 是 ban 时必填，且不能为空，取值范围0-2天。", "example": "10" }, { "name": "PunishTimeUnit", "type": "string", "required": false, "description": "ip 封禁的惩罚时间单位，取值有： second：秒； minutes：分； hour：小时。默认为 second。", "example": "second" }, { "name": "Name", "type": "string", "required": false, "description": "自定义返回页面的名称。Action 是 page 时必填，且不能为空。", "example": "error.html" }, { "name": "PageId", "type": "integer", "required": false, "description": "自定义返回页面的实例 Id。默认为0，代表使用系统默认拦截页面。该参数已废弃。", "example": "0" }, { "name": "CustomResponseId", "type": "string", "required": false, "description": "自定义响应 Id。该 Id 可通过查询自定义错误页列表接口获取。默认值为default，使用系统默认页面。Action 是 page 时必填，且不能为空。", "example": "p-xxx" }, { "name": "ResponseCode", "type": "integer", "required": false, "description": "自定义返回页面的响应码。Action 是 page 时必填，且不能为空，取值: 100~600，不支持 3xx 响应码。默认值：567。", "example": "567" }, { "name": "RedirectUrl", "type": "string", "required": false, "description": "重定向时候的地址。Action 是 redirect 时必填，且不能为空。", "example": "http%3A%2F%2Fexample.com%2Fpath%2Ferror.html" } ] }, { "name": "Customizes", "type": "array", "required": false, "description": "托管定制规则", "example": "无", "item_type": "object", "children": [ { "name": "RuleName", "type": "string", "required": true, "description": "规则名。", "example": "rule1" }, { "name": "Action", "type": "string", "required": true, "description": "处罚动作，取值有： trans：放行； drop：拦截； monitor：观察； ban：IP 封禁； redirect：重定向； page：指定页面； alg：JavaScript 挑战。", "example": "drop" }, { "name": "RuleStatus", "type": "string", "required": true, "description": "规则状态，取值有： on：生效； off：失效。", "example": "on" }, { "name": "AclConditions", "type": "array", "required": true, "description": "自定义规则。", "example": "无", "item_type": "string" }, { "name": "RulePriority", "type": "integer", "required": true, "description": "规则优先级，取值范围0-100。", "example": "50" }, { "name": "RuleID", "type": "integer", "required": false, "description": "规则 Id。仅出参使用。", "example": "1" }, { "name": "UpdateTime", "type": "string", "required": false, "description": "更新时间。仅出参使用。", "example": "2024-12-16T07:47:28Z" }, { "name": "PunishTime", "type": "integer", "required": false, "description": "ip 封禁的惩罚时间。Action 是 ban 时必填，且不能为空，取值范围0-2天。", "example": "10" }, { "name": "PunishTimeUnit", "type": "string", "required": false, "description": "ip 封禁的惩罚时间单位，取值有： second：秒； minutes：分； hour：小时。默认为 second。", "example": "second" }, { "name": "Name", "type": "string", "required": false, "description": "自定义返回页面的名称。Action 是 page 时必填，且不能为空。", "example": "error.html" }, { "name": "PageId", "type": "integer", "required": false, "description": "自定义返回页面的实例 Id。默认为0，代表使用系统默认拦截页面。该参数已废弃。", "example": "0" }, { "name": "CustomResponseId", "type": "string", "required": false, "description": "自定义响应 Id。该 Id 可通过查询自定义错误页列表接口获取。默认值为default，使用系统默认页面。Action 是 page 时必填，且不能为空。", "example": "p-xxx" }, { "name": "ResponseCode", "type": "integer", "required": false, "description": "自定义返回页面的响应码。Action 是 page 时必填，且不能为空，取值: 100~600，不支持 3xx 响应码。默认值：567。", "example": "567" }, { "name": "RedirectUrl", "type": "string", "required": false, "description": "重定向时候的地址。Action 是 redirect 时必填，且不能为空。", "example": "http%3A%2F%2Fexample.com%2Fpath%2Ferror.html" } ] } ] }, { "name": "BotConfig", "type": "object", "required": false, "description": "Bot配置。如果入参为空或不填，默认使用历史配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "bot开关，取值有： on：开启； off：关闭。", "example": "off" }, { "name": "BotManagedRule", "type": "object", "required": false, "description": "通用详细基础规则。如果为null，默认使用历史配置。", "example": "无", "children": [ { "name": "Action", "type": "string", "required": true, "description": "触发规则后的处置方式，取值有： drop：拦截； trans：放行； alg：Javascript挑战； monitor：观察。", "example": "drop" }, { "name": "RuleID", "type": "integer", "required": false, "description": "本规则的ID。仅出参使用。", "example": "1" }, { "name": "TransManagedIds", "type": "array", "required": false, "description": "放行的规则ID。默认所有规则不配置放行。", "example": "[1,2]", "item_type": "integer" }, { "name": "AlgManagedIds", "type": "array", "required": false, "description": "JS挑战的规则ID。默认所有规则不配置JS挑战。", "example": "[1,2]", "item_type": "integer" }, { "name": "CapManagedIds", "type": "array", "required": false, "description": "数字验证码的规则ID。默认所有规则不配置数字验证码。", "example": "[1,2]", "item_type": "integer" }, { "name": "MonManagedIds", "type": "array", "required": false, "description": "观察的规则ID。默认所有规则不配置观察。", "example": "[1,2]", "item_type": "integer" }, { "name": "DropManagedIds", "type": "array", "required": false, "description": "拦截的规则ID。默认所有规则不配置拦截。", "example": "[1,2]", "item_type": "integer" } ] }, { "name": "BotPortraitRule", "type": "object", "required": false, "description": "用户画像规则。如果为null，默认使用历史配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "本功能的开关，取值有： on：开启； off：关闭。", "example": "off" }, { "name": "RuleID", "type": "integer", "required": false, "description": "本规则的ID。仅出参使用。", "example": "1" }, { "name": "AlgManagedIds", "type": "array", "required": false, "description": "JS挑战的规则ID。默认所有规则不配置JS挑战。", "example": "[1,2]", "item_type": "integer" }, { "name": "CapManagedIds", "type": "array", "required": false, "description": "数字验证码的规则ID。默认所有规则不配置数字验证码。", "example": "[1,2]", "item_type": "integer" }, { "name": "MonManagedIds", "type": "array", "required": false, "description": "观察的规则ID。默认所有规则不配置观察。", "example": "[1,2]", "item_type": "integer" }, { "name": "DropManagedIds", "type": "array", "required": false, "description": "拦截的规则ID。默认所有规则不配置拦截。", "example": "[1,2]", "item_type": "integer" } ] }, { "name": "IntelligenceRule", "type": "object", "required": false, "description": "Bot智能分析。如果为null，默认使用历史配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "开关，取值有： on：开启； off：关闭。", "example": "off" }, { "name": "IntelligenceRuleItems", "type": "array", "required": false, "description": "规则详情。", "example": "无", "item_type": "string" } ] }, { "name": "BotUserRules", "type": "array", "required": false, "description": "Bot自定义规则。如果为null，默认使用历史配置。", "example": "无", "item_type": "object", "children": [ { "name": "RuleName", "type": "string", "required": true, "description": "规则名，只能以英文字符，数字，下划线组合，且不能以下划线开头。", "example": "rule" }, { "name": "Action", "type": "string", "required": true, "description": "处置动作，取值有： drop：拦截； monitor：观察； trans：放行； redirect：重定向； page：指定页面； alg：JavaScript 挑战； captcha：托管挑战； random：随机处置； silence：静默； shortdelay：短时响应； longdelay：长时响应。", "example": "drop" }, { "name": "RuleStatus", "type": "string", "required": true, "description": "规则状态，取值有： on：生效； off：不生效。默认 on 生效。", "example": "on" }, { "name": "AclConditions", "type": "array", "required": true, "description": "规则详情。", "example": "无", "item_type": "string" }, { "name": "RulePriority", "type": "integer", "required": true, "description": "规则权重，取值范围0-100。", "example": "1" }, { "name": "RuleID", "type": "integer", "required": false, "description": "规则 Id。仅出参使用。", "example": "1" }, { "name": "ExtendActions", "type": "array", "required": false, "description": "随机处置的处置方式及占比，非随机处置可不填暂不支持。", "example": "drop", "item_type": "string" }, { "name": "FreqFields", "type": "array", "required": false, "description": "过滤词，取值有： sip：客户端 ip。 默认为空字符串。", "example": "\"sip\"", "item_type": "string" }, { "name": "UpdateTime", "type": "string", "required": false, "description": "更新时间。仅出参使用。", "example": "2024-12-16T07:47:28Z" }, { "name": "FreqScope", "type": "array", "required": false, "description": "统计范围。取值有： source_to_eo：（响应）源站到 EdgeOne； client_to_eo：（请求）客户端到 EdgeOne。 默认为 source_to_eo。", "example": "source_to_eo", "item_type": "string" }, { "name": "Name", "type": "string", "required": false, "description": "自定义返回页面的名称。Action 是 page 时必填，且不能为空。", "example": "error.html" }, { "name": "CustomResponseId", "type": "string", "required": false, "description": "自定义响应 Id。该 Id 可通过查询自定义错误页列表接口获取。默认值为default，使用系统默认页面。Action 是 page 时必填，且不能为空。", "example": "p-xxx" }, { "name": "ResponseCode", "type": "integer", "required": false, "description": "自定义返回页面的响应码。Action 是 page 时必填，且不能为空，取值: 100~600，不支持 3xx 响应码。默认值：567。", "example": "567" }, { "name": "RedirectUrl", "type": "string", "required": false, "description": "重定向时候的地址。Action 是 redirect 时必填，且不能为空。", "example": "http%3A%2F%2Fexample.com%2Fpath%2Ferror.html" } ] }, { "name": "AlgDetectRule", "type": "array", "required": false, "description": "Bot主动特征识别规则。", "example": "无", "item_type": "object", "children": [ { "name": "RuleID", "type": "integer", "required": false, "description": "规则id。", "example": "1" }, { "name": "RuleName", "type": "string", "required": false, "description": "规则名。", "example": "rule1" }, { "name": "Switch", "type": "string", "required": false, "description": "规则开关。", "example": "on" }, { "name": "AlgConditions", "type": "array", "required": false, "description": "自定义规则。", "example": "无", "item_type": "string" }, { "name": "AlgDetectSession", "type": "object", "required": false, "description": "Cookie校验和会话行为分析。", "example": "无" }, { "name": "AlgDetectJS", "type": "array", "required": false, "description": "客户端行为校验。", "example": "无", "item_type": "string" }, { "name": "UpdateTime", "type": "string", "required": false, "description": "更新时间。仅出参使用。", "example": "2022-09-01 00:00:00" } ] }, { "name": "Customizes", "type": "array", "required": false, "description": "Bot托管定制策略，入参可不填，仅出参使用。", "example": "无", "item_type": "object", "children": [ { "name": "RuleName", "type": "string", "required": true, "description": "规则名，只能以英文字符，数字，下划线组合，且不能以下划线开头。", "example": "rule" }, { "name": "Action", "type": "string", "required": true, "description": "处置动作，取值有： drop：拦截； monitor：观察； trans：放行； redirect：重定向； page：指定页面； alg：JavaScript 挑战； captcha：托管挑战； random：随机处置； silence：静默； shortdelay：短时响应； longdelay：长时响应。", "example": "drop" }, { "name": "RuleStatus", "type": "string", "required": true, "description": "规则状态，取值有： on：生效； off：不生效。默认 on 生效。", "example": "on" }, { "name": "AclConditions", "type": "array", "required": true, "description": "规则详情。", "example": "无", "item_type": "string" }, { "name": "RulePriority", "type": "integer", "required": true, "description": "规则权重，取值范围0-100。", "example": "1" }, { "name": "RuleID", "type": "integer", "required": false, "description": "规则 Id。仅出参使用。", "example": "1" }, { "name": "ExtendActions", "type": "array", "required": false, "description": "随机处置的处置方式及占比，非随机处置可不填暂不支持。", "example": "drop", "item_type": "string" }, { "name": "FreqFields", "type": "array", "required": false, "description": "过滤词，取值有： sip：客户端 ip。 默认为空字符串。", "example": "\"sip\"", "item_type": "string" }, { "name": "UpdateTime", "type": "string", "required": false, "description": "更新时间。仅出参使用。", "example": "2024-12-16T07:47:28Z" }, { "name": "FreqScope", "type": "array", "required": false, "description": "统计范围。取值有： source_to_eo：（响应）源站到 EdgeOne； client_to_eo：（请求）客户端到 EdgeOne。 默认为 source_to_eo。", "example": "source_to_eo", "item_type": "string" }, { "name": "Name", "type": "string", "required": false, "description": "自定义返回页面的名称。Action 是 page 时必填，且不能为空。", "example": "error.html" }, { "name": "CustomResponseId", "type": "string", "required": false, "description": "自定义响应 Id。该 Id 可通过查询自定义错误页列表接口获取。默认值为default，使用系统默认页面。Action 是 page 时必填，且不能为空。", "example": "p-xxx" }, { "name": "ResponseCode", "type": "integer", "required": false, "description": "自定义返回页面的响应码。Action 是 page 时必填，且不能为空，取值: 100~600，不支持 3xx 响应码。默认值：567。", "example": "567" }, { "name": "RedirectUrl", "type": "string", "required": false, "description": "重定向时候的地址。Action 是 redirect 时必填，且不能为空。", "example": "http%3A%2F%2Fexample.com%2Fpath%2Ferror.html" } ] } ] }, { "name": "SwitchConfig", "type": "object", "required": false, "description": "七层防护总开关。如果入参为空或不填，默认使用历史配置。", "example": "无", "children": [ { "name": "WebSwitch", "type": "string", "required": true, "description": "Web类型的安全总开关，取值有： on：开启； off：关闭。不影响DDoS与Bot的开关。", "example": "on" } ] }, { "name": "IpTableConfig", "type": "object", "required": false, "description": "基础访问管控。如果入参为空或不填，默认使用历史配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "开关，取值有： on：开启； off：关闭；", "example": "off" }, { "name": "IpTableRules", "type": "array", "required": false, "description": "基础管控规则。如果为null，默认使用历史配置。", "example": "无", "item_type": "object", "children": [ { "name": "Action", "type": "string", "required": true, "description": "动作，取值有： drop：拦截； trans：放行； monitor：观察。", "example": "drop" }, { "name": "MatchFrom", "type": "string", "required": true, "description": "根据类型匹配，取值有： ip：客户端 IP 进行匹配； area：客户端 IP 所属地区匹配； asn：客户端所属的自治系统进行匹配； referer：请求头 Referer 进行匹配； ua：请求头 User-Agent 进行匹配； url：请求 URL 进行匹配。", "example": "ip" }, { "name": "Operator", "type": "string", "required": false, "description": "规则的匹配方式。取值有： 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 , re...", "example": "equal" }, { "name": "RuleID", "type": "integer", "required": false, "description": "规则id。仅出参使用。", "example": "0" }, { "name": "UpdateTime", "type": "string", "required": false, "description": "更新时间。仅出参使用。", "example": "2024-07-15T00:00:00+08:00" }, { "name": "Status", "type": "string", "required": false, "description": "规则启用状态。取值有： on：启用； off：未启用。 当入参缺省时，按 on 取值。", "example": "on" }, { "name": "RuleName", "type": "string", "required": false, "description": "规则名。", "example": "rule1" }, { "name": "MatchContent", "type": "string", "required": false, "description": "匹配内容。支持多值输入。 当输入多个匹配值时，请使用英文逗号分隔； 当 MatchFrom 为 ua 时，不支持多值输入； 当 Operator 为 is_empty 或 not_exists 时，本字段入参值无效。", "example": "1.1.1.1" } ] } ] }, { "name": "ExceptConfig", "type": "object", "required": false, "description": "例外规则配置。如果入参为空或不填，默认使用历史配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "配置开关，取值有： on：开启； off：关闭。", "example": "on" }, { "name": "ExceptUserRules", "type": "array", "required": false, "description": "例外规则详情。如果为null，默认使用历史配置。", "example": "无", "item_type": "object", "children": [ { "name": "RuleName", "type": "string", "required": true, "description": "规则名称，不可使用中文。", "example": "rule1" }, { "name": "Action", "type": "string", "required": true, "description": "规则的处置方式，当前仅支持skip：跳过全部托管规则。", "example": "skip" }, { "name": "RuleStatus", "type": "string", "required": true, "description": "规则生效状态，取值有： on：生效； off：失效。", "example": "on" }, { "name": "RuleID", "type": "integer", "required": false, "description": "规则ID。仅出参使用。默认由底层生成。", "example": "1" }, { "name": "UpdateTime", "type": "string", "required": false, "description": "更新时间，如果为null，默认由底层按当前时间生成。", "example": "2024-07-15T00:00:00+08:00" }, { "name": "ExceptUserRuleConditions", "type": "array", "required": false, "description": "匹配条件。", "example": "无", "item_type": "string" }, { "name": "ExceptUserRuleScope", "type": "object", "required": false, "description": "规则生效的范围。", "example": "无" }, { "name": "RulePriority", "type": "integer", "required": false, "description": "优先级，取值范围0-100。如果为null，默认由底层设置为0。", "example": "无" } ] } ] }, { "name": "DropPageConfig", "type": "object", "required": false, "description": "自定义拦截页面配置。如果入参为空或不填，默认使用历史配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "配置开关，取值有： on：开启； off：关闭。", "example": "on" }, { "name": "WafDropPageDetail", "type": "object", "required": false, "description": "Waf(托管规则)模块的拦截页面配置。如果为null，默认使用历史配置。", "example": "无", "children": [ { "name": "PageId", "type": "integer", "required": true, "description": "拦截页面的唯一 Id。系统默认包含一个自带拦截页面，Id 值为0。 该 Id 可通过创建拦截页面接口进行上传获取。如传入0，代表使用系统默认拦截页面。该参数已废弃。", "example": "0" }, { "name": "StatusCode", "type": "integer", "required": true, "description": "拦截页面的 HTTP 状态码。状态码取值：100～600，不支持 3xx 状态码。托管规则拦截页面默认：566，安全防护（除托管规则外）拦截页面默认：567.", "example": "566" }, { "name": "Name", "type": "string", "required": true, "description": "页面文件名或 url。", "example": "error.html" }, { "name": "Type", "type": "string", "required": true, "description": "页面的类型，取值有： page：指定页面。", "example": "url" }, { "name": "CustomResponseId", "type": "string", "required": false, "description": "自定义响应 Id。该 Id 可通过查询自定义错误页列表接口获取。默认值为default，使用系统默认页面。Type 类型是 page 时必填，且不能为空。", "example": "page-xxx\t" } ] }, { "name": "AclDropPageDetail", "type": "object", "required": false, "description": "自定义页面的拦截页面配置。如果为null，默认使用历史配置。", "example": "无", "children": [ { "name": "PageId", "type": "integer", "required": true, "description": "拦截页面的唯一 Id。系统默认包含一个自带拦截页面，Id 值为0。 该 Id 可通过创建拦截页面接口进行上传获取。如传入0，代表使用系统默认拦截页面。该参数已废弃。", "example": "0" }, { "name": "StatusCode", "type": "integer", "required": true, "description": "拦截页面的 HTTP 状态码。状态码取值：100～600，不支持 3xx 状态码。托管规则拦截页面默认：566，安全防护（除托管规则外）拦截页面默认：567.", "example": "566" }, { "name": "Name", "type": "string", "required": true, "description": "页面文件名或 url。", "example": "error.html" }, { "name": "Type", "type": "string", "required": true, "description": "页面的类型，取值有： page：指定页面。", "example": "url" }, { "name": "CustomResponseId", "type": "string", "required": false, "description": "自定义响应 Id。该 Id 可通过查询自定义错误页列表接口获取。默认值为default，使用系统默认页面。Type 类型是 page 时必填，且不能为空。", "example": "page-xxx\t" } ] } ] }, { "name": "TemplateConfig", "type": "object", "required": false, "description": "模板配置。此处仅出参数使用。", "example": "无", "children": [ { "name": "TemplateId", "type": "string", "required": true, "description": "模板ID。", "example": "1" }, { "name": "TemplateName", "type": "string", "required": true, "description": "模板名称。", "example": "1" } ] }, { "name": "SlowPostConfig", "type": "object", "required": false, "description": "慢速攻击配置。如果入参为空或不填，默认使用历史配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "开关，取值有： on：开启； off：关闭。", "example": "off" }, { "name": "FirstPartConfig", "type": "object", "required": false, "description": "首包配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "开关，取值有： on：开启； off：关闭。", "example": "off" }, { "name": "StatTime", "type": "integer", "required": false, "description": "首段包的统计时长，单位是秒，即期望首段包的统计时长是多少，默认5秒。", "example": "10" } ] }, { "name": "SlowRateConfig", "type": "object", "required": false, "description": "基础配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "开关，取值有： on：开启； off：关闭。", "example": "off" }, { "name": "Interval", "type": "integer", "required": false, "description": "统计的间隔，单位是秒，即在首段包传输结束后，将数据传输轴按照本参数切分，每个分片独立计算慢速攻击。", "example": "5" }, { "name": "Threshold", "type": "integer", "required": false, "description": "统计时应用的速率阈值，单位是bps，即如果本分片中的传输速率没达到本参数的值，则判定为慢速攻击，应用慢速攻击的处置方式。", "example": "80" } ] }, { "name": "Action", "type": "string", "required": false, "description": "慢速攻击的处置动作，取值有： monitor：观察； drop：拦截。", "example": "monitor" }, { "name": "RuleId", "type": "integer", "required": false, "description": "本规则的Id。", "example": "1" } ] }, { "name": "DetectLengthLimitConfig", "type": "object", "required": false, "description": "检测长度限制配置。仅出参使用。", "example": "无", "children": [ { "name": "DetectLengthLimitRules", "type": "array", "required": true, "description": "检测长度限制的规则列表。", "example": "无", "item_type": "object", "children": [ { "name": "RuleId", "type": "integer", "required": true, "description": "规则Id。仅出参使用。", "example": "10468982785" }, { "name": "RuleName", "type": "string", "required": true, "description": "规则名称。仅出参使用。", "example": "请求正文最大检测长度" }, { "name": "Description", "type": "string", "required": true, "description": "规则描述，仅出参使用。", "example": "在检查请求正文内容时，安全策略仅检测一定长度范围内的请求正文数据，超过该范围的数据不会触发安全策略。您可以选择如何处理正文超长的请求。" }, { "name": "Conditions", "type": "array", "required": true, "description": "规则配置条件。仅出参使用。", "example": "无", "item_type": "string" }, { "name": "Action", "type": "string", "required": true, "description": "处置方式，取值有： skip：当请求正文数据超过 Conditions 出参中 body_depth 设置的检测深度时，跳过所有请求正文内容的检测； scan：仅检测 Conditions 出参中 body_depth 设置的检测深度，对超出部分的请求正文内容直接截断处理，超出部分的请求正文不会经过安全检测。仅出参使用。", "example": "scan" } ] } ] } ] }, { "name": "SecurityPolicy", "type": "object", "required": false, "description": "安全策略配置。对 Web 例外规则、防护自定义策略、速率规则、托管规则和 Bot 管理配置建议使用，支持表达式语法对安全策略进行配置。", "example": "无", "children": [ { "name": "CustomRules", "type": "object", "required": false, "description": "自定义规则配置。", "example": "无", "children": [ { "name": "Rules", "type": "array", "required": false, "description": "自定义规则的定义列表。使用 ModifySecurityPolicy 修改 Web 防护配置时: - 若未指定 Rules 参数，或 Rules 参数长度为零：清空所有自定义规则配置。 - 若 SecurityPolicy 参数中，未指定 CustomRules 参数值：保持已有自定义规则配置，不做修改。", "example": "参考 CustomRule 结构", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "自定义规则的名称。", "example": "SampleBasicACLRule" }, { "name": "Condition", "type": "string", "required": true, "description": "自定义规则的具体内容，需符合表达式语法，详细规范参见产品文档。", "example": "${http.request.ip} in ['1.1.1.1', '10.10.10.0/24', ${security.ip_group['123'@'zone-2xsnpvkhdjes']} ]" }, { "name": "Action", "type": "object", "required": true, "description": "自定义规则的执行动作。 SecurityAction 的 Name 取值支持：Deny：拦截；Monitor：观察；ReturnCustomPage：使用指定页面拦截；Redirect：重定向至 URL；BlockIP：IP 封禁；JSChallenge：JavaScript 挑战；ManagedChallenge：托管挑战；Allow：放行。", "example": "参考SecurityAction结构" }, { "name": "Enabled", "type": "string", "required": true, "description": "自定义规则是否开启。取值有：on：开启off：关闭", "example": "on" }, { "name": "Id", "type": "string", "required": false, "description": "自定义规则的 ID。通过规则 ID 可支持不同的规则配置操作： - 增加新规则：ID 为空或不指定 ID 参数； - 修改已有规则：指定需要更新/修改的规则 ID； - 删除已有规则：CustomRules 参数中，Rules 列表中未包含的已有规则将被删除。", "example": "1492837231" }, { "name": "RuleType", "type": "string", "required": false, "description": "自定义规则的类型。取值有：BasicAccessRule：基础访问管控；PreciseMatchRule：精准匹配规则，默认；ManagedAccessRule：专家定制规则，仅出参。默认为PreciseMatchRule。", "example": "PreciseMatchRule" }, { "name": "Priority", "type": "integer", "required": false, "description": "自定义规则的优先级，范围是 0 ~ 100，默认为 0，仅支持精准匹配规则（PreciseMatchRule）。", "example": "10" } ] } ] }, { "name": "ManagedRules", "type": "object", "required": false, "description": "托管规则配置。", "example": "无", "children": [ { "name": "Enabled", "type": "string", "required": true, "description": "托管规则是否开启。取值有：on：开启，所有托管规则按配置生效；off：关闭，所有托管规则不生效。", "example": "on" }, { "name": "DetectionOnly", "type": "string", "required": true, "description": "评估模式是否开启，仅在 Enabled 参数为 on 时有效。取值有：on：开启，表示所有托管规则以观察模式生效；off：关闭，表示所有托管规则以实际配置生效。", "example": "on" }, { "name": "SemanticAnalysis", "type": "string", "required": false, "description": "托管规则语义分析选项是否开启，仅在 Enabled 参数为 on 时有效。取值有：on：开启，对请求进行语义分析后进行处理；off：关闭，对请求不进行语义分析，直接进行处理。 默认为 off。", "example": "on" }, { "name": "AutoUpdate", "type": "object", "required": false, "description": "托管规则自动更新选项。", "example": "无", "children": [ { "name": "AutoUpdateToLatestVersion", "type": "string", "required": true, "description": "是否开启自动更新至最新版本。取值有：on：开启off：关闭", "example": "on" }, { "name": "RulesetVersion", "type": "string", "required": false, "description": "当前使用的版本，格式符合ISO 8601标准，如2023-12-21T12:00:32Z，默认为空，仅出参。", "example": "2023-12-21T12:00:32Z" } ] }, { "name": "ManagedRuleGroups", "type": "array", "required": false, "description": "托管规则组的配置。如果此结构传空数组或 GroupId 未包含在列表内将按照默认方式处理。", "example": "无", "item_type": "object", "children": [ { "name": "GroupId", "type": "string", "required": true, "description": "托管规则的组名称，未指定配置的规则分组将按照默认配置处理，GroupId 的具体取值参考产品文档。", "example": "wafmanagedrulegroup-file-upload-attacks" }, { "name": "SensitivityLevel", "type": "string", "required": true, "description": "托管规则组的防护级别。取值有：loose：宽松，只包含超高风险规则，此时需配置Action，且RuleActions配置无效；normal：正常，包含超高风险和高风险规则，此时需配置Action，且RuleActions配置无效；strict：严格，包含超高风险、高风险和中风险规则，此时需配置Action，且RuleActions配置无效；extreme：超严格，包含超高风险、高风险、中风险和低风险规则，此时需配置Action，且RuleActions...", "example": "loose" }, { "name": "Action", "type": "object", "required": true, "description": "托管规则组的处置动作。SecurityAction 的 Name 取值支持：Deny：拦截，响应拦截页面；Monitor：观察，不处理请求记录安全事件到日志中；Disabled：未启用，不扫描请求跳过该规则。", "example": "参考 SecurityAction 结构。" }, { "name": "RuleActions", "type": "array", "required": false, "description": "托管规则组下规则项的具体配置，仅在 SensitivityLevel 为 custom 时配置生效。", "example": "参考 ManagedRuleAction 结构。", "item_type": "string" }, { "name": "MetaData", "type": "object", "required": false, "description": "托管规则组信息，仅出参。", "example": "参考 ManagedRuleGroupMeta 结构。" } ] }, { "name": "FrequentScanningProtection", "type": "object", "required": false, "description": "高频扫描防护配置选项，当某一访客的请求频繁命中「配置为拦截」的托管规则时，在一段时间内封禁该访客所有请求。", "example": "无", "children": [ { "name": "Enabled", "type": "string", "required": false, "description": "高频扫描防护规则是否开启。取值有：on：开启，高频扫描防护规则生效；off：关闭，高频扫描防护规则不生效。", "example": "on" }, { "name": "Action", "type": "object", "required": false, "description": "高频扫描防护的处置动作。 当 Enabled 为 on 时，此字段必填。SecurityAction 的 Name 取值支持：Deny：拦截，响应拦截页面；Monitor：观察，不处理请求记录安全事件到日志中；JSChallenge：JavaScript 挑战，响应 JavaScript 挑战页面。", "example": "无" }, { "name": "CountBy", "type": "string", "required": false, "description": "请求统计的匹配方式，当 Enabled 为 on 时，此字段必填。取值有：http.request.xff_header_ip：客户端 IP（优先匹配 XFF 头部）；http.request.ip：客户端 IP。", "example": "http.request.ip" }, { "name": "BlockThreshold", "type": "integer", "required": false, "description": "此参数指定高频扫描防护的阈值，即在 CountingPeriod 所设置时间范围内命中「配置为拦截」的托管规则时的累计拦截次数，取值范围 1 ~ 4294967294，例如 100，当超过此统计值时，后续请求将触发 Action 所设置的处置动作。当 Enabled 为 on 时，此字段必填。", "example": "100" }, { "name": "CountingPeriod", "type": "string", "required": false, "description": "此参数指定高频扫描防护所统计的时间窗口，即命中「配置为拦截」的托管规则的请求的统计时间窗口，取值 5 ~ 1800，单位仅支持秒（s），例如 5s。 当 Enabled 为 on 时，此字段必填。", "example": "10s" }, { "name": "ActionDuration", "type": "string", "required": false, "description": "此参数指定高频扫描防护 Action 参数所设置处置动作的持续时长，取值范围 60 ~ 86400，单位仅支持秒（s），例如 60s。当 Enabled 为 on 时，此字段必填。", "example": "60s" } ] } ] }, { "name": "HttpDDoSProtection", "type": "object", "required": false, "description": "HTTP DDOS 防护配置。", "example": "无", "children": [ { "name": "AdaptiveFrequencyControl", "type": "object", "required": false, "description": "自适应频控的具体配置。", "example": "无", "children": [ { "name": "Enabled", "type": "string", "required": true, "description": "自适应频控是否开启。取值有：on：开启；off：关闭。", "example": "on" }, { "name": "Sensitivity", "type": "string", "required": false, "description": "自适应频控的限制等级，当 Enabled 为 on 时，此字段必填。取值有：Loose：宽松；Moderate：适中；Strict：严格。", "example": "Loose" }, { "name": "Action", "type": "object", "required": false, "description": "自适应频控的处置方式，当 Enabled 为 on 时，此字段必填。SecurityAction 的 Name 取值支持：Monitor：观察；Deny：拦截；Challenge：挑战，其中ChallengeActionParameters.Name仅支持JSChallenge。", "example": "无" } ] }, { "name": "ClientFiltering", "type": "object", "required": false, "description": "智能客户端过滤的具体配置。", "example": "无", "children": [ { "name": "Enabled", "type": "string", "required": true, "description": "智能客户端过滤是否开启。取值有：on：开启；off：关闭。", "example": "on" }, { "name": "Action", "type": "object", "required": false, "description": "智能客户端过滤的处置方式，当 Enabled 为 on 时，此字段必填。SecurityAction 的 Name 取值支持：Monitor：观察；Deny：拦截；Challenge：挑战，其中ChallengeActionParameters.Name仅支持JSChallenge。", "example": "无" } ] }, { "name": "BandwidthAbuseDefense", "type": "object", "required": false, "description": "流量防盗刷的具体配置。", "example": "无", "children": [ { "name": "Enabled", "type": "string", "required": true, "description": "流量防盗刷（仅适用中国大陆地区）是否开启。取值有：on：开启；off：关闭。", "example": "on" }, { "name": "Action", "type": "object", "required": false, "description": "流量防盗刷（仅适用中国大陆地区）的处置方式，当 Enabled 为 on 时，此字段必填。SecurityAction 的 Name 取值支持：Monitor：观察；Deny：拦截；Challenge：挑战，其中ChallengeActionParameters.Name仅支持JSChallenge。", "example": "参考 SecurityAction 结构" } ] }, { "name": "SlowAttackDefense", "type": "object", "required": false, "description": "慢速攻击防护的具体配置。", "example": "无", "children": [ { "name": "Enabled", "type": "string", "required": true, "description": "慢速攻击防护是否开启。取值有：on：开启；off：关闭。", "example": "on" }, { "name": "Action", "type": "object", "required": false, "description": "慢速攻击防护的处置方式，当 Enabled 为 on 时，此字段必填。SecurityAction 的 Name 取值支持：Monitor：观察；Deny：拦截；", "example": "无" }, { "name": "MinimalRequestBodyTransferRate", "type": "object", "required": false, "description": "正文传输最小速率阈值的具体配置，当 Enabled 为 on 时，此字段必填。", "example": "无" }, { "name": "RequestBodyTransferTimeout", "type": "object", "required": false, "description": "正文传输超时时长的具体配置，当 Enabled 为 on 时，此字段必填。", "example": "无" } ] } ] }, { "name": "RateLimitingRules", "type": "object", "required": false, "description": "速率限制规则配置。", "example": "无", "children": [ { "name": "Rules", "type": "array", "required": false, "description": "精准速率限制的定义列表。使用 ModifySecurityPolicy 修改 Web 防护配置时: 若未指定 Rules 参数，或 Rules 参数长度为零：清空所有精准速率限制配置。 若 SecurityPolicy 参数中，未指定 RateLimitingRules 参数值：保持已有自定义规则配置，不做修改。", "example": "无", "item_type": "object", "children": [ { "name": "Id", "type": "string", "required": false, "description": "精准速率限制的 ID。通过规则 ID 可支持不同的规则配置操作： 增加新规则：ID 为空或不指定 ID 参数；修改已有规则：指定需要更新/修改的规则 ID；删除已有规则：RateLimitingRules 参数中，Rules 列表中未包含的已有规则将被删除。", "example": "2181399690" }, { "name": "Name", "type": "string", "required": false, "description": "精准速率限制的名称。", "example": "SampleHttpDdosRule" }, { "name": "Condition", "type": "string", "required": false, "description": "精准速率限制的具体内容，需符合表达式语法，详细规范参见[产品文档](https://cloud.tencent.com/document/product/1552/125343)。", "example": "${http.request.uri.path} in ['/api/v3/test','/api/v3/submit']" }, { "name": "CountBy", "type": "array", "required": false, "description": "速率阈值请求特征的匹配方式， 当 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-ag...", "example": "http.request.ip", "item_type": "string" }, { "name": "MaxRequestThreshold", "type": "integer", "required": false, "description": "精准速率限制在时间范围内的累计拦截次数，取值范围 1 ~ 100000。", "example": "100" }, { "name": "CountingPeriod", "type": "string", "required": false, "description": "统计的时间窗口，取值有：1s：1秒；5s：5秒；10s：10秒；20s：20秒；30s：30秒；40s：40秒；50s：50秒；1m：1分钟；2m：2分钟；5m：5分钟；10m：10分钟；1h：1小时。", "example": "10s" }, { "name": "ActionDuration", "type": "string", "required": false, "description": "Action 动作的持续时长，单位仅支持：s：秒，取值 1 ~ 120；m：分钟，取值 1 ~ 120；h：小时，取值 1 ~ 48；d：天，取值 1 ~ 30。", "example": "60s" }, { "name": "Action", "type": "object", "required": false, "description": "精准速率限制的处置方式。取值有：Monitor：观察；Deny：拦截，其中DenyActionParameters.Name支持Deny和ReturnCustomPage；Challenge：挑战，其中ChallengeActionParameters.Name支持JSChallenge和ManagedChallenge；Redirect：重定向至URL；", "example": "无" }, { "name": "Priority", "type": "integer", "required": false, "description": "精准速率限制的优先级，范围是 0 ~ 100，默认为 0。", "example": "50" }, { "name": "Enabled", "type": "string", "required": false, "description": "精准速率限制规则是否开启。取值有：on：开启；off：关闭。", "example": "on" } ] } ] }, { "name": "ExceptionRules", "type": "object", "required": false, "description": "例外规则配置。", "example": "无", "children": [ { "name": "Rules", "type": "array", "required": false, "description": "例外规则的定义列表。使用 ModifySecurityPolicy 修改 Web 防护配置时: 若未指定 Rules 参数，或 Rules 参数长度为零：清空所有例外规则配置。若 SecurityPolicy 参数中，未指定 ExceptionRules 参数值：保持已有例外规则配置，不做修改。", "example": "参考 ExceptionRule 结构", "item_type": "object", "children": [ { "name": "Id", "type": "string", "required": false, "description": "例外规则的 ID。通过规则 ID 可支持不同的规则配置操作： 增加新规则：ID 为空或不指定 ID 参数； 修改已有规则：指定需要更新/修改的规则 ID； 删除已有规则：ExceptionRules 参数中，Rules 列表中未包含的已有规则将被删除。", "example": "2181399686" }, { "name": "Name", "type": "string", "required": false, "description": "例外规则的名称。", "example": "SampleBasicExceptionRule" }, { "name": "Condition", "type": "string", "required": false, "description": "例外规则的具体内容，需符合表达式语法，详细规范参见产品文档。", "example": "${http.request.uri.path} in ['/api/v3/test','/api/v3/submit'] and ${http.request.method} in ['POST']" }, { "name": "SkipScope", "type": "string", "required": false, "description": "例外规则执行选项，取值有：WebSecurityModules: 指定例外规则的安全防护模块。ManagedRules：指定托管规则。", "example": "WebSecurityModules" }, { "name": "SkipOption", "type": "string", "required": false, "description": "跳过请求的具体类型，取值有：SkipOnAllRequestFields: 跳过所有请求；SkipOnSpecifiedRequestFields: 跳过指定请求字段。仅当 SkipScope 为 ManagedRules 时有效。", "example": "SkipOnSpecifiedRequestFields" }, { "name": "WebSecurityModulesForException", "type": "array", "required": false, "description": "指定例外规则的安全防护模块，仅当 SkipScope 为 WebSecurityModules 时有效。取值有：websec-mod-managed-rules：托管规则；websec-mod-rate-limiting：速率限制；websec-mod-custom-rules：自定义规则；websec-mod-adaptive-control：自适应频控、智能客户端过滤、慢速攻击防护、流量盗刷防护；websec-mod-bot：Bot管理。", "example": "[\"websec-mod-custom-rules\",\"websec-mod-rate-limiting\"]", "item_type": "string" }, { "name": "ManagedRulesForException", "type": "array", "required": false, "description": "指定例外规则的具体托管规则，仅当 SkipScope 为 ManagedRules 时有效，且此时不能指定 ManagedRuleGroupsForException 。", "example": "[\"4401215074\",\"4368124487\"]", "item_type": "string" }, { "name": "ManagedRuleGroupsForException", "type": "array", "required": false, "description": "指定例外规则的托管规则组，仅当 SkipScope 为 ManagedRules 时有效，且此时不能指定 ManagedRulesForException 。", "example": "[\"wafgroup-sql-injection-attacks\"]", "item_type": "string" }, { "name": "RequestFieldsForException", "type": "array", "required": false, "description": "指定例外规则跳过指定请求字段的具体配置，仅当 SkipScope 为 ManagedRules 并且 SkipOption 为 SkipOnSpecifiedRequestFields 时有效。", "example": "参考 RequestFieldsForException 结构", "item_type": "string" }, { "name": "Enabled", "type": "string", "required": false, "description": "例外规则是否开启。取值有：on：开启off：关闭", "example": "on" } ] } ] }, { "name": "BotManagement", "type": "object", "required": false, "description": "Bot 管理配置。", "example": "无", "children": [ { "name": "Enabled", "type": "string", "required": false, "description": "Bot 管理是否开启。取值有：on：开启；off：关闭。", "example": "on" }, { "name": "CustomRules", "type": "object", "required": false, "description": "Bot 管理的自定义规则，组合各类爬虫和请求行为特征，精准定义 Bot 并配置定制化处置方式。", "example": "无", "children": [ { "name": "Rules", "type": "array", "required": false, "description": "Bot 自定义规则的列表。使用 ModifySecurityPolicy 修改 Web 防护配置时： 若未指定 SecurityPolicy.BotManagement.CustomRules 中的 Rules 参数，或 Rules 参数长度为零：清空所有 Bot 自定义规则配置。 若 SecurityPolicy.BotManagement 参数中，未指定 CustomRules 参数值：保持已有 Bot 自定义规则配置，不做修改。", "example": "无", "item_type": "string" } ] }, { "name": "BasicBotSettings", "type": "object", "required": false, "description": "Bot 管理的基础配置，对策略关联的所有域名生效。可以通过 CustomRules 进行精细化定制。", "example": "无", "children": [ { "name": "SourceIDC", "type": "object", "required": false, "description": "客户端 IP 的来源 IDC 配置，用于处置来自 IDC（数据中心） 的客户端 IP 的访问请求。此类来源请求不是由移动端或浏览器端直接访问。", "example": "无" }, { "name": "SearchEngineBots", "type": "object", "required": false, "description": "搜索引擎爬虫配置，用于处置来自搜索引擎爬虫的请求。此类请求的 IP、User-Agent 或 rDNS 结果匹配已知搜索引擎爬虫。", "example": "无" }, { "name": "KnownBotCategories", "type": "object", "required": false, "description": "商业或开源工具 UA 特征配置（原 UA 特征规则），用于处置来自已知商业工具或开源工具的访问请求。此类请求的 User-Agent 头部符合已知商业或开源工具特征。", "example": "无" }, { "name": "IPReputation", "type": "object", "required": false, "description": "IP 威胁情报库（原客户端画像分析）配置，用于处置近期访问行为具有特定风险特征的客户端 IP。", "example": "无" }, { "name": "BotIntelligence", "type": "object", "required": false, "description": "Bot 智能分析的具体配置。", "example": "无" } ] }, { "name": "ClientAttestationRules", "type": "object", "required": false, "description": "客户端认证规则的定义列表。该功能内测中，如需使用，请提工单。", "example": "无", "children": [ { "name": "Rules", "type": "array", "required": false, "description": "客户端认证的列表。使用 ModifySecurityPolicy 修改 Web 防护配置时： 若未指定 SecurityPolicy.BotManagement.ClientAttestationRules 中的 Rules 参数，或 Rules 参数长度为零：清空所有客户端认证规则配置。 若 SecurityPolicy.BotManagement 参数中，未指定 ClientAttestationRules 参数值：保持已有客户端认证规则配置，不做修改。", "example": "无", "item_type": "string" } ] }, { "name": "BrowserImpersonationDetection", "type": "object", "required": false, "description": "配置浏览器伪造识别规则（原主动特征识别规则）。设置注入 JavaScript 的响应页面范围，浏览器校验选项，以及对非浏览器客户端的处置方式。", "example": "无", "children": [ { "name": "Rules", "type": "array", "required": false, "description": "浏览器伪造识别规则的列表。使用 ModifySecurityPolicy 修改 Web 防护配置时： 若未指定 SecurityPolicy.BotManagement.BrowserImpersonationDetection 中的 Rules 参数，或 Rules 参数长度为零： 清空所有浏览器伪造识别规则配置。 若 SecurityPolicy.BotManagement 参数中，未指定 BrowserImpersonationDetection 参数值： 保持已有浏览器伪造识别规则配置，不做修改。", "example": "无", "item_type": "string" } ] } ] }, { "name": "BotManagementLite", "type": "object", "required": false, "description": "基础 Bot 管理配置。", "example": "无", "children": [ { "name": "CAPTCHAPageChallenge", "type": "object", "required": false, "description": "人机校验页的具体配置。", "example": "无", "children": [ { "name": "Enabled", "type": "string", "required": false, "description": "人机校验页是否开启，取值有：on：开启；off：关闭。", "example": "on" } ] }, { "name": "AICrawlerDetection", "type": "object", "required": false, "description": "AI爬虫检测的具体配置。", "example": "无", "children": [ { "name": "Enabled", "type": "string", "required": false, "description": "AI 爬虫检测是否开启。取值有： on：开启； off：关闭。", "example": "on" }, { "name": "Action", "type": "object", "required": false, "description": "AI 爬虫检测的执行动作，当 Enabled 为 on 时，此字段必填。SecurityAction 的 Name 取值仅支持： Deny：拦截； Monitor：观察； Allow：放行； Challenge：挑战，其中 ChallengeActionParameters 中的 ChallengeOption 仅支持 JSChallenge 和 ManagedChallenge。", "example": "无" } ] } ] } ] }, { "name": "Entity", "type": "string", "required": false, "description": "安全策略类型，可使用以下参数值： ZoneDefaultPolicy：用于指定站点级策略；Template：用于指定策略模板，需要同时指定 TemplateId 参数；Host：用于指定域名级策略（注意：当使用域名来指定域名服务策略时，仅支持已经应用了域名级策略的域名服务或者策略模板）。", "example": "Host" }, { "name": "Host", "type": "string", "required": false, "description": "指定域名。当 Entity 参数值为 Host 时，使用本参数指定的域名级策略，例如：使用 www.example.com ，配置该域名的域名级策略。", "example": "www.example.com" }, { "name": "TemplateId", "type": "string", "required": false, "description": "指定策略模板 ID。当 Entity 参数值为 Template 时，使用本参数指定策略模板的 ID。", "example": "temp-wj86oi2" } ], "required": [ "ZoneId", "SecurityConfig" ] }, { "name": "ModifyWebSecurityTemplate", "description": "修改安全策略配置模板", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。需要传入目标策略模板在访问权限上归属的站点，可使用 DescribeWebSecurityTemplates 接口查询策略模板归属的站点。", "example": "zone-2wkpkd52kac5" }, { "name": "TemplateId", "type": "string", "required": true, "description": "策略模板 ID。", "example": "temp-8pw98uer" }, { "name": "TemplateName", "type": "string", "required": false, "description": "修改后的策略模板名称。由中文、英文、数字和下划线组成，不能以下划线开头，且长度不能超过32个字符。字段为空时则不修改。", "example": "CC防护标准模板V2" }, { "name": "SecurityPolicy", "type": "object", "required": false, "description": "安全策略模板配置内容。值为空时不修改；没有传入的子模块结构不会被修改。目前支持 Web 防护模块中的例外规则、自定义规则、速率限制规则和托管规则配置，通过表达式语法对安全策略进行配置。 Bot 管理规则配置暂不支持，正在开发中。 特别说明：当入参某个子模块结构时，请确保携带所有需要保留的规则内容，未传入规则内容视为删除。", "example": "无", "children": [ { "name": "CustomRules", "type": "object", "required": false, "description": "自定义规则配置。", "example": "无", "children": [ { "name": "Rules", "type": "array", "required": false, "description": "自定义规则的定义列表。使用 ModifySecurityPolicy 修改 Web 防护配置时: - 若未指定 Rules 参数，或 Rules 参数长度为零：清空所有自定义规则配置。 - 若 SecurityPolicy 参数中，未指定 CustomRules 参数值：保持已有自定义规则配置，不做修改。", "example": "参考 CustomRule 结构", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "自定义规则的名称。", "example": "SampleBasicACLRule" }, { "name": "Condition", "type": "string", "required": true, "description": "自定义规则的具体内容，需符合表达式语法，详细规范参见产品文档。", "example": "${http.request.ip} in ['1.1.1.1', '10.10.10.0/24', ${security.ip_group['123'@'zone-2xsnpvkhdjes']} ]" }, { "name": "Action", "type": "object", "required": true, "description": "自定义规则的执行动作。 SecurityAction 的 Name 取值支持：Deny：拦截；Monitor：观察；ReturnCustomPage：使用指定页面拦截；Redirect：重定向至 URL；BlockIP：IP 封禁；JSChallenge：JavaScript 挑战；ManagedChallenge：托管挑战；Allow：放行。", "example": "参考SecurityAction结构" }, { "name": "Enabled", "type": "string", "required": true, "description": "自定义规则是否开启。取值有：on：开启off：关闭", "example": "on" }, { "name": "Id", "type": "string", "required": false, "description": "自定义规则的 ID。通过规则 ID 可支持不同的规则配置操作： - 增加新规则：ID 为空或不指定 ID 参数； - 修改已有规则：指定需要更新/修改的规则 ID； - 删除已有规则：CustomRules 参数中，Rules 列表中未包含的已有规则将被删除。", "example": "1492837231" }, { "name": "RuleType", "type": "string", "required": false, "description": "自定义规则的类型。取值有：BasicAccessRule：基础访问管控；PreciseMatchRule：精准匹配规则，默认；ManagedAccessRule：专家定制规则，仅出参。默认为PreciseMatchRule。", "example": "PreciseMatchRule" }, { "name": "Priority", "type": "integer", "required": false, "description": "自定义规则的优先级，范围是 0 ~ 100，默认为 0，仅支持精准匹配规则（PreciseMatchRule）。", "example": "10" } ] } ] }, { "name": "ManagedRules", "type": "object", "required": false, "description": "托管规则配置。", "example": "无", "children": [ { "name": "Enabled", "type": "string", "required": true, "description": "托管规则是否开启。取值有：on：开启，所有托管规则按配置生效；off：关闭，所有托管规则不生效。", "example": "on" }, { "name": "DetectionOnly", "type": "string", "required": true, "description": "评估模式是否开启，仅在 Enabled 参数为 on 时有效。取值有：on：开启，表示所有托管规则以观察模式生效；off：关闭，表示所有托管规则以实际配置生效。", "example": "on" }, { "name": "SemanticAnalysis", "type": "string", "required": false, "description": "托管规则语义分析选项是否开启，仅在 Enabled 参数为 on 时有效。取值有：on：开启，对请求进行语义分析后进行处理；off：关闭，对请求不进行语义分析，直接进行处理。 默认为 off。", "example": "on" }, { "name": "AutoUpdate", "type": "object", "required": false, "description": "托管规则自动更新选项。", "example": "无", "children": [ { "name": "AutoUpdateToLatestVersion", "type": "string", "required": true, "description": "是否开启自动更新至最新版本。取值有：on：开启off：关闭", "example": "on" }, { "name": "RulesetVersion", "type": "string", "required": false, "description": "当前使用的版本，格式符合ISO 8601标准，如2023-12-21T12:00:32Z，默认为空，仅出参。", "example": "2023-12-21T12:00:32Z" } ] }, { "name": "ManagedRuleGroups", "type": "array", "required": false, "description": "托管规则组的配置。如果此结构传空数组或 GroupId 未包含在列表内将按照默认方式处理。", "example": "无", "item_type": "object", "children": [ { "name": "GroupId", "type": "string", "required": true, "description": "托管规则的组名称，未指定配置的规则分组将按照默认配置处理，GroupId 的具体取值参考产品文档。", "example": "wafmanagedrulegroup-file-upload-attacks" }, { "name": "SensitivityLevel", "type": "string", "required": true, "description": "托管规则组的防护级别。取值有：loose：宽松，只包含超高风险规则，此时需配置Action，且RuleActions配置无效；normal：正常，包含超高风险和高风险规则，此时需配置Action，且RuleActions配置无效；strict：严格，包含超高风险、高风险和中风险规则，此时需配置Action，且RuleActions配置无效；extreme：超严格，包含超高风险、高风险、中风险和低风险规则，此时需配置Action，且RuleActions...", "example": "loose" }, { "name": "Action", "type": "object", "required": true, "description": "托管规则组的处置动作。SecurityAction 的 Name 取值支持：Deny：拦截，响应拦截页面；Monitor：观察，不处理请求记录安全事件到日志中；Disabled：未启用，不扫描请求跳过该规则。", "example": "参考 SecurityAction 结构。" }, { "name": "RuleActions", "type": "array", "required": false, "description": "托管规则组下规则项的具体配置，仅在 SensitivityLevel 为 custom 时配置生效。", "example": "参考 ManagedRuleAction 结构。", "item_type": "string" }, { "name": "MetaData", "type": "object", "required": false, "description": "托管规则组信息，仅出参。", "example": "参考 ManagedRuleGroupMeta 结构。" } ] }, { "name": "FrequentScanningProtection", "type": "object", "required": false, "description": "高频扫描防护配置选项，当某一访客的请求频繁命中「配置为拦截」的托管规则时，在一段时间内封禁该访客所有请求。", "example": "无", "children": [ { "name": "Enabled", "type": "string", "required": false, "description": "高频扫描防护规则是否开启。取值有：on：开启，高频扫描防护规则生效；off：关闭，高频扫描防护规则不生效。", "example": "on" }, { "name": "Action", "type": "object", "required": false, "description": "高频扫描防护的处置动作。 当 Enabled 为 on 时，此字段必填。SecurityAction 的 Name 取值支持：Deny：拦截，响应拦截页面；Monitor：观察，不处理请求记录安全事件到日志中；JSChallenge：JavaScript 挑战，响应 JavaScript 挑战页面。", "example": "无" }, { "name": "CountBy", "type": "string", "required": false, "description": "请求统计的匹配方式，当 Enabled 为 on 时，此字段必填。取值有：http.request.xff_header_ip：客户端 IP（优先匹配 XFF 头部）；http.request.ip：客户端 IP。", "example": "http.request.ip" }, { "name": "BlockThreshold", "type": "integer", "required": false, "description": "此参数指定高频扫描防护的阈值，即在 CountingPeriod 所设置时间范围内命中「配置为拦截」的托管规则时的累计拦截次数，取值范围 1 ~ 4294967294，例如 100，当超过此统计值时，后续请求将触发 Action 所设置的处置动作。当 Enabled 为 on 时，此字段必填。", "example": "100" }, { "name": "CountingPeriod", "type": "string", "required": false, "description": "此参数指定高频扫描防护所统计的时间窗口，即命中「配置为拦截」的托管规则的请求的统计时间窗口，取值 5 ~ 1800，单位仅支持秒（s），例如 5s。 当 Enabled 为 on 时，此字段必填。", "example": "10s" }, { "name": "ActionDuration", "type": "string", "required": false, "description": "此参数指定高频扫描防护 Action 参数所设置处置动作的持续时长，取值范围 60 ~ 86400，单位仅支持秒（s），例如 60s。当 Enabled 为 on 时，此字段必填。", "example": "60s" } ] } ] }, { "name": "HttpDDoSProtection", "type": "object", "required": false, "description": "HTTP DDOS 防护配置。", "example": "无", "children": [ { "name": "AdaptiveFrequencyControl", "type": "object", "required": false, "description": "自适应频控的具体配置。", "example": "无", "children": [ { "name": "Enabled", "type": "string", "required": true, "description": "自适应频控是否开启。取值有：on：开启；off：关闭。", "example": "on" }, { "name": "Sensitivity", "type": "string", "required": false, "description": "自适应频控的限制等级，当 Enabled 为 on 时，此字段必填。取值有：Loose：宽松；Moderate：适中；Strict：严格。", "example": "Loose" }, { "name": "Action", "type": "object", "required": false, "description": "自适应频控的处置方式，当 Enabled 为 on 时，此字段必填。SecurityAction 的 Name 取值支持：Monitor：观察；Deny：拦截；Challenge：挑战，其中ChallengeActionParameters.Name仅支持JSChallenge。", "example": "无" } ] }, { "name": "ClientFiltering", "type": "object", "required": false, "description": "智能客户端过滤的具体配置。", "example": "无", "children": [ { "name": "Enabled", "type": "string", "required": true, "description": "智能客户端过滤是否开启。取值有：on：开启；off：关闭。", "example": "on" }, { "name": "Action", "type": "object", "required": false, "description": "智能客户端过滤的处置方式，当 Enabled 为 on 时，此字段必填。SecurityAction 的 Name 取值支持：Monitor：观察；Deny：拦截；Challenge：挑战，其中ChallengeActionParameters.Name仅支持JSChallenge。", "example": "无" } ] }, { "name": "BandwidthAbuseDefense", "type": "object", "required": false, "description": "流量防盗刷的具体配置。", "example": "无", "children": [ { "name": "Enabled", "type": "string", "required": true, "description": "流量防盗刷（仅适用中国大陆地区）是否开启。取值有：on：开启；off：关闭。", "example": "on" }, { "name": "Action", "type": "object", "required": false, "description": "流量防盗刷（仅适用中国大陆地区）的处置方式，当 Enabled 为 on 时，此字段必填。SecurityAction 的 Name 取值支持：Monitor：观察；Deny：拦截；Challenge：挑战，其中ChallengeActionParameters.Name仅支持JSChallenge。", "example": "参考 SecurityAction 结构" } ] }, { "name": "SlowAttackDefense", "type": "object", "required": false, "description": "慢速攻击防护的具体配置。", "example": "无", "children": [ { "name": "Enabled", "type": "string", "required": true, "description": "慢速攻击防护是否开启。取值有：on：开启；off：关闭。", "example": "on" }, { "name": "Action", "type": "object", "required": false, "description": "慢速攻击防护的处置方式，当 Enabled 为 on 时，此字段必填。SecurityAction 的 Name 取值支持：Monitor：观察；Deny：拦截；", "example": "无" }, { "name": "MinimalRequestBodyTransferRate", "type": "object", "required": false, "description": "正文传输最小速率阈值的具体配置，当 Enabled 为 on 时，此字段必填。", "example": "无" }, { "name": "RequestBodyTransferTimeout", "type": "object", "required": false, "description": "正文传输超时时长的具体配置，当 Enabled 为 on 时，此字段必填。", "example": "无" } ] } ] }, { "name": "RateLimitingRules", "type": "object", "required": false, "description": "速率限制规则配置。", "example": "无", "children": [ { "name": "Rules", "type": "array", "required": false, "description": "精准速率限制的定义列表。使用 ModifySecurityPolicy 修改 Web 防护配置时: 若未指定 Rules 参数，或 Rules 参数长度为零：清空所有精准速率限制配置。 若 SecurityPolicy 参数中，未指定 RateLimitingRules 参数值：保持已有自定义规则配置，不做修改。", "example": "无", "item_type": "object", "children": [ { "name": "Id", "type": "string", "required": false, "description": "精准速率限制的 ID。通过规则 ID 可支持不同的规则配置操作： 增加新规则：ID 为空或不指定 ID 参数；修改已有规则：指定需要更新/修改的规则 ID；删除已有规则：RateLimitingRules 参数中，Rules 列表中未包含的已有规则将被删除。", "example": "2181399690" }, { "name": "Name", "type": "string", "required": false, "description": "精准速率限制的名称。", "example": "SampleHttpDdosRule" }, { "name": "Condition", "type": "string", "required": false, "description": "精准速率限制的具体内容，需符合表达式语法，详细规范参见[产品文档](https://cloud.tencent.com/document/product/1552/125343)。", "example": "${http.request.uri.path} in ['/api/v3/test','/api/v3/submit']" }, { "name": "CountBy", "type": "array", "required": false, "description": "速率阈值请求特征的匹配方式， 当 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-ag...", "example": "http.request.ip", "item_type": "string" }, { "name": "MaxRequestThreshold", "type": "integer", "required": false, "description": "精准速率限制在时间范围内的累计拦截次数，取值范围 1 ~ 100000。", "example": "100" }, { "name": "CountingPeriod", "type": "string", "required": false, "description": "统计的时间窗口，取值有：1s：1秒；5s：5秒；10s：10秒；20s：20秒；30s：30秒；40s：40秒；50s：50秒；1m：1分钟；2m：2分钟；5m：5分钟；10m：10分钟；1h：1小时。", "example": "10s" }, { "name": "ActionDuration", "type": "string", "required": false, "description": "Action 动作的持续时长，单位仅支持：s：秒，取值 1 ~ 120；m：分钟，取值 1 ~ 120；h：小时，取值 1 ~ 48；d：天，取值 1 ~ 30。", "example": "60s" }, { "name": "Action", "type": "object", "required": false, "description": "精准速率限制的处置方式。取值有：Monitor：观察；Deny：拦截，其中DenyActionParameters.Name支持Deny和ReturnCustomPage；Challenge：挑战，其中ChallengeActionParameters.Name支持JSChallenge和ManagedChallenge；Redirect：重定向至URL；", "example": "无" }, { "name": "Priority", "type": "integer", "required": false, "description": "精准速率限制的优先级，范围是 0 ~ 100，默认为 0。", "example": "50" }, { "name": "Enabled", "type": "string", "required": false, "description": "精准速率限制规则是否开启。取值有：on：开启；off：关闭。", "example": "on" } ] } ] }, { "name": "ExceptionRules", "type": "object", "required": false, "description": "例外规则配置。", "example": "无", "children": [ { "name": "Rules", "type": "array", "required": false, "description": "例外规则的定义列表。使用 ModifySecurityPolicy 修改 Web 防护配置时: 若未指定 Rules 参数，或 Rules 参数长度为零：清空所有例外规则配置。若 SecurityPolicy 参数中，未指定 ExceptionRules 参数值：保持已有例外规则配置，不做修改。", "example": "参考 ExceptionRule 结构", "item_type": "object", "children": [ { "name": "Id", "type": "string", "required": false, "description": "例外规则的 ID。通过规则 ID 可支持不同的规则配置操作： 增加新规则：ID 为空或不指定 ID 参数； 修改已有规则：指定需要更新/修改的规则 ID； 删除已有规则：ExceptionRules 参数中，Rules 列表中未包含的已有规则将被删除。", "example": "2181399686" }, { "name": "Name", "type": "string", "required": false, "description": "例外规则的名称。", "example": "SampleBasicExceptionRule" }, { "name": "Condition", "type": "string", "required": false, "description": "例外规则的具体内容，需符合表达式语法，详细规范参见产品文档。", "example": "${http.request.uri.path} in ['/api/v3/test','/api/v3/submit'] and ${http.request.method} in ['POST']" }, { "name": "SkipScope", "type": "string", "required": false, "description": "例外规则执行选项，取值有：WebSecurityModules: 指定例外规则的安全防护模块。ManagedRules：指定托管规则。", "example": "WebSecurityModules" }, { "name": "SkipOption", "type": "string", "required": false, "description": "跳过请求的具体类型，取值有：SkipOnAllRequestFields: 跳过所有请求；SkipOnSpecifiedRequestFields: 跳过指定请求字段。仅当 SkipScope 为 ManagedRules 时有效。", "example": "SkipOnSpecifiedRequestFields" }, { "name": "WebSecurityModulesForException", "type": "array", "required": false, "description": "指定例外规则的安全防护模块，仅当 SkipScope 为 WebSecurityModules 时有效。取值有：websec-mod-managed-rules：托管规则；websec-mod-rate-limiting：速率限制；websec-mod-custom-rules：自定义规则；websec-mod-adaptive-control：自适应频控、智能客户端过滤、慢速攻击防护、流量盗刷防护；websec-mod-bot：Bot管理。", "example": "[\"websec-mod-custom-rules\",\"websec-mod-rate-limiting\"]", "item_type": "string" }, { "name": "ManagedRulesForException", "type": "array", "required": false, "description": "指定例外规则的具体托管规则，仅当 SkipScope 为 ManagedRules 时有效，且此时不能指定 ManagedRuleGroupsForException 。", "example": "[\"4401215074\",\"4368124487\"]", "item_type": "string" }, { "name": "ManagedRuleGroupsForException", "type": "array", "required": false, "description": "指定例外规则的托管规则组，仅当 SkipScope 为 ManagedRules 时有效，且此时不能指定 ManagedRulesForException 。", "example": "[\"wafgroup-sql-injection-attacks\"]", "item_type": "string" }, { "name": "RequestFieldsForException", "type": "array", "required": false, "description": "指定例外规则跳过指定请求字段的具体配置，仅当 SkipScope 为 ManagedRules 并且 SkipOption 为 SkipOnSpecifiedRequestFields 时有效。", "example": "参考 RequestFieldsForException 结构", "item_type": "string" }, { "name": "Enabled", "type": "string", "required": false, "description": "例外规则是否开启。取值有：on：开启off：关闭", "example": "on" } ] } ] }, { "name": "BotManagement", "type": "object", "required": false, "description": "Bot 管理配置。", "example": "无", "children": [ { "name": "Enabled", "type": "string", "required": false, "description": "Bot 管理是否开启。取值有：on：开启；off：关闭。", "example": "on" }, { "name": "CustomRules", "type": "object", "required": false, "description": "Bot 管理的自定义规则，组合各类爬虫和请求行为特征，精准定义 Bot 并配置定制化处置方式。", "example": "无", "children": [ { "name": "Rules", "type": "array", "required": false, "description": "Bot 自定义规则的列表。使用 ModifySecurityPolicy 修改 Web 防护配置时： 若未指定 SecurityPolicy.BotManagement.CustomRules 中的 Rules 参数，或 Rules 参数长度为零：清空所有 Bot 自定义规则配置。 若 SecurityPolicy.BotManagement 参数中，未指定 CustomRules 参数值：保持已有 Bot 自定义规则配置，不做修改。", "example": "无", "item_type": "string" } ] }, { "name": "BasicBotSettings", "type": "object", "required": false, "description": "Bot 管理的基础配置，对策略关联的所有域名生效。可以通过 CustomRules 进行精细化定制。", "example": "无", "children": [ { "name": "SourceIDC", "type": "object", "required": false, "description": "客户端 IP 的来源 IDC 配置，用于处置来自 IDC（数据中心） 的客户端 IP 的访问请求。此类来源请求不是由移动端或浏览器端直接访问。", "example": "无" }, { "name": "SearchEngineBots", "type": "object", "required": false, "description": "搜索引擎爬虫配置，用于处置来自搜索引擎爬虫的请求。此类请求的 IP、User-Agent 或 rDNS 结果匹配已知搜索引擎爬虫。", "example": "无" }, { "name": "KnownBotCategories", "type": "object", "required": false, "description": "商业或开源工具 UA 特征配置（原 UA 特征规则），用于处置来自已知商业工具或开源工具的访问请求。此类请求的 User-Agent 头部符合已知商业或开源工具特征。", "example": "无" }, { "name": "IPReputation", "type": "object", "required": false, "description": "IP 威胁情报库（原客户端画像分析）配置，用于处置近期访问行为具有特定风险特征的客户端 IP。", "example": "无" }, { "name": "BotIntelligence", "type": "object", "required": false, "description": "Bot 智能分析的具体配置。", "example": "无" } ] }, { "name": "ClientAttestationRules", "type": "object", "required": false, "description": "客户端认证规则的定义列表。该功能内测中，如需使用，请提工单。", "example": "无", "children": [ { "name": "Rules", "type": "array", "required": false, "description": "客户端认证的列表。使用 ModifySecurityPolicy 修改 Web 防护配置时： 若未指定 SecurityPolicy.BotManagement.ClientAttestationRules 中的 Rules 参数，或 Rules 参数长度为零：清空所有客户端认证规则配置。 若 SecurityPolicy.BotManagement 参数中，未指定 ClientAttestationRules 参数值：保持已有客户端认证规则配置，不做修改。", "example": "无", "item_type": "string" } ] }, { "name": "BrowserImpersonationDetection", "type": "object", "required": false, "description": "配置浏览器伪造识别规则（原主动特征识别规则）。设置注入 JavaScript 的响应页面范围，浏览器校验选项，以及对非浏览器客户端的处置方式。", "example": "无", "children": [ { "name": "Rules", "type": "array", "required": false, "description": "浏览器伪造识别规则的列表。使用 ModifySecurityPolicy 修改 Web 防护配置时： 若未指定 SecurityPolicy.BotManagement.BrowserImpersonationDetection 中的 Rules 参数，或 Rules 参数长度为零： 清空所有浏览器伪造识别规则配置。 若 SecurityPolicy.BotManagement 参数中，未指定 BrowserImpersonationDetection 参数值： 保持已有浏览器伪造识别规则配置，不做修改。", "example": "无", "item_type": "string" } ] } ] }, { "name": "BotManagementLite", "type": "object", "required": false, "description": "基础 Bot 管理配置。", "example": "无", "children": [ { "name": "CAPTCHAPageChallenge", "type": "object", "required": false, "description": "人机校验页的具体配置。", "example": "无", "children": [ { "name": "Enabled", "type": "string", "required": false, "description": "人机校验页是否开启，取值有：on：开启；off：关闭。", "example": "on" } ] }, { "name": "AICrawlerDetection", "type": "object", "required": false, "description": "AI爬虫检测的具体配置。", "example": "无", "children": [ { "name": "Enabled", "type": "string", "required": false, "description": "AI 爬虫检测是否开启。取值有： on：开启； off：关闭。", "example": "on" }, { "name": "Action", "type": "object", "required": false, "description": "AI 爬虫检测的执行动作，当 Enabled 为 on 时，此字段必填。SecurityAction 的 Name 取值仅支持： Deny：拦截； Monitor：观察； Allow：放行； Challenge：挑战，其中 ChallengeActionParameters 中的 ChallengeOption 仅支持 JSChallenge 和 ManagedChallenge。", "example": "无" } ] } ] } ] } ], "required": [ "ZoneId", "TemplateId" ] }, { "name": "ModifyZone", "description": "修改站点信息。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-xxxxx" }, { "name": "Type", "type": "string", "required": false, "description": "站点接入方式，取值有： full：NS 接入； partial：CNAME 接入，如果站点当前是无域名接入，仅支持切换到 CNAME 接入； dnsPodAccess：DNSPod 托管接入，该接入模式要求您的域名已托管在 DNSPod 内。不填写保持原有配置。", "example": "partial" }, { "name": "VanityNameServers", "type": "object", "required": false, "description": "自定义站点信息，以替代系统默认分配的名称服务器。不填写保持原有配置。当站点是无域名接入方式时不允许传此参数。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "自定义 ns 开关，取值有： on：开启； off：关闭。", "example": "on" }, { "name": "Servers", "type": "array", "required": false, "description": "自定义 ns 列表。", "example": "[\"ns1.test.com\",\"ns2.test.com\"]", "item_type": "string" } ] }, { "name": "AliasZoneName", "type": "string", "required": false, "description": "同名站点标识。限制输入数字、英文、\".\" 、\"-\" 和 \"_\"，长度 200 个字符以内。", "example": "zone-example" }, { "name": "Area", "type": "string", "required": false, "description": "站点接入地域，取值有： global：全球； mainland：中国大陆； overseas：境外区域。当站点是无域名接入方式时，不允许传此参数。", "example": "global" }, { "name": "ZoneName", "type": "string", "required": false, "description": "站点名称。仅当站点由无域名接入方式切换到CNAME接入方式的场景下有效。", "example": "test.com" } ], "required": [ "ZoneId" ] }, { "name": "ModifyZoneSetting", "description": "本接口为旧版，EdgeOne 已对规则引擎相关接口全面升级，详情请参考 [ModifyL7AccSetting](https://cloud.tencent.com/document/product/1552/115817)。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "待变更的站点 ID。", "example": "zone-21xfqlh4qjee" }, { "name": "CacheConfig", "type": "object", "required": false, "description": "缓存过期时间配置。 不填写表示保持原有配置。", "example": "无", "children": [ { "name": "Cache", "type": "object", "required": false, "description": "缓存配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "缓存配置开关，取值有： on：开启； off：关闭。", "example": "on/off" }, { "name": "CacheTime", "type": "integer", "required": false, "description": "缓存过期时间设置。 单位为秒，最大可设置为 365 天。", "example": "36000" } ] }, { "name": "NoCache", "type": "object", "required": false, "description": "不缓存配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "不缓存配置开关，取值有： on：开启； off：关闭。", "example": "on/off" } ] }, { "name": "FollowOrigin", "type": "object", "required": false, "description": "遵循源站配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "遵循源站配置开关，取值有： on：开启； off：关闭。", "example": "on" }, { "name": "DefaultCache", "type": "string", "required": false, "description": "源站未返回 Cache-Control 头时，缓存/不缓存开关。当 Switch 为 on 时，此字段必填，当 Switch 为 off 时，无需填写此字段，若填写则不生效。取值有： on：缓存； off：不缓存。", "example": "on" }, { "name": "DefaultCacheStrategy", "type": "string", "required": false, "description": "源站未返回 Cache-Control 头时，使用/不使用默认缓存策略开关。当 DefaultCache 为 on 时，此字段必填，否则此字段不生效；当 DefaultCacheTime 不为 0 时，此字段必须为 off。取值有： on：使用默认缓存策略； off：不使用默认缓存策略。", "example": "on" }, { "name": "DefaultCacheTime", "type": "integer", "required": false, "description": "源站未返回 Cache-Control 头时，表示默认的缓存时间，单位为秒，取值：0-315360000。当 DefaultCache 为 on 时，此字段必填，否则此字段不生效；当 DefaultCacheStrategy 为 on 时， 此字段必须为 0。", "example": "0" } ] } ] }, { "name": "CacheKey", "type": "object", "required": false, "description": "节点缓存键配置。 不填写表示保持原有配置。", "example": "无", "children": [ { "name": "FullUrlCache", "type": "string", "required": false, "description": "是否开启全路径缓存，取值有： on：开启全路径缓存（即关闭参数忽略）； off：关闭全路径缓存（即开启参数忽略）。", "example": "on/off" }, { "name": "IgnoreCase", "type": "string", "required": false, "description": "是否忽略大小写缓存，取值有： on：忽略； off：不忽略。", "example": "on/off" }, { "name": "QueryString", "type": "object", "required": false, "description": "CacheKey 中包含请求参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "CacheKey是否由QueryString组成，取值有： on：是； off：否。", "example": "on/off" }, { "name": "Action", "type": "string", "required": false, "description": "CacheKey使用QueryString的方式，取值有： includeCustom：使用部分url参数； excludeCustom：排除部分url参数。", "example": "includeCustom" }, { "name": "Value", "type": "array", "required": false, "description": "使用/排除的url参数数组。", "example": "key1;key2", "item_type": "string" } ] } ] }, { "name": "MaxAge", "type": "object", "required": false, "description": "浏览器缓存配置。 不填写表示保持原有配置。", "example": "无", "children": [ { "name": "FollowOrigin", "type": "string", "required": false, "description": "是否遵循源站，取值有： on：遵循源站，忽略MaxAge 时间设置； off：不遵循源站，使用MaxAge 时间设置。", "example": "on/off" }, { "name": "MaxAgeTime", "type": "integer", "required": false, "description": "MaxAge 时间设置，单位为秒，取值：0～315360000。 注意：时间为0，即不缓存。", "example": "600" } ] }, { "name": "OfflineCache", "type": "object", "required": false, "description": "离线缓存配置。 不填写表示保持原有配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "离线缓存是否开启，取值有： on：开启； off：关闭。", "example": "on/off" } ] }, { "name": "Quic", "type": "object", "required": false, "description": "Quic 访问配置。 不填写表示保持原有配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "是否开启 Quic 配置，取值有： on：开启； off：关闭。", "example": "on/off" } ] }, { "name": "PostMaxSize", "type": "object", "required": false, "description": "Post 请求传输配置。 不填写表示保持原有配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "是否开启 POST 请求上传文件限制，平台默认为限制为32MB，取值有： on：开启限制； off：关闭限制。", "example": "on/off" }, { "name": "MaxSize", "type": "integer", "required": false, "description": "最大限制，该字段仅在 Switch 为 on 时生效，取值在 1MB 和 800MB 之间，单位字节。", "example": "10000000" } ] }, { "name": "Compression", "type": "object", "required": false, "description": "智能压缩配置。 不填写表示保持原有配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "智能压缩配置开关，取值有： on：开启； off：关闭。", "example": "on/off" }, { "name": "Algorithms", "type": "array", "required": false, "description": "支持的压缩算法列表，取值有： brotli：brotli算法； gzip：gzip算法。", "example": "[\"brotli\",\"gzip\"]", "item_type": "string" } ] }, { "name": "UpstreamHttp2", "type": "object", "required": false, "description": "Http2 回源配置。 不填写表示保持原有配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "http2 回源配置开关，取值有： on：开启； off：关闭。", "example": "on/off" } ] }, { "name": "ForceRedirect", "type": "object", "required": false, "description": "访问协议强制 Https 跳转配置。 不填写表示保持原有配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "访问强制跳转配置开关，取值有： on：开启； off：关闭。", "example": "on/off" }, { "name": "RedirectStatusCode", "type": "integer", "required": false, "description": "重定向状态码，取值有： 301：301跳转； 302：302跳转。", "example": "302" } ] }, { "name": "Https", "type": "object", "required": false, "description": "Https 加速配置。 不填写表示保持原有配置。", "example": "无", "children": [ { "name": "Http2", "type": "string", "required": false, "description": "http2 配置开关，取值有： on：开启； off：关闭。", "example": "on/off" }, { "name": "OcspStapling", "type": "string", "required": false, "description": "OCSP 配置开关，取值有： on：开启； off：关闭。", "example": "on/off" }, { "name": "TlsVersion", "type": "array", "required": false, "description": "Tls 版本设置，取值有： TLSv1：TLSv1版本； TLSv1.1：TLSv1.1版本； TLSv1.2：TLSv1.2版本； TLSv1.3：TLSv1.3版本。修改时必须开启连续的版本。", "example": "[\"TLSv1\", \"TLSv1.1\"]", "item_type": "string" }, { "name": "Hsts", "type": "object", "required": false, "description": "HSTS 配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "是否开启，取值有： on：开启； off：关闭。", "example": "on/off" }, { "name": "MaxAge", "type": "integer", "required": false, "description": "MaxAge 数值。单位为秒，最大值为1天。", "example": "600" }, { "name": "IncludeSubDomains", "type": "string", "required": false, "description": "是否包含子域名，取值有： on：开启； off：关闭。", "example": "on/off" }, { "name": "Preload", "type": "string", "required": false, "description": "是否开启预加载，取值有： on：开启； off：关闭。", "example": "on/off" } ] }, { "name": "CertInfo", "type": "array", "required": false, "description": "证书配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "CertId", "type": "string", "required": true, "description": "服务器证书 ID。来源于 SSL 侧，您可以前往 [SSL 证书列表](https://console.cloud.tencent.com/ssl) 查看 CertId。", "example": "EO-dsfdsf" }, { "name": "Alias", "type": "string", "required": false, "description": "证书备注名。", "example": "默认证书" }, { "name": "Type", "type": "string", "required": false, "description": "证书类型，取值有： default：默认证书； upload：用户上传； managed：腾讯云托管。", "example": "default" }, { "name": "ExpireTime", "type": "string", "required": false, "description": "证书过期时间。", "example": "2014-08-03T12:00:00+08:00" }, { "name": "DeployTime", "type": "string", "required": false, "description": "证书部署时间。", "example": "2014-08-03T12:00:00+08:00" }, { "name": "SignAlgo", "type": "string", "required": false, "description": "签名算法。", "example": "RSA" }, { "name": "CommonName", "type": "string", "required": false, "description": "证书归属域名名称。", "example": "tencent.cloud" } ] }, { "name": "ApplyType", "type": "string", "required": false, "description": "申请类型，取值有： apply：托管EdgeOne； none：不托管EdgeOne。不填，默认取值为none。", "example": "none" }, { "name": "CipherSuite", "type": "string", "required": false, "description": "密码套件，取值有： loose-v2023：提供高兼容性，安全性一般，支持 TLS 1.0-1.3 密码套件； general-v2023：提供较高兼容性，安全性中等，支持 TLS 1.2-1.3 密码套件； strict-v2023：提供高安全性能，禁用所有含不安全隐患的加密套件，支持 TLS 1.2-1.3 密码套件。", "example": "loose-v2023" } ] }, { "name": "Origin", "type": "object", "required": false, "description": "源站配置。 不填写表示保持原有配置。", "example": "无", "children": [ { "name": "Origins", "type": "array", "required": false, "description": "主源站列表。", "example": "[\"1.1.1.1\"]", "item_type": "string" }, { "name": "BackupOrigins", "type": "array", "required": false, "description": "备源站列表。", "example": "[\"2.2.2.2\"]", "item_type": "string" }, { "name": "OriginPullProtocol", "type": "string", "required": false, "description": "回源协议配置，取值有： http：强制 http 回源； follow：协议跟随回源； https：强制 https 回源。", "example": "https" }, { "name": "CosPrivateAccess", "type": "string", "required": false, "description": "源站为腾讯云 COS 时，是否为私有访问 bucket，取值有： on：私有访问； off：公共访问。", "example": "off" } ] }, { "name": "SmartRouting", "type": "object", "required": false, "description": "智能加速配置。 不填写表示保持原有配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "智能加速配置开关，取值有： on：开启； off：关闭。", "example": "on/off" } ] }, { "name": "WebSocket", "type": "object", "required": false, "description": "WebSocket 配置。 不填写表示保持原有配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "WebSocket 超时时间配置开关，取值有： on：使用Timeout作为WebSocket超时时间； off：平台仍支持WebSocket连接，此时使用系统默认的15秒为超时时间。", "example": "off" }, { "name": "Timeout", "type": "integer", "required": false, "description": "超时时间，单位为秒，最大超时时间120秒。", "example": "10" } ] }, { "name": "ClientIpHeader", "type": "object", "required": false, "description": "客户端 IP 回源请求头配置。 不填写表示保持原有配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "配置开关，取值有： on：开启； off：关闭。", "example": "on/off" }, { "name": "HeaderName", "type": "string", "required": false, "description": "回源时，存放客户端 IP 的请求头名称。当 Switch 为 on 时，该参数必填。该参数不允许填写 X-Forwarded-For。", "example": "X-ClientIp" } ] }, { "name": "CachePrefresh", "type": "object", "required": false, "description": "缓存预刷新配置。 不填写表示保持原有配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "缓存预刷新配置开关，取值有： on：开启； off：关闭。", "example": "on/off" }, { "name": "Percent", "type": "integer", "required": false, "description": "缓存预刷新百分比，取值范围：1-99。", "example": "10" } ] }, { "name": "Ipv6", "type": "object", "required": false, "description": "Ipv6 访问配置。 不填写表示保持原有配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "Ipv6 访问功能配置，取值有： on：开启Ipv6访问功能； off：关闭Ipv6访问功能。", "example": "on" } ] }, { "name": "ClientIpCountry", "type": "object", "required": false, "description": "回源时是否携带客户端 IP 所属地域信息的配置。 不填写表示保持原有配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "配置开关，取值有： on：开启； off：关闭。", "example": "on" }, { "name": "HeaderName", "type": "string", "required": false, "description": "存放客户端 IP 所属地域信息的请求头名称，当 Switch=on 时有效。 为空则使用默认值：EO-Client-IPCountry。", "example": "EO-Client-IPCountry" } ] }, { "name": "Grpc", "type": "object", "required": false, "description": "Grpc 协议支持配置。 不填写表示保持原有配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "是否开启 Grpc 配置，取值有： on：开启； off：关闭。", "example": "on" } ] }, { "name": "NetworkErrorLogging", "type": "object", "required": false, "description": "网络错误日志记录配置。不填写表示保持原有配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "是否开启网络错误日志记录配置，取值有： on：开启； off：关闭。", "example": "on" } ] }, { "name": "ImageOptimize", "type": "object", "required": false, "description": "图片优化配置。 不填写表示关闭。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "开关，取值有： on：开启； off：关闭。", "example": "on" } ] }, { "name": "StandardDebug", "type": "object", "required": false, "description": "标准 Debug 配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "Debug 功能开关，取值有： on：开启； off：关闭。", "example": "on" }, { "name": "AllowClientIPList", "type": "array", "required": true, "description": "允许的客户端来源。支持填写 IPv4 以及 IPv6 的 IP/IP 段。0.0.0.0/0 表示允许所有 IPv4 客户端进行调试，::/0 表示允许所有 IPv6 客户端进行调试。", "example": "[\"9.142.236.194\", \"43.154.226.0/24\"]", "item_type": "string" }, { "name": "ExpireTime", "type": "string", "required": true, "description": "Debug 功能到期时间。超出设置的时间，则功能失效。", "example": "2023-06-30T17:37:56+0800" } ] }, { "name": "JITVideoProcess", "type": "object", "required": false, "description": "视频即时处理配置。不填写表示保持原有配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "视频即时处理配置开关，取值有： on：开启； off：关闭。", "example": "on" } ] } ], "required": [ "ZoneId" ] }, { "name": "ModifyZoneStatus", "description": "用于开启，关闭站点。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-xxxx" }, { "name": "Paused", "type": "boolean", "required": true, "description": "站点状态，取值有： false：开启站点； true：关闭站点。", "example": "false" } ], "required": [ "ZoneId", "Paused" ] }, { "name": "ModifyZoneWorkMode", "description": "本接口用于修改站点下各配置模块的工作模式。站点各配置模块可按照配置组维度开启「版本管理模式」或「即时生效模式」，详情请参考 [版本管理](https://cloud.tencent.com/document/product/1552/113690)。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-27********v1" }, { "name": "WorkModeInfos", "type": "array", "required": false, "description": "版本管理配置组工作模式。站点各配置模块可按照配置组维度开启「版本管理模式」或「即时生效模式」，详情请参考 [版本管理](https://cloud.tencent.com/document/product/1552/113690)。", "example": "无", "item_type": "object", "children": [ { "name": "ConfigGroupType", "type": "string", "required": true, "description": "配置组类型，可选项如下：l7_acceleration: 七层加速配置组；edge_functions: 边缘函数配置组。", "example": "l7_acceleration" }, { "name": "WorkMode", "type": "string", "required": true, "description": "工作模式，可选项如下：immediate_effect: 即时生效模式；version_control: 版本管理模式。", "example": "immediate_effect" } ] } ], "required": [ "ZoneId" ] }, { "name": "RefreshMultiPathGatewaySecretKey", "description": "通过本接口刷新多通道安全加速网关的密钥。客户基于接入密钥签名接入多通道安全加速网关。每个站点下只有一个密钥，可用于接入该站点下的所有网关，刷新密钥后，原始密钥会失效。", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "站点 ID。", "example": "zone-27q0p0bal192" } ], "required": [ "ZoneId" ] }, { "name": "RenewPlan", "description": "当您的套餐需要延长有效期，可以通过该接口进行续费。套餐续费仅支持个人版，基础版，标准版套餐。 \u003e 费用详情可参考 [套餐费用](https://cloud.tencent.com/document/product/1552/94158)", "status": "online", "parameters": [ { "name": "PlanId", "type": "string", "required": true, "description": "套餐 ID，形如 edgeone-2unuvzjmmn2q。", "example": "edgeone-2unuvzjmmn2q" }, { "name": "Period", "type": "integer", "required": true, "description": "续费套餐的时长，单位：月，取值有：1，2，3，4，5，6，7，8，9，10，11，12，24，36。", "example": "1" }, { "name": "AutoUseVoucher", "type": "string", "required": false, "description": "是否自动使用代金券，取值有： true：是； false：否。不填写使用默认值 false。", "example": "true" } ], "required": [ "PlanId", "Period" ] }, { "name": "UpgradePlan", "description": "当您需要使用高等级套餐才拥有的功能，可以通过本接口升级套餐，仅支持个人版，基础版套餐进行升级。 \u003e 不同类型 Edgeone 计费套餐区别参考 [Edgeone计费套餐选型对比](https://cloud.tencent.com/document/product/1552/94165) 计费套餐升级规则以及资费详情参考 [Edgeone计费套餐升配说明](https://cloud.tencent.com/document/product/1552/95291) 如果需要将套餐升级至企业版，请 [联系我们](https://cloud.tencent....", "status": "online", "parameters": [ { "name": "PlanId", "type": "string", "required": true, "description": "套餐 ID，形如 edgeone-2unuvzjmmn2q。", "example": "edgeone-2unuvzjmmn2q" }, { "name": "PlanType", "type": "string", "required": true, "description": "需要升级到的目标套餐版本，取值有： basic：基础版套餐； standard：标准版套餐。", "example": "basic" }, { "name": "AutoUseVoucher", "type": "string", "required": false, "description": "是否自动使用代金券，取值有： true：是； false：否。不填写使用默认值 false。", "example": "true" } ], "required": [ "PlanId", "PlanType" ] }, { "name": "VerifyOwnership", "description": "在 CNAME 接入模式下，您需要对站点或者域名的归属权进行验证，可以通过本接口触发验证。若站点通过归属权验证后，后续添加域名无需再验证。详情参考 [站点/域名归属权验证](https://cloud.tencent.com/document/product/1552/70789)。 在 NS 接入模式下，您也可以通过本接口来查询 NS 服务器是否切换成功，详情参考 [修改 DNS 服务器](https://cloud.tencent.com/document/product/1552/90452)。", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "站点域名或者站点下的加速域名。", "example": "qq.com" } ], "required": [ "Domain" ] } ] }