BLB-WAF-API

更新时间：2024-04-19

wafBlbRegionOverview

接口描述

用于查询用户在某个区域购买的 BLB WAF 实例列表清单，需要指定pageNo、pageSize用来做分页查询。

请求结构

GET /v{version}/wafBlbRegionOverview?pageNo=1&pageSize=10&clientToken={clientToken} HTTP/1.1
Host: bss.{region}.baidubce.com             
Authorization: authorization string

请求头域

除公共头域外，无其他特殊头域。

参数名称	类型	是否必需	描述
region	region	是	详见Region

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值2
pageNo	Int	是	Query参数	waf列表页号码
PageSize	Int	是	Query参数	waf列表页展示的数量
clientToken	String	是	Query参数	幂等性Token，详见幂等性

返回状态码

成功返回200，失败返回见错误码。

返回头域

除公共头域外，无其他特殊头域。

返回参数

参数名称	类型	描述
wafList	List<WafResourceInstanceModel>	BLB-WAF实例的列表
totalCount	Int	用户在某个区的WAF实例的数量

请求示例

GET /v2/wafBlbRegionOverview?pageNo=1&pageSize=10&clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
Host: bss.bj.baidubce.com
Authorization: authorization string

返回示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2018 08:26:52 GMT
Content-Length: 
Connection: keep-alive
Content-Type: application/json;charset=UTF-8
Server: nginx
{
    "wafList": [
        {
            "region": "bj",                 //WAF实例资源所在地域,gz:广州|bj:北京|su:苏州|hkg:香港|fsh:上海|fwh:武汉|bd:保定
            "wafName": "NAME",              //WAF实例的名称
            "wafId": "WAFID",               //WAF实例的ID
            "status": "available",          //WAF实例的状态,见InstanceStatus 
            "blbName": "BLBNAME",           //绑定的BLB实例的名称
            "blbId": "BLBID",               //绑定的BLB实例的ID
            "blbListenerId": "BLID",        //BLB监听ID
            "blbListenerPort": "8003",      //BLB监听端口
            "blbListenerProtocol": "HTTP",  //BLB监听协议
            "autoRenew": "true",            //是否自动续费，true:是|false:否
            "domain": "demo.com",           //绑定的主域名
            "productType": "postpay",       //计费方式，postpy:后付费|prepay:预付费
            "expireTime": "2022-06-06T06:10:00Z"，//服务过期时间
            "subDomainConfig": {
                "customSwitch": "0",        //子域名自定义防护开关,0:关闭|1:开启
                "subDomain": "test",        //子域名
                "webSwitch": "0",           //子域名web防护开关,0:关闭|1:开启
            },
            "ipCustomSwitch": "0",          //BLB EIP自定义防护开关,0:关闭|1:开启
            "ipWebSwitch": "0",             //BLB EIP web防护开关,0:关闭|1:开启
            "webSwitch": "0",               //子域名web防护开关,0:关闭|1:开启。只要有任意一个子域名为开启状态，该字段即标记为开启
            "customSwitch": "0",             //子域名自定义防护开关,0:关闭|1:开启。只要有任意一个子域名为开启状态，该字段即标记为开启
            "webDomainCloseN": 0,           //关闭web防护的子域名数量
            "webDomainOpenN": 8,            //开启web防护的子域名数量
            "customDomainCloseN": 1,        //关闭自定义防护子域名数量
            "customDomainOpenN": 7,         //开启自定义防护域名数量
        },
        {...},
    ],
    "totalCount": 100                       //总条目数
}

wafBlbAllOverview

描述

用于查询用户在所有区域购买的BLB WAF 实例列表清单，需要指定pageNo、pageSize用来做分页查询。

请求结构

GET /v{version}/wafBlbAllOverview?pageNo=1&pageSize=10&clientToken={clientToken} HTTP/1.1
Host: bss.{region}.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其他特殊头域。

