Web 应用防火墙新增或更新会话定义

1. 接口描述

接口请求域名： waf.tencentcloudapi.com 。

新增或更新WAF会话（Session）定义
说明：SessionID传-1时为新增，传已有ID时为更新。每个域名最多支持10条会话规则。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：UpsertSession。
Version	是	String	公共参数，本接口取值：2018-01-25。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-guangzhou, ap-seoul, ap-singapore 。
Domain	是	String	域名入参限制：必填，必须为合法域名格式示例值：www.testxxx.com
Source	是	String	会话来源位置取值说明：get-从URL查询参数中提取，post-从POST Body中提取，cookie-从Cookie中提取，header-从HTTP Header中提取入参限制：必填，取值范围为get/post/cookie/header 示例值：none
Category	是	String	提取类别取值说明：location-按位置提取（使用StartOffset和EndOffset），match-按字符串匹配提取（使用KeyOrStartMat和EndMat），exact_key-按精准Key提取（使用Key字段）入参限制：必填，取值范围为location/match/exact_key 示例值：match
KeyOrStartMat	是	String	提取key或者起始匹配模式入参限制：最长32个字符，不允许包含MongoDB注入字符说明：当Category为match时，表示匹配的起始字符串；当Category为exact_key时，表示精确匹配的key名示例值：key_a=
EndMat	是	String	结束匹配模式入参限制：必填，最长32个字符，不允许包含MongoDB注入字符说明：当Category为match时，表示匹配的结束字符串示例值：none
StartOffset	是	String	起始偏移位置入参限制：必填，整数字符串约束条件：EndOffset不能小于StartOffset，且EndOffset-StartOffset+1不能超过256 说明：当Category为location时生效，表示从会话值中提取的起始字节位置示例值：-1
EndOffset	是	String	结束偏移位置入参限制：必填，整数字符串约束条件：不能小于StartOffset，且EndOffset-StartOffset+1不能超过256 说明：当Category为location时生效，表示从会话值中提取的结束字节位置示例值：-1
Edition	否	String	版本示例值：sparta-waf
SessionName	否	String	会话名称说明：用于标识会话的可读名称示例值：小程序SESSION
SessionID	否	Integer	会话ID 说明：传-1表示新增会话（系统自动生成ID），传已有ID表示更新该会话配置约束条件：新增时每个域名最多10条会话规则示例值：200000001
Key	否	String	会话标识参数（精准匹配key）入参限制：key中"."分隔的层级不超过2层说明：当Category为exact_key时使用，表示要精确匹配的参数名示例值：waf

3. 输出参数

参数名称	类型	描述
Data	String	结果示例值：success
SessionID	Integer	会话ID 说明：新增时返回系统生成的SessionID，更新时返回请求中传入的SessionID 示例值：200000001
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 新增会话定义

输入示例

https://waf.tencentcloudapi.com/?Action=UpsertSession
&Domain=test.com
&Category=match
&KeyOrStartMat=hashId
&EndMat=end
&Source=get
&StartOffset=-1
&EndOffset=-1
&Edition=clb-waf
&SessionName=测试SESSION
&<公共请求参数>

输出示例

{
    "Response": {
        "Data": "success",
        "SessionID": 200000001,
        "RequestId": "5029e2b0-493c-4dcc-9e4e-d53ab98ede99"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败。
InternalError	内部错误。
InternalError.DBErr	DBErr
InvalidParameter	参数错误。
LimitExceeded.SpecificationErr	SpecificationErr
UnsupportedOperation	操作不支持。
UnsupportedOperation.InvalidRequest	InvalidRequest

新增或更新会话定义

本页目录：