腾讯云对象存储快速入门

下载与安装

相关资源

对象存储服务的 XML JS SDK 资源 github 地址：XML Node.js SDK。SDK 快速下载地址：XML Node.js SDK。演示示例 Demo 下载地址：XML Node.js SDK Demo。SDK 文档中的所有示例代码请参见 SDK 代码示例。SDK 更新日志请参见 ChangeLog。说明如果您在使用 SDK 时遇到函数或方法不存在等错误，请先将 SDK 升级到最新版再重试。

环境依赖

1. 使用 SDK 需要您的运行环境包含 nodejs 以及 npm，其中 nodejs 版本要求 ≥ 6。2. 登录 对象存储控制台 创建存储桶后，获取存储桶名称和 地域名称。3. 登录 访问管理控制台 获取您的项目 SecretId 和 SecretKey。说明关于本文中出现的 SecretId、SecretKey、Bucket 等名称的含义和获取方式请参见 COS 术语信息。

安装 SDK

通过 npm 安装环境 SDK： npm 地址。

npm i cos-nodejs-sdk-v5 --save

开始使用

初始化

注意建议用户 使用临时密钥 调用 SDK，通过临时授权的方式进一步提高 SDK 使用的安全性。申请临时密钥时，请遵循 最小权限指引原则，防止泄露目标存储桶或对象之外的资源。如果您一定要使用永久密钥，建议遵循 最小权限指引原则 对永久密钥的权限范围进行限制。

使用临时密钥初始化(推荐)

临时密钥生成和使用请参见 临时密钥生成及使用指引。Node.js SDK 支持通过传入临时密钥进行初始化，请参考以下示例代码：

