接口规范
更新时间:2021-08-23
请求响应格式标准
- HTTP请求,Querystring中参数的Key,为首字母小写的驼峰方式。如 productType,serviceType等。
- 除RFC2616规定的标准Header外,其他Header以x-bce-*的形式定义。
- 财务系统的RESTful API支持仅支持JSON形式。
- 所有JSON中,Key均为首字母小写的驼峰方式。
- Header中Date、Content-MD5、Content-Type、Content-Length等相关字段遵守RFC 2616约束。
- 依据HTTP协议的规定,Content-MD5既要做MD5也要进行Base64编码,其计算方法如下: Content-MD5 = "Content-MD5" ":" md5-digest md5-digest = <base64 of 128 bit MD5 digest as per RFC 1864>
公共请求头
头域 | 说明 | 是否必须 |
---|---|---|
Authorization | 用于验证请求合法性的认证信息。更多参见鉴权认证 | 必须 |
x-bce-date | 该请求创建的时间,表示日期一律采用YYYY-MM-DD方式,例如2014-06-01表示2014年6月1日。如果用户使用了标准的Date域,该头域可以不填。当两者同时存在时,以x-bce-date为准。 | 可选 |
Content-Length | RFC2616中定义的HTTP请求内容的长度 | 可选 |
Content-Type | RFC2616中定义的HTTP请求内容的类型 | 可选 |
Content-MD5 | RFC2616定义的HTTP请求内容的MD5摘要 | 可选 |
Date | HTTP 1.1协议中规定的GMT时间,如Wed, 06 Apr 2016 06:34:40 GMT |
可选 |
Host | 访问Host值,取值为billing.baidubce.com |
可选 |
公共响应头
名字 | 类型 | 描述 |
---|---|---|
Content-Length | String | RFC2616中定义的HTTP请求内容长度。 |
Content-Type | String | RFC2616中定义的HTTP请求内容的类型。 |
Connection | String | 服务器是否断开连接,取值为close 或者keep-alive 。 |
Date | String | HTTP 1.1协议中规定的GMT时间,如Wed, 06 Apr 2016 06:34:40 GMT 。 |
x-bce-request-id | String | 由财务服务创建,是请求Bce Billing的唯一标识,用于帮助排除故障的标识ID,如果在使用财务服务过程中遇到问题,可以在工单中提供该字段便于快速定位问题 |
其中,request id使用UUID version4由财务服务生成。