调用规范
更新时间：2025-08-22
数据交换格式为JSON，所有request/response body内容均采用UTF-8编码。URL参数中所使用的IP均使用点分十进制表示。
请求参数
请求参数包括如下4种：
| 参数类型 | 说明 |
|---|---|
| URI | 通常用于指明操作实体,如:PUT /v1/schedule/{scheduleId} |
| Query参数 | URL中携带的请求参数 |
| HEADER | 通过HTTP头域传入,如:x-bce-date |
| RequestBody | 通过JSON格式组织的请求数据体 |
API版本号
| 参数 | 类型 | 参数位置 | 描述 | 是否必须 |
|---|---|---|---|---|
| version | String | Url参数 | 当前API版本为2 | 是 |
返回值说明
返回值分为两种形式：
| 返回内容 | 说明 |
|---|---|
| HTTP STATUS CODE | 如200,400,403,404等 |
| ResponseBody | JSON格式组织的响应数据体 |
公共头
公共请求头
下表列出了所有waf API所携带的公共头域。HTTP协议的标准头域不在此处列出
| 头域（HEADER） | 是否必须 | 说明 |
|---|---|---|
| Authorization | 是 | 包含Access Key与请求签名 |
| Content-Type | 是 | application/json; charset=utf-8 |
| x-bce-date | 否 | 表示日期的字符串，符合BCE API规范 |
| Host | 是 | 表示请求API的域名 |
公共响应头
下表列出了所有Waf API的公共响应头域。HTTP协议的标准响应头域不在此处列出
| 头域（HEADER） | 说明 |
|---|---|
| Content-Type | 只支持JSON格式，application/json; charset=utf-8 |
| x-bce-request-id | Waf后端生成，并自动设置到响应头域中 |