参数名称	类型	是否必需	描述
region	region	是	详见Region

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值2
pageNo	Int	是	Query参数	waf列表页号码
PageSize	Int	是	Query参数	waf列表页展示的数量
clientToken	String	是	Query参数	幂等性Token，详见幂等性

返回状态码

成功返回200，失败返回见错误码。

返回头域

除公共头域外，无其他特殊头域。

返回参数

参数名称	类型	描述
wafList	List<WafResourceInstanceModel>	BLB-WAF实例的列表
totalCount	Int	用户在某个区的WAF实例的数量

请求示例

GET /v2/wafBlbRegionOverview?pageNo=1&pageSize=10&clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
Host: bss.bj.baidubce.com
Authorization: authorization string

返回示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2018 08:26:52 GMT
Content-Length: 
Connection: keep-alive
Content-Type: application/json;charset=UTF-8
Server: nginx
{
    "wafList": [
        {
            "region": "bj",                 //WAF实例资源所在地域,gz:广州|bj:北京|su:苏州|hkg:香港|fsh:上海|fwh:武汉|bd:保定
            "wafName": "NAME",              //WAF实例的名称
            "wafId": "WAFID",               //WAF实例的ID
            "status": "STATUS",             //WAF实例的状态，见附录InstanceStatus 
            "blbName": "BLBNAME",           //绑定的BLB实例的名称
            "blbId": "BLBID",               //绑定的BLB实例的ID
            "blbListenerId": "BLID",        //BLB监听ID
            "blbListenerPort": "8003",      //BLB监听端口
            "blbListenerProtocol": "HTTP",  //BLB监听协议
            "autoRenew": "true",            //是否自动续费，true:是|false:否
            "domain": "demo.com",           //绑定的主域名
            "productType": "postpay",       //计费方式，postpy:后付费|prepay:预付费
            "expireTime": "2022-06-06T06:10:00Z"，//服务过期时间
            "subDomainConfig": {
                "customSwitch": "0",        //子域名自定义防护开关,0:关闭|1:开启
                "subDomain": "test",        //子域名
                "webSwitch": "0",           //子域名web防护开关,0:关闭|1:开启
            },
            "ipCustomSwitch": "0",          //BLB EIP自定义防护开关,0:关闭|1:开启
            "ipWebSwitch": "0",             //BLB EIP web防护开关,0:关闭|1:开启
            "webSwitch": "0",               //子域名web防护开关,0:关闭|1:开启。只要有任意一个子域名为开启状态，该字段即标记为开启
            "customSwitch": "0",            //子域名自定义防护开关,0:关闭|1:开启。只要有任意一个子域名为开启状态，该字段即标记为开启
            "webDomainCloseN": 0,           //关闭web防护的子域名数量
            "webDomainOpenN": 8,            //开启web防护的子域名数量
            "customDomainCloseN": 1,        //关闭自定义防护子域名数量
            "customDomainOpenN": 7,         //开启自定义防护域名数量
        },
        {...},
    ],
    "totalCount": 100                       //总条目数
}

wafBlb

描述

查询用户名下可用于绑定某个 WAF 实例的所有blb实例，以及blb实例下可绑定的协议和端口。需要指定waf的标志符。

请求结构

GET /v{version}/wafBlb/{waf_id}?clientToken={clientToken} HTTP/1.1
Host: bss.{region}.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其他特殊头域。

参数名称	类型	是否必需	描述
region	region	是	详见Region

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值2
waf_id	String	是	URL参数	waf标志符
clientToken	String	是	Query参数	幂等性Token，详见幂等性

返回状态码

成功返回200，失败返回见错误码。

返回头域

除公共头域外，无其他特殊头域。

返回参数

参数名称	类型	描述
blbList	List<BlbInstance>	用户拥有的blb实例的配置详情列表

请求示例

