API Call Method Download PDF Document

HTTPS protocol

All API interfaces of BaishanCloud use HTTPS protocol, providing a high-security communication channel

Request methods

Support restful request method such as POST、GET、DELETE、PUT, etc.

API Parameters

In addition to the specific parameters of each interface, you also need to bring authentication related parameters.
The current authentication method is as follows:

https+token
that is, put the token parameter in the querystring part of the URL

Character Encoding

BaishanCloud API requests and return results are all encoded using UTF-8 character set.

Request frequency

1. The request interface frequency of a single user (user-level frequency) defaults to 2 seconds and no more than 24 times.
2. A single interface will set different request frequencies according to its service type. The frequency upper limit has three types of control, include per minute, hour, and day. The specific number of times will be reflected in the response header of each interface, and the response header information can be seen in [response results] (#responsive results)

Response header

The response result is returned in the following public request headers, each header field indicates the request frequency and restriction information of the current interface
X-Ratelimit-Grad: Restriction type (there are three types per minute/hour/day, whichever comes first, which type is displayed here)
X-Ratelimit-Limit: The maximum number of API requests allowed in the current minute
X-Ratelimit-Remaining: The remaining number of API requests allowed in the current minute
X-Retry-After: Reset after this time

Sample Request:

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

Error code

Regardless of 4xx, 5xx, 2xx and other status codes (except for timeout and abnormal network disconnection), the response content will be returned in the following format.
When the code is 0, the request is executed normally and returned correctly.
When it is not 0, it is consistent with the corresponding status code, for example code=400

{
    "code": 0, //code = 0 means success, otherwise failed
    "data": {
        "id": "2729151231",
        "domain": "aa.com",
        "type": "page",
        "status": "deploying",
        "cname": "aa.com.qingcdn.com.",
        "config": {
            "origin": {
                "default_master": "1.1.1.1."
            }
        }
    }
}