myQNAPcloud Object S3 API Guide

Guía de la API de myQNAPcloud Object S3

myQNAPcloud Object is a cloud-based object storage service designed to provide high-performance, reliable, and secure data storage for a broad range of applications and use cases. This service is built to be fully compatible with the Amazon Web Service Simple Storage Service (AWS S3) API, ensuring seamless integration with S3-compatible applications and gateway devices.

myQNAPcloud Object is tailored for individuals and organizations seeking a cost-effective and efficient data storage infrastructure. Designed to work with S3-compatible applications, myQNAPcloud Object enables users to leverage familiar tools and workflows while benefiting from the reliability and flexibility of QNAP’s ecosystem.

• Compatibility: myQNAPcloud Object is designed to be fully compatible with the AWS S3 API, ensuring that existing AWS S3-compatible applications can work seamlessly.
• Performance: myQNAPcloud Object offers a high-performance storage solution optimized for reliability and efficiency.

While myQNAPcloud Object aligns closely with AWS S3, certain features may have been enhanced or implemented differently. This guide aims to clarify these nuances to help users maximize the potential of myQNAPcloud Object.

This guide uses examples involving access to buckets in specific myQNAPcloud Object regions. For more information about region-specific endpoints and service URLs, see "Service URLs for myQNAPcloud Object Storage Regions".

Host Designation

