通用说明
更新时间：2024-05-30
API调用遵循HTTP协议，采用全局唯一域名，具体域名为cfw.baidubce.com。 数据交换格式为JSON，所有request/response body内容均采用UTF-8编码。
请求参数
请求参数包括如下4种：
| 参数类型 | 说明 |
|---|---|
| URI | 通常用于指明操作实体，如:GET /v1/cfw |
| Query参数 | URL中携带的请求参数 |
| HEADER | 通过HTTP头域传入，如:x-bce-date |
| RequestBody | 通过JSON格式组织的请求数据体 |
返回值说明
返回值分为两种形式：
| 返回内容 | 说明 |
|---|---|
| HTTP STATUS CODE | 如200、400、403、404等 |
| ResponseBody | JSON格式组织的响应数据体 |
API版本号
| 参数 | 类型 | 参数位置 | 描述 | 是否必选 |
|---|---|---|---|---|
| version | String | URL参数 | API版本号，当前 API 版本v1。 | 是 |
认证机制
所有API的安全认证一律采用Access Key与请求签名机制。 Access Key由Access Key ID和Secret Access Key组成，均为字符串。 对于每个HTTP请求，使用下面所描述的算法生成一个认证字符串。提交认证字符串放在Authorization头域里。服务端根据生成算法验证认证字符串的正确性。 认证字符串的格式为bce-auth-v{version}/{accessKeyId}/{timestamp}/{expirationPeriodInSeconds}/{signedHeaders}/{signature}。
- version是正整数，目前取值为1。
- timestamp是生成签名时的UTC时间。
- expirationPeriodInSeconds表示签名有效期限。
- signedHeaders是签名算法中涉及到的头域列表。头域名之间用分号（;）分隔，如host;x-bce-date。列表按照字典序排列。（本API签名仅使用host和x-bce-date两个header）
- signature是256位签名的十六进制表示，由64个小写字母组成。
鉴权认证机制的详细内容请参见鉴权认证。