CDN-WAF-API

更新时间：2024-04-19

Overview

描述

查询用户的 CDN-WAF 实例

请求结构

    GET /v{version}/cdnwaf/overview?clientToken={clientToken} HTTP/1.1
    Host: bss.bj.baidubce.com
    Authorization: authorization string

请求头域

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

请求参数

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

返回状态码

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

返回头域

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

返回参数

参数名称	类型	描述
wafList	List<CdnWafInstance>	用户所有的cdn-waf实例列表

请求示例

    GET /v2/cdnwaf/overview?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 2016 08:26:52 GMT
    Transfer-Encoding: chunked
    Content-Type: application/json;charset=UTF-8
    Server: BWS
    {
        "wafList": [
            {
                "wafName": "NAME",              //WAF实例的名称
                "wafId": "WAFID",               //WAF实例的ID
                "status": "STATUS",             //WAF实例的状态，见附录InstanceStatus 
                "autoRenew": "true",            //是否自动续费，true:是|false:否
                "domain": "demo.com",           //绑定的主域名
                "subDomain": {                  //已配可配子域名数量
                    "used": 0,                  //已配子域名数量
                    "total": "10"               //可配子域名数量
                },
                "productType": "postpay",       //计费方式，postpy:后付费|prepay:预付费
                "expireTime": "2022-06-06T06:10:00Z"，//服务过期时间
                "subDomainConfig": {
                    "customSwitch": "0",        //子域名自定义防护开关,0:关闭|1:开启
                    "subDomain": "test",        //子域名
                    "webSwitch": "0",           //子域名web防护开关,0:关闭|1:开启
                },
                "webDomainCloseN": 0,           //关闭web防护的子域名数量
                "webDomainOpenN": 8,            //开启web防护的子域名数量
                "customDomainCloseN": 1,        //关闭自定义防护子域名数量
                "customDomainOpenN": 7,         //开启自定义防护域名数量
            },
            {...},
        ],
        "totalCount": 100                       //总条目数
    }

DomainList

接口描述

返回用户所有的主域名列表

请求结构

    GET /v{version}/cdnwaf/domainList?clientToken={clientToken} HTTP/1.1
    Host: bss.bj.baidubce.com
    Authorization: authorization string

请求头域

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

请求参数

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

返回状态码

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

返回头域

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

返回参数

参数名称	类型	描述
domainList	List	主域名列表

请求示例

    GET /v2/cdnwaf/domainList?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 2016 08:26:52 GMT
    Transfer-Encoding: chunked
    Content-Type: application/json;charset=UTF-8
    Server: BWS
    {
        "domainList": [
            {
                "domain": "demo.com",           //CDN中的主域名
            },
            {...},
        ]
    }

querySubDomainList

接口描述

查询符合主域名且未添加到其他waf实例的可用子域名列表，或者该waf实例绑定的子域名

请求结构

    PUT /v{version}/cdnwaf/querySubDomainList/{waf_id}?clientToken={clientToken} HTTP/1.1
    Host: bss.bj.baidubce.com
    Authorization: authorization string
    {
        "domain": "demo.com",              //CDN 中的主域名
    }

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值2
domain	String	是	Request Body参数	域名
clientToken	String	是	Query参数	幂等性Token，详见幂等性

返回状态码

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

返回头域

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

返回参数

参数名称	类型	描述
subDomainList	List	返回用户可用的子域名列表， subDomain是子域名称，status是子域名状态

请求示例

    PUT /v2/cdnwaf/querySubDomainList/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
    {
         "domain": "demo.com",  
    }

响应示例

    HTTP/1.1 200 OK
    x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
    Date: Wed, 10 Apr 2016 08:26:52 GMT
    Transfer-Encoding: chunked
    Content-Type: application/json;charset=UTF-8
    {
        "subDomainList": [
            {
                "subDomain": "a.demo.com",       //cdn中的子域名
                "status": "1",                   //子域名状态,0:未添加|1:已添加到该waf实例                              
            },
            {...},
        ]
    }

cdnWafRules

接口描述

