ColdStack Docs
Search…
Tools
ListObjects/ListObjectsV2
Returns a list of objects in a bucket.
When issuing, pagination is used; in one request, you can get a list of no longer than 1000 objects. If there are more objects, then it is necessary to execute several queries in a row.
Note
This method has two versions.
listObjectsV2- up-to-date version, more convenient to use.listObjectsV1- previous version.
To call both methods, the same is used
URL, but it differs in the query parameter. To invoke listObjectsV2, use the parameter list-type=2.listObjectsV2
Request
1
GET /{bucket}?list-type=2&continuation-token=ContinuationToken&delimiter=Delimiter&encoding-type=EncodingType&max-keys=MaxKeys&prefix=Prefix&start-after=StartAfter HTTP/1.1
Copied!
Path parameters
Parameter
Description
bucketBucket name.
Query parameters
All parameters listed in the table are optional.
Parameter
Description
continuation-tokenUsed to get the next part of the list if all the results do not fit into one answer.
To get the next part of the list, use the value
NextContinuationTokenfrom the previous answer.delimiterSeparator character.
If specified, Object Storage treats the key as a file path, where directories are separated by a character
delimiter. In response to the request, the user will see a list of files and directories in the bucket. Files will be displayed in items Contents, and directories in items CommonPrefixes.
If a parameter is also specified in the request prefix, then Object Storage will return a list of files and directories in the directory prefix .encoding-typeServer response encoding.
Object Storage, at the request of the client, can encode the response in the required form.
Possible values:
url.max-keysThe maximum number of items in a response.
By default, Object Storage yields no more than 1000 items
Contentsand CommonPrefixes. This parameter should be used if you need to get less than 1000 items in one response.
If more keys fall under the selection criteria than fit in the search results, then the answer contains <IsTruncated>true</IsTruncated>.
To get all the elements of the issue, if there are more of them max-keys, it is necessary to perform several consecutive requests to Object Storage with a parameter continuation-token, where for each request continuation-tokenis equal to the value of the element NextContinuationTokenfrom the previous response.prefixThe string that the key should start with.
Object Storage will only select keys that start with
prefix.
It can be used simultaneously with the parameter delimiter. In this case, the output logic is determined by the parameter delimiter.start-afterThe key to start the listing with.
Headings
Response
Headings
Response codes
The successful response contains additional data in XML format, the schema of which is described below.
Data schema
1
<?xml version="1.0" encoding="UTF-8"?>
2
<ListBucketResult>
3
<IsTruncated>boolean</IsTruncated>
4
<Contents>
5
<ETag>string</ETag>
6
<Key>string</Key>
7
<LastModified>timestamp</LastModified>
8
<Size>integer</Size>
9
<StorageClass>string</StorageClass>
10
</Contents>
11
...
12
<Name>string</Name>
13
<Prefix>string</Prefix>
14
<Delimiter>string</Delimiter>
15
<MaxKeys>integer</MaxKeys>
16
<CommonPrefixes>
17
<Prefix>string</Prefix>
18
</CommonPrefixes>
19
...
20
<EncodingType>string</EncodingType>
21
<KeyCount>integer</KeyCount>
22
<ContinuationToken>string</ContinuationToken>
23
<NextContinuationToken>string</NextContinuationToken>
24
<StartAfter>string</StartAfter>
25
</ListBucketResult>
Copied!
Element
Description
ListBucketResultRoot element.
IsTruncatedA flag indicating whether all results were returned in this response.
True- everything. False- Not all.
Path: /ListBucketResult/IsTruncated.ContentsDescription of the object.
The response will contain as many elements
Contentsas the keys match the request conditions.
Path: /ListBucketResult/Contents.ETagMD5 hash of the object. Metadata is not included in the hash calculation.
Path:
/ListBucketResult/Contents/ETag.KeyObject key.
Path:
/ListBucketResult/Contents/Key.LastModifiedThe date and time the object was last modified.
Path:
/ListBucketResult/Contents/LastModified.SizeThe size of the object in bytes.
Path:
/ListBucketResult/Contents/Size.StorageClassObject storage class:
STANDARDor COLD.
Path: /ListBucketResult/Contents/StorageClass.NameBucket name.
Path:
/ListBucketResult/Name.PrefixThe value of the query parameter
prefix.
Path: /ListBucketResult/Prefix.DelimiterThe value of the query parameter
delimiter.
Path: /ListBucketResult/Delimiter.MaxKeysThe value of the query parameter
max-keys.
Path: /ListBucketResult/MaxKeys.CommonPrefixesThe part of the key name that is determined when processing query parameters
delimiterand prefix.
Path: /ListBucketResult/CommonPrefixes.EncodingTypeThe encoding in which Object Storage represents the key in the XML response.
Appears if the client passed a parameter when requested
encoding-type.
Path: /ListBucketResult/EncodingType.KeyCountThe number of keys returned by the query.
The number of keys will always be less than or equal
MaxKeys.
Path: /ContinuationToken/KeyCount.ContinuationTokenThe value of the query parameter
continuation-token.
Path: /ContinuationToken/ContinuationToken.NextContinuationTokenThe value that must be substituted into the query parameter
continuation-tokento get the next part of the list, if the entire list does not fit into the current response.
Refundable only if IsTruncated = true.
Path: /ListBucketResult/NextContinuationToken.StartAfterThe value of the query parameter
start-after.
Path: /ListBucketResult/StartAfter.ListObjects
Request
1
GET /{bucket}?delimiter=Delimiter&encoding-type=EncodingType&marker=Marker&max-keys=MaxKeys&prefix=Prefix HTTP/1.1
Copied!
Path parameters
Parameter
Description
bucketBucket name.
Query parameters
All parameters listed in the table are optional.
Parameter
Description
delimiterSeparator character.
If specified, Object Storage treats the key as a file path, where directories are separated by a character
delimiter. In response to the request, the user will see a list of files and directories in the bucket. Files will be displayed in items Contents, and directories in items CommonPrefixes.
If a parameter is also specified in the request prefix, then Object Storage will return a list of files and directories in the directory prefix .encoding-typeServer response encoding.
Object Storage, at the request of the client, can encode the response in the required form.
Possible values:
url.markerThe key from which the issuance will begin.
In the resulting output, Object Storage will leave the keys starting from the next one after
marker.max-keysThe maximum number of items in a response.
By default, Object Storage yields no more than 1000 items
Contentsand CommonPrefixes. This parameter should be used if you need to get less than 1000 items in one response.
If more keys fall under the selection criteria than fit in the search results, then the answer contains <IsTruncated>true</IsTruncated>.
To get all the elements of the issue, if there are more of them max-keys, it is necessary to perform several consecutive requests to Object Storage with a parameter marker, where for each request markeris equal to the value of the element NextMarkerfrom the previous response.prefixThe string that the key should start with.
Object Storage will only select keys that start with
prefix.
It can be used simultaneously with the parameter delimiter. In this case, the output logic is determined by the parameter delimiter.Headings
Response
Headings
Response codes
The successful response contains additional data in XML format, the schema of which is described below.
Data schema
1
<?xml version="1.0" encoding="UTF-8"?>
2
<ListBucketResult>
3
<IsTruncated>boolean</IsTruncated>
4
<Marker>string</Marker>
5
<NextMarker>string</NextMarker>
6
<Contents>
7
<ETag>string</ETag>
8
<Key>string</Key>
9
<LastModified>timestamp</LastModified>
10
<Size>integer</Size>
11
<StorageClass>string</StorageClass>
12
</Contents>
13
...
14
<Name>string</Name>
15
<Prefix>string</Prefix>
16
<Delimiter>string</Delimiter>
17
<MaxKeys>integer</MaxKeys>
18
<CommonPrefixes>
19
<Prefix>string</Prefix>
20
</CommonPrefixes>
21
...
22
<EncodingType>string</EncodingType>
23
</ListBucketResult>
Copied!
Element
Description
ListBucketResultRoot element.
IsTruncatedA flag indicating whether all results were returned in this response.
True- everything. False- Not all.
Path: /ListBucketResult/IsTruncated.MarkerThe value of the query parameter
marker.
Path: /ListBucketResult/Marker.NextMarkerThe value that must be substituted into the query parameter
markerto get the next part of the list, if the entire list does not fit into the current response.
Path: /ListBucketResult/NextMarker.ContentsDescription of the object.
The response will contain as many elements
Contentsas the keys match the request conditions.
Path: /ListBucketResult/Contents.ETagMD5 hash of the object. Metadata is not included in the hash calculation.
Path:
/ListBucketResult/Contents/ETag.KeyObject key.
Path:
/ListBucketResult/Contents/Key.LastModifiedThe date and time the object was last modified.
Path:
/ListBucketResult/Contents/LastModified.SizeThe size of the object in bytes.
Path:
/ListBucketResult/Contents/Size.StorageClassObject storage class:
STANDARDor COLD.
Path: /ListBucketResult/Contents/StorageClass.NameBucket name.
Path:
/ListBucketResult/Name.PrefixThe value of the query parameter
prefix.
Path: /ListBucketResult/Prefix.DelimiterThe value of the query parameter
delimiter.
Path: /ListBucketResult/Delimiter.MaxKeysThe value of the query parameter
max-keys.
Path: /ListBucketResult/MaxKeys.CommonPrefixesThe part of the key name that is determined when processing query parameters
delimiterand prefix.
Path: /ListBucketResult/CommonPrefixes.EncodingTypeThe encoding in which Object Storage represents the key in the XML response.
Appears if the client passed a parameter when requested
encoding-type.
Path: /ListBucketResult/EncodingType.Last modified 9mo ago
Copy link