tencent cloud

简介

本文档提供关于列出对象操作相关的 API 概览以及 SDK 示例代码。

功能说明

查询存储桶下的部分或者全部对象。

注意：

在 COS 中，列出的对象键为 project/，表示是一个内容为空的对象，展示方式上模拟了传统文件夹。相关介绍可参见 文件夹和目录。

使用示例

示例一：列出目录 a 的所有文件。

cos.getBucket({
   Bucket: 'examplebucket-1250000000', /* 填入您自己的存储桶，必须字段 */
   Region: 'COS_REGION',  /* 存储桶所在地域，例如ap-beijing，必须字段 */
   Prefix: 'a/',           /* Prefix表示列出的object的key以prefix开始，非必须 */
}, function(err, data) {
   console.log(err || data.Contents);
});

返回值格式：

{
  "Name": "examplebucket-1250000000",
  "Prefix": "",
  "Marker": "a/",
  "MaxKeys": "1000",
  "Delimiter": "",
  "IsTruncated": "false",
  "Contents": [{
      "Key": "a/3mb.zip",
      "LastModified": "2018-10-18T07:08:03.000Z",
      "ETag": "\"05a9a30179f3db7b63136f30aa6aacae-3\"",
      "Size": "3145728",
      "Owner": {
          "ID": "1250000000",
          "DisplayName": "1250000000"
      },
      "StorageClass": "STANDARD"
  }],
  "statusCode": 200,
  "headers": {}
}

示例二：列出目录 a 的文件，不深度遍历。

cos.getBucket({
   Bucket: 'examplebucket-1250000000', /* 填入您自己的存储桶，必须字段 */
   Region: 'COS_REGION',  /* 存储桶所在地域，例如ap-beijing，必须字段 */
   Prefix: 'a/',             /* Prefix表示列出的object的key以prefix开始，非必须 */
   Delimiter: '/',            /* Deliter表示分隔符, 设置为/表示列出当前目录下的object, 设置为空表示列出所有的object，非必须 */
}, function(err, data) {
   console.log(err || data.CommonPrefixes);
});

返回值格式：

{
  "Name": "examplebucket-1250000000",
  "Prefix": "a/",
  "Marker": "",
  "MaxKeys": "1000",
  "Delimiter": "/",
  "IsTruncated": "false",
  "CommonPrefixes": [{
      "Prefix": "a/1/"
  }],
  "Contents": [{
      "Key": "a/3mb.zip",
      "LastModified": "2018-10-18T07:08:03.000Z",
      "ETag": "\"05a9a30179f3db7b63136f30aa6aacae-3\"",
      "Size": "3145728",
      "Owner": {
          "ID": "1250000000",
          "DisplayName": "1250000000"
      },
      "StorageClass": "STANDARD"
  }],
  "statusCode": 200,
  "headers": {}
}

示例三：列出目录下所有文件。

var listFolder = function(marker) {
  cos.getBucket({
      Bucket: 'examplebucket-1250000000', /* 填入您自己的存储桶，必须字段 */
      Region: 'COS_REGION',  /* 存储桶所在地域，例如ap-beijing，必须字段 */
      Prefix: 'a/',   /* Prefix表示列出的object的key以prefix开始，非必须 */
      Marker: marker,
      MaxKeys: 1000,
  }, function(err, data) {
      if (err) {
          return console.log('list error:', err);
      } else {
          console.log('list result:', data.Contents);
          if (data.IsTruncated === 'true') listFolder(data.NextMarker);
          else return console.log('list complete');
      }
  });
};
listFolder();

参数说明

回调函数说明

function(err, data) { ... }