openstack/swift
Code Issues Proposed changes
b4c1517ddd
swift/api-ref/source/storage-container-services.inc

532 lines
14 KiB
PHP
Raw Normal View History

Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
.. -*- rst -*-
==========
Containers
==========
Lists objects in a container. Creates, shows details for, and
deletes containers. Creates, updates, shows, and deletes container
Corrections for the API specifications in api-ref Fixes a number of technical issues with the api-ref section including: - Added missing headers - The header descriptions were made specific to whether they are used in requests or responses and the verb in question (example: Content-Length in object HEAD is the object size, not the response body length). - Added references to API features such as bulk delete. - Many typographical fixes (e.g., spaces in the middle of header names) - Restored xml and json account/container listing examples. The following areas were not updated and it is proposed to defer them to a subsequent update. This is because I don't have time or their merit is debatable: - ACLs (as used in a Keystone context) are not described. - Account create/delete is not described. - I left List Endpoints as-is. Change-Id: I315b4e550b7d10880fbc00fce9311127ba609c2d
2016-08-12 15:52:55 +01:00
metadata. For more information and concepts about
containers see `Object Storage API overview
<http://docs.openstack.org/developer/swift/api/object_api_v1_overview.html>`_.
Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
Show container details and list objects
=======================================
.. rest_method:: GET /v1/{account}/{container}
Shows details for a container and lists objects, sorted by name, in the container.
Specify query parameters in the request to filter the list and
Corrections for the API specifications in api-ref Fixes a number of technical issues with the api-ref section including: - Added missing headers - The header descriptions were made specific to whether they are used in requests or responses and the verb in question (example: Content-Length in object HEAD is the object size, not the response body length). - Added references to API features such as bulk delete. - Many typographical fixes (e.g., spaces in the middle of header names) - Restored xml and json account/container listing examples. The following areas were not updated and it is proposed to defer them to a subsequent update. This is because I don't have time or their merit is debatable: - ACLs (as used in a Keystone context) are not described. - Account create/delete is not described. - I left List Endpoints as-is. Change-Id: I315b4e550b7d10880fbc00fce9311127ba609c2d
2016-08-12 15:52:55 +01:00
return a subset of objects. Omit query parameters to return
a list of objects that are stored in the container,
Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
up to 10,000 names. The 10,000 maximum value is configurable. To
view the value for the cluster, issue a GET ``/info`` request.
Example requests and responses:
- ``OK (200)``. Success. The response body lists the objects.
- ``No Content (204)``. Success. The response body shows no objects.
Either the container has no objects or you are paging through a
Corrections for the API specifications in api-ref Fixes a number of technical issues with the api-ref section including: - Added missing headers - The header descriptions were made specific to whether they are used in requests or responses and the verb in question (example: Content-Length in object HEAD is the object size, not the response body length). - Added references to API features such as bulk delete. - Many typographical fixes (e.g., spaces in the middle of header names) - Restored xml and json account/container listing examples. The following areas were not updated and it is proposed to defer them to a subsequent update. This is because I don't have time or their merit is debatable: - ACLs (as used in a Keystone context) are not described. - Account create/delete is not described. - I left List Endpoints as-is. Change-Id: I315b4e550b7d10880fbc00fce9311127ba609c2d
2016-08-12 15:52:55 +01:00
long list of objects by using the ``marker``, ``limit``, or
Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
``end_marker`` query parameter and you have reached the end of
the list.
If the container does not exist, the call returns the ``Not Found
(404)`` response code.
Normal response codes: 200
Error response codes:416,404,204,
Request
-------
.. rest_parameters:: parameters.yaml
- account: account
- container: container
- limit: limit
- marker: marker
- end_marker: end_marker
- prefix: prefix
- format: format
- delimiter: delimiter
- path: path
- X-Auth-Token: X-Auth-Token
Corrections for the API specifications in api-ref Fixes a number of technical issues with the api-ref section including: - Added missing headers - The header descriptions were made specific to whether they are used in requests or responses and the verb in question (example: Content-Length in object HEAD is the object size, not the response body length). - Added references to API features such as bulk delete. - Many typographical fixes (e.g., spaces in the middle of header names) - Restored xml and json account/container listing examples. The following areas were not updated and it is proposed to defer them to a subsequent update. This is because I don't have time or their merit is debatable: - ACLs (as used in a Keystone context) are not described. - Account create/delete is not described. - I left List Endpoints as-is. Change-Id: I315b4e550b7d10880fbc00fce9311127ba609c2d
2016-08-12 15:52:55 +01:00
- X-Service-Token: X-Service-Token
Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
- X-Newest: X-Newest
- Accept: Accept
- X-Container-Meta-Temp-URL-Key: X-Container-Meta-Temp-URL-Key
- X-Container-Meta-Temp-URL-Key-2: X-Container-Meta-Temp-URL-Key-2
- X-Trans-Id-Extra: X-Trans-Id-Extra
Corrections for the API specifications in api-ref Fixes a number of technical issues with the api-ref section including: - Added missing headers - The header descriptions were made specific to whether they are used in requests or responses and the verb in question (example: Content-Length in object HEAD is the object size, not the response body length). - Added references to API features such as bulk delete. - Many typographical fixes (e.g., spaces in the middle of header names) - Restored xml and json account/container listing examples. The following areas were not updated and it is proposed to defer them to a subsequent update. This is because I don't have time or their merit is debatable: - ACLs (as used in a Keystone context) are not described. - Account create/delete is not described. - I left List Endpoints as-is. Change-Id: I315b4e550b7d10880fbc00fce9311127ba609c2d
2016-08-12 15:52:55 +01:00
- X-Storage-Policy: X-Storage-Policy
Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- X-Container-Meta-name: X-Container-Meta-name
Corrections for the API specifications in api-ref Fixes a number of technical issues with the api-ref section including: - Added missing headers - The header descriptions were made specific to whether they are used in requests or responses and the verb in question (example: Content-Length in object HEAD is the object size, not the response body length). - Added references to API features such as bulk delete. - Many typographical fixes (e.g., spaces in the middle of header names) - Restored xml and json account/container listing examples. The following areas were not updated and it is proposed to defer them to a subsequent update. This is because I don't have time or their merit is debatable: - ACLs (as used in a Keystone context) are not described. - Account create/delete is not described. - I left List Endpoints as-is. Change-Id: I315b4e550b7d10880fbc00fce9311127ba609c2d
2016-08-12 15:52:55 +01:00
- Content-Length: Content-Length_listing_resp
Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
- X-Container-Object-Count: X-Container-Object-Count
Corrections for the API specifications in api-ref Fixes a number of technical issues with the api-ref section including: - Added missing headers - The header descriptions were made specific to whether they are used in requests or responses and the verb in question (example: Content-Length in object HEAD is the object size, not the response body length). - Added references to API features such as bulk delete. - Many typographical fixes (e.g., spaces in the middle of header names) - Restored xml and json account/container listing examples. The following areas were not updated and it is proposed to defer them to a subsequent update. This is because I don't have time or their merit is debatable: - ACLs (as used in a Keystone context) are not described. - Account create/delete is not described. - I left List Endpoints as-is. Change-Id: I315b4e550b7d10880fbc00fce9311127ba609c2d
2016-08-12 15:52:55 +01:00
- X-Container-Bytes-Used: X-Container-Bytes-Used
Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
- Accept-Ranges: Accept-Ranges
- X-Container-Meta-Temp-URL-Key: X-Container-Meta-Temp-URL-Key
- X-Container-Meta-Temp-URL-Key-2: X-Container-Meta-Temp-URL-Key-2
Corrections for the API specifications in api-ref Fixes a number of technical issues with the api-ref section including: - Added missing headers - The header descriptions were made specific to whether they are used in requests or responses and the verb in question (example: Content-Length in object HEAD is the object size, not the response body length). - Added references to API features such as bulk delete. - Many typographical fixes (e.g., spaces in the middle of header names) - Restored xml and json account/container listing examples. The following areas were not updated and it is proposed to defer them to a subsequent update. This is because I don't have time or their merit is debatable: - ACLs (as used in a Keystone context) are not described. - Account create/delete is not described. - I left List Endpoints as-is. Change-Id: I315b4e550b7d10880fbc00fce9311127ba609c2d
2016-08-12 15:52:55 +01:00
- X-Storage-Policy: X-Storage-Policy
- X-Container-Read: X-Container-Read_resp
- X-Container-Write: X-Container-Write_resp
- X-Container-Sync-Key: X-Container-Sync-Key_resp
- X-Container-Sync-To: X-Container-Sync-To_resp
- X-Versions-Location: X-Versions-Location_resp
- X-Versions-Mode: X-Versions-Mode_resp
Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
- X-Timestamp: X-Timestamp
- X-Trans-Id: X-Trans-Id
Corrections for the API specifications in api-ref Fixes a number of technical issues with the api-ref section including: - Added missing headers - The header descriptions were made specific to whether they are used in requests or responses and the verb in question (example: Content-Length in object HEAD is the object size, not the response body length). - Added references to API features such as bulk delete. - Many typographical fixes (e.g., spaces in the middle of header names) - Restored xml and json account/container listing examples. The following areas were not updated and it is proposed to defer them to a subsequent update. This is because I don't have time or their merit is debatable: - ACLs (as used in a Keystone context) are not described. - Account create/delete is not described. - I left List Endpoints as-is. Change-Id: I315b4e550b7d10880fbc00fce9311127ba609c2d
2016-08-12 15:52:55 +01:00
- Content_Type: Content-Type_listing_resp
Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
- Date: Date
- hash: hash
- last_modified: last_modified
Corrections for the API specifications in api-ref Fixes a number of technical issues with the api-ref section including: - Added missing headers - The header descriptions were made specific to whether they are used in requests or responses and the verb in question (example: Content-Length in object HEAD is the object size, not the response body length). - Added references to API features such as bulk delete. - Many typographical fixes (e.g., spaces in the middle of header names) - Restored xml and json account/container listing examples. The following areas were not updated and it is proposed to defer them to a subsequent update. This is because I don't have time or their merit is debatable: - ACLs (as used in a Keystone context) are not described. - Account create/delete is not described. - I left List Endpoints as-is. Change-Id: I315b4e550b7d10880fbc00fce9311127ba609c2d
2016-08-12 15:52:55 +01:00
- content_type: content_type
Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
- bytes: bytes
- name: name
Corrections for the API specifications in api-ref Fixes a number of technical issues with the api-ref section including: - Added missing headers - The header descriptions were made specific to whether they are used in requests or responses and the verb in question (example: Content-Length in object HEAD is the object size, not the response body length). - Added references to API features such as bulk delete. - Many typographical fixes (e.g., spaces in the middle of header names) - Restored xml and json account/container listing examples. The following areas were not updated and it is proposed to defer them to a subsequent update. This is because I don't have time or their merit is debatable: - ACLs (as used in a Keystone context) are not described. - Account create/delete is not described. - I left List Endpoints as-is. Change-Id: I315b4e550b7d10880fbc00fce9311127ba609c2d
2016-08-12 15:52:55 +01:00
Response Example format=json
----------------------------
Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
Corrections for the API specifications in api-ref Fixes a number of technical issues with the api-ref section including: - Added missing headers - The header descriptions were made specific to whether they are used in requests or responses and the verb in question (example: Content-Length in object HEAD is the object size, not the response body length). - Added references to API features such as bulk delete. - Many typographical fixes (e.g., spaces in the middle of header names) - Restored xml and json account/container listing examples. The following areas were not updated and it is proposed to defer them to a subsequent update. This is because I don't have time or their merit is debatable: - ACLs (as used in a Keystone context) are not described. - Account create/delete is not described. - I left List Endpoints as-is. Change-Id: I315b4e550b7d10880fbc00fce9311127ba609c2d
2016-08-12 15:52:55 +01:00
.. literalinclude:: samples/objects-list-http-response-json.txt
.. literalinclude:: samples/objects-list-response.json
Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
Corrections for the API specifications in api-ref Fixes a number of technical issues with the api-ref section including: - Added missing headers - The header descriptions were made specific to whether they are used in requests or responses and the verb in question (example: Content-Length in object HEAD is the object size, not the response body length). - Added references to API features such as bulk delete. - Many typographical fixes (e.g., spaces in the middle of header names) - Restored xml and json account/container listing examples. The following areas were not updated and it is proposed to defer them to a subsequent update. This is because I don't have time or their merit is debatable: - ACLs (as used in a Keystone context) are not described. - Account create/delete is not described. - I left List Endpoints as-is. Change-Id: I315b4e550b7d10880fbc00fce9311127ba609c2d
2016-08-12 15:52:55 +01:00
Response Example format=xml
---------------------------
Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
Corrections for the API specifications in api-ref Fixes a number of technical issues with the api-ref section including: - Added missing headers - The header descriptions were made specific to whether they are used in requests or responses and the verb in question (example: Content-Length in object HEAD is the object size, not the response body length). - Added references to API features such as bulk delete. - Many typographical fixes (e.g., spaces in the middle of header names) - Restored xml and json account/container listing examples. The following areas were not updated and it is proposed to defer them to a subsequent update. This is because I don't have time or their merit is debatable: - ACLs (as used in a Keystone context) are not described. - Account create/delete is not described. - I left List Endpoints as-is. Change-Id: I315b4e550b7d10880fbc00fce9311127ba609c2d
2016-08-12 15:52:55 +01:00
.. literalinclude:: samples/objects-list-http-response-xml.txt
.. literalinclude:: samples/objects-list-response.xml
Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
Create container
================
.. rest_method:: PUT /v1/{account}/{container}
Creates a container.
You do not need to check whether a container already exists before
issuing a PUT operation because the operation is idempotent: It
creates a container or updates an existing container, as
appropriate.
Corrections for the API specifications in api-ref Fixes a number of technical issues with the api-ref section including: - Added missing headers - The header descriptions were made specific to whether they are used in requests or responses and the verb in question (example: Content-Length in object HEAD is the object size, not the response body length). - Added references to API features such as bulk delete. - Many typographical fixes (e.g., spaces in the middle of header names) - Restored xml and json account/container listing examples. The following areas were not updated and it is proposed to defer them to a subsequent update. This is because I don't have time or their merit is debatable: - ACLs (as used in a Keystone context) are not described. - Account create/delete is not described. - I left List Endpoints as-is. Change-Id: I315b4e550b7d10880fbc00fce9311127ba609c2d
2016-08-12 15:52:55 +01:00
To create, update, or delete a custom metadata item, use the ``X
-Container-Meta-{name}`` header, where ``{name}`` is the name of
the metadata item.
api-ref: Move repeated paragraph to an include file Move repeated test re metadata header syntax to an include file and make it be rendered as a note. Also make already included text about metadata header value encoding be a note. Change-Id: I4795836587492954ad24dd5baaa5d668746d6040
2016-09-08 16:41:26 +01:00
.. include:: metadata_header_syntax.inc
Corrections for the API specifications in api-ref Fixes a number of technical issues with the api-ref section including: - Added missing headers - The header descriptions were made specific to whether they are used in requests or responses and the verb in question (example: Content-Length in object HEAD is the object size, not the response body length). - Added references to API features such as bulk delete. - Many typographical fixes (e.g., spaces in the middle of header names) - Restored xml and json account/container listing examples. The following areas were not updated and it is proposed to defer them to a subsequent update. This is because I don't have time or their merit is debatable: - ACLs (as used in a Keystone context) are not described. - Account create/delete is not described. - I left List Endpoints as-is. Change-Id: I315b4e550b7d10880fbc00fce9311127ba609c2d
2016-08-12 15:52:55 +01:00
.. include:: metadata_header_encoding.inc
Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
Example requests and responses:
- Create a container with no metadata:
::
curl -i $publicURL/steven -X PUT -H "Content-Length: 0" -H "X-Auth-Token: $token"
::
HTTP/1.1 201 Created
Content-Length: 0
Content-Type: text/html; charset=UTF-8
X-Trans-Id: tx7f6b7fa09bc2443a94df0-0052d58b56
Date: Tue, 14 Jan 2014 19:09:10 GMT
- Create a container with metadata:
::
curl -i $publicURL/marktwain -X PUT -H "X-Auth-Token: $token" -H "X-Container-Meta-Book: TomSawyer"
Corrections for the API specifications in api-ref Fixes a number of technical issues with the api-ref section including: - Added missing headers - The header descriptions were made specific to whether they are used in requests or responses and the verb in question (example: Content-Length in object HEAD is the object size, not the response body length). - Added references to API features such as bulk delete. - Many typographical fixes (e.g., spaces in the middle of header names) - Restored xml and json account/container listing examples. The following areas were not updated and it is proposed to defer them to a subsequent update. This is because I don't have time or their merit is debatable: - ACLs (as used in a Keystone context) are not described. - Account create/delete is not described. - I left List Endpoints as-is. Change-Id: I315b4e550b7d10880fbc00fce9311127ba609c2d
2016-08-12 15:52:55 +01:00
::
HTTP/1.1 201 Created
Content-Length: 0
Content-Type: text/html; charset=UTF-8
X-Trans-Id: tx06021f10fc8642b2901e7-0052d58f37
Date: Tue, 14 Jan 2014 19:25:43 GMT
- Create a container with an ACL to allow anybody to get an object in the
marktwain container:
::
curl -i $publicURL/marktwain -X PUT -H "X-Auth-Token: $token" -H "X-Container-Read: .r:*"
Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
::
HTTP/1.1 201 Created
Content-Length: 0
Content-Type: text/html; charset=UTF-8
X-Trans-Id: tx06021f10fc8642b2901e7-0052d58f37
Date: Tue, 14 Jan 2014 19:25:43 GMT
Error response codes:201,204,
Request
-------
.. rest_parameters:: parameters.yaml
- account: account
- container: container
- X-Auth-Token: X-Auth-Token
Corrections for the API specifications in api-ref Fixes a number of technical issues with the api-ref section including: - Added missing headers - The header descriptions were made specific to whether they are used in requests or responses and the verb in question (example: Content-Length in object HEAD is the object size, not the response body length). - Added references to API features such as bulk delete. - Many typographical fixes (e.g., spaces in the middle of header names) - Restored xml and json account/container listing examples. The following areas were not updated and it is proposed to defer them to a subsequent update. This is because I don't have time or their merit is debatable: - ACLs (as used in a Keystone context) are not described. - Account create/delete is not described. - I left List Endpoints as-is. Change-Id: I315b4e550b7d10880fbc00fce9311127ba609c2d
2016-08-12 15:52:55 +01:00
- X-Service-Token: X-Service-Token
Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
- X-Container-Read: X-Container-Read
- X-Container-Write: X-Container-Write
- X-Container-Sync-To: X-Container-Sync-To
- X-Container-Sync-Key: X-Container-Sync-Key
- X-Versions-Location: X-Versions-Location
Add "history" mode to versioned_writes middleware This change introduces the concept of a "versioning mode" for versioned_writes. The following modes are supported: * stack When deleting, check whether any previous versions exist in the versions container. If none is found, the object is deleted. If the most-recent version in the versions container is not a delete marker, it is copied into the versioned container (overwriting the current version if one exists) and then deleted from the versions container. This preserves the previous behavior. If the most-recent version in the versions container is a delete marker and a current version exists in the versioned container, the current version is deleted. If the most-recent version in the versions container is a delete marker and no current version exists in the versioned container, we copy the next-most-recent version from the versions container into the versioned container (assuming it exists and is not a delete marker) and delete both the most-recent version (i.e., the delete marker) and the just-copied next-most-recent version from the versions container. With this mode, DELETEs to versioned containers "undo" operations on containers. Previously this was limited to undoing PUTs, but now it will also undo DELETEs performed while in "history" mode. * history When deleting, check whether a current version exists in the versioned container. If one is found, it is copied to the versions container. Then an empty "delete marker" object is also put into the versions container; this records when the object was deleted. Finally, the original current version is deleted from the versioned container. As a result, subsequent GETs or HEADs will return a 404, and container listings for the versioned container do not include the object. With this mode, DELETEs to versioned containers behave like DELETEs to other containers, but with a history of what has happened. Clients may specify (via a new X-Versions-Mode header) which mode a container should use. By default, the existing "stack" mode is used. Upgrade consideration: ====================== Clients should not use the "history" mode until all proxies in the cluster have been upgraded. Attempting to use the "history" mode during a rolling upgrade may result in some requests being served by proxies running old code (which necessarily uses the "stack" mode), leading to data loss. Change-Id: I555dc17fefd0aa9ade681aa156da24e018ebe74b
2015-08-19 12:17:47 -07:00
- X-Versions-Mode: X-Versions-Mode
Corrections for the API specifications in api-ref Fixes a number of technical issues with the api-ref section including: - Added missing headers - The header descriptions were made specific to whether they are used in requests or responses and the verb in question (example: Content-Length in object HEAD is the object size, not the response body length). - Added references to API features such as bulk delete. - Many typographical fixes (e.g., spaces in the middle of header names) - Restored xml and json account/container listing examples. The following areas were not updated and it is proposed to defer them to a subsequent update. This is because I don't have time or their merit is debatable: - ACLs (as used in a Keystone context) are not described. - Account create/delete is not described. - I left List Endpoints as-is. Change-Id: I315b4e550b7d10880fbc00fce9311127ba609c2d
2016-08-12 15:52:55 +01:00
- X-Container-Meta-name: X-Container-Meta-name_req
Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
- X-Container-Meta-Access-Control-Allow-Origin: X-Container-Meta-Access-Control-Allow-Origin
- X-Container-Meta-Access-Control-Max-Age: X-Container-Meta-Access-Control-Max-Age
- X-Container-Meta-Access-Control-Expose-Headers: X-Container-Meta-Access-Control-Expose-Headers
- X-Container-Meta-Temp-URL-Key: X-Container-Meta-Temp-URL-Key
- X-Container-Meta-Temp-URL-Key-2: X-Container-Meta-Temp-URL-Key-2
- X-Trans-Id-Extra: X-Trans-Id-Extra
Corrections for the API specifications in api-ref Fixes a number of technical issues with the api-ref section including: - Added missing headers - The header descriptions were made specific to whether they are used in requests or responses and the verb in question (example: Content-Length in object HEAD is the object size, not the response body length). - Added references to API features such as bulk delete. - Many typographical fixes (e.g., spaces in the middle of header names) - Restored xml and json account/container listing examples. The following areas were not updated and it is proposed to defer them to a subsequent update. This is because I don't have time or their merit is debatable: - ACLs (as used in a Keystone context) are not described. - Account create/delete is not described. - I left List Endpoints as-is. Change-Id: I315b4e550b7d10880fbc00fce9311127ba609c2d
2016-08-12 15:52:55 +01:00
- X-Storage-Policy: X-Storage-Policy
Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- Date: Date
- X-Timestamp: X-Timestamp
Corrections for the API specifications in api-ref Fixes a number of technical issues with the api-ref section including: - Added missing headers - The header descriptions were made specific to whether they are used in requests or responses and the verb in question (example: Content-Length in object HEAD is the object size, not the response body length). - Added references to API features such as bulk delete. - Many typographical fixes (e.g., spaces in the middle of header names) - Restored xml and json account/container listing examples. The following areas were not updated and it is proposed to defer them to a subsequent update. This is because I don't have time or their merit is debatable: - ACLs (as used in a Keystone context) are not described. - Account create/delete is not described. - I left List Endpoints as-is. Change-Id: I315b4e550b7d10880fbc00fce9311127ba609c2d
2016-08-12 15:52:55 +01:00
- Content-Length: Content-Length_cud_resp
- Content-Type: Content-Type_cud_resp
Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
- X-Trans-Id: X-Trans-Id
Create, update, or delete container metadata
============================================
.. rest_method:: POST /v1/{account}/{container}
Creates, updates, or deletes custom metadata for a container.
To create, update, or delete a custom metadata item, use the ``X
-Container-Meta-{name}`` header, where ``{name}`` is the name of
the metadata item.
api-ref: Move repeated paragraph to an include file Move repeated test re metadata header syntax to an include file and make it be rendered as a note. Also make already included text about metadata header value encoding be a note. Change-Id: I4795836587492954ad24dd5baaa5d668746d6040
2016-09-08 16:41:26 +01:00
.. include:: metadata_header_syntax.inc
Corrections for the API specifications in api-ref Fixes a number of technical issues with the api-ref section including: - Added missing headers - The header descriptions were made specific to whether they are used in requests or responses and the verb in question (example: Content-Length in object HEAD is the object size, not the response body length). - Added references to API features such as bulk delete. - Many typographical fixes (e.g., spaces in the middle of header names) - Restored xml and json account/container listing examples. The following areas were not updated and it is proposed to defer them to a subsequent update. This is because I don't have time or their merit is debatable: - ACLs (as used in a Keystone context) are not described. - Account create/delete is not described. - I left List Endpoints as-is. Change-Id: I315b4e550b7d10880fbc00fce9311127ba609c2d
2016-08-12 15:52:55 +01:00
.. include:: metadata_header_encoding.inc
Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
Subsequent requests for the same key and value pair overwrite the
previous value.
To delete container metadata, send an empty value for that header,
such as for the ``X-Container-Meta-Book`` header. If the tool you
use to communicate with Object Storage, such as an older version of
cURL, does not support empty headers, send the ``X-Remove-
Container-Meta-{name}`` header with an arbitrary value. For
example, ``X-Remove-Container-Meta-Book: x``. The operation ignores
the arbitrary value.
If the container already has other custom metadata items, a request
to create, update, or delete metadata does not affect those items.
Example requests and responses:
- Create container metadata:
::
curl -i $publicURL/marktwain -X POST -H "X-Auth-Token: $token" -H "X-Container-Meta-Author: MarkTwain" -H "X-Container-Meta-Web-Directory-Type: text/directory" -H "X-Container-Meta-Century: Nineteenth"
::
HTTP/1.1 204 No Content
Content-Length: 0
Content-Type: text/html; charset=UTF-8
X-Trans-Id: tx05dbd434c651429193139-0052d82635
Date: Thu, 16 Jan 2014 18:34:29 GMT
- Update container metadata:
::
curl -i $publicURL/marktwain -X POST -H "X-Auth-Token: $token" -H "X-Container-Meta-Author: SamuelClemens"
::
HTTP/1.1 204 No Content
Content-Length: 0
Content-Type: text/html; charset=UTF-8
X-Trans-Id: txe60c7314bf614bb39dfe4-0052d82653
Date: Thu, 16 Jan 2014 18:34:59 GMT
- Delete container metadata:
::
curl -i $publicURL/marktwain -X POST -H "X-Auth-Token: $token" -H "X-Remove-Container-Meta-Century: x"
::
HTTP/1.1 204 No Content
Content-Length: 0
Content-Type: text/html; charset=UTF-8
X-Trans-Id: tx7997e18da2a34a9e84ceb-0052d826d0
Date: Thu, 16 Jan 2014 18:37:04 GMT
If the request succeeds, the operation returns the ``No Content
(204)`` response code.
To confirm your changes, issue a show container metadata request.
Error response codes:204,
Request
-------
.. rest_parameters:: parameters.yaml
- account: account
- container: container
- X-Auth-Token: X-Auth-Token
Corrections for the API specifications in api-ref Fixes a number of technical issues with the api-ref section including: - Added missing headers - The header descriptions were made specific to whether they are used in requests or responses and the verb in question (example: Content-Length in object HEAD is the object size, not the response body length). - Added references to API features such as bulk delete. - Many typographical fixes (e.g., spaces in the middle of header names) - Restored xml and json account/container listing examples. The following areas were not updated and it is proposed to defer them to a subsequent update. This is because I don't have time or their merit is debatable: - ACLs (as used in a Keystone context) are not described. - Account create/delete is not described. - I left List Endpoints as-is. Change-Id: I315b4e550b7d10880fbc00fce9311127ba609c2d
2016-08-12 15:52:55 +01:00
- X-Service-Token: X-Service-Token
Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
- X-Container-Read: X-Container-Read
- X-Remove-Container-name: X-Remove-Container-name
- X-Container-Write: X-Container-Write
- X-Container-Sync-To: X-Container-Sync-To
- X-Container-Sync-Key: X-Container-Sync-Key
- X-Versions-Location: X-Versions-Location
Add "history" mode to versioned_writes middleware This change introduces the concept of a "versioning mode" for versioned_writes. The following modes are supported: * stack When deleting, check whether any previous versions exist in the versions container. If none is found, the object is deleted. If the most-recent version in the versions container is not a delete marker, it is copied into the versioned container (overwriting the current version if one exists) and then deleted from the versions container. This preserves the previous behavior. If the most-recent version in the versions container is a delete marker and a current version exists in the versioned container, the current version is deleted. If the most-recent version in the versions container is a delete marker and no current version exists in the versioned container, we copy the next-most-recent version from the versions container into the versioned container (assuming it exists and is not a delete marker) and delete both the most-recent version (i.e., the delete marker) and the just-copied next-most-recent version from the versions container. With this mode, DELETEs to versioned containers "undo" operations on containers. Previously this was limited to undoing PUTs, but now it will also undo DELETEs performed while in "history" mode. * history When deleting, check whether a current version exists in the versioned container. If one is found, it is copied to the versions container. Then an empty "delete marker" object is also put into the versions container; this records when the object was deleted. Finally, the original current version is deleted from the versioned container. As a result, subsequent GETs or HEADs will return a 404, and container listings for the versioned container do not include the object. With this mode, DELETEs to versioned containers behave like DELETEs to other containers, but with a history of what has happened. Clients may specify (via a new X-Versions-Mode header) which mode a container should use. By default, the existing "stack" mode is used. Upgrade consideration: ====================== Clients should not use the "history" mode until all proxies in the cluster have been upgraded. Attempting to use the "history" mode during a rolling upgrade may result in some requests being served by proxies running old code (which necessarily uses the "stack" mode), leading to data loss. Change-Id: I555dc17fefd0aa9ade681aa156da24e018ebe74b
2015-08-19 12:17:47 -07:00
- X-Versions-Mode: X-Versions-Mode
Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
- X-Remove-Versions-Location: X-Remove-Versions-Location
Corrections for the API specifications in api-ref Fixes a number of technical issues with the api-ref section including: - Added missing headers - The header descriptions were made specific to whether they are used in requests or responses and the verb in question (example: Content-Length in object HEAD is the object size, not the response body length). - Added references to API features such as bulk delete. - Many typographical fixes (e.g., spaces in the middle of header names) - Restored xml and json account/container listing examples. The following areas were not updated and it is proposed to defer them to a subsequent update. This is because I don't have time or their merit is debatable: - ACLs (as used in a Keystone context) are not described. - Account create/delete is not described. - I left List Endpoints as-is. Change-Id: I315b4e550b7d10880fbc00fce9311127ba609c2d
2016-08-12 15:52:55 +01:00
- X-Container-Meta-name: X-Container-Meta-name_req
Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
- X-Container-Meta-Access-Control-Allow-Origin: X-Container-Meta-Access-Control-Allow-Origin
- X-Container-Meta-Access-Control-Max-Age: X-Container-Meta-Access-Control-Max-Age
- X-Container-Meta-Access-Control-Expose-Headers: X-Container-Meta-Access-Control-Expose-Headers
- X-Container-Meta-Quota-Bytes: X-Container-Meta-Quota-Bytes
- X-Container-Meta-Quota-Count: X-Container-Meta-Quota-Count
- X-Container-Meta-Web-Directory-Type: X-Container-Meta-Web-Directory-Type
- X-Container-Meta-Temp-URL-Key: X-Container-Meta-Temp-URL-Key
- X-Container-Meta-Temp-URL-Key-2: X-Container-Meta-Temp-URL-Key-2
- X-Trans-Id-Extra: X-Trans-Id-Extra
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- Date: Date
- X-Timestamp: X-Timestamp
Corrections for the API specifications in api-ref Fixes a number of technical issues with the api-ref section including: - Added missing headers - The header descriptions were made specific to whether they are used in requests or responses and the verb in question (example: Content-Length in object HEAD is the object size, not the response body length). - Added references to API features such as bulk delete. - Many typographical fixes (e.g., spaces in the middle of header names) - Restored xml and json account/container listing examples. The following areas were not updated and it is proposed to defer them to a subsequent update. This is because I don't have time or their merit is debatable: - ACLs (as used in a Keystone context) are not described. - Account create/delete is not described. - I left List Endpoints as-is. Change-Id: I315b4e550b7d10880fbc00fce9311127ba609c2d
2016-08-12 15:52:55 +01:00
- Content-Length: Content-Length_cud_resp
- Content-Type: Content-Type_cud_resp
Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
- X-Trans-Id: X-Trans-Id
Show container metadata
=======================
.. rest_method:: HEAD /v1/{account}/{container}
Shows container metadata, including the number of objects and the total bytes of all objects stored in the container.
Show container metadata request:
::
curl -i $publicURL/marktwain -X HEAD -H "X-Auth-Token: $token"
::
HTTP/1.1 204 No Content
Content-Length: 0
X-Container-Object-Count: 1
Accept-Ranges: bytes
X-Container-Meta-Book: TomSawyer
X-Timestamp: 1389727543.65372
X-Container-Meta-Author: SamuelClemens
X-Container-Bytes-Used: 14
Content-Type: text/plain; charset=utf-8
X-Trans-Id: tx0287b982a268461b9ec14-0052d826e2
Date: Thu, 16 Jan 2014 18:37:22 GMT
If the request succeeds, the operation returns the ``No Content
(204)`` response code.
Error response codes:204,
Request
-------
.. rest_parameters:: parameters.yaml
- account: account
- container: container
- X-Auth-Token: X-Auth-Token
Corrections for the API specifications in api-ref Fixes a number of technical issues with the api-ref section including: - Added missing headers - The header descriptions were made specific to whether they are used in requests or responses and the verb in question (example: Content-Length in object HEAD is the object size, not the response body length). - Added references to API features such as bulk delete. - Many typographical fixes (e.g., spaces in the middle of header names) - Restored xml and json account/container listing examples. The following areas were not updated and it is proposed to defer them to a subsequent update. This is because I don't have time or their merit is debatable: - ACLs (as used in a Keystone context) are not described. - Account create/delete is not described. - I left List Endpoints as-is. Change-Id: I315b4e550b7d10880fbc00fce9311127ba609c2d
2016-08-12 15:52:55 +01:00
- X-Service-Token: X-Service-Token
Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
- X-Newest: X-Newest
- X-Trans-Id-Extra: X-Trans-Id-Extra
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- X-Container-Meta-name: X-Container-Meta-name
Corrections for the API specifications in api-ref Fixes a number of technical issues with the api-ref section including: - Added missing headers - The header descriptions were made specific to whether they are used in requests or responses and the verb in question (example: Content-Length in object HEAD is the object size, not the response body length). - Added references to API features such as bulk delete. - Many typographical fixes (e.g., spaces in the middle of header names) - Restored xml and json account/container listing examples. The following areas were not updated and it is proposed to defer them to a subsequent update. This is because I don't have time or their merit is debatable: - ACLs (as used in a Keystone context) are not described. - Account create/delete is not described. - I left List Endpoints as-is. Change-Id: I315b4e550b7d10880fbc00fce9311127ba609c2d
2016-08-12 15:52:55 +01:00
- Content-Length: Content-Length_cud_resp
Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
- X-Container-Object-Count: X-Container-Object-Count
Corrections for the API specifications in api-ref Fixes a number of technical issues with the api-ref section including: - Added missing headers - The header descriptions were made specific to whether they are used in requests or responses and the verb in question (example: Content-Length in object HEAD is the object size, not the response body length). - Added references to API features such as bulk delete. - Many typographical fixes (e.g., spaces in the middle of header names) - Restored xml and json account/container listing examples. The following areas were not updated and it is proposed to defer them to a subsequent update. This is because I don't have time or their merit is debatable: - ACLs (as used in a Keystone context) are not described. - Account create/delete is not described. - I left List Endpoints as-is. Change-Id: I315b4e550b7d10880fbc00fce9311127ba609c2d
2016-08-12 15:52:55 +01:00
- X-Container-Bytes-Used: X-Container-Bytes-Used
- X-Container-Write: X-Container-Write_resp
- X-Container-Meta-Quota-Bytes: X-Container-Meta-Quota-Bytes
Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
- X-Container-Meta-Quota-Count: X-Container-Meta-Quota-Count
- Accept-Ranges: Accept-Ranges
Corrections for the API specifications in api-ref Fixes a number of technical issues with the api-ref section including: - Added missing headers - The header descriptions were made specific to whether they are used in requests or responses and the verb in question (example: Content-Length in object HEAD is the object size, not the response body length). - Added references to API features such as bulk delete. - Many typographical fixes (e.g., spaces in the middle of header names) - Restored xml and json account/container listing examples. The following areas were not updated and it is proposed to defer them to a subsequent update. This is because I don't have time or their merit is debatable: - ACLs (as used in a Keystone context) are not described. - Account create/delete is not described. - I left List Endpoints as-is. Change-Id: I315b4e550b7d10880fbc00fce9311127ba609c2d
2016-08-12 15:52:55 +01:00
- X-Container-Read: X-Container-Read_resp
Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
- X-Container-Meta-Access-Control-Expose-Headers: X-Container-Meta-Access-Control-Expose-Headers
- X-Container-Meta-Temp-URL-Key: X-Container-Meta-Temp-URL-Key
- X-Container-Meta-Temp-URL-Key-2: X-Container-Meta-Temp-URL-Key-2
- X-Timestamp: X-Timestamp
- X-Container-Meta-Access-Control-Allow-Origin: X-Container-Meta-Access-Control-Allow-Origin
- X-Container-Meta-Access-Control-Max-Age: X-Container-Meta-Access-Control-Max-Age
Corrections for the API specifications in api-ref Fixes a number of technical issues with the api-ref section including: - Added missing headers - The header descriptions were made specific to whether they are used in requests or responses and the verb in question (example: Content-Length in object HEAD is the object size, not the response body length). - Added references to API features such as bulk delete. - Many typographical fixes (e.g., spaces in the middle of header names) - Restored xml and json account/container listing examples. The following areas were not updated and it is proposed to defer them to a subsequent update. This is because I don't have time or their merit is debatable: - ACLs (as used in a Keystone context) are not described. - Account create/delete is not described. - I left List Endpoints as-is. Change-Id: I315b4e550b7d10880fbc00fce9311127ba609c2d
2016-08-12 15:52:55 +01:00
- X-Container-Sync-Key: X-Container-Sync-Key_resp
- X-Container-Sync-To: X-Container-Sync-To_resp
Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
- Date: Date
- X-Trans-Id: X-Trans-Id
Corrections for the API specifications in api-ref Fixes a number of technical issues with the api-ref section including: - Added missing headers - The header descriptions were made specific to whether they are used in requests or responses and the verb in question (example: Content-Length in object HEAD is the object size, not the response body length). - Added references to API features such as bulk delete. - Many typographical fixes (e.g., spaces in the middle of header names) - Restored xml and json account/container listing examples. The following areas were not updated and it is proposed to defer them to a subsequent update. This is because I don't have time or their merit is debatable: - ACLs (as used in a Keystone context) are not described. - Account create/delete is not described. - I left List Endpoints as-is. Change-Id: I315b4e550b7d10880fbc00fce9311127ba609c2d
2016-08-12 15:52:55 +01:00
- Content-Type: Content-Type_cud_resp
- X-Versions-Location: X-Versions-Location_resp
- X-Versions-Mode: X-Versions-Mode_resp
- X-Storage-Policy: X-Storage-Policy
Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
Delete container
================
.. rest_method:: DELETE /v1/{account}/{container}
Deletes an empty container.
This operation fails unless the container is empty. An empty
container has no objects.
Delete the ``steven`` container:
::
curl -i $publicURL/steven -X DELETE -H "X-Auth-Token: $token"
If the container does not exist, the response is:
::
HTTP/1.1 404 Not Found
Content-Length: 70
Content-Type: text/html; charset=UTF-8
X-Trans-Id: tx4d728126b17b43b598bf7-0052d81e34
Date: Thu, 16 Jan 2014 18:00:20 GMT
If the container exists and the deletion succeeds, the response is:
::
HTTP/1.1 204 No Content
Content-Length: 0
Content-Type: text/html; charset=UTF-8
X-Trans-Id: txf76c375ebece4df19c84c-0052d81f14
Date: Thu, 16 Jan 2014 18:04:04 GMT
If the container exists but is not empty, the response is:
::
HTTP/1.1 409 Conflict
Content-Length: 95
Content-Type: text/html; charset=UTF-8
X-Trans-Id: tx7782dc6a97b94a46956b5-0052d81f6b
Date: Thu, 16 Jan 2014 18:05:31 GMT
<html>
<h1>Conflict
</h1>
<p>There was a conflict when trying to complete your request.
</p>
</html>
Error response codes:404,204,409,
Request
-------
.. rest_parameters:: parameters.yaml
- account: account
- container: container
- X-Auth-Token: X-Auth-Token
Corrections for the API specifications in api-ref Fixes a number of technical issues with the api-ref section including: - Added missing headers - The header descriptions were made specific to whether they are used in requests or responses and the verb in question (example: Content-Length in object HEAD is the object size, not the response body length). - Added references to API features such as bulk delete. - Many typographical fixes (e.g., spaces in the middle of header names) - Restored xml and json account/container listing examples. The following areas were not updated and it is proposed to defer them to a subsequent update. This is because I don't have time or their merit is debatable: - ACLs (as used in a Keystone context) are not described. - Account create/delete is not described. - I left List Endpoints as-is. Change-Id: I315b4e550b7d10880fbc00fce9311127ba609c2d
2016-08-12 15:52:55 +01:00
- X-Service-Token: X-Service-Token
Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
- X-Trans-Id-Extra: X-Trans-Id-Extra
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- Date: Date
- X-Timestamp: X-Timestamp
Corrections for the API specifications in api-ref Fixes a number of technical issues with the api-ref section including: - Added missing headers - The header descriptions were made specific to whether they are used in requests or responses and the verb in question (example: Content-Length in object HEAD is the object size, not the response body length). - Added references to API features such as bulk delete. - Many typographical fixes (e.g., spaces in the middle of header names) - Restored xml and json account/container listing examples. The following areas were not updated and it is proposed to defer them to a subsequent update. This is because I don't have time or their merit is debatable: - ACLs (as used in a Keystone context) are not described. - Account create/delete is not described. - I left List Endpoints as-is. Change-Id: I315b4e550b7d10880fbc00fce9311127ba609c2d
2016-08-12 15:52:55 +01:00
- Content-Length: Content-Length_cud_resp
- Content-Type: Content-Type_cud_resp
Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
- X-Trans-Id: X-Trans-Id
Copy Permalink