如何调用Web应用防火墙接口-阿里云帮助中心

Web应用防火墙接口调用是向WAF API的服务端地址发送HTTP GET请求，并按照接口说明在请求中加入相应请求参数，调用后系统会返回处理结果。请求及返回结果都使用UTF-8字符集编码。

请求结构

Web应用防火墙的API是RPC风格，您可以通过发送HTTP GET请求调用WAF API。

其请求结构如下：

https://Endpoint/?Action=xx&Parameters

其中：

Endpoint：根据WAF实例所属的地域选择适合的API服务接入地址。
- 中国内地：wafopenapi.cn-hangzhou.aliyuncs.com
- 非中国内地：wafopenapi.ap-southeast-1.aliyuncs.com
Action：要执行的操作，如使用DescribeDomainNames查询已添加的域名名称列表。
Version：要使用的API版本，WAF的API版本是2019-09-10。
Parameters：请求参数，每个参数之间用“&”分隔。
请求参数由公共请求参数和API自定义参数组成。公共参数中包含API版本号、身份验证等信息，详情请参见公共参数。

下面是一个调用DescribeDomainNames接口查询指定WAF实例中已添加的域名名称列表的示例：

说明

为了便于用户查看，本文档中的示例都做了格式化处理。

https://wafopenapi.cn-hangzhou.aliyuncs.com/?Action=DescribeDomainNames
&Region=cn
&InstanceId=waf_elasticity-cn-0xldbqtm005
&Format=xml
&Version=2019-09-10
&Signature=xxxx%xxxx%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=**********
&TimeStamp=2012-06-01T12:00:00Z
…

API授权

为了确保您的账号安全，建议您使用子账号的身份凭证调用API。如果您使用RAM账号调用WAF API，您需要为该RAM账号创建、附加相应的授权策略。

API签名

WAF服务会对每个API请求进行身份验证，无论使用HTTP还是HTTPS协议提交请求，都需要在请求中包含签名（Signature）信息。

WAF通过使用AccessKey ID和AccessKey Secret进行对称加密的方法来验证请求的发送者身份。AccessKey是为阿里云账号和RAM用户发布的一种身份凭证（类似于用户的登录密码），其中AccessKey ID用于标识访问者的身份，AccessKey Secret是用于加密签名字符串和服务器端验证签名字符串的密钥，必须严格保密。

RPC API需按如下格式在请求中增加签名（Signature）：

https://endpoint/?SignatureVersion=1.0&SignatureMethod=HMAC-SHA1&Signature=CT9X0VtwR86fNWSnsc6v8YGOjuE%3D&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf

以DescribeDomainNames为例，则签名前的请求URL如下：

https://wafopenapi.cn-hangzhou.aliyuncs.com/?Action=DescribeDomainNames
&Region=cn
&InstanceId=waf_elasticity-cn-0xldbqtm005
&TimeStamp=2016-02-23T12:46:24Z
&Format=XML
&AccessKeyId=testid
&SignatureMethod=HMAC-SHA1
&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf
&Version=2019-09-10
&SignatureVersion=1.0

完成以下步骤计算签名：

使用请求参数创建待签名字符串：

GET&%2F&AccessKeyId%****************DomainNames&Region%3Dcn&InstanceId%3Dwaf_elasticity-cn-0xldbqtm005&Format%3DXML&SignatureMethod%3DHMAC-SHA1&SignatureNonce%3D3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&SignatureVersion%3D1.0&TimeStamp%3D2016-02-23T12%253A46%253A24Z&Version%3D2019-09-10

计算待签名的HMAC的值。
在AccessKey Secret后添加一个“&”作为计算HMAC值的key。本示例中的key为testsecret&。
```
CT9X0VtwR86fNWSnsc6v8YGOjuE=
```

将签名加到请求参数中：

https://wafopenapi.cn-hangzhou.aliyuncs.com/?Action=DescribeDomainNames
&Region=cn
&InstanceId=waf_elasticity-cn-0xldbqtm005
&TimeStamp=2016-02-23T12:46:24Z
&Format=XML
&AccessKeyId=***********
&SignatureMethod=HMAC-SHA1
&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf
&Version=2019-09-10
&SignatureVersion=1.0
&Signature=CT9X0VtwR86fNWSnsc6v8YGOjuE%3D