Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
s3compatibleapi [2018_01_30 22:35] – [7 Useful Apps] steven | s3compatibleapi [2023_06_22 05:41] – external edit 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== | + | # Amazon S3 compatible API |
- | We provide | + | The Enterprise File Fabric provides |
- | For those interested, moving from a file based structure to a flat file object structure was achieved using the [[http:// | + | The S3 API is available on the SaaS hosted service and also on the enterprise on-premises edition of the product. |
- | Below is a practical implementation of using the S3 API. | + | ## Client Configuration |
- | ===== 1 Setting up an S3 Tool to work with SMEStorage ===== | + | To use the S3 API the: |
+ | 1. Cloud S3 Endpoint | ||
+ | 2. Access Key ID | ||
+ | 3. Secret Access Key | ||
+ | are required. | ||
- | {{:/ | + | ### 1. Cloud S3 Endpoint |
- | Lets look at a practical implementation | + | For the SaaS hosted service it is required to use one of the following |
+ | * http:// | ||
+ | * https:// | ||
+ | * http:// | ||
+ | * https:// | ||
- | ===== 2 Creating a New Account ===== | + | Naturally http endpoints are not secure and should not be used for production data. |
- | {{:/ | + | For the enterprise on-premises version of the product the S3 access nomenclature is set through the ConfigServer. |
- | Choose to add an account and fill in the endpoint as either: | + | ### 2. Access Key ID |
- | **// | + | The Access Key ID is the SME or File Fabric username. |
- | and the QueryID should be set as the SME username. You can obtain the API key from logging into SME going to **//My Account//** from the sidebar and copying the API key from where it says **//API secret | + | ### 3. Secret Access |
+ | You can obtain the API secret key by logging into the File Fabric going to **My Account** from the sidebar and copying the key from where it says **API secret key**. | ||
- | ===== 3 Confirm Connection ===== | + | ## Use With a Variety of S3 Clients |
- | {{:/s3compatibleapi:steps:sme_3_confirm_connection.png}} | + | The File Fabric' |
+ | * [[standalone/explorer|]] - SME desktop application for users to easily access S3-compatible and other object storage | ||
+ | * [[https:// | ||
+ | * [[https://blog.storagemadeeasy.com/ | ||
+ | * [[https:// | ||
+ | * [[https:// | ||
- | Now you can choose to access the service using the CloudBerry explorer: | + | ## API Implementation |
- | ===== 4 Accessing Service ===== | + | The File Fabric implements |
- | + | ||
- | {{:/ | + | |
- | + | ||
- | You can can now browse, download, upload files directly from your SME Clouds which is happening over the S3 API. | + | |
- | + | ||
- | ===== 5 Working with Clouds ===== | + | |
- | + | ||
- | {{:/ | + | |
- | + | ||
- | This screenshot shows the root view of the Google Docs folder being access via CloudBerry using the S3 compatible API. Accessing different Clouds is just as easy as changing directories for Clouds that are mapped to an account. | + | |
- | + | ||
- | ===== 6 Usefulness ===== | + | |
- | + | ||
- | {{:/ | + | |
- | + | ||
- | The S3 API can be useful in a number of scenarios. For example: | + | |
- | * Building an S3 compatible Cloud but using one or more different Storage implementations to deliver it, using the SMEStorage Cloud Appliance. | + | |
- | * Transitioning from existing S3 use to a different Cloud but without having to change code ie. only changing the endpoint implementation | + | |
- | * Using S3 Tools and scripts to work with Clouds other than S3 | + | |
- | + | ||
- | ===== 7 Useful Apps ===== | + | |
- | + | ||
- | {{:/ | + | |
- | + | ||
- | Useful Apps for interacting with SME over the Amazon S3 API are: | + | |
- | * [[http:// | + | |
- | * [[http:// | + | |
- | * [[http:// | + | |
- | + | ||
- | + | ||
- | ===== 8 Note! ===== | + | |
- | + | ||
- | {{:/ | + | |
- | + | ||
- | SME S3 API does not support multi-part upload (as it makes no sense as we interacting with back end clouds that do not support it). | + | |
- | + | ||
- | Certain S3 client tools may need you to change a setting to turn off multi-part upload. | + | |
- | + | ||
- | For example you need to do this with Cyberduck.Multipart uploads can be disabled by setting the hidden option s3.upload.multipart to false.. See https:// | + | |
- | + | ||
- | SME supports | + | |
- | **PUT request** to create a bucket http:// | + | |
+ | * **[[http:// | ||
+ | * **[[http:// | ||
+ | * **[[http:// | ||
+ | * **[[http:// | ||
+ | * **[[http:// | ||
+ | * **[[http:// | ||
+ | * **[[http:// | ||
+ | * **[[http:// | ||
+ | * **[[http:// | ||
+ | ## S3 Signatures Supported | ||
+ | The S3 API supports V2 and V4 signatures. Which one is used is dependent on the client request. |