GET /v2/wafBlb/waf-3a4b5c?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST bss.bj.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2018 08:26:52 GMT
Content-Length: 
Connection: keep-alive
Content-Type: application/json;charset=UTF-8
Server: nginx
{
   "blbList": [
       {
           "blbId": "BLBID",                //BLB ID
           "blongId": "BLBLONGID",          //BLB 长ID
           "blbName": "NAME",               //BLB NAME
           "listenerList": [
               {
                   "listenerId": "396920",   //listener监听ID
                   "protocol": "HTTP",      //listener协议,HTTP|HTTPS
                   "port": "80",            //listener端口,1-65535
                   "rsList" [
                        "xxxxxx-xxxxxx-xxxxxx-xxxx",              //BLB绑定的BCC
                            ]

               },
               {
                  ...
               },
           ],
           "bccList": ["instance-1","instance-2"], //BLB绑定的BCC
       },
       {...},
   ]
}

wafBind

描述

将一个 WAF实例绑定到目标BLB实例的监听上，需要指定waf标志符、blb的标志符以及blb绑定协议和监听端口。

请求结构

PUT /v{version}/wafBind/{waf_id}?clientToken={clientToken}  HTTP/1.1
Host: bss.{region}.baidubce.com
Authorization: authorization string
{
    "blbId": "BLBID",                   //BLB 标志符
    "listener": {
        "protocol": "HTTP|HTTPS",       //listener协议,HTTP|HTTPS,需要注意大小写
        "port": "80",                   //listener端口,1-65535
    }
    bindEip: "0|1"                      //是否绑定eip,1:是|0:否
}

请求头域

除公共头域外，无其他特殊头域。

参数名称	类型	是否必需	描述
region	region	是	详见Region

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值2
waf_id	String	是	URL参数	waf标志符
blbId	String	是	Request Body参数	要绑定的blb标志符
listener	Object	是	Request Body参数	blb监听的协议和端口
bindEip	int	是	Request Body参数	是否绑定 EIP
clientToken	String	是	Query参数	幂等性Token，详见幂等性

返回状态码

成功返回200，失败返回见错误码。

返回头域

除公共头域外，无其他特殊头域。

返回参数

无特殊返回参数。

请求示例

PUT /v2/wafBind/waf-3a4b5c?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST bss.bj.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
{
    "blbId": "lb-ecfca910"
    "listener": {
        "protocol": "HTTP",             
        "port": 80,                 
    }
    bindEip:1
}

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2018 08:26:52 GMT
Content-Length: 
Connection: keep-alive
Content-Type: application/json;charset=UTF-8

wafUnbind

接口描述

将一个 WAF实例从BLB实例的监听上解除绑定，需要指定waf标志符、blb的标志符以及blb绑定协议和监听端口。

请求结构

PUT /v{version}/wafUnbind/{waf_id}?clientToken={clientToken} HTTP/1.1
Host: bss.{region}.baidubce.com
Authorization: authorization string
{
    "blbId": "BLBID",                       //BLB ID
    "listener": {
        "protocol": "HTTP|HTTPS",           //listener协议:HTTP|HTTPS,需要注意大小写
        "port": "80",                       //listener端口，int型: 1-65535
    }
    bindEip: "0|1"                          //是否绑定eip,1:是|0:否
}

请求头域

除公共头域外，无其他特殊头域。

参数名称	类型	是否必需	描述
region	region	是	详见Region

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值2
waf_id	String	是	URL参数	WAF 标志符
blbId	String	是	Request Body参数	要绑定的blb标志符
listener	Object	是	Request Body参数	blb监听的协议和端口
bindEip	int	是	Request Body参数	是否绑定 EIP
clientToken	String	是	Query参数	幂等性Token，详见幂等性

返回状态码

成功返回200，失败返回见错误码。

返回头域

除公共头域外，无其他特殊头域。

返回参数

无特殊返回参数。

请求示例

PUT /v2/wafUnbind/waf-3a4b5c?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST bss.bj.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
{
    "blbId": "lb-ecfca910"
    "listener": {
        "protocol": "HTTP",             
        "port": 80,                 
    }
    bindEip:0  
}

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2018 08:26:52 GMT
Content-Length: 
Connection: keep-alive
Content-Type: application/json;charset=UTF-8

