(Tcl) Backblaze S3 List Bucket Objects

See more Backblaze S3 Examples

Demonstrates how to list the objects in a bucket.

The Chilkat S3 functions in the HTTP class are compatible with the Backblaze service. However, because of some specific issues, Chilkat v9.5.0.89 or later is needed.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# This example assumes the Chilkat HTTP API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set http [new_CkHttp]

# keyID = Access Key ID or Access Key
CkHttp_put_AwsAccessKey $http "access-key"

# applicationKey = Secret Access Key or Secret Key
CkHttp_put_AwsSecretKey $http "secret-key"

# Region is the 2nd part of your S3 Endpoint
CkHttp_put_AwsEndpoint $http "s3.us-west-002.backblazeb2.com"

set bucketName "chilkat-test"

set strXml [CkHttp_s3_ListBucketObjects $http $bucketName]
if {[CkHttp_get_LastMethodSuccess $http] != 1} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    exit
}

puts "Response status code = [CkHttp_get_LastStatus $http]"

set xml [new_CkXml]

set success [CkXml_LoadXml $xml $strXml]
if {$success != 1} then {
    puts [CkXml_lastErrorText $xml]
    delete_CkHttp $http
    delete_CkXml $xml
    exit
}

# If the response status code was not 200, then the XML response is not a 
# listing of objects, but instead contains error information.
if {[CkHttp_get_LastStatus $http] != 200} then {
    puts [CkXml_getXml $xml]
    puts "Failed."
    delete_CkHttp $http
    delete_CkXml $xml
    exit
}

# A sample response is shown below.
puts [CkXml_getXml $xml]
puts "----"

# Use this online tool to generate parsing code from sample XML: 
# Generate Parsing Code from XML

# <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
# <ListBucketResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
#     <Contents>
#         <ETag>"303fb46cf341094fef6274b7789cd6aa"</ETag>
#         <Key>orchard.json</Key>
#         <LastModified>2021-10-30T14:45:52.000Z</LastModified>
#         <Owner>
#             <ID>f2ebbc5f792c</ID>
#             <DisplayName/>
#         </Owner>
#         <Size>22</Size>
#         <StorageClass>STANDARD</StorageClass>
#     </Contents>
#     <Contents>
#         <ETag>"a8551f0a5437f43a796fca7623ee9232"</ETag>
#         <Key>seahorse.jpg</Key>
#         <LastModified>2021-10-30T14:38:53.000Z</LastModified>
#         <Owner>
#             <ID>f2ebbc5f792c</ID>
#             <DisplayName/>
#         </Owner>
#         <Size>24388</Size>
#         <StorageClass>STANDARD</StorageClass>
#     </Contents>
#     <IsTruncated>false</IsTruncated>
#     <MaxKeys>1000</MaxKeys>
#     <Name>chilkat-test</Name>
#     <Prefix/>
#     <Marker/>
# </ListBucketResult>

set ListBucketResult_xmlns [CkXml_getAttrValue $xml "xmlns"]
set i 0
set count_i [CkXml_NumChildrenHavingTag $xml "Contents"]
while {$i < $count_i} {
    CkXml_put_I $xml $i
    set ETag [CkXml_getChildContent $xml "Contents[i]|ETag"]
    set Key [CkXml_getChildContent $xml "Contents[i]|Key"]
    set LastModified [CkXml_getChildContent $xml "Contents[i]|LastModified"]
    set ID [CkXml_getChildContent $xml "Contents[i]|Owner|ID"]
    set SizeDecimalStr [CkXml_getChildContent $xml "Contents[i]|Size"]
    set StorageClass [CkXml_getChildContent $xml "Contents[i]|StorageClass"]
    set i [expr $i + 1]
}
set IsTruncated [CkXml_getChildContent $xml "IsTruncated"]
set MaxKeys [CkXml_GetChildIntValue $xml "MaxKeys"]
set Name [CkXml_getChildContent $xml "Name"]

delete_CkHttp $http
delete_CkXml $xml