S3 Get Object

S3 Get Object

API code: S3_GET_OBJECT
Pre-authorized role(s): TENANT_USER | TENANT_ADMIN | ANONYMOUS

Request
URI
GET
https://{api_host}//api/v1/s3/{bucketName}/{objectKey}
COPY
Path Parameters
bucketName
Required

The bucket name. It must be URL encoded.

objectKey
Required

The object key. It must be URL encoded.

Header Parameters
Range
Optional

The range of bytes to download.

x-amz-server-side-encryption-customer-algorithm
Optional

The algorithm used during SSE-C encryption.

x-amz-server-side-encryption-customer-key
Optional

The 256-bit, base64-encoded key used to encrypt or decrypt data.

x-amz-server-side-encryption-customer-key-md5
Optional

The base64-encoded 128-bit MD5 digest of the encryption key.

x-amz-request-payer
Optional

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests.

If-Match
Optional

Returns the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).

If-None-Match
Optional

Returns the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).

If-Modified-Since
Optional

Returns the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

If-Unmodified-Since
Optional

Returns the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).

response-cache-control
Optional

Sets the Cache-Control header of the response.

response-content-disposition
Optional

Sets the Content-Disposition header of the response.

response-content-encoding
Optional

Sets the Content-Encoding header of the response.

response-content-language
Optional

Sets the Content-Language header of the response.

response-content-type
Optional

Sets the Content-Type header of the response.

response-expires
Optional

Sets the Expires header of the response.


Authentication
This operation uses the following authentication methods.
Responses
200

Success

Operation doesn't return any data structure

Response Headers

undefined
x-amz-website-redirect-location

${api_response_header.websiteRedirectLocation}

undefined
Content-Range

${api_response_header.contentRange}

undefined
x-amz-server-side-encryption-aws-kms-key-id

${api_response_header.kmsKeyId}

undefined
Last-Modified

${api_response_header.lastModified}

undefined
x-amz-meta-*

${api_response_header.metadata}

undefined
x-amz-server-side-encryption

${api_response_header.sse}

undefined
X-VMWARE-VOSS-CREATION-DATE

${api_response_header.creationDate}

undefined
x-amz-tagging-count

${api_response_header.taggingCount}

undefined
x-amz-object-lock-retain-until-date

${api_response_header.objectLockRetainUntilDate}

undefined
x-amz-restore

${api_response_header.objectRestore}

undefined
x-amz-server-side-encryption-customer-key-md5

${api_response_header.customerKeyMD5}

undefined
Content-Encoding

${api_response_header.contentEncoding}

undefined
Content-Length

${api_response_header.contentLength}

undefined
x-amz-request-charged

${api_response_header.requestCharged}

undefined
Content-Type

${api_response_header.contentType}

undefined
x-amz-storage-class

${api_response_header.storageClass}

undefined
X-VMWARE-VOSS-TENANT

${api_response_header.tenant}

undefined
x-amz-object-lock-mode

${api_response_header.objectLockMode}

undefined
X-VMWARE-VOSS-KEY

${api_response_header.key}

undefined
x-amz-version-id

${api_response_header.versionId}

undefined
X-VMWARE-VOSS-PATH

${api_response_header.path}

undefined
Accept-Ranges

${api_response_header.acceptRanges}

undefined
x-amz-mp-parts-count

${api_response_header.mpPartsCount}

undefined
x-amz-replication-status

${api_response_header.replicationStatus}

undefined
X-VMWARE-VOSS-OWNER

${api_response_header.owner}

undefined
x-amz-object-lock-legal-hold

${api_response_header.objectLockLegalHold}

undefined
Cache-Control

${api_response_header.cacheControl}

undefined
ETag

${api_response_header.etag}

undefined
x-amz-expiration

${api_response_header.expiration}

undefined
Content-Disposition

${api_response_header.contentDisposition}

undefined
Expires

${api_response_header.expires}

undefined
x-amz-server-side-encryption-customer-algorithm

${api_response_header.customerAlgorithm}

undefined
Content-Language

${api_response_header.contentLanguage}