CDN-WAF-API
更新时间：2024-04-19
Overview
描述
查询用户的 CDN-WAF 实例
请求结构
Plain Text
1 GET /v{version}/cdnwaf/overview?clientToken={clientToken} HTTP/1.1
2 Host: bss.bj.baidubce.com
3 Authorization: authorization string请求头域
除公共头域外，无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值2 |
| clientToken | String | 是 | Query参数 | 幂等性Token，详见幂等性 |
返回状态码
成功返回200，失败返回见错误码
返回头域
除公共头域外，无其他特殊头域
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| wafList | List<CdnWafInstance> | 用户所有的cdn-waf实例列表 |
请求示例
Plain Text
1 GET /v2/cdnwaf/overview?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
2 HOST bss.bj.baidubce.com
3 Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02响应示例
Plain Text
1 HTTP/1.1 200 OK
2 x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3 Date: Wed, 10 Apr 2016 08:26:52 GMT
4 Transfer-Encoding: chunked
5 Content-Type: application/json;charset=UTF-8
6 Server: BWS
7 {
8 "wafList": [
9 {
10 "wafName": "NAME", //WAF实例的名称
11 "wafId": "WAFID", //WAF实例的ID
12 "status": "STATUS", //WAF实例的状态，见附录InstanceStatus
13 "autoRenew": "true", //是否自动续费，true:是|false:否
14 "domain": "demo.com", //绑定的主域名
15 "subDomain": { //已配可配子域名数量
16 "used": 0, //已配子域名数量
17 "total": "10" //可配子域名数量
18 },
19 "productType": "postpay", //计费方式，postpy:后付费|prepay:预付费
20 "expireTime": "2022-06-06T06:10:00Z"，//服务过期时间
21 "subDomainConfig": {
22 "customSwitch": "0", //子域名自定义防护开关,0:关闭|1:开启
23 "subDomain": "test", //子域名
24 "webSwitch": "0", //子域名web防护开关,0:关闭|1:开启
25 },
26 "webDomainCloseN": 0, //关闭web防护的子域名数量
27 "webDomainOpenN": 8, //开启web防护的子域名数量
28 "customDomainCloseN": 1, //关闭自定义防护子域名数量
29 "customDomainOpenN": 7, //开启自定义防护域名数量
30 },
31 {...},
32 ],
33 "totalCount": 100 //总条目数
34 }DomainList
接口描述
- 返回用户所有的主域名列表
请求结构
Plain Text
1 GET /v{version}/cdnwaf/domainList?clientToken={clientToken} HTTP/1.1
2 Host: bss.bj.baidubce.com
3 Authorization: authorization string请求头域
除公共头域外，无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值2 |
| clientToken | String | 是 | Query参数 | 幂等性Token，详见幂等性 |
返回状态码
成功返回200，失败返回见错误码
返回头域
除公共头域外，无其他特殊头域
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| domainList | List |
主域名列表 |
请求示例
Plain Text
1 GET /v2/cdnwaf/domainList?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
2 HOST bss.bj.baidubce.com
3 Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02响应示例
Plain Text
1 HTTP/1.1 200 OK
2 x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3 Date: Wed, 10 Apr 2016 08:26:52 GMT
4 Transfer-Encoding: chunked
5 Content-Type: application/json;charset=UTF-8
6 Server: BWS
7 {
8 "domainList": [
9 {
10 "domain": "demo.com", //CDN中的主域名
11 },
12 {...},
13 ]
14 } querySubDomainList
接口描述
- 查询符合主域名且未添加到其他waf实例的可用子域名列表，或者该waf实例绑定的子域名
请求结构
Plain Text
1 PUT /v{version}/cdnwaf/querySubDomainList/{waf_id}?clientToken={clientToken} HTTP/1.1
2 Host: bss.bj.baidubce.com
3 Authorization: authorization string
4 {
5 "domain": "demo.com", //CDN 中的主域名
6 } 请求头域
除公共头域外，无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值2 |
| domain | String | 是 | Request Body参数 | 域名 |
| clientToken | String | 是 | Query参数 | 幂等性Token，详见幂等性 |
返回状态码
成功返回200，失败返回见错误码
返回头域
除公共头域外，无其他特殊头域
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| subDomainList | List |
返回用户可用的子域名列表， subDomain是子域名称，status是子域名状态 |
请求示例
Plain Text
1 PUT /v2/cdnwaf/querySubDomainList/waf-3a4b5c?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
2 HOST bss.bj.baidubce.com
3 Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
4 {
5 "domain": "demo.com",
6 } 响应示例
Plain Text
1 HTTP/1.1 200 OK
2 x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3 Date: Wed, 10 Apr 2016 08:26:52 GMT
4 Transfer-Encoding: chunked
5 Content-Type: application/json;charset=UTF-8
6 {
7 "subDomainList": [
8 {
9 "subDomain": "a.demo.com", //cdn中的子域名
10 "status": "1", //子域名状态,0:未添加|1:已添加到该waf实例
11 },
12 {...},
13 ]
14 }cdnWafRules
接口描述
查询CDN WAF实例可配置的子域名和自定义规则数，需要指定waf的标志符、需要指定cdn的主域名
请求结构
Plain Text
1 GET /v{version}/cdnwaf/cdnWafRules/{waf_id}?clientToken={clientToken} HTTP/1.1
2 Host: bss.bj.baidubce.com
3 Authorization: authorization string
4 {
5 "domain": "demo.com", //CDN 中的主域名
6 } 请求头域
除公共头域外，无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值2 |
| clientToken | String | 是 | Query参数 | 幂等性Token，详见幂等性 |
返回状态码
成功返回200，失败返回见错误码
返回头域
除公共头域外，无其他特殊头域
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| domainSum | Int | 子域名数 |
| ruleSum | Int | 规则数 |
请求示例
Plain Text
1 GET /v2/cdnwaf/cdnWafRules/waf-3a4b5c?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
2 HOST bss.bj.baidubce.com
3 Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02响应示例
Plain Text
1 HTTP/1.1 200 OK
2 x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3 Date: Wed, 10 Apr 2016 08:26:52 GMT
4 Transfer-Encoding: chunked
5 Content-Type: application/json;charset=UTF-8
6 {
7 "domainSum": DOMAINSUM, //子域名数,int型:10|20|30|40|50
8 "ruleSum": RULESUM, //规则数,int型:20|40|60|80|100
9 } cdnWafConfig
接口描述
用于对 CDN-WAF 实例下发规则配置。
请求结构
Plain Text
1 PUT /v{version}/cdnwaf/cdnWafConfig/{waf_id}?clientToken={clientToken}
2 Host: bss.bj.baidubce.com
3 Authorization: authorization string
4 {
5 "baseConfig": { //基本配置信息
6 "domain": "demo.com", //主域
7 },
8 "subDomainConfigList": [ //子域名配置信息
9 {
10 "subDomain": "test.baidu.com", //子域名
11 "subDomainPrefix": "test", //子域名前缀
12 "webSwitch": "0|1", //web防护开关,0:关闭|1:开启
13 "webPolicy": "high|middle|low", //策略等级
14 "webType": "log|deny", //执行的策略
15 "ccDefenseSwitch": 1, //自定义防护开关，0关闭｜1开启
16 "ccDefenseTemplateId": 1, //防护模版id
17 },
18 {...},
19 ]
20 } 请求头域
除公共头域外，无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| 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，失败返回见错误码
返回头域
除公共头域外，无其他特殊头域
返回参数
无特殊返回参数
请求示例
Plain Text
1 PUT /v2/cdnwaf/cdnWafConfig/waf-3a4b5c?clientToken=be31b98c-5e41-4838-9830-9be700de5a20
2 Host bss.bj.baidubce.com
3 Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
4 {
5 {
6 "baseConfig": { //基本配置信息
7 "domain": "demo.com", //主域
8 },
9 "subDomainConfigList": [ //子域名配置信息
10 {
11 "subDomain": "test.baidu.com" //子域名
12 "subDomainPrefix": "test", //子域名前缀
13 "webPolicy": "high", //策略等级
14 "webType": "log", //执行的策略,log:观察模式|deny:拦截模式
15 "webSwitch": 1, //web防护开关,0:关闭|1:开启
16 "ccDefenseSwitch": 1, //自定义防护开关，0关闭｜1开启
17 "ccDefenseTemplateId": 1, //防护模版id
18 },
19 {...},
20 ]
21 }
22 } 响应示例
Plain Text
1 HTTP/1.1 200 OK
2 x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3 Date: Wed, 10 Apr 2016 08:26:52 GMT
4 Transfer-Encoding: chunked
5 Content-Type: application/json;charset=UTF-8cdnWafConfig
接口描述
用于查询 CDN-WAF 的规则配置。
请求结构
Plain Text
1 GET /v{version}/cdnwaf/cdnWafConfig/{waf_id}?clientToken={clientToken}
2 Host: bss.bj.baidubce.com
3 Authorization: authorization string请求头域
除公共头域外，无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值2 |
| waf_id | String | 是 | URL参数 | WAF标志符 |
| clientToken | String | 是 | Query参数 | 幂等性Token，详见幂等性 |
返回状态码
成功返回200，失败返回见错误码
返回头域
除公共头域外，无其他特殊头域
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| baseConfig | Object | waf配置基本信息，具体字段详见响应示例 |
| subDomainConfigList | List |
waf配置子域名列表及其对应配置信息，具体字段详见响应示例 |
请求示例
Plain Text
1 GET /v2/cdnwaf/cdnWafConfig/waf-3a4b5c?clientToken=be31b98c-5e41-4838-9830-9be700de5a20
2 Host bss.bj.baidubce.com
3 Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02响应示例
Plain Text
1 HTTP/1.1 200 OK
2 x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3 Date: Wed, 10 Apr 2016 08:26:52 GMT
4 Transfer-Encoding: chunked
5 Content-Type: application/json;charset=UTF-8
6 {
7 "baseConfig": { //基本配置信息
8 "createTime": "2021-07-05T11:12:21Z", //实例创建时间
9 "domain": "dome.com", //主域
10 "expireTime": "2022-06-05T11:12:21Z", //服务过期时间
11 "name": "WAF-541f2a75", //实例名称
12 "productType": "prepay", //计费类型 prepay:预付费，postpay:后付费
13 "region": "global", //资源地域,CDN-WAF 资源地域统一为 global
14 "status": "available", //WAF实例状态
15 },
16 "subDomainConfigList": [ //子域名配置信息
17 {
18 “subDomain”: "test.baidu.com" //子域名
19 "subDomainPrefix": "test", //子域名前缀
20 "webPolicy": "high", //自定义策略等级,high|middle|low
21 "webType": "log", //执行的策略：log:观察模式|deny:拦截模式
22 "ccDefenseSwitch": 1, //自定义防护开关，0关闭｜1开启
23 "ccDefenseTemplateId": 1, //防护模版id
24 "webSwitch": 1, //web防护开关,0:关闭|1:开启
25 },
26 {...},
27 ]
28 }