通用说明
更新时间：2025-02-18
通信协议
API 调用遵循 HTTPS 协议。
API服务域名
| 区域 | 服务端点Endpoint | 支持协议 |
|---|---|---|
| 全局 | qianfan.baidubce.com | HTTPS |
请求结构说明
数据交换格式为JSON，所有request/response body内容均采用UTF-8编码。
请求参数包括如下4种：
| 参数类型 | 说明 |
|---|---|
| URI | 通常用于指明操作实体,如:POST /v{version}/instance/{instanceId} |
| Query参数 | URL中携带的请求参数 |
| HEADER | 通过HTTP头域传入,如:x-bce-date |
| RequestBody | 通过JSON格式组织的请求数据体 |
响应结构说明
响应值分为两种形式：
| 返回内容 | 说明 |
|---|---|
| HTTP STATUS CODE | 如200,400,403,404等 |
| ResponseBody | JSON格式组织的响应数据体 |
公共请求头与公共响应头
公共请求头
| 参数名称 | 描述 | 是否必填 | 示例 |
|---|---|---|---|
| Authorization | 请求签名 格式为：Bearer <AppBuilder API Key> | 必须 | Bearer bce-v3/ALTAK-LLfggwDKNJ3mZJFtIMYP8/0d******55cdb5e8b319f93b00fffc584cex8 |
| Content-Type | application/json;charset=utf-8 通用数据交互格式（默认） multipart/form-data;charset=utf-8 支持图片、文件等上传，以及语音二进制流传输 text/event-stream;charset=utf-8 支持服务端向客户端推送服务、事件和消息通知的数据格式 | 必须 | application/json;multipart/form-data;text/event-stream; |
| x-bce-date | 表示日期的字符串 | 可选 | x-bce-date:2013-07-08T22%3A08%3A55Z 注意x-bce-date里面的冒号（:）已经被规范化成%3A。 |
| Host | 表示请求API的域名 | 可选 | host: qianfan.baidubce.com |
| User-Agent | 用户请求来源，SDK的请求，可由SDK指定对应的User-Agent。用户使用OpenAPI接入的情况，一般会被用户使用的工具自行填充。 | 可选 | python-requests/2.25.1(python) okhttp/4.10.0、ReactorNetty/1.0.17（java） curl/7.68.0（curl） appbuilder-sdk/0.4.1 |
HTTPS协议的标准头域不在这里列出。公共头域将在请求中出现。
公共响应头
| 参数名称 | 描述 |
|---|---|
| x-bce-request-id | 请求ID，后端生成，并自动设置到响应头域中 |
| Content-Type | application/json;charset=utf-8 text/event-stream;charset=utf-8 |
时间和日期规范
日期与时间的表示有多种方式。为统一起见，除非是约定俗成或者有相应规范的，凡需要日期时间表示的地方一律采用UTC时间，遵循ISO 8601，并做以下约束：
- 表示日期一律采用
YYYY-MM-DD方式，例如2014-06-01表示2014年6月1日。 - 表示时间一律采用
hh:mm:ss方式，并在最后加一个大写字母Z表示UTC时间。例如23:00:10Z表示UTC时间23点0分10秒。 - 凡涉及日期和时间合并表示时，在两者中间加大写字母T，例如
2014-06-01T23:00:10Z表示UTC时间2014年6月1日23点0分10秒。