PUT - 更新过滤器

介绍更新过滤器配置的步骤。

接口介绍

在当前系统上更新过滤器。

请求方式（HTTP/1.1）

PUT

接口地址

https://UCSS_URL/qkact/v0/filters/<filter_id>

<filter_id>是待更新的过滤器ID。参考章节获取和查询过滤器ID：GET - 查询所有过滤器

请求参数

参数名称 参数位置 值 是否必须 描述
Content-Type header application/json 是 定义网络文件的类型和网页的编码。
Authorization header Basic base64("client-id:access-token") 是 base64加密的Http Basic认证。
即Basic 加密串，如Basic dXNlcjp1c2Vy。
注： client-id是客户端ID，access-token是在获取认证时返回的值。
User-Agent header QKAct-External-Client 是 检查浏览页面的访问者在用什么操作系统（包括版本号）浏览器（包括版本号）和用户个人偏好的代码。
POST请求Body - JSON字符串示例
{
    " sources":[
        {
            "user":{
                "value-type":"ip-range",
                "value":"192.168.1.10-192.168.1.20"
            }
        },
        {
            "user":{
                "value-type":"ip",
                "value":"192.168.1.21"
            }
        }
    ]
}
Body参数定义如下表所示：
参数名 说明
filters 过滤器列表，包含当前系统下所有的过滤器。
id 过滤器ID。字段类型为String。
sources 来源，包括user和group两种。
user user的value-type包含email、ip、ip-range等配置字段，参考章节获取详细信息：过滤器源user的value-type参数说明。
group group的value-type包含name和LDAP配置字段，参考章节获取详细信息：过滤器源group的value-type参数说明。
policy-id 策略ID（对应UCSS策略UUID）
destinations 目标。destinations的value-type包含email、url、ip等配置字段，参考章节获取详细信息：过滤器目标的value-type参数说明。
is-exception 是否是例外规则。字段类型为boolean。

返回结果（更新成功的返回示例）

{
    "status":0,
    "id":"abcd123-4567-8910-a475-0022647abcde",
    " sources":[
        {
            "user":{
                "value-type":"ip-range",
                "value":"192.168.1.10-192.168.1.20"
            }
        },
        {
            "user":{
                "value-type":"ip",
                "value":"192.168.1.21"
            }
        }
    ],
    "destinations":[
        {
            "value-type":"url",
            "value":"www.taobao.com"
        },
        {
            "value-type":"ip",
            "value":"124.127.119.214"
        }
    ],
    "policy-id":"abcd6c8-73ec-11df-a475-0022647abcde",
    "is-exception":false
}

返回结果（更新失败的返回示例）

{
    "status": 1,
    "reason": "Invalid id"
}
返回值参数定义如下表所示：
参数名 说明
status 请求是否成功，成功为0，失败为1。
reason 说明。