Downloading an Archive Object
If you have any questions during development, post them on the Issues page of GitHub. For details about parameters and usage of each API, see the API Reference.
Before you can download an Archive object, you must restore it. Archive objects can be restored in either of the following ways.
Option |
Description |
Value in OBS Node.js SDK |
---|---|---|
Expedited restore |
Data can be restored within 1 to 5 minutes. |
ObsClient.enums.RestoreTierExpedited |
Standard restore |
Data can be restored within 3 to 5 hours. This is the default option. |
ObsClient.enums.RestoreTierStandard |
To prolong the validity period of the Archive data restored, you can repeatedly restore the Archive data, but you will be billed for each restore. After a second restore, the validity period of Standard object copies will be prolonged, and you need to pay for storing these copies during the prolonged period.
You can call ObsClient.restoreObject to restore an Archive object. Sample code is as follows:
// Import the OBS library. // Use npm to install the client. var ObsClient = require('esdk-obs-nodejs'); // Use the source code to install the client. // var ObsClient = require('./lib/obs'); // Create an ObsClient instance. var obsClient = new ObsClient({ //Obtain an AK/SK pair using environment variables or import the AK/SK pair in other ways. Using hard coding may result in leakage. //Obtain an AK/SK pair on the management console. For details, see https://support.huaweicloud.com/intl/en-us/usermanual-ca/ca_01_0003.html. access_key_id: process.env.ACCESS_KEY_ID, secret_access_key: process.env.SECRET_ACCESS_KEY, server : 'https://your-endpoint' }); // Restore an Archive object. obsClient.restoreObject({ Bucket : 'bucketname', Key : 'objectname', Days : 1, Tier : obsClient.enums.RestoreTierExpedited }, (err, result) => { if(err){ console.error('Error-->' + err); }else{ console.log('Status-->' + result.CommonMsg.Status); // Wait for the object to be restored. setTimeout(()=>{ // Download the object to obtain the object content. obsClient.getObject({ Bucket : 'bucketname', Key : 'objectname' }, (err, result) => { if(err){ console.error('Error-->' + err); }else{ console.log('Status-->' + result.CommonMsg.Status); if(result.CommonMsg.Status < 300 && result.InterfaceResult){ // Obtain the object content. console.log('Object Content:'); console.log(result.InterfaceResult.Content.toString()); } } }); }, 6 * 60 * 1000); } });
- The object specified in ObsClient.restoreObject must be in the OBS Archive storage class. Otherwise, an error will be reported when you call this API.
- Use the Days parameter to specify the retention period (from 1 to 30 days) of the restored objects and the Tier parameter to specify the time spent on restoring the objects.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot