Key terms and concepts
All Bitiful S4 buckets are directory buckets, roughly equivalent to the Directory Buckets recently introduced by Amazon AWS.
AWS built its latest high-performance S3 offering on them: S3 Express One Zone
Bucket
- A bucket is your dedicated space for storing objects. Every object must belong to a bucket. Buckets have various configuration properties, including region and access permissions.
- Bucket names are globally unique. Once you create a bucket with a given name, no other user can create a bucket with the same name.
- There is no limit on the storage capacity of a bucket.
- Bucket naming rules:
- Names can contain only lowercase letters a ~ z, digits 0 ~ 9, and hyphens (-).
- Names must begin and end with a letter or digit.
- Names must be between 4 ~ 63 characters long.
Object
An object is the basic unit of data storage in S4. In this documentation, "object," "file," and "Object" mean the same thing. An object consists of three parts: a key, data, and metadata.
- Key: The unique identifier of an object (file) within a bucket, consisting of its full path, including directories and extension. The bucket name plus the key form the URL used to access and operate on the object over the internet.
- Data: The actual content of the object, for example, the image itself.
- Metadata: Unlike a local file system, object storage has "metadata" that describes additional properties of an object (file).
- Object naming rules:
- Names must be UTF-8 encoded.
- Names must be between 1 and 696 characters long.
- Names cannot begin with a backslash ().
- The characters \a, \b, \t, \n, \v, \f, and \r are not supported.
- Non-printable ASCII characters 0 ~ 31 and 127 are not supported.
- Directory objects vs. file objects
- Directory objects are an S4-specific object type designed to bring native features such as Rename to high-performance scenarios.
- Directory object keys must end with a slash (/).
- Directory objects contain no actual binary data (the body is empty).
Example: the object https://somebucket.s3.bitiful.net/userFiles/000001.avatar
- The bucket name is: somebucket
- The key is: userFiles/000001.avatar
- The data is: the actual binary content of the image
- The metadata is: image/jpeg. In object storage, you don't need to rely on the file extension to determine the file type (MIME type). As long as the metadata specifies the type as "image/jpeg", browsers automatically recognize the object as an image when it's accessed.
Region
A region is the geographic location of the availability zone that hosts an S4 data center. Currently, only the China East 1 availability zone (cn-east-1) is available.
Sub-account (sub-user)
A sub-account is the smallest unit of permission management in Bitiful. You can set separate permissions on different buckets for each sub-account, and every AccessKey under a sub-account inherits all of that sub-account's permissions.
AccessKey
AccessKey (AK) is the collective term for an AccessKey ID and an AccessKey Secret. With an AccessKey, you can easily use Bitiful S4 from any S3-compatible third-party tool or SDK.