查询CDN WAF实例可配置的子域名和自定义规则数，需要指定waf的标志符、需要指定cdn的主域名

请求结构

    GET /v{version}/cdnwaf/cdnWafRules/{waf_id}?clientToken={clientToken} HTTP/1.1
    Host: bss.bj.baidubce.com
    Authorization: authorization string
    {
        "domain": "demo.com",                   //CDN 中的主域名
    }

请求头域

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

请求参数

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

返回状态码

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

返回头域

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

返回参数

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

请求示例

    GET /v2/cdnwaf/cdnWafRules/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 2016 08:26:52 GMT
    Transfer-Encoding: chunked
    Content-Type: application/json;charset=UTF-8
    {
        "domainSum": DOMAINSUM,             //子域名数,int型:10|20|30|40|50
        "ruleSum": RULESUM,                 //规则数,int型:20|40|60|80|100
    }

cdnWafConfig

接口描述

用于对 CDN-WAF 实例下发规则配置。

请求结构

    PUT /v{version}/cdnwaf/cdnWafConfig/{waf_id}?clientToken={clientToken}
    Host: bss.bj.baidubce.com
    Authorization: authorization string
    {
        "baseConfig": {                                 //基本配置信息
            "domain": "demo.com",                       //主域
        },
        "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   
            },
            {...},
        ] 
    }

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
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/cdnwaf/cdnWafConfig/waf-3a4b5c?clientToken=be31b98c-5e41-4838-9830-9be700de5a20
    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",                       //主域
            },
            "subDomainConfigList": [                        //子域名配置信息
                {
                    "subDomain": "test.baidu.com"           //子域名
                    "subDomainPrefix": "test",              //子域名前缀
                    "webPolicy": "high",                    //策略等级
                    "webType": "log",                       //执行的策略,log:观察模式|deny:拦截模式
                    "webSwitch": 1,                         //web防护开关,0:关闭|1:开启
                    "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 2016 08:26:52 GMT
    Transfer-Encoding: chunked
    Content-Type: application/json;charset=UTF-8

cdnWafConfig

接口描述

用于查询 CDN-WAF 的规则配置。

请求结构

    GET /v{version}/cdnwaf/cdnWafConfig/{waf_id}?clientToken={clientToken}
    Host: bss.bj.baidubce.com
    Authorization: authorization string

请求头域

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

请求参数

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

返回状态码

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

返回头域

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

返回参数

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

请求示例

    GET /v2/cdnwaf/cdnWafConfig/waf-3a4b5c?clientToken=be31b98c-5e41-4838-9830-9be700de5a20
    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 2016 08:26:52 GMT
    Transfer-Encoding: chunked
    Content-Type: application/json;charset=UTF-8
    {
        "baseConfig": {                             //基本配置信息
            "createTime": "2021-07-05T11:12:21Z",   //实例创建时间
	        "domain": "dome.com",                   //主域
	        "expireTime": "2022-06-05T11:12:21Z",   //服务过期时间
	        "name": "WAF-541f2a75",                 //实例名称
	        "productType": "prepay",                //计费类型 prepay:预付费，postpay:后付费
	        "region": "global",                     //资源地域,CDN-WAF 资源地域统一为 global
	        "status": "available",                  //WAF实例状态
	    },
        "subDomainConfigList": [                    //子域名配置信息
            {
                “subDomain”: "test.baidu.com"               //子域名
                "subDomainPrefix": "test",                  //子域名前缀
                "webPolicy": "high",                        //自定义策略等级,high|middle|low
                "webType": "log",                           //执行的策略：log:观察模式|deny:拦截模式
                "ccDefenseSwitch": 1,                       //自定义防护开关，0关闭｜1开启
                "ccDefenseTemplateId": 1,                   //防护模版id   
                "webSwitch": 1,                             //web防护开关,0:关闭|1:开启
            },
            {...},
        ]
    }

BLB-WAF-API

附录

百度智能云

应用防火墙 WAF

应用防火墙 WAF

CDN-WAF-API

Overview

DomainList

querySubDomainList

cdnWafRules

cdnWafConfig

cdnWafConfig