Show container details and list objects

get

/v1/{account}/{container}

Shows details for a container and lists objects, sorted by name, in the container.

Request

Path Parameters
account
Type: string
Required: true
The unique name for the account. An account is also known as the project or tenant.
container
Type: string
Required: true
The unique name for the container. The container name must be from 1 to 256 characters long and can start with any character and contain any pattern. Character set must be UTF-8. The container name cannot contain a slash (/) character because this character delimits the container and object name. For example, /account/container/object.
Query Parameters
delimiter
Type: string (char)
Delimiter value, which returns the object names that are nested in the container.
end_marker
Type: string
For a string value, x, returns container names that are less than the marker value.
format
Type: string
The response format. Valid values are json, xml, or plain. The default is plain.

If you append the format=xml or format=json query parameter to the storage account URL, the response shows extended container information serialized in that format.

If you append the format=plain query parameter, the response lists the container names separated by newlines.

limit
Type: integer
For an integer value n, limits the number of results to n. Any negative value will be equivalent to 0: no items will be returned.
marker
Type: string
For a string value, x, returns container names that are greater than the marker value.
path
Type: string
For a string value, returns the object names that are nested in the pseudo path. Equivalent to setting delimiter to / and prefix to the path with a / at the end.
prefix
Type: string
Prefix value. Named items in the response begin with this value.
Header Parameters
Accept
Type: string
Instead of using the format query parameter, set this header to application/json, application/xml, or text/xml.
X-Auth-Token
Type: string
Required: true
Authentication token.
X-Newest
Type: boolean
If set to true, Object Storage queries all replicas to return the most recent one. If you omit this header, Object Storage responds faster after it finds one valid replica. Because setting this header to true is more expensive for the back end, use it only when it is absolutely needed.

Response

Supported Media Types
  • application/json
200 Response
Success. The response body lists the objects.
Headers
Accept-Ranges
Type: string
The type of ranges that the object accepts.
Content-Length
Type: integer
Minimum Value: 0
The length of the response body that contains the list of names.
Content-Type
Type: string
The MIME type of the list of names.
Date
Type: string (date)
The transaction date and time.

The date and time stamp format is ISO 8601:

CCYY-MM-DDThh:mm:ss±hh:mm
For example, 2015-08-27T09:49:58-05:00.

The ±hh:mm value, if included, is the time zone as an offset from UTC. In the previous example, the offset value is -05:00.

A null value indicates that the token never expires.

X-Container-Bytes-Used
Type: integer
Minimum Value: 0
The count of bytes used in total.
X-Container-Meta-Access-Control-Allow-Origin
Type: string
(Optional) List of origins to be allowed to make cross-origin Requests. Entries in the list are space-separated.
X-Container-Meta-Access-Control-Expose-Headers
Type: string
(Optional) List of headers exposed to the user agent (e.g. browser) in the actual request response. Entries in the list are space-separated.
X-Container-Meta-Access-Control-Max-Age
Type: integer
Minimum Value: 0
(Optional) Maximum age in seconds for the origin to hold the preflight results.
X-Container-Meta-Temp-URL-Key
Type: string
(Optional) The secret key value for temporary URLs.
X-Container-Meta-Temp-URL-Key-2
Type: string
(Optional) A second secret key value for temporary URLs. The second key enables you to rotate keys by having two active keys at the same time.
X-Container-Meta-{name}
Type: string
The custom container metadata item, where {name} is the name of the metadata item. One X-Container-Meta-{name} response header appears for each metadata item (for each {name}).
X-Container-Object-Count
Type: integer
Minimum Value: 0
The number of objects.
X-Timestamp
Type: integer (timestamp)
Minimum Value: 0
The date and time in UNIX Epoch time stamp format when the account, container, or object was initially created as a current version.

For example, 1440619048 is equivalent to Mon, Wed, 26 Aug 2015 19:57:28 GMT.

X-Trans-Id
Type: string (uuid)
A unique transaction identifier for this request. Your service provider might need this value if you report a problem.
Body
Root Schema : /paths/~1v1~1{account}~1{container}/get/responses/200/schema
Nested Schema : /paths/~1v1~1{account}~1{container}/get/responses/200/schema/items
Type: object
204 Response
Success. The response body shows no objects. Either the container has no objects or you are paging through a long list of names by using the marker, limit, or end_marker query parameter and you have reached the end of the list.
Headers
Accept-Ranges
Type: string
The type of ranges that the object accepts.
Content-Length
Type: integer
Minimum Value: 0
The length of the response body that contains the list of names.
Content-Type
Type: string
The MIME type of the list of names.
Date
Type: string (date)
The transaction date and time.

