--- title: "Object Storage Swift - Pierwsze kroki z API Swift S3" description: "Dowiedz się, jak korzystać z API Swift S3" url: https://docs.ovhcloud.com/pl/guides/storage-and-backup/object-storage/pcs-getting-started-with-the-swift-s3-api lang: pl lastUpdated: 2025-02-11 --- # Object Storage Swift - Pierwsze kroki z API Swift S3 ## Objective The Swift s3api middleware providing S3 API compatibility has been enabled on all Public Cloud regions. **This guide will help you access objects in Swift using a software designed to interact with S3-compatible endpoints.** ## Requirements - [Prepare the environment to use the OpenStack API](/pl/guides/public-cloud/cross-functional/compute-prepare-openstack-api-environment.md) - [Get the Openstack RC File v3 from Horizon](/pl/guides/public-cloud/cross-functional/compute-set-openstack-environment-variables.md) ## Instructions ### Set the OpenStack environment variables ```bash user@host:~$ source -openrc.sh Please enter your OpenStack Password for project as user : user@host:~$ ``` ### Install OpenStack client if needed ```bash user@host:~$ pip install python-openstackclient user@host:~$ ``` OpenStack client command reference [here](https://docs.openstack.org/python-openstackclient/latest/). ### Create EC2 credentials S3 tokens are different, you need 2 parameters (**access** and **secret**) to generate a S3 token. These credentials will be safely stored in Keystone. To generate it: With python-openstack client: ```bash user@host:~$ openstack ec2 credentials create +------------+----------------------------------------------------------------------------------------------------------------------------+ | Field | Value | +------------+----------------------------------------------------------------------------------------------------------------------------+ | access | 5a4d8b8d88104123a862c527ede5a3d3 | | links | {u'self': u'https://auth.cloud.ovh.net/v3/users/d74d05ff121b44bea9216495e7f0df61/credentials/OS- | | | EC2/5a4d8b8d88104123a862c527ede5a3d3'} | | project_id | 20e124b71be141299e111ec26b1892fa | | secret | 925d5fcfcd9f436d8ffcb20548cc53a2 | | trust_id | None | | user_id | d74d05ff121b44bea9216495e7f0df61 | +------------+----------------------------------------------------------------------------------------------------------------------------+ ``` With curl: ```bash . openrc.sh TMP_FILE=$(mktemp) OS_USER_ID=$(curl -s -D $TMP_FILE -X POST "${OS_AUTH_URL}auth/tokens" -H "Content-Type: application/json" -d '{"auth":{"identity":{"methods":["password"],"password":{"user":{"name":"'$OS_USERNAME'","domain":{"id":"default"},"password":"'$OS_PASSWORD'"}}},"scope":{"project":{ "id":"'$OS_TENANT_ID'","domain":{"id":"default"}}}}}' | jq -r '.["token"]["user"]["id"]') OS_TOKEN=$(awk 'BEGIN{IGNORECASE=1} /^X-Subject-Token/ {print $2}' $TMP_FILE | tr -d "\r") curl -s -X POST -H "Content-Type: application/json" -H "X-Auth-Token: $OS_TOKEN" -d '{"tenant_id": "'$OS_TENANT_ID'"}' "${OS_AUTH_URL}users/${OS_USER_ID}`/credentials/OS-EC2`" | jq . { "credential": { "user_id": "d74d05ff121b44bea9216495e7f0df61", "links": { "self": "https://auth.cloud.ovh.net/v3/users/d74d05ff121b44bea9216495e7f0df61/credentials/OS-EC2/660c89cfc4764271ba169941c7b2f310" }, "tenant_id": "20e124b71be141299e111ec26b1892fa", "access": "660c89cfc4764271ba169941c7b2f310", "secret": "fc9e8eb545724accadcfabbd99207df1", "trust_id": null } } ``` ### Configure AWS client You can either use the CLI method or create AWS configuration files manually. Install the AWS client and configure it as follows: **Python package** ```bash user@host:~$ pip install awscli ``` **Debian-based OS** ```bash user@host:~$ sudo apt install awscli ``` **RHEL-based OS** ```bash user@host:~$ sudo yum install awscli ``` **CLI method** ```bash user@host:~$ aws configure ``` Then, follow the steps and enter your AWS credentials generated by the commands above. **Manual method** ```bash user@host:~$ cat ~/.aws/credentials [default] aws_access_key_id = aws_secret_access_key = user@host:~$ cat ~/.aws/config [plugins] endpoint = awscli_plugin_endpoint [default] region = s3 = endpoint_url = https://s3..cloud.ovh.net signature_version = s3v4 s3api = endpoint_url = https://s3..cloud.ovh.net ``` Virtual hosted-style and path-style access are supported in all regions, but we recommend to use virtual hosted-style since path-style access will be deprecated after September 30, 2020. ### Use AWS client List buckets (containers): :::info If you have more than one profile, add `--profile ` to the command line. ::: ```bash user@host:~$ aws s3 ls ``` Create a new bucket: ```bash user@host:~$ aws s3 mb s3://bucket ``` :::info S3 Buckets can only be created on PCS policy (Object Storage). ::: :::info The container name must respect the following rules. - The bucket name can be between 3 and 63 characters long, and can contain only lower-case characters, numbers, periods, and dashes. - Each bucket name must start with a lowercase letter or number. - The bucket name cannot contain underscores, end with a dash, have consecutive periods, or use dashes adjacent to periods. - The bucket name cannot be formatted as an IP address (198.51.100.24). ::: Upload a local file to Swift: ```bash user@host:~$ aws s3 cp file.txt s3://bucket/file.txt ``` Download an object from Swift: ```bash user@host:~$ aws s3 cp s3://bucket/file.txt file.txt ``` Delete a Swift object: ```bash user@host:~$ aws s3 rm s3://bucket/file.txt ``` Delete a bucket: ```bash user@host:~$ aws s3 rb s3://bucket ``` ## Go further - OpenStack client command reference [here](https://docs.openstack.org/python-openstackclient/latest/) - S3 client command reference [here](https://docs.aws.amazon.com/cli/latest/reference/s3/index.html) If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](https://www.ovhcloud.com/pl/professional-services/) to get a quote and ask our Professional Services experts for assisting you on your specific use case of your project. Join our [community of users](https://community.ovhcloud.com/).