流控信息
请求参数
| 字段名称 | 字段详情 |
|---|---|
InstanceIdstring | WAF 实例的 ID。展开详情 示例值:waf-cn-7pp26f1****参考取值来源: DescribeInstanceInfo |
Domainstring | 要操作的域名。展开详情 示例值:www.example.com参考取值来源: CreateDomain DescribeDomainList SetDomainRuleGroup |
SourceIpsstring | 域名对应的源站服务器 IP 或服务器回源域名。您只能选择设置源站服务器 IP 或服务器回源域名中的一种：展开详情 示例值:["39.XX.XX.197"] |
LoadBalancinginteger<int32> | 回源时采用的负载均衡算法。取值：展开详情 示例值:0 |
HttpPortstring | HTTP 协议端口列表，使用 示例值:[80] |
HttpsPortstring | HTTPS 协议端口列表，使用 示例值:[443] |
Http2Portstring | HTTP 2.0 协议端口列表，使用 示例值:[443] |
HttpsRedirectinteger<int32> | 是否开启 HTTPS 强制跳转。开启强制跳转后，客户端的 HTTP 请求将被强制跳转成 HTTPS 请求，默认跳转端口为 443。取值：展开详情 示例值:0 |
HttpToUserIpinteger<int32> | 是否开启 HTTP 回源。开启 HTTP 回源后，HTTPS 访问请求将通过 HTTP 协议转发回源站，默认回源端口为 80。取值：展开详情 示例值:0 |
IsAccessProductinteger<int32> | 域名在 WAF 前是否配置有七层代理（例如高防、CDN 等），即客户端访问流量到 WAF 前是否有经过其他七层代理转发。取值：展开详情 示例值:0 |
AccessHeaderModeinteger<int32> | WAF 获取客户端真实 IP 的方式。取值：展开详情 示例值:0 |
AccessHeadersstring | 设置用于获取客户端 IP 的自定义字段列表，使用 示例值:["X-Client-IP"] |
LogHeadersstring | 域名的流量标记字段和值，用于标记经过 WAF 处理的流量。展开详情 示例值:[{"k":"ALIWAF-TAG","v":"Yes"}] |
ClusterTypeinteger<int32> | WAF 防护集群类型。取值：展开详情 示例值:0 |
ConnectionTimeinteger<int32> | WAF 独享集群的连接超时时长。单位：秒。展开详情 示例值:5 |
ReadTimeinteger<int32> | WAF 独享集群的读连接超时时长。单位：秒。展开详情 示例值:120 |
WriteTimeinteger<int32> | WAF 独享集群的写连接超时时长。单位：秒。展开详情 示例值:120 |
AccessTypestring | 域名接入方式。取值：展开详情 示例值:waf-cloud-dns |
CloudNativeInstancesstring | 透明接入的服务器及端口配置列表。使用 JSON 数组转化的字符串格式表示。JSON 数组中的每个元素是一个结构体，包含以下字段：展开详情 示例值:[{"ProtocolPortConfigs":[{"Ports":[80],"Protocol":"http"}],"RedirectionTypeName":"ALB","InstanceId":"alb-s65nua68wdedsp****","IPAddressList":["182.XX.XX.113"],"CloudNativeProductName":"ALB"}] |
IpFollowStatusinteger<int32> | 源站服务器地址同时包含 IPv4 和 IPv6 地址时，是否开启 IPv4/IPv6 回源协议跟随。开启回源协议跟随后，WAF 将来自 IPv4 地址的请求转发到 IPv4 源站、将来自 IPv6 地址的请求转发到 IPv6 源站。取值：展开详情 示例值:0 |
SniStatusinteger<int32> | 设置是否开启回源 SNI。回源 SNI 表示 WAF 转发客户端请求到源站服务器，在与源站进行 TLS 握手时，通过 SNI 扩展字段（Server Name Indicator extension）指定要访问的主机，并与该主机建立 HTTPS 连接。如果您的源站服务器有多个虚拟主机（对应不同域名），则您需要开启回源 SNI。取值：展开详情 示例值:1 |
SniHoststring | 自定义 SNI 扩展字段的值。如果不设置该参数，则默认使用请求头中 Host 字段的值作为 SNI 扩展字段的值。展开详情 示例值:waf.example.com |
Retryboolean | WAF 回源失败时，是否重试。取值：展开详情 示例值:true |
Keepaliveboolean | 是否保持长连接。取值：展开详情 示例值:true |
KeepaliveRequestsinteger<int32> | 复用长连接的请求个数。取值范围：60~1000，单位：个。展开详情 示例值:1000取值 <= 1000 |
KeepaliveTimeoutinteger<int32> | 空闲长连接超时时间，取值范围：1~60，默认 15，单位：秒。展开详情 示例值:60取值 <= 3600 |
ResourceGroupIdstring | WAF 实例在资源管理服务中所属的资源组 ID。展开详情 示例值:rg-atstuj3rtop**** |
RegionIdstring | WAF 实例所属地域。取值：展开详情 示例值:cn-hangzhou |
请求说明
调用 API 时，除了本文中该 API 的请求参数，还需加入阿里云 API 公共请求参数。公共请求参数的详细介绍，请参见公共参数。
调用 API 的请求格式，请参见本文示例中的请求示例。
返回参数
| 字段名称 | 字段详情 |
|---|---|
RequestIdstring | 本次请求的 ID。 示例值:D7861F61-5B61-46CE-A47C-6B19****5EB0 |
返回示例
变更历史
| 变更时间 | 变更内容概要 | 操作 | |
|---|---|---|---|
| 2023-08-28 | |||
| 2023-05-23 | |||
| 2022-08-22 |