调用方式下载PDF文档

通信协议

白山云所有API接口均使用 HTTPS 进行通信，提供高安全性的通信通道。

请求方法

支持 POST、GET、DELETE、PUT等类restful风格的请求

请求参数

除各个接口特定的参数外, 还需带上签名相关参数.
目前签名方式如下:

https+token的方式, 即在url的querystring部分带上token参数

字符编码

白山云API的请求及返回结果均使用UTF-8字符集进行编码。

请求频率

单用户(用户级频率)请求接口频率默认为2秒不超过24次
单个接口根据其业务特性, 会设定不同的请求频率, 频次上限有每分钟、每小时、每天三个时间类型的控制。具体次数会体现在每次接口的响应头上，响应头信息可见响应结果

响应结果

响应结果以如下公共请求头返回, 各头字段注明了当前接口的请求频次及限制信息
X-Ratelimit-Grad: 限制类型(有每分钟/每小时/每天三个类型, 哪个先到, 这里就显示哪个类型)
X-Ratelimit-Limit: 当前分钟api允许请求的次数上限
X-Ratelimit-Remaining: 当前分钟api剩余的请求次数
X-Retry-After: 在几秒后重置次数

请求头示例如下:

HTTP/1.0 200 OK
Api-Id:                100438085
Content-Type:          application/json; charset=utf-8
X-Ratelimit-Grad:      minute
X-Ratelimit-Limit:     100
X-Ratelimit-Remaining: 100
X-Retry-After:         1

错误码

不论4xx, 5xx, 2xx等状态码(超时和网络异常断开除外),
响应内容部分统一会返回如下格式.
其中code为0时表示请求正常执行并正确返回.
非0时, 与对应状态码的4xx保持一致, 例如code=400

{
    "code": 0, //code为0，表示数据返回正常，非0时则不正常
    "data": {
        "id": "2729151231",
        "domain": "aa.com",
        "type": "page",
        "status": "deploying",
        "cname": "aa.com.qingcdn.com.",
        "config": {
            "origin": {
                "default_master": "1.1.1.1."
            }
        }
    }
}

调用方式 下载PDF文档