GET - 查询指定类型的策略

介绍查询指定类型策略的步骤。

接口介绍

查询指定类型的所有策略。

请求方式(HTTP/1.1)

GET

接口地址

https://UCSS_URL/qkact/v1/policies/search?category=<policy_category>

<policy_category>是在查询所有策略列表时返回的策略类型,如:dlp。查看章节获取详细信息: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 检查浏览页面的访问者在用什么操作系统(包括版本号)浏览器(包括版本号)和用户个人偏好的代码。

返回结果

注: 以下示例为查询策略类型为dlp的所有策略。
{
    "status":0,
    "policies":[
        {
            "id":"abcd6c8-73ec-11df-a475-0022647abcde",
            "name":"dlp-policy-1",
            "category":"dlp"
        },
        {
            "id":"cddd123-4567-11df-a475-0022647abcde",
            "name":"dlp-policy-2",
            "category":"dlp"
        },
        {
            "id":"abcdef1-4567-11df-a475-0022647abcde",
            "name":"dlp-mta-policy-2",
            "category":"dlp"
        }
    ]
}
返回值参数定义如下表所示:
参数名 说明
status 请求是否成功,成功为0,失败为1。
policies
id 策略id(对应UCSS策略UUID)。字段类型为String。
name 策略名称。字段类型为String。
category 策略类型,如:web代表SWG策略、dlp代表DLP策略、email代表SEG策略和mobile代表Mobile策略。字段类型为String。
注: 当前版本不支持Mobile策略。