Depending on whether the bucket name is included in the hostname in the HS3 request, the request line for a request to list the contents of a bucket of a bucket has either of these formats:
•With the bucket name included in the hostname:
GET /[?query-parameters] HTTP/1.1
•With the bucket name following the hostname:
GET /bucket-name[?query-parameters] HTTP/1.1
In these formats, query-parameters can be none, one, or more of the query parameters described in the table below.
Query parameter | Description |
---|---|
delimiter |
Includes a list of common prefixes in the bucket listing, where a prefix is the name of an item up through the first occurrence of a specified character string. The specified character string can contain any valid UTF-8 characters. including white space. When specifying a character string, percent-encode non-ASCII characters and reserved special characters such as ampersands (&), commas (,) and equal signs (=). If a character string contains spaces, enclose it in quotation marks. The delimiter parameter name and the character string you specify are both case sensitive. For more information on the delimiter parameter, see Limiting a listing of current items. |
key-marker |
Starts the returned bucket listing with the next item after the first item with a name that starts with a specified character string. The specified character string can contain any valid UTF-8 characters. including white space. When specifying a character string, percent-encode non-ASCII characters and reserved special characters such as ampersands (&), commas (,) and equal signs (=). If a character string contains spaces, enclose it in quotation marks. The key-marker parameter name and the character string you specify are both case sensitive. The key-marker parameter is ignored if specified in a GET request that does not include the versions parameter. For more information on the key-marker parameter, see Limiting a version listing above. |
marker |
Starts the returned bucket listing with the next item after the first item with a name that starts with a specified character string. The specified character string can contain any valid UTF-8 characters. including white space. When specifying a character string, percent-encode non-ASCII characters and reserved special characters such as ampersands (&), commas (,) and equal signs (=). If a character string contains spaces, enclose it in quotation marks. The marker parameter name and the character string you specify are both case sensitive. The marker parameter is ignored if specified in a GET request that includes the versions parameter. For more information on the marker parameter, see Limiting a listing of current items. |
max-keys |
Specifies the maximum number of items to be included in the returned bucket listing. Valid values are integers in the range zero through 2,147,483,647. If you specify an integer greater than one thousand, the returned bucket listing includes only the first one thousand items that satisfy the request criteria (or fewer if fewer than one thousand items satisfy the criteria). The max-keys parameter name is case sensitive. For more information on the max-keys parameter, see Limiting a listing of current items. |
prefix |
Requests that only items with names that begin with a specified character string (the prefix) be included in the returned bucket listing. The specified character string can contain any valid UTF-8 characters. including white space. When specifying a character string, percent-encode non-ASCII characters and reserved special characters such as ampersands (&), commas (,) and equal signs (=). If a character string contains spaces, enclose it in quotation marks. The prefix parameter name and the character string you specify are both case sensitive. For more information on the prefix parameter, see Limiting a listing of current items. |
version-id-marker |
When used in conjunction with the key-marker parameter, starts the returned bucket listing with the first item with a name that’s equal to the character string specified by the key-marker parameter and a version ID that’s greater than a specified value. Valid values are integers greater than or equal to zero. The version-id-marker parameter name is case sensitive. For more information on the version-id-marker parameter, see Limiting a version listing. |
versions |
Includes old versions of objects in the listing and provides version information for each listed item. The versions parameter name is not case sensitive. |
© 2017 Hitachi Data Systems Corporation. All rights reserved.