PHP Extension

Glacier Download Archive

See more Amazon Glacier Examples

Demonstrates how to download an Amazon Glacier archive. Downloading a Glacier archive is a two step process. First an archive retrieval job is initiated. After it completes, the job output is downloaded (i.e. the archive contents are downloaded.)

Note: This example requires Chilkat v9.5.0.78 or greater.

PHP Extension

<?php

include("chilkat.php");

$success = false;

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$rest = new CkRest();

// Connect to the Amazon AWS REST server in the desired region.
$bTls = true;
$port = 443;
$bAutoReconnect = true;
$success = $rest->Connect('glacier.us-west-2.amazonaws.com',$port,$bTls,$bAutoReconnect);

// Provide AWS credentials.
$authAws = new CkAuthAws();
$authAws->put_AccessKey('AWS_ACCESS_KEY');
$authAws->put_SecretKey('AWS_SECRET_KEY');
$authAws->put_ServiceName('glacier');
$authAws->put_Region('us-west-2');

$success = $rest->SetAuthAws($authAws);

// --------------------------------------------------------------------------
// Note: The above REST connection and setup of the AWS credentials
// can be done once.  After connecting, any number of REST calls can be made.
// The "auto reconnect" property passed to rest.Connect indicates that if
// the connection is lost, a REST method call will automatically reconnect
// if needed.
// --------------------------------------------------------------------------

// 
// For more information, see Glacier Retrieve Job Output Reference Documentation
// 
$rest->AddHeader('x-amz-glacier-version','2012-06-01');

// To download an archive, we'll make several method calls:
// 1) Send the HTTPS GET request.
// 2) Get the response body.
// 3) If the response status code indicates success, stream the response body (i.e the archive data) to a file.
// 4) If the response status code indicates an error, get the JSON error response.

// Send the GET request.
$success = $rest->SendReqNoBody('GET','/AWS_ACCOUNT_ID/vaults/chilkat/jobs/JOB_ID/output');
if ($success != true) {
    print $rest->lastErrorText() . "\n";
    exit;
}

// Read the response header.
$responseStatusCode = $rest->ReadResponseHeader();
if ($responseStatusCode < 0) {
    print $rest->lastErrorText() . "\n";
    exit;
}

print 'Response status code = ' . $responseStatusCode . "\n";

// We expect a 200 response status if the archive data is coming.
// Otherwise, we'll get a JSON response body with an error message(or no response body).
if ($responseStatusCode == 200) {

    $bodyStream = new CkStream();

    // The stream's sink will be a file.
    $bodyStream->put_SinkFile('qa_output/archiveData.dat');

    // Read the response body to the stream.
    $success = $rest->ReadRespBodyStream($bodyStream,true);
    if ($success != true) {
        print $rest->lastErrorText() . "\n";
        exit;
    }

    print 'Successfully received the archive file.' . "\n";

}
else {
    $jsonError = $rest->readRespBodyString();
    if ($rest->get_LastMethodSuccess() != true) {
        print $rest->lastErrorText() . "\n";
    }
    else {
        print $jsonError . "\n";
    }

}


?>