更新时间:2022-02-22 GMT+08:00

获取套餐信息

功能介绍

获取某个用户的套餐信息。

URI

  • URI格式

    GET /v1/{project_id}/waf/bundle

  • 参数说明
    表1 Path参数说明

    名称

    是否必选

    参数类型

    说明

    project_id

    String

    用户操作的项目ID。

请求消息

请求参数

响应消息

响应参数
表2 响应参数说明

名称

参数类型

说明

type

Integer

版本信息。

name

String

套餐名称。

options

表3

套餐防护策略开关可开启范围。

rule

表4

套餐防护策略中规则条数限制。

host

表5

套餐防护策略中规则域名限制。

other

表6

套餐中的其他限制。

表3 options

名称

参数类型

说明

webattack

Boolean

套餐防护策略开关,Web攻击是否可以开启。

  • true:表示可以开启。
  • false:表示不能开启。

common

Boolean

套餐防护策略开关,Web攻击的常规攻击检测是否可以开启。

  • true:表示可以开启。
  • false:表示不能开启。

crawler

Boolean

套餐防护策略开关,Web攻击的爬虫检测主开关是否可以开启。

  • true:表示可以开启。
  • false:表示不能开启。
说明:

当crawler开关关闭时,crawler开关的所有子开关功能将无效。

crawler_engine

Boolean

套餐防护策略开关,Web攻击的爬虫检测搜索引擎是否可以开启。

  • true:表示可以开启。
  • false:表示不能开启。

crawler_scanner

Boolean

套餐防护策略开关,Web攻击的爬虫检测扫描器是否可以开启。

  • true:表示可以开启。
  • false:表示不能开启。

crawler_script

Boolean

套餐防护策略开关,Web攻击的爬虫检测脚本工具是否可以开启。

  • true:表示可以开启。
  • false:表示不能开启。

crawler_other

Boolean

套餐防护策略开关,Web攻击的爬虫检测其他爬虫是否可以开启。

  • true:表示可以开启。
  • false:表示不能开启。

webshell

Boolean

套餐防护策略开关,Web攻击的Webshell是否可以开启。

  • true:表示可以开启。
  • false:表示不能开启。

cc

Boolean

套餐防护策略开关,Web攻击的CC防护是否可以开启。

  • true:表示可以开启。
  • false:表示不能开启。

custom

Boolean

套餐防护策略开关,Web攻击的精准防护是否可以开启。

  • true:表示可以开启。
  • false:表示不能开启。

whiteblackip

Boolean

套餐防护策略开关,Web攻击的IP黑白名单是否可以开启。

  • true:表示可以开启。
  • false:表示不能开启。

privacy

Boolean

套餐防护策略开关,Web攻击的隐私屏蔽是否可以开启。

  • true:表示可以开启。
  • false:表示不能开启。

Ignore

Boolean

套餐防护策略开关,Web攻击的误报屏蔽是否可以开启。

  • true:表示可以开启。
  • false:表示不能开启。

antitamper

Boolean

套餐防护策略开关,Web攻击的网页防篡改是否可以开启。

  • true:表示可以开启。
  • false:表示不能开启。

full_detection

Boolean

套餐防护策略开关,精准防护的全检测模式是否可以开启。

  • true:全检测。当用户的请求符合精准防护中的拦截条件时,不会立即拦截,WAF会继续执行其他防护的检测,待其他防护的检测完成后进行拦截。
  • false:短路检测。当用户的请求符合精准防护中的拦截条件时,便立刻终止检测,进行拦截。

log_download

Boolean

套餐防护策略开关,日志下载是否可用。

  • true:表示可用。
  • false:表示不可用。
表4 rule

名称

参数类型

说明

antitamper

Integer

可设置的网页防篡改规则的总条数。最大值为100。

cc

Integer

可设置的CC规则的总条数。最大值为100。

custom

Integer

可设置的精准防护规则的总条数。最大值为100。

ignore

Integer

可设置的误报屏蔽规则的总条数。最大值为1000。

privacy

Integer

可设置的隐私屏蔽规则的总条数。最大值为1000。

whiteblackip

Integer

可设置的IP黑白名单的总条数。最大值为100。

用户可以联系管理员,申请增大表4中的最大值配额。

表5 host

名称

参数类型

说明

wildcard

Boolean

是否支持泛域名。

  • true:表示支持泛域名。
  • false:表示不支持泛域名。

ports

表7

支持端口的范围。

protocol

表8

对外协议。

server

Integer

支持的后端服务器数量。最大取值为30。

host

Integer

支持的子域名数量。最大取值为100。

domain

Integer

支持的域名数量。最大取值为100。

cert_num

Integer

支持的证书数量。最大取值为100。

policy_apply_to

Boolean

是否支持一个策略对应多个域名。

  • true:表示支持一个策略对应多个域名。
  • false:表示不支持一个策略对应多个域名。

policy_num

Integer

支持的策略数量。最大数量为5000。

表6 other

名称

参数类型

说明

default_cc

Integer

防护策略中默认CC规则的最大的请求次数。

表7 ports

名称

参数类型

说明

http

Array

支持的HTTP端口列表。

https

Array

支持的HTTPS端口列表。

max_num

Integer

支持端口的个数。

none_standard

Boolean

是否支持非标准端口。

  • true:支持非标准端口。
  • false:不支持非标准端口。
表8 protocol

名称

参数类型

说明

http

Boolean

是否支持http协议。

  • true:表示支持http协议。
  • false:表示不支持http协议。

https

Boolean

是否支持https协议。

  • true:表示支持https协议。
  • false:表示不支持https协议。

http_https

Boolean

是否同时支持http和https协议。

  • true:表示同时支持http和https协议。
  • false:表示同时不支持http和https协议。

示例

如下以获取套餐信息为例。

响应样例
{
  "type": 1,
  "name": "Basic",
  "options": {
    "webattack": true,
    "common": true,
    "crawler": true,
    "webshell": false,
    "cc": false,
    "custom": false,
    "whiteblackip": true,
    
    "privacy": true,
    "ignore": true,
    "antitamper": false,
"log_download": true,
  },
  "rule": {
    "cc": 0,
    "custom": 0,
    "whiteblackip": 10,
   
    "privacy": 10,
    "ignore": 1000,
"antitamper": 0,
  },
  "host": {
    "wildcard": false,
    "protocol": {
      "http": true,
      "https": false,
      "http_https": false
    },
    "ports": {
      "none_standard": false,
      "http": [],
      "https": [],
      "max_num": 0
    },
    "domain": 1,
    "host": 10,
    "server": 10,
    "route": false
  },
  "other": {
      "default_cc": 25000
    }
}

状态码

表9描述的是API返回的正常状态码。
表9 状态码

状态码

编码

状态说明

200

OK

客户端请求已处理成功。

异常状态码,请参见状态码