开发前必读
更新时间:2021-01-11
前置任务
- 您必须先注册百度智能云账号(若没有百度智能云账号),并完成企业认证。
- 舆情API的调用服务必须部署在百度智能云BCC虚拟机上。用户需要先申请北京地区BCC虚拟机资源并创建实例,随后远程登录BCC编写代码调用舆情API服务接口。 BCC资源申请与操作指南 如有疑问可联系工作人员处理。
开发者规范
通用约定
- 所有编码都采用UTF-8
- 日期格式采用yyyy-MM-dd方式,如2015-08-10
-
Content-type为application/x-www-form-urlencoded
- object类型的key必须使用双引号(")括起来
公共请求头
头域(Header) | 是否必须 | 说明 |
---|---|---|
Authorization | 必须 | 包含Access Key与请求签名 |
Host | 必须 | 包含API的域名 |
Content-Type | 可选 | application/x-www-form-urlencoded |
公共响应头
头域(Header) | 说明 |
---|---|
Content-Type | application/x-www-form-urlencoded |
x-bce-request-id | 舆情服务后端生成,并自动设置到响应头域中 |
响应状态码
返回的响应状态码遵循RFC 2616 section 6.1.1
- 1xx: Informational - Request received, continuing process.
- 2xx: Success - The action was successfully received, understood, and accepted.
- 3xx: Redirection - Further action must be taken in order to complete the request.
- 4xx: Client Error - The request contains bad syntax or cannot be fulfilled.
- 5xx: Server Error - The server failed to fulfill an apparently valid request.
通用错误返回格式
当调用接口出错时,将返回通用的错误格式。HTTP的返回状态码为4xx或5xx,返回的消息体将包括全局唯一的请求、错误代码以及错误信息。调用方可根据错误码以及错误信息定位问题,当无法定位到错误原因时,可以发工单联系百度技术人员,并提供requestId以便于快速地帮助您解决问题。
消息体定义
参数名 | 类型 | 说明 |
---|---|---|
requestId | String | 请求的唯一标识 |
code | String | 错误类型代码 |
message | String | 错误的信息说明 |
错误返回示例
{
"requestId": "47e0ef1a-9bf2-11e1-9279-0100e8cf109a",
"code":"NoSuchKey",
"message":"The resource you requested does not exist"
}
公共错误码
Code | Msg |
---|---|
101 | Token错误或过期 |
200 | 请求成功 |
401 | 缺少必要参数 |
402 | 参数解析错误 |
501 | 系统错误 |
502 | Taskid不存在 |
503 | 用户权限错误 |
504 | 用户过时 |
505 | 用户容器数量溢出 |
506 | 无权限查看该任务 |
507 | 存在大词 |
508 | Api未开放 |