const request = require('request');const COS = require('cos-nodejs-sdk-v5');const cos = new COS({    getAuthorization: function (options, callback) {        // 初始化时不会调用，只有调用 cos 方法（例如 cos.putObject）时才会进入        // 异步获取临时密钥        request({            url: 'https://example.com/sts', // 替换为自己的获取临时密钥的服务url            data: {                // 可从 options 取需要的参数            }        }, function (err, response, body) {            let data = null;            let credentials = null;            try {                data = JSON.parse(body);                credentials = data.credentials;            } catch(e) {}            if (!data || !credentials) return console.error('credentials invalid');            callback({                TmpSecretId: credentials.tmpSecretId,        // 临时密钥的 tmpSecretId                TmpSecretKey: credentials.tmpSecretKey,      // 临时密钥的 tmpSecretKey                SecurityToken: credentials.sessionToken, // 临时密钥的 sessionToken                // 建议返回服务器时间作为签名的开始时间，避免用户浏览器本地时间偏差过大导致签名错误                StartTime: data.startTime, // 时间戳，单位秒，如：1580000000                ExpiredTime: data.expiredTime, // 临时密钥失效时间戳，是申请临时密钥时，时间戳加 durationSeconds            });        });    }});

使用永久密钥初始化(不推荐)

使用永久密钥初始化时，请注意保管好密钥，防止泄露。
请先在访问管理控制台中的 API 密钥管理 页面获取 SecretId、SecretKey。
将 SecretId、SecretKey、Bucket 和 Region 修改为您实际开发环境下的值，测试上传文件，请参考以下示例代码：

// SECRETID 和 SECRETKEY 请登录 https://console.cloud.tencent.com/cam/capi 进行查看和管理const COS = require('cos-nodejs-sdk-v5');const cos = new COS({    SecretId: process.env.SecretId, // 推荐使用环境变量获取；用户的 SecretId，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参考https://cloud.tencent.com/document/product/598/37140    SecretKey: process.env.SecretKey, // 推荐使用环境变量获取；用户的 SecretKey，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参考https://cloud.tencent.com/document/product/598/37140});

以下是部分常用接口例子，更详细的初始化方法请参见 demo 示例。

配置项

new COS(options) 构造函数参数说明

getAuthorization 回调函数说明的函数说明（使用格式一）

getAuthorization: function(options, callback) { ... }

getAuthorization 的函数说明：

获取完临时密钥后，callback 回传一个对象，回传对象的属性列表如下：

getAuthorization 回调函数说明（使用格式二）

getAuthorization: function(options, callback) { ... }

getAuthorization 的函数说明：

getAuthorization 计算完成后，callback 回传参数支持两种格式：
格式一：回传鉴权凭证字符串 Authorization。
格式二：回传一个对象，对象属性列表如下：

获取鉴权凭证

实例本身鉴权凭证可以通过实例化时传入的参数控制如何或获取，有三种获取方式：1. 实例化时，传入 SecretId、SecretKey，每次需要签名都由实例内部计算。2. 实例化时，传入 getAuthorization 回调，每次需要签名通过这个回调计算完返回签名给实例。3. 实例化时，传入 getSTS 回调，每次需要临时密钥通过这个回调返回给实例，在每次请求时实例内部使用临时密钥计算得到签名。

使用方式

回调方式

文档里默认使用回调方式，使用代码如下:

// 这里省略初始化过程和上传参数var cos = new COS({ ... });cos.uploadFile({ ... }, function(err, data) {  if (err) {    console.log('上传出错', err);  } else {    console.log('上传成功', data);  }});

Promise

sdk 同样支持 Promise 方式调用，例如上述回调方式的代码等同于以下代码:

// 这里省略初始化过程和上传参数var cos = new COS({ ... });cos.uploadFile({ ... }).then(data => {  console.log('上传成功', data);}).catch(err => {  console.log('上传出错', err);});

同步方式

同步方式基于 JavaScript 的 async 和 await，上述回调方式的代码等同于以下代码:

async function upload() {  // 这里省略初始化过程和上传参数  var cos = new COS({ ... });  try {    var data = await cos.uploadFile({ ... });    return { err: null, data: data }  } catch (err) {    return { err: err, data: null };  }}// 可以同步拿到请求的返回值,这里举例说明,实际返回的数据格式可以自定义var uploadResult = await upload();if (uploadResult.err) {  console.log('上传出错', uploadResult.err);} else {  console.log('上传成功', uploadResult.data);}

注意cos.getObjectUrl 目前只支持回调方式。

使用技巧

通常情况下我们只需要创建一个 COS SDK 实例，然后在需要调用 SDK 方法的地方直接使用这个实例即可，示例代码如下：

var cos = new COS({  ....});
/* 自己封装的上传方法 */function myUpload() {  // 不需要在每个方法里创建一个 COS SDK 实例  // var cos = new COS({  //   ...  // });  cos.putObject({    ....  });}
/* 自己封装的删除方法 */function myDelete() {  // 不需要在每个方法里创建一个 COS SDK 实例  // var cos = new COS({  //   ...  // });  cos.deleteObject({    ....  });}

常见接口

以下是部分常用接口入口，更详细的初始化方法请参见 demo 示例。

创建存储桶

cos.putBucket({    Bucket: 'examplebucket-1250000000',    Region: 'COS_REGION'}, function(err, data) {    console.log(err || data);});

查询存储桶列表

cos.getService(function (err, data) {    console.log(data && data.Buckets);});

上传对象

该接口适用于小文件上传，大文件请使用分块上传接口，详情请参见 对象操作 文档。

cos.putObject({    Bucket: 'examplebucket-1250000000', /* 必须 */    Region: 'COS_REGION',    /* 必须 */    Key: 'exampleobject',              /* 必须 */    StorageClass: 'STANDARD',    Body: fs.createReadStream('./exampleobject'), // 上传文件对象    onProgress: function(progressData) {        console.log(JSON.stringify(progressData));    }}, function(err, data) {    console.log(err || data);});

查询对象列表

cos.getBucket({    Bucket: 'examplebucket-1250000000', /* 必须 */    Region: 'COS_REGION',     /* 必须 */    Prefix: 'a/',           /* 非必须 */}, function(err, data) {    console.log(err || data.Contents);});

下载对象

cos.getObject({    Bucket: 'examplebucket-1250000000', /* 必须 */    Region: 'COS_REGION',    /* 必须 */    Key: 'exampleobject',              /* 必须 */    Output: fs.createWriteStream('./exampleobject'),}, function(err, data) {    console.log(err || data);});

删除对象

cos.deleteObject({    Bucket: 'examplebucket-1250000000', /* 必须 */    Region: 'COS_REGION',    /* 必须 */    Key: 'exampleobject'       /* 必须 */}, function(err, data) {    console.log(err || data);});



对象存储官网1折活动，限时活动，即将结束，速速收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折，更有现金返利。同意关联立享优惠