Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Follow these rules for naming the domain, bucket, and named objects that you create for storage in Swarm.

Slashes

Swarm handles slashes this way (v11.1):

  • Leading slashes (/foo) are silently removed in all cases.

  • Trailing slashes (foo/) are silently removed for buckets, but they cause 404 Page Not Found errors for domains.

  • Trailing slashes (foo/bar//) are preserved for object names because they are valid.


Type

Reference

Rules and Notes

Examples

Tenant

RFC 1034

Applies to Gateway only.

A tenant must follow the naming rules of a domain.


Domain

RFC 1034

For maximum compatibility, verify the domains are valid DNS names that resolve in your network.

A domain name must

  • Be a 7-bit ASCII byte sequence.

  • Be case-insensitive.

  • Begin with an alphanumeric character.

  • Use alphanumeric characters, underscore (_), period (.), and hyphen (-).

  • Not have adjacent or final hyphens or periods (--, .., -., .-).

  • Not be an IPv4 or IPv6 IP address.

  • (S3 compatibility) Not be longer than 253 characters.

Valid:  

my-cluster.example.com
my_cluster.example.com

Invalid:  

domain
cluster_example_com

Bucket

RFC 1034

A bucket name (which is only used in the path) must

  • Be unique within the domain.

  • Be case-sensitive.

  • Be a valid URL-encoded, UTF-8 byte sequence.

    • Content UI: URL encoding is taken care of by the user interface.

  • Not be a UUID (32 hexadecimal characters).

  • Not exceed 8000 characters (larger than that is not tested or supported).

  • (S3 compatibility) Use lowercase ASCII and DNS-compatible names not longer than 63 characters.


Named object

RFC 3986

An object name must

  • Be unique within the bucket.

  • Be case-sensitive.

  • Be a valid URL-encoded, UTF-8 byte sequence.

    • Content UI: URL encoding is taken care of by the user interface.

Valid:  

Accounting/Customer23-03/15


Note

While you may use non-ASCII characters (such as "résumé.doc") in bucket and object names, the URL must be properly escaped in the HTTP request ("r%C3%A9sum%C3%A9.doc").

  • No labels