PureBasic

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.

PureBasic

IncludeFile "CkXml.pb"
IncludeFile "CkHttp.pb"

Procedure ChilkatExample()

    success.i = 0

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; keyID = Access Key ID or Access Key
    CkHttp::setCkAwsAccessKey(http, "access-key")

    ; applicationKey = Secret Access Key or Secret Key
    CkHttp::setCkAwsSecretKey(http, "secret-key")

    ; Region is the 2nd part of your S3 Endpoint
    CkHttp::setCkAwsEndpoint(http, "s3.us-west-002.backblazeb2.com")

    bucketName.s = "chilkat-test"

    strXml.s = CkHttp::ckS3_ListBucketObjects(http,bucketName)
    If CkHttp::ckLastMethodSuccess(http) <> 1
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        ProcedureReturn
    EndIf

    Debug "Response status code = " + Str(CkHttp::ckLastStatus(http))

    xml.i = CkXml::ckCreate()
    If xml.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkXml::ckLoadXml(xml,strXml)
    If success <> 1
        Debug CkXml::ckLastErrorText(xml)
        CkHttp::ckDispose(http)
        CkXml::ckDispose(xml)
        ProcedureReturn
    EndIf

    ; 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::ckLastStatus(http) <> 200
        Debug CkXml::ckGetXml(xml)
        Debug "Failed."
        CkHttp::ckDispose(http)
        CkXml::ckDispose(xml)
        ProcedureReturn
    EndIf

    ; A sample response is shown below.
    Debug CkXml::ckGetXml(xml)
    Debug "----"

    ; 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>

    ETag.s
    Key.s
    LastModified.s
    ID.s
    SizeDecimalStr.s
    StorageClass.s

    ListBucketResult_xmlns.s = CkXml::ckGetAttrValue(xml,"xmlns")
    i.i = 0
    count_i.i = CkXml::ckNumChildrenHavingTag(xml,"Contents")
    While i < count_i
        CkXml::setCkI(xml, i)
        ETag = CkXml::ckGetChildContent(xml,"Contents[i]|ETag")
        Key = CkXml::ckGetChildContent(xml,"Contents[i]|Key")
        LastModified = CkXml::ckGetChildContent(xml,"Contents[i]|LastModified")
        ID = CkXml::ckGetChildContent(xml,"Contents[i]|Owner|ID")
        SizeDecimalStr = CkXml::ckGetChildContent(xml,"Contents[i]|Size")
        StorageClass = CkXml::ckGetChildContent(xml,"Contents[i]|StorageClass")
        i = i + 1
    Wend
    IsTruncated.s = CkXml::ckGetChildContent(xml,"IsTruncated")
    MaxKeys.i = CkXml::ckGetChildIntValue(xml,"MaxKeys")
    Name.s = CkXml::ckGetChildContent(xml,"Name")


    CkHttp::ckDispose(http)
    CkXml::ckDispose(xml)


    ProcedureReturn
EndProcedure