Jump to

• Request
• Response
• Examples

Show account metadata

head

/v1/{account}

Shows metadata for an account.

Request

Path Parameters

• account: string
  The unique name for the account. An account is also known as the project or tenant.

Header Parameters

• X-Auth-Token: string
  Authentication token.
• X-Newest(optional): 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.

Back to Top

Response

Supported Media Types

• application/json

204 Response

Success

Headers

• Content-Length: integer
  Minimum Value: 0

  Maximum Value: 0

  This value is zero (0).
• X-Account-Bytes-Used: integer
  Minimum Value: 0

  The total number of bytes that are stored in Object Storage for the account.
• X-Account-Container-Count: integer
  Minimum Value: 0

  The number of containers.
• X-Account-Meta-Temp-URL-Key: string
  (Optional) The secret key value for temporary URLs. If not set, this header is not returned in the response.'
• X-Account-Meta-Temp-URL-Key-2: string
  (Optional) A second secret key value for temporary URLs. If not set, this header is not returned in the response.
• X-Account-Meta-{name}: string
  (Optional) The custom account metadata item, where {name} is the name of the metadata item.

  One X-Account-Meta-{name} response header appears for each metadata item (for each {name}).

• X-Account-Object-Count: integer
  Minimum Value: 0

  The number of objects in the account.
• X-Timestamp: 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: 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: integer
  Minimum Value: 0

  The length of the error text in the response body.
• Content-Type: string
  The MIME type of the error text in the response body.

Back to Top

Examples

cURL Command

Sample Cloud account with the following details:

• Account name: acme

• REST Endpoint URL: https://acme.storage.oraclecloud.com/v1/Storage-acme

• REST Endpoint (Permanent) URL: https://storage-7b16fede61e1417ab83eb52e06f0e365.storage.oraclecloud.com/v1/Storage-7b16fede61e1417ab83eb52e06f0e365

Note:

The REST Endpoint (Permanent) URL is displayed for the accounts created after November 2017.

The following example shows how to retrieve information about your account in Oracle Cloud Infrastructure Object Storage Classic by submitting a HEAD request on the REST resource using cURL. For more information about cURL, see Use cURL.

• Using the REST Endpoint URL obtained from the REST Endpoint field in the My Services dashboard:

  curl -v -X HEAD \
       -H "X-Auth-Token: AUTH_tkb4fdf39c92e9f62cca9b7c196f8b6e6b" \
       https://acme.storage.oraclecloud.com/v1/Storage-acme

  The following is a sample response of this command:

  HTTP/1.1 204 No Content
  Content-Length: 0
  Date: Fri, 06 Mar 2015 11:48:19 GMT
  X-Account-Container-Count: 3
  X-Account-Meta-Owner: IT
  Accept-Ranges: bytes
  X-Account-Object-Count: 843
  X-Account-Bytes-Used: 10304761355
  X-Timestamp: 1412823447.62495
  X-Account-Meta-Quota-Bytes: 107374182400
  Content-Type: text/plain; charset=utf-8
  X-Trans-Id: tx23a1084b8c674fdeae8d4-0054f982ac
  

• Using the Service Permanent REST Endpoint URL obtained from the REST Endpoint (Permanent) field in the My Services dashboard:

  Note:

  This cURL command example applies to the accounts created after November 2017.

  curl -v -X HEAD \
       -H "X-Auth-Token: AUTH_tkb4fdf39c92e9f62cca9b7c196f8b6e6b" \
       https://storage-7b16fede61e1417ab83eb52e06f0e365.storage.oraclecloud.com/v1/Storage-7b16fede61e1417ab83eb52e06f0e365

  The following is a sample response of this command:

  HTTP/1.1 204 No Content
  Content-Length: 0
  Date: Fri, 06 Mar 2015 11:48:19 GMT
  X-Account-Container-Count: 3
  X-Account-Meta-Owner: IT
  Accept-Ranges: bytes
  X-Account-Object-Count: 843
  X-Account-Bytes-Used: 10304761355
  X-Timestamp: 1412823447.62495
  X-Account-Meta-Quota-Bytes: 107374182400
  Content-Type: text/plain; charset=utf-8
  X-Trans-Id: tx23a1084b8c674fdeae8d4-0054f982ac
  

Back to Top