Use S3-Compatible API

The OORT Storage S3 Gateway supports a API that is compatible with the basic data access model of the Amazon S3 API.

API Endpoint

The OORT Storage S3-Compatible API endpoint URL is:

Standard：https://s3-standard.oortech.com

Archive：https://s3-archive.oortech.com

Authentication

OORT Storage S3-Compatible API supports AWS v4 signature (AWS4-HMAC-SHA256) for authentication, supports AWS v2 signature, v4 signature is recommended.

Https Protocol

OORT Storage maintains strict https-only standards. This means that objects and API calls are only served over https. The port for this connection is the https standard port 443 . There is currently no way to disable this feature. Requests sent over the http protocol will be redirected to https.

Rate Limit

The OORT Storage S3-Compatible API has an effective rate limit of 100 RPS (requests per second).

Supported API Methods

Method Name	Method Description
CreateBucket	Creates a new bucket.
ListBuckets	Returns a list of all buckets owned by the authenticated sender of the request.
DeleteBucket	Deletes the bucket. All objects in the bucket must be deleted before the bucket itself can be deleted.
ListObjects	Returns some or all (up to 1,000) of the objects in a bucket. We recommend that you use the newer version, ListObjectsV2
ListObjectsV2	Returns some or all (up to 1,000) of the objects in a bucket.
GetObject	Retrieves objects from OORT Storage. To use GET, you must have READ access to the object.
HeadObject	The HEAD action retrieves metadata from an object without returning the object itself.
PutObject	Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object to it.
CopyObject	Creates a copy of an object that is already stored in OORT Storage.
DeleteObject	Delete an object from a bucket. If there isn't a null object, OORT Storage does not remove any objects but will still respond that the command was successful.
DeleteObjects	Delete an object from a bucket. If there isn't a null object, OORT Storage does not remove any objects but will still respond that the command was successful.
AbortMultipartUpload	This action aborts a multipart upload. After a multipart upload is aborted, no additional parts can be uploaded using that upload ID.
CreateMultipartUpload	This action initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload.
CompleteMultipartUpload	Completes a multipart upload by assembling previously uploaded parts.
UploadPart	Uploads a part in a multipart upload.
UploadPartCopy	Uploads a part by copying data from an existing object as data source.
GetSignedUrl	Supports pre-signed URLs for downloading and uploading objects.

When a response payload is present, all responses are returned using UTF-8 encoded XML.

Presigned URL

The OORT Storage S3-Compatible API supports pre-signed URLs for downloading and uploading objects. Presigned URLs can be generated in several ways, including the AWS CLI and AWS SDKs.