调用说明
更新时间:2024-03-21
概述
IBS API接口域名为ibs.baidubce.com
,接口规范遵循BCE标准,协议支持HTTP1.0/1.1、HTTPS。支持PUT、POST、GET、DELETE请求方法。
通用约定
编码及数据格式
数据交换格式使用JSON格式,Content-Type为applicaton/json样式,所有request/response body内容均使用UTF-8编码。
签名认证
IBS API会对每个访问的请求进行身份认证,以保障用户的安全。 安全认证采用Access Key与请求签名机制。Access Key由Access Key ID(简称AK)和Secret Access Key(简称SK)组成,均为字符串,由百度智能云官方颁发给用户。其中AK用于标识用户身份,SK是用于加密签名字符串和服务器端验证签名字符串的密钥,必须严格保密。生成的签名字符串字段Authorization,需要包含在API请求中。 在对IBS API请求时,在HTTP Header中包含认证字符串。
百度智能云目前支持两个签名版本:认证字符串版本v2和认证字符串版本v1,IBS的签名认证使用v1版本
签名字符串格式
bce-auth-v{version}/{accessKeyId}/{timestamp}/{expireTime}/{signedHeaders}/{signature}
签名申请步骤
关于AK/SK的获取,请参看获取AK/SK。
签名生成算法
百度智能云采用统一的API鉴权认证机制,详情请见鉴权认证机制。 使用常用工具快速生成签名请求,可以选择在线签名工具。
公共头
公共请求头域
IBS API服务需要在请求的HTTP头域中包含以下信息:
头域(Header) | 说明 | 是否必须 |
---|---|---|
host | http host | 是 |
Authorization | 签名字符串 | 是 |
x-bce-request-id | 用来跟踪调试的Id,为一个uuid字符 | 否 |
公共响应头域
头域(Header) | 说明 |
---|---|
x-bce-request-id | 对应请求的requestId |
Content-Type | application/json,charset=utf-8。一期编码只支持utf-8,所以charset是固定的。 |
错误信息格式
IBS API的错误信息除了HTTP状态码以外,在HTTP body中还包JSON格式的错误信息,内容如下:
参数名 | 类型 | 说明 |
---|---|---|
message | String | 有关该错误的详细说明 |