接口规范
更新时间：2024-09-06
调用方式
API 调用遵循 HTTP/HTTPS 协议，各 Region 采用不同的域名，例如：华北-北京的具体域名为http(s)://bls-log.bj.baidubce.com。 数据交换格式为JSON，所有 request/response body内容均采用 UTF-8 编码。
认证机制
所有的 API 通过 AK（Access Key ID）/SK（Secret Access Key）完成请求签名以通过服务端的鉴权和认证。鉴权认证机制的详细内容请参见鉴权认证机制。
公共请求头域
BLS API 采用 Restful 风格，公共请求头域适用于所有 API 请求，具体定义如下：
| Header | 类型 | 说明 |
|---|---|---|
| Authorization | String | 用于验证请求合法性的认证信息。更多参见鉴权认证 |
| Host | String | 访问 Host 值，例如：bls-log.{region}.baidubce.com |
| Content-Type | String | RFC 2616 中定义的 HTTP 请求内容类型，目前 BLS API 请求只支持 application/json |
| Content-Length | Int | RFC 2616 中定义的 HTTP 请求内容长度 |
| X-Bce-Date | String | 表示日期的字符串 |
| X-Bce-Request-Id | String | 本次请求的 request id |
| X-Bce-Security-Token | String | 当使用 STS 临时身份发送数据时该项必填，其他情况不要填写 |
| X-Region | String | 请求访问的地域 |
作为示例，下面是一个标准的用户查询日志集详情的请求头域内容:
GET /v1/logstore/demo HTTP/1.1
X-Bce-Date: 2019-09-04T13:04:26Z
Host: bls-log.bj.baidubce.com
Content-Type: application/json
Authorization:bce-auth-v1/18717522d39411e9b721df098b0b908c/2019-09-10T07:00:20Z/1800/content-type;host;x-bce-date;x-bce-request-id/6a7cb6c9ac7ec156c805e55e7d0bcfc443b47feee97cf099c1c0d9公共响应头域
BLS API 采用 Restful 风格，公共响应头域适用于所有 API 请求，具体定义如下：
| Header | 类型 | 说明 |
|---|---|---|
| Content-Type | String | RFC 2616 中定义的 HTTP 响应内容类型，目前 BLS API 请求只支持 application/json |
| Content-Length | Int | RFC 2616 中定义的 HTTP 请求内容长度 |
| x-Bce-Request-Id | String | 服务端返回的请求 ID，用于追踪和定位问题，用户提交工单时可以提供该 ID |