wafRules

接口描述

查询用户可配置的子域名数量以及自定义规则数量，需要指定 WAF 的标志符。

请求结构

GET /v{version}/wafRules/{waf_id}?clientToken={clientToken}	
Host: bss.{region}.baidubce.com	
Authorization: authorization string

请求头域

除公共头域外，无其他特殊头域。

参数名称	类型	是否必需	描述
region	region	是	详见Region

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值2
waf_id	String	是	URL参数	WAF 标志符
clientToken	String	是	Query参数	幂等性Token，详见幂等性

返回状态码

成功返回200，失败返回见错误码。

返回头域

除公共头域外，无其他特殊头域。

返回参数

参数名称	类型	描述
domainSum	Int	子域名的个数
ruleSum	Int	规则的数量

请求示例

GET /v2/wafRules/waf-3a4b5c?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1	
HOST bss.bj.baidubce.com	
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

响应示例

HTTP/1.1 200 OK	
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09	
Date: Wed, 10 Apr 2018 08:26:52 GMT	
Content-Length: 	
Connection: keep-alive	
Content-Type: application/json;charset=UTF-8	
{	
    "domainSum": 20,     //子域名数,int型:10|20|30|40|50	
    "ruleSum": 40,       //规则数,int型:20|40|60|80|100	
}

BLB-WAF 下发规则配置

接口描述

对 BLB-WAF 实例下发规则配置，需要指定 WAF 的标志符，需要传入 WAF 和 BLB 的配置。

请求结构

PUT /v{version}/wafConfig/{waf_id}?clientToken={clientToken}
Host: bss.{region}.baidubce.com
Authorization: authorization string
{
     "baseConfig": {                                    //基本配置信息
        "domain": "demo.com",                           //主域
        "ccDefenseSwitch": 1,                           //自定义防护开关，0关闭｜1开启
        "ccDefenseTemplateId": 1,                       //防护模版id 
        "blbId": "BLBID",                               //BLB ID
        "listener":{                                    //BLB 监听信息内部三个字段在wafBlb接口均有返回，请确认填写正确避免影响防护效果
            "listenerId": "LISTENERID",                 //BLB 监听ID
            "port": "PORT",                             //BLB 监听端口
            "protocol": "PROTOCOL"                      //BLB 监听协议
        }
     },
     "subDomainConfigList": [                           //子域名配置信息
        {
            "subDomain": "test.baidu.com",              //子域名
            "subDomainPrefix": "test",                  //子域名前缀
            "webSwitch": "0|1",                         //web防护开关,0:关闭|1:开启
            "webPolicy": "high|middle|low",             //策略等级
            "webType": "log|deny",                      //执行的策略
            "ccDefenseSwitch": 1,                       //自定义防护开关，0关闭｜1开启
            "ccDefenseTemplateId": 1,                   //防护模版id     
        },
        {...},
     ]  
}

请求头域

除公共头域外，无其他特殊头域。

参数名称	类型	是否必需	描述
region	region	是	详见Region

请求参数

BLB-WAF配置详情见wafConfig。

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值2
waf_id	String	是	URL参数	WAF标志符
clientToken	String	是	Query参数	幂等性Token，详见幂等性
baseConfig	Object	是	Request Body参数	waf配置基本信息，具体字段详见请求结构
subDomainConfigList	List	是	Request Body参数	waf配置子域名列表及其对应配置信息，具体字段详见请求结构

返回状态码

成功返回200，失败返回见错误码。

返回头域

除公共头域外，无其他特殊头域。

返回参数

无特殊返回参数。

请求示例

