概述

BCE DRCDN API接口域名http://cdn.baidubce.com，所有接口统一使用/v2前缀，接口规范遵循BCE标准，采用HTTP协议通信，支持HTTP1.0/1.1。支持HTTP的PUT、POST、GET、DELETE请求方法。

通用约定

编码及数据格式

数据交换格式使用JSON格式，Content-Type为applicaton/json样式，所有request/response body内容均使用UTF-8编码。

日期与时间

日期与时间的表示有多种方式。为统一起见，除非是约定俗成或者有相应规范的，凡是HTTP标准中规定的表示日期和时间字段用GMT，其他日期时间表示的地方一律采用UTC时间，遵循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秒。

BCE CDN API与时间相关的数值类型统一采用上述格式，称为Timestamp类型。

规范化字符串

通常一个字符串中可以包含任何Unicode字符。在编程中这种灵活性会带来不少困扰。因此引入“规范字符串”的概念。一个规范字符串只包含百分号编码字符以及URI（Uniform Resource Identifier）非保留字符（Unreserved Characters）。 RFC 3986规定URI非保留字符包括以下字符：字母（A-Z，a-z）、数字（0-9）、连字号（-）、点号（.）、下划线（_）、波浪线（~）。 将任意一个字符串转换为规范字符串的方式是:

• 将字符串转换成UTF-8编码的字节流。
• 保留所有URI非保留字符原样不变。
• 对其余字节做一次RFC 3986中规定的百分号编码（Percent-Encoding），即一个%后面跟着两个表示该字节值的十六进制字母。字母一律采用大写形式。 示例： 原字符串：this is an example for 测试 对应的规范字符串：this%20is%20an%20example%20for%20%E6%B5%8B%E8%AF%95

在请求时，需要对Querystring的Value做UrlEncode，如下所示：

public static String uri-encode(CharSequence input, boolean encodeSlash) {
          StringBuilder result = new StringBuilder()
          for (int i = 0; i < input.length(); i++) {
              char ch = input.charAt(i);
              if ((ch >= 'A' && ch <= 'Z') || (ch >= 'a' && ch <= 'z') || (ch >= '0' && ch <= '9') || ch == '_' || ch == '-' || ch == '~' || ch == '.') {
                  result.append(ch)
              } else if (ch == '/') {
                  result.append(encodeSlash ? "%2F" : ch)
              } else {
                  result.append(toHexUTF8(ch))
              }
          }
          return result.toString()
}

编码规范

• 可解析内容，所有request/response body内容目前均使用UTF-8编码，后续会支持更多encoding类型。
• 在请求时，需要对QueryString的Value做UrlEncode。

签名认证

CDN API会对每个访问的请求进行身份认证，以保障用户的安全。安全认证采用Access Key与请求签名机制。Access Key由Access Key ID（简称AK）和Secret Access Key（简称SK）组成，均为字符串，由百度智能云官方颁发给用户。其中Access Key ID用于标识用户身份，Secret Access Key 是用于加密签名字符串和服务器端验证签名字符串的密钥，必须严格保密。

签名字符串格式

bce-auth-v{version}/{accessKeyId}/{timestamp}/{expireTime}/{signedHeaders}/{signature}

签名申请步骤

关于AK/SK的获取，请参看获取AK/SK。

签名生成算法

百度智能云采用统一的API鉴权认证机制，详情请见鉴权认证机制。

公共头

公共请求头域

CDN API服务需要在请求的HTTP头域中包含以下信息：

公共响应头域

错误信息格式

BCE CDN API的错误信息除了HTTP状态码以外，在HTTP body中还包JSON格式的错误信息，内容如下：

例如：

{ 
    "code":"IllegalRequestUrl", 
    "message":"The requested url belongs to domain which is not under acceleration",
    "requestId":" 81d0b05f-5ad4-1f22-8068-d5c9de60a1d7" 
}

通用错误码

除了后面各个接口单独列出的错误格式定义以外，BCE CDN API的通用错误码还包含但不限于以下形式：

省份、运营商格式