# 文件下载(Node.js SDK)
![](https://support.huaweicloud.com/sdk-nodejs-devg-obs/public_sys-resources/notice_3.0-zh-cn.png)
开发过程中，您有任何问题可以在GitHub上[提交issue](https://github.com/huaweicloud/huaweicloud-sdk-nodejs-obs/issues)，或者在[华为云对象存储服务论坛](https://bbs.huaweicloud.com/forum/forum-620-1.html)中发帖求助。
#### 功能说明
您可以根据需要将存储在OBS中的对象以文件形式下载到本地。
#### 接口约束
- 您必须是桶拥有者或拥有下载对象的权限，才能下载对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:GetObject权限，如果使用桶策略则需授予GetObject权限。相关授权方式介绍可参见[OBS权限控制概述](https://support.huaweicloud.com/perms-cfg-obs/obs_40_0001.html)，配置方式详见[使用IAM自定义策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0121.html)、[配置对象策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0075.html)。
- OBS支持的Region与Endpoint的对应关系，详细信息请参见[地区与终端节点](https://console.huaweicloud.com/apiexplorer/#/endpoint/OBS)。
- 对于存储类别为归档存储或深度归档存储的对象，需要确认对象的状态为"已恢复"才能对其进行下载。
 
#### 方法定义
```
ObsClient.getObject(params)
```
#### 请求参数
表1请求参数列表 
| **参数名称**                   | **类型**   | **是否必选**       | **说明**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|:---|:---|:---|:---|
| Bucket                     | string   | 必选             | **参数解释** **：** 桶名。 **约束限制：** - 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。  - 桶命名规则如下： - 3～63个字符，数字或字母开头，支持小写字母、数字、"-"、"."。  - 禁止使用IP地址。  - 禁止以"-"或"."开头及结尾。  - 禁止两个"."相邻（如："my..bucket"）。  - 禁止"."和"-"相邻（如："my-.bucket"和"my.-bucket"）。    - 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。   **取值范围：** 长度为3～63个字符。 **默认取值：** 无 |
| Key                        | string   | 必选             | **参数解释：** 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。 例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。 **约束限制：** 无 **取值范围：** 长度大于0且不超过1024的字符串。 **默认取值：** 无                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| VersionId                  | string   | 可选             | **参数解释：** 对象的版本号。例如：G001117FCE89978B0000401205D5DC9A。 **约束限制：** 无 **取值范围：** 长度为32的字符串。 **默认取值：** 无                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| SaveAsFile                 | string   | 可选             | **参数解释：** 下载对象的目标路径，包含文件名。 **约束限制：** 包含文件名，如aa/bb.txt **取值范围：** 无 **默认取值：** 无                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| SaveAsStream               | boolean  | 可选             | **参数解释：** 是否将对象以流（stream.Readable）的形式返回。 **取值范围：** - true：将对象以流（stream.Readable）的形式返回。  - false：不将对象以流（stream.Readable）的形式返回。   **默认取值：** false                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| ProgressCallback           | function | 可选             | **参数解释：** 获取下载进度的回调函数。 说明： 该回调函数依次包含三个参数：已下载的字节数、总字节数、已使用的时间（单位：秒）。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| IfMatch                    | string   | 可选             | **参数解释：** 指定一个预设的Etag值，如果下载对象的ETag值与该参数值相同，则返回对象内容，否则返回错误。 **约束限制：** 无 **取值范围：** 长度为32的字符串。 **默认取值：** 无                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| IfModifiedSince            | string   | 可选             | **参数解释：** 如果对象的修改时间晚于该参数值指定的时间，则返回对象内容，否则返回异常码。 **约束限制：** 该参数值必须符合http://www.ietf.org/rfc/rfc2616.txt规定的HTTP时间格式。 **取值范围：** 无 **默认取值：** 无                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| IfNoneMatch                | string   | 可选             | **参数解释：** 指定一个预设的Etag值，如果下载对象的ETag值与该参数值不相同，则返回对象内容，否则返回错误。 **约束限制：** 无 **取值范围：** 长度为32的字符串。 **默认取值：** 无                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| IfUnmodifiedSince          | string   | 可选             | **参数解释：** 如果对象的修改时间早于该参数值指定的时间，则返回对象内容，否则返回异常码。 **约束限制：** 该参数值必须符合http://www.ietf.org/rfc/rfc2616.txt规定的HTTP时间格式。 **取值范围：** 无 **默认取值：** 无                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| Range                      | string   | 可选             | **参数解释：** 指定下载的范围。例如：0-999，即对象的第1个字节到1000字节。 **约束限制：** 如果Range的最大长度超出对象长度-1，仍旧取对象长度-1。 **取值范围：** 取值区间：\[0，对象长度-1\]，格式：bytes=x-y。 **默认取值：** 无                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| Origin                     | string   | 可选             | **参数解释：** 预请求指定的跨域请求Origin（通常为域名）。 **约束限制：** 每个匹配规则允许使用最多一个"\*"通配符。 **取值范围：** 无 **默认取值：** 无                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| RequestHeader              | string   | 可选             | **参数解释：** 跨域请求可以使用的HTTP头域。只有匹配上允许的头域中的配置，才被视为是合法的CORS请求。 **约束限制：** 每个头域可填写一个"\*"通配符，不支持\&、:、\<、空格以及中文字符。 **取值范围：** 无 **默认取值：** 无                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| ResponseCacheControl       | string   | 可选             | **参数解释：** 重写响应中的Cache-Control头。 **约束限制：** 无 **取值范围：** 参见HTTP标准头域Cache-Control的取值。 **默认取值：** 无                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| ResponseContentDisposition | string   | 可选             | **参数解释：** 重写响应中的Content-Disposition头。 **约束限制：** 无 **取值范围：** 参见HTTP标准头域Content-Disposition的取值。 **默认取值：** 无                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| ResponseContentEncoding    | string   | 可选             | **参数解释：** 重写响应中的Content-Encoding头。 **约束限制：** 无 **取值范围：** 参见HTTP标准头域Content-Encoding的取值。 **默认取值：** 无                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| ResponseContentLanguage    | string   | 可选             | **参数解释：** 重写响应中的Content-Language头。 **约束限制：** 无 **取值范围：** 参见HTTP标准头域Content-Language的取值。 **默认取值：** 无                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| ResponseContentType        | string   | 可选             | **参数解释：** 重写响应中的Content-Type头。 **约束限制：** 无 **取值范围：** 常见的Content-Type（MIME）列表参见[如何理解Content-Type（MIME）(Node.js SDK)](https://support.huaweicloud.com/sdk-nodejs-devg-obs/obs_29_1716.html) **默认取值：** 无                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| ResponseExpires            | string   | 可选             | **参数解释：** 重写响应中的Expires头。 **约束限制：** 无 **取值范围：** 参见HTTP标准头域Expires的取值。 **默认取值：** 无                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| ImageProcess               | string   | 可选             | **参数解释：** 图片处理参数，描述针对对象的图片处理命令或处理样式。例如表示对图片依次进行缩放、旋转，取值：image/resize,m_fixed,w_100,h_100/rotate,90。 **约束限制：** 无 **取值范围：** 命令方式：image/命令参数。 样式方式：style/样式名称。 详细参数说明参见[处理图片](https://support.huaweicloud.com/usermanual-obs/obs_01_0224.html)。 **默认取值：** 如果不输入处理命令，将返回原图。                                                                                                                                                                                                                                                                                                                                          |
| SseC                       | string   | 当使用SSE-C方式时，必选 | **参数解释：** 以SSE-C方式解密对象。 **约束限制：** 仅支持AES256。 **取值范围：** 可选值：AES256。 **默认取值：** 无                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| SseCKey                    | string   | 当使用SSE-C方式时，必选 | **参数解释：** SSE-C方式下解密的密钥，该密钥用于解密对象。 **约束限制：** 该头域由256bit的密钥经过Base64编码得到，示例：K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw= **取值范围：** 无 **默认取值：** 无                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
   
![](https://support.huaweicloud.com/sdk-nodejs-devg-obs/public_sys-resources/note_3.0-zh-cn.png)
- 如果包含IfUnmodifiedSince并且不符合或者包含IfMatch并且不符合，抛出异常中HTTP状态码为：412 precondition failed。
- 如果包含IfModifiedSince并且不符合或者包含IfNoneMatch并且不符合，抛出异常中HTTP状态码为：304 Not Modified。
 
#### 返回结果
表2返回结果 
| **参数类型**                                                                                                                                                | 描述                                                                                      |
|:---|:---|
| [表3] 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 | **参数解释：** 接口返回信息，详见[表3]。 |
   
 表3Response 
| **参数名称**        | **参数类型**                                        | 描述                                                                                                                                                                             |
|:---|:---|:---|
| CommonMsg       | [ICommonMsg] | **参数解释：** 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见[ICommonMsg]。                                                      |
| InterfaceResult | [表5]               | **参数解释：** 操作成功后的结果数据，详见[表5]。 **约束限制：** 当Status大于300时为空。 |
   
 表4ICommonMsg 
| **参数名称**  | **参数类型** |                                                                                                                                                                                                       **描述**                                                                                                                                                                                                        |
|---|---|---|
| Status    | number   | **参数解释：** OBS服务端返回的HTTP状态码。 **取值范围：** 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见[状态码](https://support.huaweicloud.com/api-obs/obs_04_0114.html)。 |
| Code      | string   | **参数解释：** OBS服务端返回的错误码。                                                                                                                                                                                                                                                                                                                                    |
| Message   | string   | **参数解释：** OBS服务端返回的错误描述。                                                                                                                                                                                                                                                                                                                                  |
| HostId    | string   | **参数解释：** OBS服务端返回的请求服务端ID。                                                                                                                                                                                                                                                                                                                               |
| RequestId | string   | **参数解释：** OBS服务端返回的请求ID。                                                                                                                                                                                                                                                                                                                                  |
| Id2       | string   | **参数解释：** OBS服务端返回的请求ID2。                                                                                                                                                                                                                                                                                                                               |
| Indicator | string   | **参数解释：** OBS服务端返回的详细错误码。                                                                                                                                                                                                                                                                                                                                |
   
 表5GetObjectOutput 
| **参数名称**                | **参数类型**                                             | **描述**                                                                                                                                                 |
|:---|:---|:---|
| RequestId               | string                                               | **参数解释：** OBS服务端返回的请求ID。                                                                                                 |
| DeleteMarker            | string                                               | **参数解释：** 标识删除的对象是否是删除标记。                                                                                                  |
| LastModified            | string                                               | **参数解释：** 对象的最近一次修改时间。                                                                                                    |
| ContentLength           | string                                               | **参数解释：** 对象数据的长度。                                                                                                        |
| CacheControl            | string                                               | **参数解释：** 响应中的Cache-Control头。                                                                                              |
| ContentDisposition      | string                                               | **参数解释：** 响应中的Content-Disposition头。                                                                                      |
| ContentEncoding         | string                                               | **参数解释：** 响应中的Content-Encoding头                                                                                          |
| ContentLanguage         | string                                               | **参数解释：** 响应中的Content-Language头                                                                                           |
| ContentType             | string                                               | **参数解释：** 对象的MIME类型。                                                                                                       |
| Expires                 | string                                               | **参数解释：** 响应中的Expires头。                                                                                                   |
| ETag                    | string                                               | **参数解释：** 对象的ETag值。                                                                                                       |
| VersionId               | string                                               | **参数解释：** 对象的版本号。                                                                                                          |
| WebsiteRedirectLocation | string                                               | **参数解释：** 当桶设置了Website配置，该参数指明对象的重定向地址。                                                                                    |
| StorageClass            | string                                               | **参数解释：** 对象的存储类型，当对象存储类型是标准存储时，该值为空。                                                                                       |
| Restore                 | string                                               | **参数解释：** 归档存储类型对象的恢复状态。                                                                                                   |
| Expiration              | string                                               | **参数解释：** 对象的详细过期信息。                                                                                                     |
| Content                 | string \| stream.Readable | **参数解释：** 对象的内容。当设置了SaveAsFile时该值为空；当设置了SaveAsStream且为true时该值为stream.Readable对象；当SaveAsFile和SaveAsStream都未设置时为Buffer对象。 |
| Metadata                | object                                               | **参数解释：** 对象自定义元数据。需要在桶的CORS配置中增加允许响应中可返回的附加头域。例如，新增x-amz-meta-property1以获取自定义元数据property1。                              |
   
#### 代码示例
本示例用于文件下载对象，以examplebucket/objectname为例。
```
// 引入obs库
// 使用npm安装
const ObsClient = require("esdk-obs-nodejs");
// 使用源码安装
// var ObsClient = require('./lib/obs');
// 创建ObsClient实例
const obsClient = new ObsClient({
  // 推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险
  // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
  access_key_id: process.env.ACCESS_KEY_ID,
  secret_access_key: process.env.SECRET_ACCESS_KEY,
  // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入
  // security_token: process.env.SECURITY_TOKEN,
  // endpoint填写Bucket对应的Endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写
  server: "https://obs.cn-north-4.myhuaweicloud.com",
});
async function getObject() {
  try {
    const params = {
      // 指定存储桶名称
      Bucket: "examplebucket",
      // 指定对象名，此处以 example/objectname 为例
      Key: 'example/objectname',
      // 指定下载对象的目标路径
      SaveAsFile: 'localfile'
    };
    
    // 文件下载对象
    const result = await obsClient.getObject(params);
    if (result.CommonMsg.Status <= 300) {
      console.log("Get object(%s) under the bucket(%s) successful!", params.Key, params.Bucket);
      console.log("RequestId: %s", result.CommonMsg.RequestId);
      return;
    };
    console.log("An ObsError was found, which means your request sent to OBS was rejected with an error response.");
    console.log("Status: %d", result.CommonMsg.Status);
    console.log("Code: %s", result.CommonMsg.Code);
    console.log("Message: %s", result.CommonMsg.Message);
    console.log("RequestId: %s", result.CommonMsg.RequestId);
  } catch (error) {
    console.log("An Exception was found, which means the client encountered an internal problem when attempting to communicate with OBS, for example, the client was unable to access the network.");
    console.log(error);
  };
};
getObject();
```