The date and time stamp format is ISO 8601:

CCYY-MM-DDThh:mm:ss±hh:mm
For example, 2015-08-27T09:49:58-05:00.

The ±hh:mm value, if included, is the time zone as an offset from UTC. In the previous example, the offset value is -05:00.

A null value indicates that the token never expires.

X-Container-Bytes-Used
Type: integer
Minimum Value: 0
The count of bytes used in total.
X-Container-Meta-Access-Control-Allow-Origin
Type: string
(Optional) List of origins to be allowed to make cross-origin Requests. Entries in the list are space-separated.
X-Container-Meta-Access-Control-Expose-Headers
Type: string
(Optional) List of headers exposed to the user agent (e.g. browser) in the actual request response. Entries in the list are space-separated.
X-Container-Meta-Access-Control-Max-Age
Type: integer
Minimum Value: 0
(Optional) Maximum age in seconds for the origin to hold the preflight results.
X-Container-Meta-Temp-URL-Key
Type: string
(Optional) The secret key value for temporary URLs.
X-Container-Meta-Temp-URL-Key-2
Type: string
(Optional) A second secret key value for temporary URLs. The second key enables you to rotate keys by having two active keys at the same time.
X-Container-Meta-{name}
Type: string
The custom container metadata item, where {name} is the name of the metadata item. One X-Container-Meta-{name} response header appears for each metadata item (for each {name}).
X-Container-Object-Count
Type: integer
The number of objects.
X-Timestamp
Type: integer (timestamp)
Minimum Value: 0
The date and time in UNIX Epoch time stamp format when the account, container, or object was initially created as a current version.

For example, 1440619048 is equivalent to Mon, Wed, 26 Aug 2015 19:57:28 GMT.

X-Trans-Id
Type: string (uuid)
A unique transaction identifier for this request. Your service provider might need this value if you report a problem.
401 Response
Request does not include an authentication token, or authentication token specified in the request is not valid. It may have expired. Authentication tokens expire after 30 minutes.
Headers
Content-Length
Type: integer
Minimum Value: 0
The length of the error text in the response body.
Content-Type
Type: string
The MIME type of the error text in the response body.
403 Response
Forbidden. Possible causes:
  • A data center has not been selected for your service in Oracle Cloud My Services.
  • The request was sent to an incorrect data center. For example, the data center for your service is Chicago (us2), but the request was sent to the URL corresponding to the Ashburn (us6) data center.
  • You don't have the required permission to perform the operation on the specified container. For example, there may be a change in the roles assigned to your user or the access privileges defined for the container specified in the request.
Headers
Content-Length
Type: integer
Minimum Value: 0
The length of the error text in the response body.
Content-Type
Type: string
The MIME type of the error text in the response body.
404 Response
The container does not exist or has just been created and hasn't been replicated across all three nodes.
Headers
Content-Length
Type: integer
Minimum Value: 0
The length of the error text in the response body.
Content-Type
Type: string
The MIME type of the error text in the response body.
416 Response
Returned for any ranged GET requests that specify more than:
  • Fifty ranges
  • Three overlapping ranges
  • Eight non-increasing ranges
Headers
Content-Length
Type: integer
Minimum Value: 0
The length of the error text in the response body.
Content-Type
Type: string
The MIME type of the error text in the response body.

Examples

cURL Command

The following example shows how to retrieve the details for a container (and the objects in the container) in your account in Oracle Cloud Infrastructure Object Storage Classic by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -v -X GET \
     -H "X-Auth-Token: AUTH_tkb4fdf39c92e9f62cca9b7c196f8b6e6b" \
     https://foo.storage.oraclecloud.com/v1/myservice-bar/FirstContainer

Sample Response

The following is a sample response of this command:

HTTP/1.1 200 OK
X-Container-Object-Count: 5
X-Container-Write: myDomain.myservice.Storage_ReadWriteGroup
Accept-Ranges: bytes
X-Timestamp: 1434368768.60255
X-Container-Read: myDomain.myservice.Storage_ReadOnlyGroup,myDomain.myservice.Storage_ReadWriteGroup
X-Container-Bytes-Used: 325079334
X-Trans-Id: tx9b1fba66533046df9b11e-0056c582faga
Date: Thu, 18 Feb 2016 08:38:18 GMT
X-Storage-Class: Standard
X-Container-Meta-Policy-Georeplication: us2
X-Last-Modified-Timestamp: 1450251526.69885
Content-Type: text/plain;charset=utf-8
Content-Length: 235
newobj-aa
newobj-ab
newobj-ac
newobj-ad
newobj-ae