POST - 创建过滤器

介绍创建过滤器的步骤。

接口介绍

在当前系统上创建过滤器。

请求方式（HTTP/1.1）

POST

接口地址

https://UCSS_URL/qkact/v0/filters/

请求参数

参数名称 参数位置 值 是否必须 描述
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字符串示例
{
    "filters": [
        {
            "sources":[{"user":{"value-type":"email","value":"samuel@skyguard.com"}}],
            "destinations":[{"value-type":"email","value":"samuel@hotmail.com"}],
            "policy-id":" abcdef1-4567-11df-a475-0022647abcde",
            "is-exception":  false
        },
        {
            "sources":[
                {"user":{"value-type":"ip","value":"192.168.1.10"}},
                {"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
        },
        {
            "sources":[
                {
                    "group":{"value-type":"LDAP","value":"cn=accouting,ou=groups,dc=skyguard,dc=com"},
                    "user":{"value-type":"LDAP","value":"cn=Samuel,ou=Beijing,dc=skyguard,dc=com"}
                },
                {
                    "group":{"value-type":"LDAP","value":"cn=dev,ou=groups,dc=skyguard,dc=com"},
                    "user":{"value-type":"name","value":"Samuel Chen"}
                }],
            "policy-id": "cddd123-4567-11df-a475-0022647abcde",
            "is-exception": true
        },
        {
            "sources":[
                {
                    "group":{"value-type":"name","value":"accounting"},
                    "user":{"value-type":"name","value":"Samuel"}
                }],
            "destinations":[{"value-type":"url","value":"www.taobao.com"}],
            "policy-id": "cddd123-4567-11df-a475-0022647abcde",
            "is-exception": false
        }
    ]
}
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,
    "filter-ids":[
        "ea12123-4567-11df-a475-0022647cdeab",
        "abcd123-4567-8910-a475-0022647abcde",
        "cdba123-4567-11df-a475-0022647abcde",
        "cadb123-4567-11df-a475-0022647abcde"
    ]
}

返回结果（创建失败的返回示例）

{
 "status": 1,
 "reason": "Not all Filters can be created",
 "failed-filters": [0,3]
}
返回值参数定义如下表所示：
参数名 说明
status 请求是否成功，成功为0，失败为1。
reason 状态解释。
filter-ids 创建成功的过滤器ID列表。
failed-filters 创建失败的过滤器序号。