下载对象

功能说明

下载指定桶中的对象。

方法定义

ObsClient.getObject

请求参数

• SaveAsFile和SaveAsStream不能同时使用。
• 如果包含IfUnmodifiedSince并且不符合或者包含IfMatch并且不符合，抛出异常中HTTP状态码为：412 precondition failed。
• 如果包含IfModifiedSince并且不符合或者包含IfNoneMatch并且不符合，抛出异常中HTTP状态码为：304 Not Modified。

返回结果（InterfaceResult）

代码样例

本示例用于范围下载examplebucket桶里的objectname对象的0-1023字节并打印进度。

// 使用npm安装
var ObsClient = require('esdk-obs-nodejs');

// 推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入。如果使用硬编码可能会存在泄露风险
// 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
const AK = process.env.AccessKeyID
const SK = process.env.SecretAccessKey
// 【可选】如果使用临时AKSK和SecurityToken访问OBS，则同样推荐通过环境变量获取
const security_token= process.env.SecurityToken
//  server填写Bucket对应的Endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写。
const server = "https://obs.cn-north-4.myhuaweicloud.com"
var obsClient = new ObsClient({
    access_key_id: AK,
    secret_access_key: SK,
    server: server,
});
const Bucket = 'examplebucket'
// 对象名
const Key = 'objectname'
// 指定下载的范围，取值区间：[0，对象长度-1]，格式：bytes=x-y。如果Range的最大长度超出对象长度-1，仍旧取对象长度-1。
const Range = 'bytes=0-1023'
// 下载对象的目标路径，包含文件名。
const SaveAsFile = 'D:\\example'
try {
    obsClient.getObject({
        Bucket,
        Key,
        Range,
        SaveAsFile,
        // 进度回调
        ProgressCallback: function (transferredAmount, totalAmount, totalSeconds) {
            // 打印下载速度，单位KB/S
            console.log(transferredAmount * 1.0 / totalSeconds / 1024);
            // 打印上传百分比
            console.log(transferredAmount * 100.0 / totalAmount);
        },
        // 是否将对象以流（stream.Readable）的形式返回。
        // SaveAsStream: true
    }, (err, result) => {
        if (err) {
            console.log('GetObject Failed')
            console.error('Error-->' + err);
        } else {
            if (result.CommonMsg.Status < 300) {
                console.log('GetObject Succeeded')
                console.log('RequestId-->' + result.InterfaceResult.RequestId);
                console.log('ETag-->' + result.InterfaceResult.ETag);
                // 多版本对象独有
                console.log('VersionId-->' + result.InterfaceResult.VersionId);
                console.log('ContentLength-->' + result.InterfaceResult.ContentLength);
                // 多版本对象独有
                console.log('DeleteMarker-->' + result.InterfaceResult.DeleteMarker);
                console.log('LastModified-->' + result.InterfaceResult.LastModified);
                // 对象的存储类型，当对象存储类型是标准存储时，该值为空
                console.log('StorageClass-->' + result.InterfaceResult.StorageClass);
                // console.log('Content-->' + result.InterfaceResult.Content.toString());
                console.log('Metadata-->' + JSON.stringify(result.InterfaceResult.Metadata));
            } else {
                console.log('GetObject Failed')
                console.log('ErrorCode-->' + result.CommonMsg.Code);
                console.log('ErrorMessage-->' + result.CommonMsg.Message);
            }
        }
    });
} catch (error) {
    console.log('GetObject Failed')
    console.error('Error-->' + error);
}