Retrieve object GET /v1/{account}/{container}/{object}
Retrieves object contents and their metadata.
When handling large objects, the response will include the object name after joining. When retrieving the manifest file of a static large object as is, use the multipart-manifest query parameter.
Upon successful completion, the 200 status code is returned. If the object does not exist, the 404 status code is returned.
Request headers
X-Auth-Token
Authentication token. If omitted, the request will fail, unless access using an ACL is permitted. Refer to ACL for details.
| Data Type | Cardinality |
|---|---|
| String | 0..1 |
X-Newest
When "True" is set, object storage searches for and returns the newest replica out of all of the replicas. If this header is omitted, object storage selects one normal replica and returns it. When "True" is specified in this header, it becomes extremely costly. Only use this item when absolutely necessary.
| Data Type | Cardinality |
|---|---|
| Boolean | 0..1 |
Range
Range of contents to be retrieved.
You can use the Range header to specify a range to retrieve part of the data. When multiple ranges are specified, separate them with a comma.
The method for specifying a range is as follows:
- Byte range:
Specify from which byte to which byte of the data is to be returned. When the end byte of the data is omitted, the data up to the end will be returned.
- Suffix byte range
Specify how many bytes to return for the data suffix.
| Data Type | Cardinality |
|---|---|
| Dict | 0..1 |
If-Match
Refer to http://www.ietf.org/rfc/rfc2616.txt.
| Data Type | Cardinality |
|---|---|
| Dict | 0..1 |
If-Modified-Since
Refer to http://www.ietf.org/rfc/rfc2616.txt.
| Data Type | Cardinality |
|---|---|
| Dict | 0..1 |
If-Unmodified-Since
Refer to http://www.ietf.org/rfc/rfc2616.txt.
| Data Type | Cardinality |
|---|---|
| Dict | 0..1 |
Request Parameter
{account}
Name uniquely assigned by project
| Data Type | Cardinality |
|---|---|
| String | 1..1 |
{container}
Container name
| Data Type | Cardinality |
|---|---|
| String | 1..1 |
{object}
Object name
| Data Type | Cardinality |
|---|---|
| String | 1..1 |
temp_url_sig
Uses a signature for requests in the URL feature with effective period.
| Data Type | Cardinality |
|---|---|
| String | 0..1 |
temp_url_expires
Specifies the effective period of the temp_url_sig in the URL feature with effective period.
| Data Type | Cardinality |
|---|---|
| String | 0..1 |
multipart-manifest
When the object is large, multipart-manifest=get can be specified in the query parameter. The object itself is not returned at that time. Instead, in the case of a dynamic large object, the X-Object-Manifest response header is returned, and in the case of a static large object, Manifest is returned in the response body.
| Data Type | Cardinality |
|---|---|
| String | 0..1 |
Response Headers
Content-Length
Size of object (bytes)
| Data Type | Cardinality |
|---|---|
| String | 1..1 |
Accept-Ranges
Ranges type that can be specified when retrieving objects
| Data Type | Cardinality |
|---|---|
| String | 1..1 |
Last-Modified
Datetime when an object was created, or the datetime when the metadata was last modified
| Data Type | Cardinality |
|---|---|
| String | 1..1 |
ETag
When an object is smaller than 5 GB, this value will be the MD5 checksum of the object. Also, this value is not enclosed in quotations.
In the case of a manifest object, a value with the retrieved MD5 checksum for a string that combines the ETag and MD5 checksums of each segment of the manifest is returned.
You are strongly advised to compare the ETag header value with the MD5 checksum value of the object that was actually downloaded. If the values are different, this indicates that the contents are corrupted, so perform retry processing.
| Data Type | Cardinality |
|---|---|
| String | 1..1 |
Content-Type
MIME type of the response body
| Data Type | Cardinality |
|---|---|
| String | 1..1 |
Content-Encoding
Metadata of Content-Encoding.
If omitted, this will not be returned.
| Data Type | Cardinality |
|---|---|
| String | 0..1 |
Content-Disposition
This is returned when the browser behavior has been set.
Refer to "http://www.ietf.org/rfc/rfc2183.txt" for details on the value that is returned.
| Data Type | Cardinality |
|---|---|
| String | 0..1 |
X-Delete-At
The date on which an object will be deleted is returned in UNIX Epoch timestamp format. If omitted, this will not be returned.
| Data Type | Cardinality |
|---|---|
| Int | 1..1 |
X-Object-Meta-name
Object metadata {name} is the name of the metadata item.
| Data Type | Cardinality |
|---|---|
| String | 0..1 |
X-Object-Manifest
Returns the dynamic large object settings. This value takes the container name and prefix name of the split object, as follows. container/prefix
| Data Type | Cardinality |
|---|---|
| String | 0..1 |
X-Static-Large-Object
If the object is the manifest object of a static large object, "True" will be returned.
| Data Type | Cardinality |
|---|---|
| Bool | 0..1 |
X-Trans-Id
ID assigned to this request. This is used when inquiring about issues.
| Data Type | Cardinality |
|---|---|
| Uuid | 1..1 |
Date
Datetime when the transaction was executed
| Data Type | Cardinality |
|---|---|
| Datetime | 1..1 |
Response Elements
The object is returned.
When an object exists
Example of Request
curl -i $publicURL/marktwain/goodbye -X GET -H "X-Auth-Token: $token"
Example of Response
HTTP/1.1 200 OK
Content-Length: 14
Accept-Ranges: bytes
Last-Modified: Wed, 15 Jan 2014 16:41:49 GMT
Etag: 451e372e48e0f6b1114fa0724aa79fa1
X-Timestamp: 1389804109.39027
X-Object-Meta-Orig-Filename: goodbyeworld.txt
Content-Type: application/octet-stream
X-Trans-Id: tx8145a190241f4cf6b05f5-0052d82a34
Date: Thu, 16 Jan 2014 18:51:32 GMT
Goodbye World!
When an object does not exist
Example of Request
curl -i $publicURL/janeausten/goodbye -X GET -H "X-Auth-Token: $token"
Example of Response
HTTP/1.1 404 Not Found
Content-Length: 70
Content-Type: text/html; charset=UTF-8
X-Trans-Id: tx073f7cbb850c4c99934b9-0052d82b04
Date: Thu, 16 Jan 2014 18:55:00 GMT
<html><h1>Not Found</h1><p>The resource could not be found.</p></html>