Calling Conventions
Last Updated：2020-08-04
The data exchange format is JSON, and all request/response body contents are encoded in UTF-8. The IPs used in the URL parameters are expressed in dotted decimal.
Request Parameter
The request parameters include the 4 kinds below:
| Parameter Type | Description |
|---|---|
| URI | Generally used to indicate the operation entity, e.g. PUT / v1/ schedule/{ scheduleId}. |
| Query parameter | Request parameters carried in URL. |
| HEADER | Passed by the HTTP header, e.g. x-bce-date. |
| RequestBody | Request data body organized in JSON format. |
API Version Number
| Parameter | Type | Parameter position | Description | Required or not |
|---|---|---|---|---|
| version | String | Url parameter | The current API version is 2. | Yes |
Return Value Description
There are two types of return values:
| Return Content | Description |
|---|---|
| HTTP STATUS CODE | E.g. 200,400,403,404, etc. |
| ResponseBody | Response data body organized in JSON format. |
Common Header
Public Request Header
The Table below lists the public headers carried by all waf APIs. The standard header of the HTTP protocol is not listed here.
| HEADER | Required or not | Description |
|---|---|---|
| Authorization | Yes | Including Access Key and request signature. |
| Content-Type | Yes | application/json; charset=utf-8 |
| x-bce-date | No | A string representing the date conforms to the BCE API specification |
| Host | Yes | Represent the domain name of request API |
Public Response Header
The Table below lists the public response headers of all Waf APIs. The standard response header of the HTTP protocol is not listed here.
| HEADER | Description |
|---|---|
| Content-Type | Only support JSON format, application/json; charset=utf-8 |
| x-bce-request-id | Waf is backend generated and automatically set to the response header |
Previous
API Service Domain NameNext
Error Return