Overview

BBC (Baidu Baremetal Compute) is the high-performance baremetal compute that users can exclusively enjoy in the cloud environment. Users have full management privilege of the physical device, and can combine with EIP and BLB for the flexible networking and inteconnect with the BCC private network, to flexibly deal with the user’s business requirements in various complex scenarios, and readily build a private network hybrid cloud.

Before you use the API document, make sure you have some basic knowledge about BBC, includingProduct Description and Pricing。

If you are calling the API of Baidu AI Cloud product for the first time, you can watch theAPI Getting Started Video Guide to quickly capacity the method of calling the API.

Interface Use Specification

Normalized String

In general, a string can contain any Unicode character.This flexibility can bring a lot of a hassle in programming.Hence the concept of "canonical strings” is introduced.A specification string contains only percent coded Characters and URI (Uniform Resource Identifier) non-reserved Characters. RFC 3986 specifies that non-reserved URI characters include the following: letters (S-z, a-z), digits (0-9), hyphens (-), dot (.), underscores (_), tilde (~) The way to convert any string to a canonical string is:

• Converts the string to the byte string coded by UTF-8.
• Leave all URI non-reserved characters as the same.
• Perform Percent-Encoding on the rest of the bytes according to RFC 3986, that means a % is followed by two hexadecimal letters representing the byte value. All letters are capitalized. Example: The original string: this is an example for test, the corresponding normal string: this%20is%20an%20example%20for%20%E6%B5%8B%E8%AF%95。

Encoding Specification

• Resolvable content, and UTF-8 encoding is adopted for all request/response body contents at present. More encoding types will be supported later.

• When requesting, UrlEncode is required for the following:

  • Objectname, where "/" needs to be ignored when Resource is doing URLEncode.
  • Querystring的Value。
  • x-bce-copy-source（ignore“/”）。
  • Custom Meta:Meta Value only supports visible ASCII characters. If other characters are needed, UrlEncode processing is recommended.

Password Encryption and Transmission Specification

All interface parameters involving password need to be encrypted and plaintext transmission is prohibited. All passwords is encrypted with AES 128-bit encryption algorithm, and with the first 16 bits of SK as the key. The binary byte stream generated after encryption is converted to the hexadecimal and transmitted to the server in the form of string. The specific steps are as follows:

• byte[] bCiphertext= AES(Plaintext,SK)
• String strHex = HexStr(bCiphertext)

Date and Time

Date and time can be represented in many ways. For unification, unless it is established by convention or has corresponding specifications, all the date and time fields specified in the HTTP standard are expressed in GMT, and all other date and time fields are expressed in UTC time, following ISO 8601 and subject to the following restrictions:

• All dates should adopt the form ofYYYY-MM-DD, for example,2014-06-01is represented as 1 June, 2014.
• All time should adopt the form ofhh:mm:ssand add a capital Z at the end to indicate UTC time. For example,23:00:10Zindicates that UTC time is 23:0:10
• As to the combination of date and time, add the letter T between the two. For example2014-06-01T23:00:10Zindicate UTC time is 23:0:10 on 1 June, 2014.

Request Response Format Standard

• HTTP request, Key of the parameter in querystring, is camel case. Such as upLoadId, partNumber, etc.
• All user-defined Meta are placed in the Header in the form of x-bce-meta-*, The total size of the custom meta shall not exceed 2K.x-bce-meta-*key of will be processed by Server side in lowercase.

For example: if the user uploadsx-bce-meta-DeMo:valueusing the Putobject interface, the Server will uniformly handle it in lowercasex-bce-meta-demo:value, When the user uses the GetObject interface, the return value of the Sever side isx-bce-meta-demo:value。

• In addition to the standard Header specified in RFC2616, other Headers are defined in the form ofx-bce-*.
• In all JSON, Key is the camel mode with lowercase initial.
• Each request response hasx-bce-request-id and x-bce-debug-id.
• Relevant fields such as Date, Content-MD5, Content-Type, Content-Length in Header comply with RFC 2616.

• According to the HTTP protocol, Content-MD5 must be MD5 and Base64 encoded. The calculation method is as follows:

  Content-MD5 = "Content-MD5" ":" md5-digest md5-digest = <base64 of 128 bit MD5 digest as per RFC 1864>

Service domain Name

The domain names of BCC API service are as follows:

Public Request Header

Public Response Header

Error Code

In addition to the HTTP status code, the error information should also include the parameters in the following table in the HTTP body, as follows:

For example:

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

Common Error Code

BBC Business Error Code