API版本号

实名认证

使用BEC API的用户需要完成个人认证以及企业认证，没有通过认证的可以前往百度智能云官网控制台中去进行认证。如果用户没有通过认证，是不能使用BEC相关服务的。

API认证机制

所有API的安全认证一律采用Access Key与请求签名机制。 Access Key由Access Key ID和Secret Access Key组成，均为字符串。 对于每个HTTP请求，使用下面所描述的算法生成一个认证字符串。提交认证字符串放在Authorization头域里。服务端根据生成算法验证认证字符串的正确性。 认证字符串的格式为bce-auth-v{version}/{accessKeyId}/{timestamp}/{expirationPeriodInSeconds}/{signedHeaders}/{signature}

• version是正整数。
• timestamp是生成签名时的UTC时间。
• expirationPeriodInSeconds表示签名有效期限。
• signedHeaders是签名算法中涉及到的头域列表。头域名之间用分号（;）分隔，如host;x-bce-date。列表按照字典序排列。（本API签名仅使用host和x-bce-date两个header）
• signature是256位签名的十六进制表示，由64个小写字母组成。

当百度智能云接收到用户的请求后，系统将使用相同的SK和同样的认证机制生成认证字符串，并与用户请求中包含的认证字符串进行比对。如果认证字符串相同，系统认为用户拥有指定的操作权限，并执行相关操作；如果认证字符串不同，系统将忽略该操作并返回错误码。

鉴权认证机制的详细内容请参见鉴权认证。

通信协议

BEC API支持HTTP和HTTPS两种方式。为了提升数据安全性，建议通过HTTPS调用。

请求结构说明

数据交换格式为JSON，所有request/response body内容均采用UTF-8编码。

请求参数包括如下4种：

响应结构说明

响应值分为两种形式

幂等性

当调用创建接口时如果遇到了请求超时或服务器内部错误，用户可能会尝试重发请求，这时用户通过clientToken参数避免创建出比预期要多的资源，即保证请求的幂等性。

幂等性基于clientToken，clientToken是一个长度不超过64位的ASCII字符串，通常放在query string里，如POST /v2/vm/instance?clientToken=be31b98c-5e41-4838-9830-9be700de5a20

如果用户使用同一个clientToken值调用创建接口，则服务端会返回相同的请求结果。因此用户在遇到错误进行重试的时候，可以通过提供相同的clientToken值，来确保只创建一个资源；如果用户提供了一个已经使用过的clientToken，但其他请求参数（包括queryString和requestBody）不同甚至url Path不同，则会返回IdempotentParameterMismatch的错误代码。

clientToken的有效期为24小时，以服务端最后一次收到该clientToken为准。也就是说，如果客户端不断发送同一个clientToken，那么该clientToken将长期有效。

密码加密传输规范

所有涉及密码的接口参数都需要加密，禁止明文传输。密码一律采用AES 128位加密算法进行加密，用SK的前16位作为密钥，加密后生成的二进制字节流需要转成十六进制，并以字符串的形式传到服务端。

需要使用BEC加密接口，传入密码明文的十六进制编码(rawHex)和账户ID(userId，非必传，不指定则默认当前账户)，将加密接口返回的accessKeyId传入BEC业务接口X-Bce-Accesskey header，返回的cipherHex传入BEC接口密码参数。

1POST /v2/ciphers/encrypt
2{
3    "rawHex": "密码明文的十六进制编码",
4    "userId": "账户ID，非必传，不指定则默认当前账户"
5}
6
7===>
8HTTP/1.1 200
9{
10    "accessKeyId":"accessKeyId",
11    "cipherHex":"密文"
12}

时间与日期规范

日期与时间的表示有多种方式。为统一起见，除非是约定俗成或者有相应规范的，凡需要日期时间表示的地方一律采用UTC时间，遵循ISO8601，并做以下约束：

1. 表示日期一律采用YYYY-MM-DD方式，例如2025-08-05表示2025-08-05
2. 表示时间一律采用hh:mm:ss方式，并在最后加一个大写字母Z表示UTC时间。例如23:00:10Z表示UTC时间23点0分10秒。
3. 凡涉及日期和时间合并表示时，在两者中间加大写字母T，例如2025-08-05T23:00:10Z表示UTC时间2025-08-0523点0分10秒。