myQNAPcloud Object supports both path-style and virtual-style requests, similar to AWS S3. A unique host name is required (for example, s3.us-east-1.myqnapcloud.io versus s3.amazonaws.com). We recommend using path-style requests, as shown in all examples in this guide (e.g., http://s3.us-east-1.myqnapcloud.io/my-bucket/my-object) because path-style requests provide greater flexibility in bucket naming, avoiding domain name conflicts.

Always Consistent

Unlike the strong consistency model of AWS S3, myQNAPcloud Object provides an "always consistent" view of all operations. This ensures that any operation following another will produce consistent results. For instance, after deleting an object (DELETE operation), performing a subsequent HEAD request will always confirm the object's deletion, eliminating the need for additional programming to wait for operation completion.

Authenticating Requests

myQNAPcloud Object supports both autonomous and signature versions 2 and 4, compatible with AWS S3, for headers and query parameters. While signature version 4 offers better security, it requires more computational resources due to the overhead of calculating the SHA256 hash. If performance is critical, signature version 2 may be used, with MD5 (returned as the ETag header) ensuring data integrity.

For version 4 signing requests, all regions are supported for myQNAPcloud Object signing requests.

myQNAPcloud Object does not support signature signing for browser-based uploads or HTML form requests, as these operations are not currently supported.

For version 2 signing, the following sub-resource keys are specified as query parameters in requests:

• append
• compose
• force_delete=true

These query parameters must be included when calculating the signature for PutObject and DeleteBucket operations.

Error Responses

Wherever possible, myQNAPcloud Object uses error responses compatible with AWS S3. Additional error codes may also be provided for enhanced functionality.

HTTP Error Codes

TCP Error Codes

myQNAPcloud Object supports the following TCP error codes:

• Unexpected EOF
• Broken Pipe
• Connection reset by Peer

Not Supported in myQNAPcloud Object

Operations on buckets include: deleting, renaming, and logging buckets as well as cross-origin resource sharing (CORS) support, lifecycle policy, object locking, and compliance.

Force Delete Bucket

AWS S3 will not allow you to delete a bucket if it contains objects that have not been deleted.

myQNAPcloud Object provides a force delete option that first deletes all the objects in the bucket and then deletes the bucket. The deletion of objects is subject to policy and compliance requirements on the bucket.

To use the force delte option, simply add it as a query string. For example:

DELETE http://s3.us-east-1.myqnapcloud.io/my-bucket?force_delete=true HTTP/1.1

Renaming a Bucket

AWS S3 does not support renaming of buckets. It only supports renaming of objects in a bucket.

myQNAPcloud Object supports the renaming of buckets. The new bucket name must not be in use for the renaming to be successful. The caller must have the s3:CreateBucket policy permission to rename a bucket.

To rename a bucket, use the HTTP method MOVE along with the header field “Destination” to give the new bucket name. For example: 

MOVE http://s3.us-east-1.myqnapcloud.io/my_old_bucket HTTP/1.1
Destination: my_new_bucket

MFA (Multi-Factor Authentication) Delete

myQNAPcloud Object supports the “x-amz-mfa” header while:

• configuring versioning on a bucket, or
• deleting objects with object deletion requests compatible with AWS S3.

myQNAPcloud Object does not require the “x-amz-mfa” header if the user's access credentials signing the request were authenticated with MFA. myQNAPcloud Object only supports virtual MFA devices.

Maximum Number of Buckets

Standard AWS S3 supports only 100 buckets.

myQNAPcloud Object allows for a maximum of 1000 buckets per account and this number may be increased by contacting myQNAPcloud Object Customer Support.

Bucket Logging

myQNAPcloud Object supports bucket logging, which creates a text log file of all access to a bucket. The format of the log file is identical to the AWS S3 log file.

myQNAPcloud Object bucket logging does not require any ACL permission settings to store logs in a target bucket. Although you can give permission settings in the logging request or in an ACL, they are not required for logging to work in myQNAPcloud Object. However, the bucket that is a target for log files must be inside the same account as the bucket being logged.

Bucket Cross-Origin Resource Sharing (CORS) Support

For compatibility with browser access to myQNAPcloud Object as a web server, the myQNAPcloud Object server will return CORS headers when the header “Origin” is given in an HTTP request. Additionally, the server supports the HTTP method OPTIONS on either buckets or objects to return the CORS headers needed for a browser pre-flight test before accessing myQNAPcloud Object.

Different from AWS, myQNAPcloud Object returns the settings that will allow the browser full access to myQNAPcloud Object. Hence, myQNAPcloud Object does not support the AWS functions that allow a PUT and GET on a bucket with the “cors” parameter in the URL. Note that allowing browser full access to data does not affect the security of access to any objects and all access policies will still be enforced.

The following are the HTTP headers returned by default when the header “Origin” is given in an HTTP request:

Access-Control-Allow-Headers: *
Access-Control-Allow-Methods: GET, HEAD, POST, PUT, DELETE, MOVE, OPTIONS
Access-Control-Allow-Origin: *
Access-Control-Expose-Headers: *
Access-Control-Max-Age: 86400

Lifecycle Policy

The Lifecyle feature establishes a Lifecycle policy with rules to define actions that you want myQNAPcloud Object to take during the life of an object. This feature replaces the need to manually delete an object after a retention period.

Configuring Lifecycle Settings 

The lifecycle settings for a bucket are configuring with the "put-bucket-lifecycle-configuration" command. For example: 

$ aws s3api put-bucket-lifecycle-configuration --bucket 1-1-1-1 --endpoint-url https://s3.us-east-1.myqnapcloud.io --lifecycle-configuration file://lifecycle.json
{

    "Rules": [
        {
            "Expiration": {
                "Days": 1
            },
            "ID": "lifecycle_rule_1",
            "Filter": {
                "And": {
                    "ObjectSizeGreaterThan": 1,
                    "ObjectSizeLessThan": 21474836480
                }
            },
            "Status": "Enabled"
        },
        {
            "Expiration": {
                "Days": 1
            },
            "ID": "object_lifecycle_rule_bucket_6807766",
            "Filter": {
                "Prefix": "1"
            },
            "Status": "Enabled"
        }
    ]
}

Here is another example:  

PUT https://s3.us-east-1.myqnapcloud.io/1-1-1-1?lifecycle
<LifecycleConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
    <Rule>
        <Expiration>
            <Days>1</Days>
        </Expiration>
        <ID>lifecycle_rule_1</ID>
        <Filter>
            <And>
                <ObjectSizeGreaterThan>1</ObjectSizeGreaterThan>
                <ObjectSizeLessThan>21474836480</ObjectSizeLessThan>
            </And>
        </Filter>
        <Status>Enabled</Status>
    </Rule>
    <Rule>
        <Expiration>
            <Days>1</Days>
        </Expiration>
        <ID>object_lifecycle_rule_bucket_6807766</ID>
        <Filter>
            <Prefix>1</Prefix>
        </Filter>
        <Status>Enabled</Status>
    </Rule>
</LifecycleConfiguration>

There is no response body for this call.

Retrieving Lifecycle Settings

The lifecycle settings for a bucket can be retrieved with the "get-bucket-lifecycle-configuration" command. For example:

$ aws s3api get-bucket-lifecycle-configuration --bucket 1-1-1-1 --endpoint-url https://s3.us-east-1.myqnapcloud.io
{
    "Rules": [
        {
            "Expiration": {
                "Days": 1
            },
            "ID": "lifecycle_rule_1",
            "Filter": {
                "And": {
                    "ObjectSizeGreaterThan": 1,
                    "ObjectSizeLessThan": 21474836480
                }
            },
            "Status": "Enabled"
        },
        {
            "Expiration": {
                "Days": 1
            },
            "ID": "object_lifecycle_rule_bucket_6807766",
            "Filter": {
                "Prefix": "1"
            },
            "Status": "Enabled"
        }
    ]
}

Here is another example:

GET https://s3.us-east-1.myqnapcloud.io/1-1-1-1?lifecycle
<?xml version="1.0" encoding="UTF-8"?>
<LifecycleConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
    <Rule>
        <Expiration>
            <Days>1</Days>
        </Expiration>
        <ID>lifecycle_rule_1</ID>
        <Filter>
            <And>
                <ObjectSizeGreaterThan>1</ObjectSizeGreaterThan>
                <ObjectSizeLessThan>21474836480</ObjectSizeLessThan>
            </And>
        </Filter>
        <Status>Enabled</Status>
    </Rule>
    <Rule>
        <Expiration>
            <Days>1</Days>
        </Expiration>
        <ID>object_lifecycle_rule_bucket_6807766</ID>
        <Filter>
            <Prefix>1</Prefix>
        </Filter>
        <Status>Enabled</Status>
    </Rule>
</LifecycleConfiguration>

Deleting Lifecycle Settings

The lifecycle settings for a bucket can be deleted with the "delete-bucket-lifecycle" command. For example:

$ aws s3api delete-bucket-lifecycle --bucket 1-1-1-1 --endpoint-url https://s3.us-east-1.myqnapcloud.io

There is no response body for this call.

Object Lock

myQNAPcloud Object supports an object lock that prevents the deletion or overwrite of object versions for a fixed amount of time or indefinitely.

The object lock settings for a bucket are specified using the “?object-lock” query string along with the object lock settings as the XML body in the request. For example:

PUT https://s3.us-east-1.myqnapcloud.io/qa.objectlock.002/?object-lock HTTP/1.1
<ObjectLockConfiguration>
     <ObjectLockEnabled>Enabled</ObjectLockEnabled>
     <Rule>
          <DefaultRetention>
               <Mode>COMPLIANCE</Mode>
               <Days>10</Days>
          </DefaultRetention>
     </Rule>
</ObjectLockConfiguration>

The object lock settings for a bucket can be retrieved by getting the bucket with the “?object-lock” query string. For example:

GET https://s3.us-east-1.myqnapcloud.io/qa.objectlock.002/?object-lock HTTP/1.1

Response body:

<?xml version="1.0" encoding="UTF-8"?>
<ObjectLockConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
     <ObjectLockEnabled>Enabled</ObjectLockEnabled>
     <Rule>
          <DefaultRetention>
               <Mode>COMPLIANCE</Mode>
               <Days>10</Days>
          </DefaultRetention>
     </Rule>
</ObjectLockConfiguration>

There are also object lock settings for each object described in Operations on Objects.

The object lock settings for a bucket can be cleared using "?object-lock" query string. For example:

PUT https://s3.us-east-1.myqnapcloud.io/qa.objectlock.002/?object-lock HTTP/1.1

Response body:

<ObjectLockConfiguration>
     <ObjectLockEnabled>Enabled</ObjectLockEnabled>
          <Rule>
               <DefaultRetention>
                    <Mode></Mode>
                    <Days></Days>
          </DefaultRetention>
     </Rule>
</ObjectLockConfiguration>

myQNAPcloud Object Compliance

myQNAPcloud Object supports a compliance policy that prevents the deletion of objects and provides additional information to prove that the original data is not modified since the time written. The compliance feature may be required for certain regulatory needs, but is also useful to prevent accidental data deletion.

Compliance is different from the object locking setting for a bucket.

You can set the compliance policy on any bucket controlling all the objects that are stored in that bucket. Specify the bucket compliance policy with the following XML tags.

The compliance settings for a bucket are specified using the “?compliance” query string along with the compliance settings as the XML body in the request. For example:

PUT http://s3.us-east-1.myqnapcloud.io/my-bucket?complianceHTTP./1.1
<BucketComplianceConfiguration>
     <Status>enabled</Status>
     <LockTime>off</LockTime>
     <RetentionDays>365</RetentionDays>
     <DeleteAfterRetention>true</DeleteAfterRetention>
</BucketComplianceConfiguration>

After compliance is enabled for a bucket, the policy is immediately applied to all objects in the bucket. An attempt to delete an object before the retention period will return an error.

The compliance settings for a bucket can be retrieved by getting the bucket with the “?compliance” query string. For example:

GET http://s3.us-east-1.myqnapcloud.io/my-buck?complianceHTTP/1.1

Response body:

<BucketComplianceConfiguration xml ns="http://s3.amazonaws.com/doc/2006-03-01/">
     <Status>enabled</Status>
     <LockTime>2016-11-07T15:08:05Z</LockTime>
     <IsLocked>false</IsLocked>
     <RetentionDays>0</RetentionDays>
     <ConditionalHold>false</ConditionalHold>
     <DeleteAfterRetention>false</DeleteAfterRetention>
</BucketComplianceConfiguration>

There are also compliance settings for each object described in Operations on Objects.

Operations on Buckets Not Supported in myQNAPcloud Object

Operations on Objects include renaming, composing, appending, and deleting objects as well as encryption, storage class, object locking, and compliance.

Renaming Objects

myQNAPcloud Object supports functionality to move an object-in effect, renaming the object by changing the key. This eliminates the two-step process of first copying an object and then deleting the original object. The caller must have s3:PutObject policy permission on the bucket to rename objects.

To rename objects, use the HTTP method MOVE along with the following parameters in the request headers that affect the move operation.

The call will return the results as an XML body of the response. The results include the following for each object renamed:

• original source key,
• renamed destination key,
• version ID of the object, and
• any error in the rename operation.

The quiet option will cause the results to list only the keys that encountered an error.

Below is an example, which renames all objects that start with the prefix “TestMove-Dir2/” to have the new prefix “TestMove-Dir2-Renamed/

MOVE http://s3.us-east-1.myqnapcloud.io/my_bucket/TestMove-Dir2/HTTP/1.1 Destination:TestMove-Dir2-Renamed/X-Wasabi-Prefix:true

Response body:

<MoveObjectResult> <SourcePrefix>TestMove-Dir2/SourcePrefix> <DestinationPrefix>TestMove-Dir2-Renamed/DestinationPrefix> <MoveObject> <SourceKey>TestMove-Dir2/SourceKey> <DestinationKey>TestMove-Dir2-Renamed/DestinationKey> MoveObject> <MoveObject> <SourceKey>TestMove-Dir2/Dir1/SourceKey> <DestinationKey>TestMove-Dir2-Renamed/Dir1/DestinationKey> MoveObject> <MoveObject> <SourceKey>TestMove-Dir2/Dir1/Obj1SourceKey> <DestinationKey>TestMove-Dir2-Renamed/Dir1/Obj1DestinationKey> MoveObject> <MoveObject> <SourceKey>TestMove-Dir2/Dir1/Obj2SourceKey> <DestinationKey>TestMove-Dir2-Renamed/Dir1/Obj2DestinationKey> MoveObject> <MoveObject> <SourceKey>TestMove-Dir2/Dir2/SourceKey> <DestinationKey>TestMove-Dir2-Renamed/Dir2/DestinationKey> MoveObject> <MoveObject> <SourceKey>TestMove-Dir2/Dir2/Obj1SourceKey> <DestinationKey>TestMove-Dir2-Renamed/Dir2/Obj1DestinationKey> MoveObject> <MoveObject> <SourceKey>TestMove-Dir2/Dir2/Obj2SourceKey> <DestinationKey>TestMove-Dir2-Renamed/Dir2/Obj2DestinationKey> MoveObject> <MoveCount>7MoveCount> MoveObjectResult>

Composing Objects

myQNAPcloud Object provides a feature to create a new object that is composed of other objects. A composed object is formed not by copying the original data objects, but rather by linking the composed object to the data objects. This is in contrast to AWS S3, which does not offer a way to compose objects. myQNAPcloud Object operation is much faster and does not require multiple copies of the original data. The original composed objects may be deleted at any time, and the system will retain the original data as long as there are any links to the data.

Composing objects is an alternative to using the multi-part upload feature for creating objects larger than 5 GB. The caller must have s3:PutObject policy permission on the bucket to compose objects. Composed objects may be created from other composed objects as well as original data objects. However, the total number of original data objects may not exceed 32 in any one composed object. Composed objects may only link to other objects in the same bucket.

The compose operation is done using the HTTP method PUT with the query string parameter “?compose” to indicate that the object is composed of objects given in the XML body. The XML body contains a list of object keys and, optionally, the version IDs that form the new object. If the version ID is not given, the latest version of the object is used. The new object will appear to be one object with all the linked data objects concatenated. The new composed object does not have an ETag (i.e, MD5) value, which is the MD5 of the concatenated objects, but rather the result of hashing all the data object MD5s together (like the calculation done when multi-part objects are completed). Composed objects may not have user provided encryption keys. However, all data is stored encrypted at rest.

There is a charge only for the metadata used in composed objects. The original data used in linked objects is charged at the normal rate until all composed objects that link to the original data object are deleted.

Below is an example that composes a new object “TestComp from three objects: “TestCompose-Data-1”, “TestCompose-Data-2”, and “TestCompose-Data-3”.

PUT http://s3.wasabisys.com/my_bucket/TestCompose-Object-1?composeHTTP/1.1Content-Type:text/xml
<ComposeRequest>
<Component>
<Key>TestCompose-Data-1</Key>
</Component>
<Component>
<Key>TestCompose-Data-2</Key>
</Component>
<Component>
<Key>TestCompose-Data-3</Key>
</Component>
</ComposeRequest>

Appending to Objects

AWS S3 does not offer a way to append to objects.

Appending to an existing object is a different form of composing an object (see Composing Objects). The call uploads the data in the body to a temporary object and then creates a new composed object consisting of the data from the original object with the newly uploaded data appended. If the bucket is versioned, a new version of the composed object is created while keeping the original data. When not versioned, the newly composed object replaces the original object. The caller must have s3:PutObject policy permission on the bucket to append to objects. Additionally for a bucket without versioning, the s3:DeleteObject policy permission may be required to replace the original object.

Like composed objects, you can append only 1023 times to any object since each creates a link to the uploaded data. Be careful not to simply append small amounts of data many times to an object since each append data uploaded creates a new object subject to minimum size charges, and can slow down the performance due to a small data read. The append operation is done using the HTTP method PUT with the query string parameter “?append”. The data to be appended is uploaded in the body of the request.

Below is an example that appends the string “<appended data>” to an existing object “TestAppend-Object”.

PUT http://s3.us-east-1.myqnapcloud.io/my-bucket/TestAppend-Object?appendHTTP/1.1Content-Length:15

PUT Object Copy Uses Link

Normally, to rename objects using AWS S3 protocol, an object is uploaded with one key value. Then, a PUT operation with the new key value copied from the original key value is given, and the object for the original key value is deleted.

myQNAPcloud Object automatically optimizes this sequence by linking the new key value object to the original data from the copy key value. This avoids making another copy of the data, which would result in higher storage charges. Because myQNAPcloud Object uses links to the original data, any size object up to the 5 TB limit may be copied and does not require the use of a multi-part upload.

Delete Object MFADelete

If the MFADelete option is turned on in the bucket versioning, the “x-amz-mfa” is not required if the access credentials were signed using MFA (see also MFA (Multi-Factor Authentication) Delete).

If bucket logging is enabled, deleting multiple objects will create a separate log entry for each object that is deleted.

GET Object Response Headers

Any header in the GET object request that starts with “response-” will be returned as a response header (minus the string “response-”).

Object Server-Side Encryption

myQNAPcloud Object encrypts all data stored at rest regardless of the requested encryption. The system will use any caller provided encryption keys when given, or generate a random key encryption key for each object if no customer key is provided. If the customer provides the encryption key, similar to AWS S3, myQNAPcloud Object will not keep a copy of the customer key in the metadata and the caller must provide the encryption key to read the data. No action on the part of the caller is needed if myQNAPcloud Object provides the encryption key.

The caller may provide the encryption key using the headers x-amz-server-side-encryption-customer-algorithm, x-amz-server-side-encryption-customer-key, and x-amz-server-side-encryption-customer-key-MD5. These parameters work identical to AWS S3.

myQNAPcloud Object does not support a key management service. Hence, the “x-amz-server-side-encryption” is not supported along with all the “aws:kms” functionality. myQNAPcloud Object stores an MD5 for the data that is always the uploaded data regardless of server-side encryption.

Object Storage Class

myQNAPcloud Object only provides a single storage class which is most like the standard AWS S3 storage class. Where the storage class is returned in any operation, myQNAPcloud Object will return the standard AWS S3 storage class.

Operations on Objects Not Supported in myQNAPcloud Object

The compliance settings for any one object in a bucket with compliance can also be changed within the limits of the compliance on the bucket. Specify the object compliance settings with the following XML tags.

The following is an example of setting the compliance on an object:

PUT http://s3.us-east-1.myqnapcloud.io/my-bucket/my-object?complianceHTTP/1.1
<ObjectComplianceConfiguration>
     <ConditionalHold>false</ConditionalHold>
     <RetentionTime>2018-03-13T10:45:00Z</RetentionTime>
</ObjectComplianceConfiguration>

The compliance settings for any specific object can also be retrieved using the “?compliance” query string. In addition to the object compliance settings above, the query returns the calculated SHA256 hash for the object, which can be used to determine that the object has not been modified. Note that the SHA256 value is only available for objects that are uploaded as a single object and is not available for multi-part or composed objects.

The following is an example of getting the compliance on an object:

GET http://s3.us-east-1.myqnapcloud.io/my-bucket/my-object?complianceHTTP/1.1

Response body:

<ObjectComplianceConfiguration xml ns="http://s3.amazonaws.com/doc/2006-03-01/">
     <RetentionTime>2016-10-31T15:08:05Z</RetentionTime>
     <ConditionalHold>false</ConditionalHold>
     <LegalHold>false</LegalHold>

<SHA256>14b4be3894e92166b508007b6c2e4fb6e88d3d0ad652c76475089a50ebe6e33b</SHA256>
</ObjectComplianceConfiguration>

The object compliance settings also appear in the bucket listings when the bucket has compliance enabled.

You can add or update the object lock settings for an object using the tags described below.

The following is an example of setting the object locking configuration on an object:

PUT https://s3.us-east-1.myqnapcloud.io/qa.objectlock.002/beta_vpn.png?retention&versionId= 001617181245457483475-4ylsTbqqvP

<Retention>
     <Mode>compliance</Mode>
     <RetainUntilDate>2021-04-06T09:00:45Z</RetainUntilDate>
</Retention>

The following is an example of setting legal hold for an object:

PUT https://s3.us-east-1.myqnapcloud.io/qa.objectlock.002/beta_vpn.png?legal-hold&versionId=001617181245457483475-4ylsTbqqvP

<LegalHold>
     <Status>ON</Status>
</LegalHold>

The following is an example of setting governance mode for an object:

PUT https://s3.us-east-1.myqnapcloud.io/qa.objectlock.002/public/ACL.PNG?retention
<Retention>
     <Mode>governance</Mode>
     <RetainUntilDate>2021-05-20T09:00:45Z</RetainUntilDate>
</Retention>

The “x-amz-bypass-governance-retention =true” header must be included whenever you want to override governance settings for an object.

The myQNAPcloud service URLs for myQNAPcloud Object's different storage regions are:

Americas

EMEA

APAC

The myQNAPcloud Object Management Console can be reached through myQNAPcloud Portal.

If you are looking for the correct service URL to use with your third-party storage application, you should choose the one that matches your bucket location.

When working with third-party storage applications, you should be aware that these applications have different methods to handle storage region service URLs. These methods include:

1. Applications that allow you to explicitly enter in the service URL. These applications are the most flexible because you can easily configure new service URLs as they become available.
2. Applications that only allow you to choose from a pre-built list of storage regions. These applications are the least flexible because, if a storage provider implements a new region, you have to wait for an application update to get access to the new region. If your storage application does not support all of the myQNAPcloud Object storage regions on their predefined region lists, contact the application vendor (not QNAP) to ask them for support.
3. Applications that only allow you to enter in your API key set and then offer up all of the buckets in your account. These applications provide flexibility but do require some automatic redirects to perform at the HTTP level.

GET Object Tagging

myQNAPcloud Object supports functionality to fetch the tag set of an object when the object:

• Does not have any tags
• Does have tags

When the Object Does Not Have Any Tags

GET https://s3.myqnapcloud.io/my_bucket/Test-object1.txt?tagging

Response body:

<?xml version="1.0" encoding="UTF-8"?>
<Tagging>
   <TagSet></TagSet>
</Tagging>

Status 200 OK

When the Object Has Tags

GET https://s3.myqnapcloud.io/my_bucket/Test-object2.pdf?tagging

Response body:

<!--?xml version="1.0" encoding="UTF-8"?-->
<Tagging>
   <TagSet>
      <Tag>
         <Key>key2</Key>
         <Value>value2</Value>
      </Tag>
      <Tag>
         <Key>key1</Key>
         <Value>value1</Value>
      </Tag>
   </TagSet>
</Tagging>

PUT Object Tagging

myQNAPcloud Object supports functionality for:

• Adding the tag value of an existing object in a bucket
• Appending the tag value of an existing object in a bucket

Adding the Tag Value of an Existing Object in a Bucket

PUT https://s3.myqnapcloud.io/my_bucket/Test-object3.pdf?tagging
Content-Type: text/xml

Response body:

<Tagging xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
   <TagSet>
      <Tag>
         <Key>tag1</Key>
         <Value>value1</Value>
      </Tag>
   </TagSet>
</Tagging>

Appending the Tag Value of an Existing Object in a Bucket

In this example, an existing object already has the tag value of “key5” –“value5”, You can append a new tag pairs along with the existing pair.

PUT https://s3.myqnapcloud.io/my_bucket/Test-object4.jpg?tagging
Content-Type: text/xml

Response body:

<Tagging xmlns="http://s3.myqnapcloud.io/doc/2006-03-01/">
   <TagSet>
      <Tag>
         <Key>key5</Key>
         <Value>value5</Value>
      </Tag>
      <Tag>
         <Key>key6</Key>
         <Value>value6</Value>
      </Tag>
   </TagSet>
</Tagging>

Status 200 OK

To PUT tags of any other version, use the versionId query parameter.

DELETE Object Tagging

This removes the entire tag set from the specified object.

DELETE https://s3.myqnapcloud.io/my_bucket/Test-object5.pdf?tagging

Response body:

<empty>

Status 204 No Content

To delete tags of any other version, use the versionId query parameter.

Get Object Tagging

myQNAPcloud Object supports functionality to fetch the tag set of an object when the object:

• Does not have any tags
• Does have tags

When the object does not have any tags

GET

https://s3.myqnapcloud.io/my_bucket/Test-object1.txt?tagging

Response body:

<?xml version="1.0" encoding="UTF-8"?>

<Tagging>

   <TagSet></TagSet>

</Tagging>

Status 200 OK

When the object has Tags

GET

https://s3.myqnapcloud.io/my_bucket/Test-object2.pdf?tagging

Response body:

<!--?xml version="1.0" encoding="UTF-8"?-->

<Tagging>

   <TagSet>

      <Tag>

         <Key>key2</Key>

         <Value>value2</Value>

      </Tag>

      <Tag>

         <Key>key1</Key>

         <Value>value1</Value>

      </Tag>

   </TagSet>

</Tagging>

PUT Object Tagging

myQNAPcloud Object supports functionality for:

• Adding the tag value of an existing object in a bucket
• Appending the tag value of an existing object in a bucket

Adding the tag value of an existing object in a bucket

PUT

https://s3.myqnapcloud.io/my_bucket/Test-object3.pdf?tagging

Content-Type: text/xml

Response body:

<Tagging xmlns="http://s3.amazonaws.com/doc/2006-03-01/">

   <TagSet>

      <Tag>

         <Key>tag1</Key>

         <Value>value1</Value>

      </Tag>

   </TagSet>

</Tagging>

Appending the Tag Value of an Existing Object in a Bucket

In this example, an existing object already has the tag value of “key5” –“value5”, You can append a new tag pair along with the existing pair.

PUT

https://s3.myqnapcloud.io/my_bucket/Test-object4.jpg?tagging

Content-Type: text/xml

Response body:

<Tagging xmlns="http://s3.myqnapcloud.io/doc/2006-03-01/">

   <TagSet>

      <Tag>

         <Key>key5</Key>

         <Value>value5</Value>

      </Tag>

      <Tag>

         <Key>key6</Key>

         <Value>value6</Value>

      </Tag>

   </TagSet>

</Tagging>

Status 200 OK

To PUT tags of any other version, use the versionId query parameter.

DELETE Object Tagging

This removes the entire tag set from the specified object.

DELETE

https://s3.myqnapcloud.io/my_bucket/Test-object5.pdf?tagging

Response body:

<empty>

Status 204 No Content

To delete tags of any other version, use the versionId query parameter.

Given its compatibility with AWS S3, the official AWS documentation for S3 serves as a complementary resource when working with myQNAPcloud Object. Refer to the Amazon Simple Storage Service API Reference for details on the API version 2006-03-01:

Amazon Simple Storage Service API Reference

myQNAPcloud Object es un servicio de Almacenamiento de objetos basado en la nube, diseñado para proporcionar un Almacenamiento de datos de alto rendimiento, confiable y seguro para una amplia gama de aplicaciones y casos de uso. Este servicio está diseñado para ser completamente compatible con la API de Amazon Web Service Simple Almacenamiento Service (AWS S3), asegurando una integración perfecta con aplicaciones y dispositivos de puerta de enlace compatibles con S3.

myQNAPcloud Object está diseñado para individuos y organizaciones que buscan una infraestructura de Almacenamiento de datos rentable y eficiente. Diseñado para trabajar con aplicaciones compatibles con S3, myQNAPcloud Object permite a los usuarios aprovechar herramientas y flujos de trabajo familiares mientras se benefician de la fiabilidad y flexibilidad del ecosistema de QNAP.

• Compatibilidad: myQNAPcloud Object está diseñado para ser completamente compatible con la API de AWS S3, asegurando que las aplicaciones existentes compatibles con AWS S3 puedan funcionar sin problemas.
• Rendimiento: myQNAPcloud Object ofrece una solución de Almacenamiento de alto rendimiento optimizada para la fiabilidad y la eficiencia.

Aunque myQNAPcloud Object se alinea estrechamente con AWS S3, ciertas características pueden haber sido mejoradas o implementadas de manera diferente. Esta guía tiene como objetivo aclarar estas diferencias para ayudar a los usuarios a maximizar el potencial de myQNAPcloud Object.

Esta guía utiliza ejemplos que involucran el acceso a Buckets en regiones específicas de myQNAPcloud Object. Para obtener más información sobre los puntos finales específicos de la región y las URL del servicio, consulte "URLs del Servicio para Regiones de myQNAPcloud Object Almacenamiento".

Designación del Host

myQNAPcloud Object admite tanto solicitudes de estilo de ruta como de estilo virtual, similar a AWS S3. Se requiere un nombre de host único (por ejemplo, s3.us-east-1.myqnapcloud.io frente a s3.amazonaws.com). Recomendamos usar solicitudes de estilo de ruta, como se muestra en todos los ejemplos de esta guía (por ejemplo, http://s3.us-east-1.myqnapcloud.io/my-bucket/my-object) porque las solicitudes de estilo de ruta ofrecen mayor flexibilidad en la nomenclatura de los buckets, evitando conflictos de nombres de dominio.

Siempre Consistente

A diferencia del modelo de consistencia fuerte de AWS S3, myQNAPcloud Object proporciona una vista "siempre consistente" de todas las operaciones. Esto asegura que cualquier operación que siga a otra producirá resultados consistentes. Por ejemplo, después de eliminar un objeto (operación DELETE), realizar una solicitud HEAD posterior siempre confirmará la eliminación del objeto, eliminando la necesidad de programación adicional para esperar la finalización de la operación.

Autenticación de Solicitudes

myQNAPcloud Object admite tanto versiones autónomas como de firma 2 y 4, compatibles con AWS S3, para encabezados y parámetros de consulta. Aunque la versión de firma 4 ofrece mejor seguridad, requiere más recursos computacionales debido a la sobrecarga de calcular el hash SHA256. Si el rendimiento es crítico, se puede usar la versión de firma 2, con MD5 (devuelto como el encabezado ETag) asegurando la integridad de los datos.

Para solicitudes de firma de la versión 4, se admiten todas las regiones para las solicitudes de firma de myQNAPcloud Object.

myQNAPcloud Object no admite la firma de solicitudes para cargas basadas en navegador o solicitudes de formularios HTML, ya que estas operaciones no están actualmente soportadas.

Para la firma de la versión 2, las siguientes claves de sub-recurso se especifican como parámetros de consulta en las solicitudes:

• append
• compose
• force_delete=true

Estos parámetros de consulta deben incluirse al calcular la firma para las operaciones PutObject y DeleteBucket.

Respuestas de Error

Siempre que sea posible, myQNAPcloud Object utiliza respuestas de error compatibles con AWS S3. También se pueden proporcionar códigos de error adicionales para una funcionalidad mejorada.

Códigos de Error HTTP

Códigos de error TCP

myQNAPcloud Object admite los siguientes códigos de error TCP:

• EOF inesperado
• Tubería rota
• Conexión restablecida por el par

No compatible en myQNAPcloud Object

Las operaciones en Buckets incluyen: eliminación, cambio de nombre y registro de Buckets, así como soporte para compartir recursos de origen cruzado (CORS), política de ciclo de vida, bloqueo de objetos y cumplimiento.

Eliminación forzada de bucket

AWS S3 no permite eliminar un bucket si contiene objetos que no han sido eliminados.

myQNAPcloud Object proporciona una opción de eliminación forzada que primero elimina todos los objetos en el bucket y luego elimina el bucket. La eliminación de objetos está sujeta a políticas y requisitos de cumplimiento en el bucket.

Para usar la opción de eliminación forzada, simplemente agréguela como una cadena de consulta. Por ejemplo:

DELETE http://s3.us-east-1.myqnapcloud.io/my-bucket?force_delete=true HTTP/1.1

Cambiar el nombre de un bucket

AWS S3 no admite el cambio de nombre de Buckets. Solo admite el cambio de nombre de objetos en un bucket.

myQNAPcloud Object admite el cambio de nombre de Buckets. El nuevo nombre del bucket no debe estar en uso para que el cambio de nombre sea exitoso. El solicitante debe tener el permiso de política s3:CreateBucket para cambiar el nombre de un bucket.

Para cambiar el nombre de un bucket, use el método HTTP MOVE junto con el campo de encabezado "Destination" para dar el nuevo nombre del bucket. Por ejemplo: 

MOVE http://s3.us-east-1.myqnapcloud.io/my_old_bucket HTTP/1.1
Destino: mi_nuevo_bucket

Eliminación MFA (Autenticación Multifactor)

myQNAPcloud Object admite el encabezado "x-amz-mfa" mientras:

• configura la versión en un bucket, o
• elimina objetos con solicitudes de eliminación compatibles con AWS S3.

myQNAPcloud Object no requiere el encabezado "x-amz-mfa" si las credenciales de acceso del usuario que firma la solicitud fueron autenticadas con MFA. myQNAPcloud Object solo admite dispositivos MFA virtuales.

Número máximo de Buckets

El estándar AWS S3 solo admite 100 Buckets.

myQNAPcloud Object permite un máximo de 1000 Buckets por cuenta y este número puede aumentarse contactando con el Soporte al Cliente de myQNAPcloud Object.

Registro de Bucket

myQNAPcloud Object admite el registro de buckets, que crea un archivo de registro de texto de todo el acceso a un bucket. El formato del archivo de registro es idéntico al archivo de registro de AWS S3.

El registro de buckets de myQNAPcloud Object no requiere configuraciones de permisos ACL para almacenar registros en un bucket de destino. Aunque puedes otorgar configuraciones de permisos en la solicitud de registro o en un ACL, no son necesarias para que el registro funcione en myQNAPcloud Object. Sin embargo, el bucket que es un destino para los archivos de registro debe estar dentro de la misma cuenta que el bucket que se está registrando.

Compatibilidad con el uso compartido de recursos de origen cruzado (CORS) de buckets

Para la compatibilidad con el acceso del navegador a myQNAPcloud Object como servidor web, el servidor myQNAPcloud Object devolverá encabezados CORS cuando se proporcione el encabezado "Origin" en una solicitud HTTP. Además, el servidor admite el método HTTP OPTIONS en Buckets u objetos para devolver los encabezados CORS necesarios para una prueba previa del navegador antes de acceder a myQNAPcloud Object.

Diferente de AWS, myQNAPcloud Object devuelve las configuraciones que permitirán al navegador acceso completo a myQNAPcloud Object. Por lo tanto, myQNAPcloud Object no admite las funciones de AWS que permiten un PUT y GET en un bucket con el parámetro "cors" en la URL. Ten en cuenta que permitir el acceso completo del navegador a los datos no afecta la seguridad del acceso a ningún objeto y todas las políticas de acceso seguirán aplicándose.

Los siguientes son los encabezados HTTP devueltos por defecto cuando se proporciona el encabezado "Origin" en una solicitud HTTP:

Access-Control-Allow-Headers: *
Access-Control-Allow-Methods: GET, HEAD, POST, PUT, DELETE, MOVE, OPTIONS
Access-Control-Allow-Origin: *
Access-Control-Expose-Headers: *
Access-Control-Max-Age: 86400

Política de ciclo de vida

La función de ciclo de vida establece una política de ciclo de vida con reglas para definir acciones que deseas que myQNAPcloud Object realice durante la vida de un objeto. Esta función reemplaza la necesidad de eliminar manualmente un objeto después de un período de retención.

Configuración de ajustes de ciclo de vida 

La configuración del ciclo de vida para un bucket se realiza con el comando "put-bucket-lifecycle-configuration". Por ejemplo: 

$ aws s3api put-bucket-lifecycle-configuration --bucket 1-1-1-1 --endpoint-url https://s3.us-east-1.myqnapcloud.io --lifecycle-configuration file://lifecycle.json
{

    "Rules": [
        {
            "Expiration": {
                "Days": 1
            },
            "ID": "lifecycle_rule_1",
            "Filter": {
                "And": {
                    "ObjectSizeGreaterThan": 1,
                    "ObjectSizeLessThan": 21474836480
                }
            },
            "Status": "Enabled"
        },
        {
            "Expiration": {
                "Days": 1
            },
            "ID": "object_lifecycle_rule_bucket_6807766",
            "Filter": {
                "Prefix": "1"
            },
            "Status": "Enabled"
        }
    ]
}

Aquí hay otro ejemplo:  

PUT https://s3.us-east-1.myqnapcloud.io/1-1-1-1?lifecycle
<LifecycleConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
    <Rule>
        <Expiration>
            <Days>1</Days>
        </Expiration>
        <ID>lifecycle_rule_1</ID>
        <Filter>
            <And>
                <ObjectSizeGreaterThan>1</ObjectSizeGreaterThan>
                <ObjectSizeLessThan>21474836480</ObjectSizeLessThan>
            </And>
        </Filter>
        <Status>Enabled</Status>
    </Rule>
    <Rule>
        <Expiration>
            <Days>1</Days>
        </Expiration>
        <ID>object_lifecycle_rule_bucket_6807766</ID>
        <Filter>
            <Prefix>1</Prefix>
        </Filter>
        <Status>Enabled</Status>
    </Rule>
</LifecycleConfiguration>

No hay cuerpo de respuesta para esta llamada.

Recuperando configuraciones del ciclo de vida

Las configuraciones del ciclo de vida para un bucket se pueden recuperar con el comando "get-bucket-lifecycle-configuration". Por ejemplo:

$ aws s3api get-bucket-lifecycle-configuration --bucket 1-1-1-1 --endpoint-url https://s3.us-east-1.myqnapcloud.io
{
    "Rules": [
        {
            "Expiration": {
                "Days": 1
            },
            "ID": "lifecycle_rule_1",
            "Filter": {
                "And": {
                    "ObjectSizeGreaterThan": 1,
                    "ObjectSizeLessThan": 21474836480
                }
            },
            "Status": "Enabled"
        },
        {
            "Expiration": {
                "Days": 1
            },
            "ID": "object_lifecycle_rule_bucket_6807766",
            "Filter": {
                "Prefix": "1"
            },
            "Status": "Enabled"
        }
    ]
}

Aquí hay otro ejemplo:

GET https://s3.us-east-1.myqnapcloud.io/1-1-1-1?lifecycle
<?xml version="1.0" encoding="UTF-8"?>
<LifecycleConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
    <Rule>
        <Expiration>
            <Days>1</Days>
        </Expiration>
        <ID>lifecycle_rule_1</ID>
        <Filter>
            <And>
                <ObjectSizeGreaterThan>1</ObjectSizeGreaterThan>
                <ObjectSizeLessThan>21474836480</ObjectSizeLessThan>
            </And>
        </Filter>
        <Status>Enabled</Status>
    </Rule>
    <Rule>
        <Expiration>
            <Days>1</Days>
        </Expiration>
        <ID>object_lifecycle_rule_bucket_6807766</ID>
        <Filter>
            <Prefix>1</Prefix>
        </Filter>
        <Status>Enabled</Status>
    </Rule>
</LifecycleConfiguration>

Eliminando configuraciones del ciclo de vida

Las configuraciones del ciclo de vida de un bucket se pueden eliminar con el comando "delete-bucket-lifecycle". Por ejemplo:

$ aws s3api delete-bucket-lifecycle --bucket 1-1-1-1 --endpoint-url https://s3.us-east-1.myqnapcloud.io

No hay cuerpo de respuesta para esta llamada.

Bloqueo de objetos

myQNAPcloud Object admite un Bloqueo de objetos que evita la eliminación o sobrescritura de versiones de objetos por un tiempo determinado o indefinidamente.

La configuración de Bloqueo de objetos para un bucket se especifica utilizando la cadena de consulta "?object-lock" junto con la configuración de Bloqueo de objetos como el cuerpo XML en la solicitud. Por ejemplo:

PUT https://s3.us-east-1.myqnapcloud.io/qa.objectlock.002/?object-lock HTTP/1.1
<ObjectLockConfiguration>
     <ObjectLockEnabled>Enabled</ObjectLockEnabled>
     <Rule>
          <DefaultRetention>
               <Mode>COMPLIANCE</Mode>
               <Days>10</Days>
          </DefaultRetention>
     </Rule>
</ObjectLockConfiguration>

La configuración de Bloqueo de objetos para un bucket se puede recuperar obteniendo el bucket con la cadena de consulta "?object-lock". Por ejemplo:

GET https://s3.us-east-1.myqnapcloud.io/qa.objectlock.002/?object-lock HTTP/1.1

Cuerpo de la respuesta:

<?xml version="1.0" encoding="UTF-8"?>
<ObjectLockConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
     <ObjectLockEnabled>Enabled</ObjectLockEnabled>
     <Rule>
          <DefaultRetention>
               <Mode>COMPLIANCE</Mode>
               <Days>10</Days>
          </DefaultRetention>
     </Rule>
</ObjectLockConfiguration>

También hay configuraciones de Bloqueo de objetos para cada objeto descrito en Operaciones en Objetos.

La configuración de Bloqueo de objetos para un bucket se puede borrar usando la cadena de consulta "?object-lock". Por ejemplo:

PUT https://s3.us-east-1.myqnapcloud.io/qa.objectlock.002/?object-lock HTTP/1.1

Cuerpo de la respuesta:

<ObjectLockConfiguration>
     <ObjectLockEnabled>Habilitado</ObjectLockEnabled>
          <Rule>
               <DefaultRetention>
                    <Mode></Mode>
                    <Days></Days>
          </DefaultRetention>
     </Rule>
</ObjectLockConfiguration>

myQNAPcloud Object Cumplimiento

myQNAPcloud Object admite una política de cumplimiento que impide la eliminación de objetos y proporciona información adicional para demostrar que los datos originales no se modifican desde el momento en que se escribieron. La función de cumplimiento puede ser necesaria para ciertas necesidades regulatorias, pero también es útil para prevenir la eliminación accidental de datos.

El cumplimiento es diferente de la configuración de bloqueo de objetos para un bucket.

Puede establecer la política de cumplimiento en cualquier bucket controlando todos los objetos que se almacenan en ese bucket. Especifique la política de cumplimiento del bucket con las siguientes etiquetas XML.

La configuración de cumplimiento para un bucket se especifica utilizando la cadena de consulta "?compliance" junto con la configuración de cumplimiento como el cuerpo XML en la solicitud. Por ejemplo:

PUT http://s3.us-east-1.myqnapcloud.io/my-bucket?complianceHTTP./1.1
<BucketComplianceConfiguration>
     <Status>enabled</Status>
     <LockTime>off</LockTime>
     <RetentionDays>365</RetentionDays>
     <DeleteAfterRetention>true</DeleteAfterRetention>
</BucketComplianceConfiguration>

Después de habilitar el cumplimiento para un bucket, la política se aplica inmediatamente a todos los objetos en el bucket. Un intento de eliminar un objeto antes del período de retención devolverá un error.

La configuración de cumplimiento para un bucket se puede recuperar obteniendo el bucket con la cadena de consulta "?compliance". Por ejemplo:

GET http://s3.us-east-1.myqnapcloud.io/my-buck?complianceHTTP/1.1

Cuerpo de la respuesta:

<BucketComplianceConfiguration xml ns="http://s3.amazonaws.com/doc/2006-03-01/">
     <Status>enabled</Status>
     <LockTime>2016-11-07T15:08:05Z</LockTime>
     <IsLocked>false</IsLocked>
     <RetentionDays>0</RetentionDays>
     <ConditionalHold>false</ConditionalHold>
     <DeleteAfterRetention>false</DeleteAfterRetention>
</BucketComplianceConfiguration>

También hay configuraciones de cumplimiento para cada objeto descritas en Operaciones en Objetos.

Operaciones en Buckets No Soportadas en myQNAPcloud Object

Las operaciones en objetos incluyen renombrar, componer, añadir y eliminar objetos, así como cifrado, clase de Almacenamiento, bloqueo de objetos y cumplimiento.

Renombrar objetos

myQNAPcloud Object admite la funcionalidad de mover un objeto, en efecto, renombrando el objeto al cambiar la clave. Esto elimina el proceso de dos pasos de primero copiar un objeto y luego eliminar el objeto original. El llamante debe tener permiso de política s3:PutObject en el bucket para renombrar objetos.

Para renombrar objetos, use el método HTTP MOVE junto con los siguientes parámetros en los encabezados de la solicitud que afectan la operación de movimiento.

La llamada devolverá los resultados como un cuerpo XML de la respuesta. Los resultados incluyen lo siguiente para cada objeto renombrado:

• clave de origen original,
• clave de destino renombrada,
• versión ID del objeto, y
• cualquier error en la operación de renombrado.

La opción silenciosa hará que los resultados solo enumeren las claves que encontraron un error.

A continuación se muestra un ejemplo, que renombra todos los objetos que comienzan con el prefijo “TestMove-Dir2/” para tener el nuevo prefijo “TestMove-Dir2-Renamed/

MOVE http://s3.us-east-1.myqnapcloud.io/my_bucket/TestMove-Dir2/HTTP/1.1 Destination:TestMove-Dir2-Renamed/X-Wasabi-Prefix:true

Cuerpo de la respuesta:

<MoveObjectResult> <SourcePrefix>TestMove-Dir2/SourcePrefix> <DestinationPrefix>TestMove-Dir2-Renamed/DestinationPrefix> <MoveObject> <SourceKey>TestMove-Dir2/SourceKey> <DestinationKey>TestMove-Dir2-Renamed/DestinationKey> MoveObject> <MoveObject> <SourceKey>TestMove-Dir2/Dir1/SourceKey> <DestinationKey>TestMove-Dir2-Renamed/Dir1/DestinationKey> MoveObject> <MoveObject> <SourceKey>TestMove-Dir2/Dir1/Obj1SourceKey> <DestinationKey>TestMove-Dir2-Renamed/Dir1/Obj1DestinationKey> MoveObject> <MoveObject> <SourceKey>TestMove-Dir2/Dir1/Obj2SourceKey> <DestinationKey>TestMove-Dir2-Renamed/Dir1/Obj2DestinationKey> MoveObject> <MoveObject> <SourceKey>TestMove-Dir2/Dir2/SourceKey> <DestinationKey>TestMove-Dir2-Renamed/Dir2/DestinationKey> MoveObject> <MoveObject> <SourceKey>TestMove-Dir2/Dir2/Obj1SourceKey> <DestinationKey>TestMove-Dir2-Renamed/Dir2/Obj1DestinationKey> MoveObject> <MoveObject> <SourceKey>TestMove-Dir2/Dir2/Obj2SourceKey> <DestinationKey>TestMove-Dir2-Renamed/Dir2/Obj2DestinationKey> MoveObject> <MoveCount>7MoveCount> MoveObjectResult>

Composición de objetos

myQNAPcloud Object  ofrece una función para crear un nuevo objeto que se compone de otros objetos. Un objeto compuesto se forma no copiando los objetos de datos originales, sino vinculando el objeto compuesto a los objetos de datos. Esto contrasta con AWS S3, que no ofrece una forma de componer objetos. La operación de myQNAPcloud Object es mucho más rápida y no requiere múltiples copias de los datos originales. Los objetos compuestos originales pueden eliminarse en cualquier momento, y el sistema retendrá los datos originales mientras haya enlaces a los datos.

Componer objetos es una alternativa al uso de la función de carga multiparte para crear objetos de más de 5 GB. El llamante debe tener permiso de política s3:PutObject en el bucket para componer objetos. Los objetos compuestos pueden crearse a partir de otros objetos compuestos, así como de objetos de datos originales. Sin embargo, el número total de objetos de datos originales no puede exceder de 32 en ningún objeto compuesto. Los objetos compuestos solo pueden enlazarse a otros objetos en el mismo bucket.

La operación de composición se realiza utilizando el método HTTP PUT con el parámetro de cadena de consulta “?compose” para indicar que el objeto está compuesto por objetos dados en el cuerpo XML. El cuerpo XML contiene una lista de claves de objetos y, opcionalmente, los IDs de versión que forman el nuevo objeto. Si no se proporciona el ID de versión, se utiliza la última versión del objeto. El nuevo objeto parecerá ser un único objeto con todos los objetos de datos enlazados concatenados. El nuevo objeto compuesto no tiene un valor ETag (es decir, MD5), que es el MD5 de los objetos concatenados, sino más bien el resultado de hash de todos los MD5 de los objetos de datos juntos (como el cálculo realizado cuando se completan objetos de múltiples partes). Los objetos compuestos no pueden tener claves de cifrado proporcionadas por el usuario. Sin embargo, todos los datos se almacenan cifrados en reposo.

Solo se cobra por los metadatos utilizados en los objetos compuestos. Los datos originales utilizados en los objetos enlazados se cobran a la tarifa normal hasta que se eliminen todos los objetos compuestos que enlazan al objeto de datos original.

A continuación se muestra un ejemplo que compone un nuevo objeto “TestComp a partir de tres objetos: “TestCompose-Data-1”, “TestCompose-Data-2” y “TestCompose-Data-3”.

PUT http://s3.wasabisys.com/my_bucket/TestCompose-Object-1?composeHTTP/1.1Content-Type:text/xml
<ComposeRequest>
<Component>
<Key>TestCompose-Data-1</Key>
</Component>
<Component>
<Key>TestCompose-Data-2</Key>
</Component>
<Component>
<Key>TestCompose-Data-3</Key>
</Component>
</ComposeRequest>

Adición a objetos

AWS S3 no ofrece una forma de añadir a los objetos.

Añadir a un objeto existente es una forma diferente de componer un objeto (ver Composición de objetos). La llamada sube los datos en el cuerpo a un objeto temporal y luego crea un nuevo objeto compuesto que consiste en los datos del objeto original con los datos recién subidos añadidos. Si el bucket tiene versiones, se crea una nueva versión del objeto compuesto mientras se mantienen los datos originales. Cuando no tiene versiones, el nuevo objeto compuesto reemplaza al objeto original. El llamante debe tener permiso de política s3:PutObject en el bucket para añadir a los objetos. Además, para un bucket sin versionado, puede ser necesario el permiso de política s3:DeleteObject para reemplazar el objeto original.

Al igual que los objetos compuestos, solo puedes añadir 1023 veces a cualquier objeto ya que cada uno crea un enlace a los datos subidos. Ten cuidado de no simplemente añadir pequeñas cantidades de datos muchas veces a un objeto ya que cada dato añadido subido crea un nuevo objeto sujeto a cargos mínimos por tamaño, y puede ralentizar el rendimiento debido a una lectura de datos pequeña. La operación de adición se realiza utilizando el método HTTP PUT con el parámetro de cadena de consulta “?append”. Los datos a añadir se suben en el cuerpo de la solicitud.

A continuación se muestra un ejemplo que añade la cadena “” a un objeto existente “TestAppend-Object”.

PUT http://s3.us-east-1.myqnapcloud.io/my-bucket/TestAppend-Object?appendHTTP/1.1Content-Length:15

PUT Object Copy Usa Enlace

Normalmente, para renombrar objetos usando el protocolo AWS S3, un objeto se sube con un valor de clave. Luego, se realiza una operación PUT con el nuevo valor de clave copiado del valor de clave original, y se elimina el objeto del valor de clave original.

myQNAPcloud Object  optimiza automáticamente esta secuencia vinculando el objeto del nuevo valor de clave a los datos originales del valor de clave copiado. Esto evita hacer otra copia de los datos, lo que resultaría en mayores cargos de Almacenamiento. Debido a que myQNAPcloud Object utiliza enlaces a los datos originales, cualquier objeto de tamaño hasta el límite de 5 TB puede ser copiado y no requiere el uso de una carga de múltiples partes.

Eliminar objeto MFADelete

Si la opción MFADelete está activada en la versionado del bucket, el “x-amz-mfa” no es necesario si las credenciales de acceso fueron firmadas usando MFA (ver también Eliminación MFA (Autenticación Multifactor)).

Si el registro del bucket está habilitado, eliminar múltiples objetos creará una entrada de registro separada para cada objeto que se elimine.

Encabezados de respuesta GET Object

Cualquier encabezado en la solicitud GET object que comience con “response-” se devolverá como un encabezado de respuesta (menos la cadena “response-”).

Cifrado del lado del servidor del objeto

myQNAPcloud Object  cifra todos los datos almacenados en reposo independientemente del cifrado solicitado. El sistema usará cualquier clave de cifrado proporcionada por el llamante cuando se proporcione, o generará una clave de cifrado aleatoria para cada objeto si no se proporciona una clave del cliente. Si el cliente proporciona la clave de cifrado, similar a AWS S3, myQNAPcloud Object no mantendrá una copia de la clave del cliente en los metadatos y el llamante debe proporcionar la clave de cifrado para leer los datos. No se necesita ninguna acción por parte del llamante si myQNAPcloud Object proporciona la clave de cifrado.

El llamante puede proporcionar la clave de cifrado usando los encabezados x-amz-server-side-encryption-customer-algorithm, x-amz-server-side-encryption-customer-key y x-amz-server-side-encryption-customer-key-MD5. Estos parámetros funcionan de manera idéntica a AWS S3.

myQNAPcloud Object  no admite un servicio de gestión de claves. Por lo tanto, el “x-amz-server-side-encryption” no es compatible junto con toda la funcionalidad de “aws:kms”.  myQNAPcloud Object  almacena un MD5 para los datos que siempre son los datos cargados independientemente del cifrado del lado del servidor.

Clase de Almacenamiento del objeto

myQNAPcloud Object  sólo proporciona una única clase de Almacenamiento que es más similar a la clase estándar de AWS S3 Almacenamiento. Donde la clase de Almacenamiento se devuelve en cualquier operación, myQNAPcloud Object devolverá la clase estándar de AWS S3 Almacenamiento.

Operaciones en objetos no compatibles en myQNAPcloud Object

Las configuraciones de cumplimiento para cualquier objeto en un bucket con cumplimiento también se pueden cambiar dentro de los límites del cumplimiento en el bucket. Especifique las configuraciones de cumplimiento del objeto con las siguientes etiquetas XML.

El siguiente es un ejemplo de cómo establecer el cumplimiento en un objeto:

PUT http://s3.us-east-1.myqnapcloud.io/my-bucket/my-object?complianceHTTP/1.1
<ObjectComplianceConfiguration>
     <ConditionalHold>false</ConditionalHold>
     <RetentionTime>2018-03-13T10:45:00Z</RetentionTime>
</ObjectComplianceConfiguration>

Las configuraciones de cumplimiento para cualquier objeto específico también se pueden recuperar usando la cadena de consulta "?compliance". Además de las configuraciones de cumplimiento del objeto mencionadas anteriormente, la consulta devuelve el hash SHA256 calculado para el objeto, que se puede usar para determinar que el objeto no ha sido modificado. Tenga en cuenta que el valor SHA256 solo está disponible para objetos que se cargan como un solo objeto y no está disponible para objetos multipartes o compuestos.

El siguiente es un ejemplo de cómo obtener el cumplimiento en un objeto:

GET http://s3.us-east-1.myqnapcloud.io/my-bucket/my-object?complianceHTTP/1.1

Cuerpo de la respuesta:

<ObjectComplianceConfiguration xml ns="http://s3.amazonaws.com/doc/2006-03-01/">
     <RetentionTime>2016-10-31T15:08:05Z</RetentionTime>
     <ConditionalHold>false</ConditionalHold>
     <LegalHold>false</LegalHold>

<SHA256>14b4be3894e92166b508007b6c2e4fb6e88d3d0ad652c76475089a50ebe6e33b</SHA256>
</ObjectComplianceConfiguration>

Las configuraciones de cumplimiento del objeto también aparecen en las listas de buckets cuando el bucket tiene el cumplimiento habilitado.

Puede agregar o actualizar las configuraciones de Bloqueo de objetos para un objeto usando las etiquetas descritas a continuación.

El siguiente es un ejemplo de configuración del bloqueo de objetos en un objeto:

PUT https://s3.us-east-1.myqnapcloud.io/qa.objectlock.002/beta_vpn.png?retention&versionId= 001617181245457483475-4ylsTbqqvP

<Retention>
     <Mode>compliance</Mode>
     <RetainUntilDate>2021-04-06T09:00:45Z</RetainUntilDate>
</Retention>

El siguiente es un ejemplo de configuración de retención legal para un objeto:

PUT https://s3.us-east-1.myqnapcloud.io/qa.objectlock.002/beta_vpn.png?legal-hold&versionId=001617181245457483475-4ylsTbqqvP

<LegalHold>
     <Status>ON</Status>
</LegalHold>

El siguiente es un ejemplo de configuración del modo de gobernanza para un objeto:

PUT https://s3.us-east-1.myqnapcloud.io/qa.objectlock.002/public/ACL.PNG?retention
<Retention>
     <Mode>governance</Mode>
     <RetainUntilDate>2021-05-20T09:00:45Z</RetainUntilDate>
</Retention>

El encabezado “x-amz-bypass-governance-retention =true” debe incluirse siempre que desee anular la configuración de gobernanza para un objeto.

Las URLs de servicio de myQNAPcloud para las diferentes regiones de myQNAPcloud Object Almacenamiento son:

Américas

EMEA

APAC

La consola de gestión de myQNAPcloud Object se puede acceder a través del portal myQNAPcloud.

Si está buscando la URL de servicio correcta para usar con su aplicación de Almacenamiento de terceros, debe elegir la que coincida con la ubicación de su bucket.

Al trabajar con aplicaciones de Almacenamiento de terceros, debe tener en cuenta que estas aplicaciones tienen diferentes métodos para manejar las URLs de servicio de la región de Almacenamiento. Estos métodos incluyen:

1. Aplicaciones que le permiten ingresar explícitamente la URL del servicio. Estas aplicaciones son las más flexibles porque puede configurar fácilmente nuevas URLs de servicio a medida que estén disponibles.
2. Aplicaciones que solo le permiten elegir de una lista predefinida de regiones de Almacenamiento. Estas aplicaciones son las menos flexibles porque, si un proveedor de Almacenamiento implementa una nueva región, debe esperar una actualización de la aplicación para acceder a la nueva región. Si su aplicación de Almacenamiento no admite todas las regiones de myQNAPcloud Object Almacenamiento en sus listas de regiones predefinidas, contacte al proveedor de la aplicación (no a QNAP) para solicitarles soporte.
3. Aplicaciones que solo le permiten ingresar su conjunto de claves API y luego ofrecen todos los Buckets en su cuenta. Estas aplicaciones proporcionan flexibilidad pero requieren algunas redirecciones automáticas para funcionar a nivel HTTP.

GET Object Tagging

myQNAPcloud Object admite la funcionalidad para obtener el conjunto de etiquetas de un objeto cuando el objeto:

• No tiene etiquetas
• Tiene etiquetas

Cuando el objeto no tiene etiquetas

GET https://s3.myqnapcloud.io/my_bucket/Test-object1.txt?tagging

Cuerpo de la respuesta:

<?xml version="1.0" encoding="UTF-8"?>
<Tagging>
   <TagSet></TagSet>
</Tagging>

Estado 200 OK

Cuando el objeto tiene etiquetas

GET https://s3.myqnapcloud.io/my_bucket/Test-object2.pdf?tagging

Cuerpo de la respuesta:

<!--?xml version="1.0" encoding="UTF-8"?-->
<Tagging>
   <TagSet>
      <Tag>
         <Key>key2</Key>
         <Value>value2</Value>
      </Tag>
      <Tag>
         <Key>key1</Key>
         <Value>value1</Value>
      </Tag>
   </TagSet>
</Tagging>

PUT Object Tagging

myQNAPcloud Object admite la funcionalidad para:

• Agregar el valor de la etiqueta de un objeto existente en un bucket
• Anexar el valor de la etiqueta de un objeto existente en un bucket

Agregar el Valor de la Etiqueta de un Objeto Existente en un Bucket

PUT https://s3.myqnapcloud.io/my_bucket/Test-object3.pdf?tagging
Content-Type: text/xml

Cuerpo de la respuesta:

<Tagging xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
   <TagSet>
      <Tag>
         <Key>tag1</Key>
         <Value>value1</Value>
      </Tag>
   </TagSet>
</Tagging>

Anexar el Valor de la Etiqueta de un Objeto Existente en un Bucket

En este ejemplo, un objeto existente ya tiene el valor de la etiqueta "key5" – "value5", puedes anexar nuevos pares de etiquetas junto con el par existente.

PUT https://s3.myqnapcloud.io/my_bucket/Test-object4.jpg?tagging
Content-Type: text/xml

Cuerpo de la respuesta:

<Tagging xmlns="http://s3.myqnapcloud.io/doc/2006-03-01/">
   <TagSet>
      <Tag>
         <Key>key5</Key>
         <Value>value5</Value>
      </Tag>
      <Tag>
         <Key>key6</Key>
         <Value>value6</Value>
      </Tag>
   </TagSet>
</Tagging>

Estado 200 OK

Para agregar etiquetas de cualquier otra versión, utiliza el parámetro de consulta versionId.

ELIMINAR Etiquetado de Objetos

Esto elimina todo el conjunto de etiquetas del objeto especificado.

DELETE https://s3.myqnapcloud.io/my_bucket/Test-object5.pdf?tagging

Cuerpo de la respuesta:

<empty>

Estado 204 Sin Contenido

Para eliminar etiquetas de cualquier otra versión, utiliza el parámetro de consulta versionId.

Obtener Etiquetado de Objetos

myQNAPcloud Object admite la funcionalidad para obtener el conjunto de etiquetas de un objeto cuando el objeto:

• No tiene etiquetas
• Tiene etiquetas

Cuando el objeto no tiene etiquetas

GET

https://s3.myqnapcloud.io/my_bucket/Test-object1.txt?tagging

Cuerpo de la respuesta:

<?xml version="1.0" encoding="UTF-8"?>

<Tagging>

   <TagSet></TagSet>

</Tagging>

Estado 200 OK

Cuando el objeto tiene etiquetas

GET

https://s3.myqnapcloud.io/my_bucket/Test-object2.pdf?tagging

Cuerpo de la respuesta:

<!--?xml version="1.0" encoding="UTF-8"?-->

<Tagging>

   <TagSet>

      <Tag>

         <Key>key2</Key>

         <Value>value2</Value>

      </Tag>

      <Tag>

         <Key>key1</Key>

         <Value>value1</Value>

      </Tag>

   </TagSet>

</Tagging>

PUT Etiquetado de Objeto

myQNAPcloud Object admite funcionalidad para:

• Añadir el valor de la etiqueta de un objeto existente en un bucket
• Agregar el valor de la etiqueta de un objeto existente en un bucket

Añadir el valor de la etiqueta de un objeto existente en un bucket

PUT

https://s3.myqnapcloud.io/my_bucket/Test-object3.pdf?tagging

Content-Type: text/xml

Cuerpo de la respuesta:

<Tagging xmlns="http://s3.amazonaws.com/doc/2006-03-01/">

   <TagSet>

      <Tag>

         <Key>tag1</Key>

         <Value>value1</Value>

      </Tag>

   </TagSet>

</Tagging>

Agregando el valor de la etiqueta de un objeto existente en un bucket

En este ejemplo, un objeto existente ya tiene el valor de la etiqueta de “key5” –“value5”, puedes agregar un nuevo par de etiquetas junto con el par existente.

PUT

https://s3.myqnapcloud.io/my_bucket/Test-object4.jpg?tagging

Content-Type: text/xml

Cuerpo de la respuesta:

<Tagging xmlns="http://s3.myqnapcloud.io/doc/2006-03-01/">

   <TagSet>

      <Tag>

         <Key>key5</Key>

         <Value>value5</Value>

      </Tag>

      <Tag>

         <Key>key6</Key>

         <Value>value6</Value>

      </Tag>

   </TagSet>

</Tagging>

Estado 200 OK

Para enviar etiquetas de cualquier otra versión, use el parámetro de consulta versionId.

ELIMINAR Etiquetado de Objetos

Esto elimina todo el conjunto de etiquetas del objeto especificado.

DELETE

https://s3.myqnapcloud.io/my_bucket/Test-object5.pdf?tagging

Cuerpo de la respuesta:

<empty>

Estado 204 Sin Contenido

Para eliminar etiquetas de cualquier otra versión, use el parámetro de consulta versionId.

Dada su compatibilidad con AWS S3, la documentación oficial de AWS para S3 sirve como un recurso complementario al trabajar con myQNAPcloud Object. Consulte la Referencia de la API del Servicio Simple de Almacenamiento de Amazon para obtener detalles sobre la versión de la API 2006-03-01:

Referencia de la API del Servicio Simple de Almacenamiento de Amazon