PUT /v2/wafConfig/waf-3a4b5c?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST bss.bj.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
{
    "baseConfig": {                                 //基本配置信息
        "domain": "demo.com",                       //主域
        "ccDefenseSwitch": 1,                       //自定义防护开关，0关闭｜1开启
        "ccDefenseTemplateId": 1,                   //防护模版id 
        "blbId":"lb-xxxxxxxxx",                     //BLB ID
        "listener":{                                //BLB 监听协议和端口，cdnwaf无此字段
            "listenerId": "114762",                 //BLB 监听ID
            "port": "8003",                         //BLB 监听端口
            "protocol": "HTTP"                      //BLB 监听协议
        }
    },
    "subDomainConfigList": [                        //子域名配置信息
        {
            "subDomain": "test.baidu.com",          //子域名
            "subDomainPrefix": "test",              //子域名前缀
            "webSwitch": 1,                         //web防护开关,0:关闭|1:开启                
            "webPolicy": "high",                    //策略等级
            "webType": "log",                       //执行的策略,log:观察模式|deny:拦截模式  
            "ccDefenseSwitch": 1,                   //自定义防护开关，0关闭｜1开启
            "ccDefenseTemplateId": 1,               //防护模版id 
        },
        {...},
    ]
}

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2018 08:26:52 GMT
Content-Length: 
Connection: keep-alive
Content-Type: application/json;charset=UTF-8

BLB-WAF 查询规则配置

接口描述

对 BLB-WAF 实例查询当前规则配置。

请求结构

GET /v{version}/wafConfig/{waf_id}?clientToken={clientToken}
Host: bss.{region}.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其他特殊头域

参数名称	类型	是否必需	描述
region	region	是	详见Region

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值2
waf_id	String	是	URL参数	waf标志符
clientToken	String	是	Query参数	幂等性Token，详见幂等性

返回状态码

成功返回200，失败返回见错误码

返回头域

除公共头域外，无其他特殊头域

返回参数

BLB-WAF配置详情见wafConfig

参数名称	类型	描述
baseConfig	Object	waf配置基本信息，具体字段详见响应示例
subDomainConfigList	List	waf配置子域名列表及其对应配置信息，具体字段详见响应示例

请求示例

GET /v2/wafConfig/waf-3a4b5c?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST bss.bj.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2018 08:26:52 GMT
Content-Length: 
Connection: keep-alive
Content-Type: application/json;charset=UTF-8
{
    "baseConfig": {                                 //基本配置信息
        "createTime": "2021-07-05T11:12:21Z",       //实例创建时间
        "domain": "demo.com",                       //主域
        "expireTime": "2022-06-05T11:12:21Z",       //服务过期时间
        "ccDefenseSwitch": 1,                       //自定义防护开关，0关闭｜1开启
        "ccDefenseTemplateId": 1,                   //防护模版id 
        "blbId":"lb-xxxxxxxxx",                     //BLB ID
        "listener":{                                //BLB 监听协议和端口
            "listenerId": "1234566",
            "port": "8003",
            "protocol": "HTTP"
        },
        "name": "WAF-541f2a75",                     //WAF 实例名称
        "productType": "prepay",                    //WAF 计费类型 prepay:预付费，postpay:后付费
        "region": "bj",                             //WAF 实例所属地域
        "status": "available",                      //WAF 实例状态
    },
    "subDomainConfigList": [                        //子域名配置信息
        {
            "subDomain": "test.demo.com",           //完整子域名
            "subDomainPrefix": "test",              //子域名前缀
            "webSwitch": 1,                         //web防护开关,0:关闭|1:开启                
            "webPolicy": "high",                    //策略等级
            "webType": "log",                       //执行的策略,log:观察模式|deny:拦截模式
            "ccDefenseSwitch": 1,                   //自定义防护开关，0关闭｜1开启
            "ccDefenseTemplateId": 1,               //防护模版id 
        },
        {...},
    ]
}

WAF数据报表相关接口

CDN-WAF-API

百度智能云

应用防火墙 WAF

应用防火墙 WAF

BLB-WAF-API

wafBlbRegionOverview

wafBlbAllOverview

wafBlb

wafBind

wafUnbind

wafRules

BLB-WAF 下发规则配置

BLB-WAF 查询规则配置