通用说明
更新时间:2026-06-17
API认证机制
所有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个小写十六进制字符组成
当百度智能云接收到用户的请求后,系统将使用相同的SK和同样的认证机制生成认证字符串,并与用户请求中包含的认证字符串进行比对。如果认证字符串相同,系统认为用户拥有指定的操作权限,并执行相关操作;如果认证字符串不同,系统将拒绝该操作并返回错误码。
鉴权认证机制的详细内容请参见鉴权认证。
请求结构说明
数据交换格式为JSON,所有request/response body内容均采用UTF-8编码。
请求参数包括如下4种:
| 参数类型 | 说明 |
|---|---|
| URI | 通常用于指明操作实体,如:POST /v{version}/instance/{instanceId}。 |
| Query参数 | URL中携带的请求参数。 |
| HEADER | 通过HTTP头域传入,如:x-bce-date。 |
| RequestBody | 通过JSON格式组织的请求数据体。 |
响应结构说明
响应值分为两种形式:
| 返回内容 | 说明 |
|---|---|
| Status-Code | 如 200,400,403,404等。 |
| ResponseHeader | 接口返回结果的 header。 |
| ResponseBody | JSON格式组织的响应数据体。 |
API版本号
| 参数 | 类型 | 参数位置 | 描述 | 是否必须 |
|---|---|---|---|---|
| version | String | URL参数 | API版本号,当前值为2。 | 是 |
公共请求头
所有 API 携带的公共头域如下。HTTP 协议的标准头域不在此处列出。
| 头域(Header) | 说明 |
|---|---|
| Authorization | 详见认证机制。 |
| Content-Type | application/json; charset=utf-8。 |
| host | 服务域名。 |
| x-bce-date | 表示日期的字符串,符合API规范。具体请参考日期与时间规范。 |
公共响应头
| 头域(Header) | 说明 |
|---|---|
| Content-Type | application/json; charset=utf-8。 |
| x-bce-request-id | 对应请求的requestId。 |
日期与时间
日期与时间的表示有多种方式。为统一起见,除非是约定俗成或者有相应规范的,凡需要日期时间表示的地方一律采用UTC+0时间,遵循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秒。
评价此篇文章
