请求说明
更新时间：2025-08-07
公共请求头
| 名称 | 类型 | 是否必选 | 描述 | 示例值 |
|---|---|---|---|---|
version |
String |
是 | API接口的版本。取值参考具体业务的接口文档说明 | v2、v3 |
authorization |
String |
是 | 用于验证请求合法性，格式为： bce-auth-v2/{accessKeyId}/{date}/{region}/{service}/{signedHeaders}/{signature} accessKeyId： 是Access Key ID，请参看获取AK/SK来获取 date：签名的UTC日期，格式为yyyymmdd，例如：20150427。region：所请求服务资源所在的区域，小写格式。例如：bj。service：所请求的服务名称，小写格式。例如：bos。signedHeaders：签名算法中涉及到的HTTP头域列表。HTTP头域名字一律要求小写且头域名字之间用分号（;）分隔，如host;range;x-bce-date。列表按照字典序排列。当signedHeaders为空时表示取默认值。signature： 256位签名的十六进制表示，由64个小写字母组成。它由SK(Secret Access Key)和authStringPrefix哈希得到signingKey，再将canonicalRequest以signingKey为key进行哈希摘要生成。具体参考：鉴权认证 |
bce-auth-v1/ffab11fa2b5a4f698d159af2c23f556e/2024-06-06T03:00:20Z/1800/host/3fbe830c1e67389523e2ff09f47ec59c4ed723dcea22018569a3aec968cdfbe6 |
content-Type |
String |
是 | 指定数据传输的格式（MIME类型）。当前支持： |
|
x-bce-date |
String |
是 | 当服务器收到请求时，需要比较时间戳与当前服务器时间。当两者相差超过30分钟时，返回RequestExpired错误。这样可以在一定程度上防止重放。 表示日期的字符串，符合API规范。具体请参考日期与时间规范。 |
2015-04-27T08:23:49Z |
host |
String |
是 | 接口域名。 | bcc.bj.baidubce.com |
x-bce-content-sha256 |
String |
否 | 表示内容部分的SHA256签名的十六进制字符串。这里内容指HTTP Request Payload Body。即Content部分在被HTTP encode之前的原始数据。 |
公共响应头
| 名称 | 描述 | 示例值 |
|---|---|---|
Content-Type |
数据传输的格式 | application/json |
Transfer-Encoding |
传输编码 | chunked |
Date |
响应日期 | Fri, 01 Aug 2025 08:52:37 GMT |
Connection |
服务器是否断开连接，取值为close或者keep-alive |
keep-alive |
请求响应
Databuilder的响应体有统一的格式，如下表所示。当用户访问 API 出现错误时，会通过响应体中的code, message以及result来返回给用户相应的错误码和具体错误信息，便于用户定位问题，并做出适当的处理。
| 参数名称 | 类型 | 描述 |
|---|---|---|
requestId |
String |
请求ID |
code |
String |
响应码 |
message |
String |
当操作失败时，由该字段返回错误描述信息。当操作成功时不会返回该字段 |
result |
Object |
当操作成功时，根据接口功能返回类型的内容。当操作失败时不会返回该字段。 |
响应码与对应响应描述信息
| 响应码 | 描述 |
|---|---|
SUCCESS |
请求成功 |
InternalError |
内部非预期错误 |
AlreadyExists |
对象已存在 |
NotExists |
对象不存在 |
StillExists |
删除工作空间时仍然有工作流存在 |
IllegalArgument |
用户提供非法的参数 |
AccessDenied |
用户对当前资源没有权限 |
UploadFileError |
上传文件错误 |
BadRequest |
错误请求 |
CreateOrderError |
购买/升降配资源时下单失败 |