列举多版本对象（Browser.js SDK）--对象存储-火山引擎

文档中心

立即注册

导航

对象存储

列举多版本对象（Browser.js SDK）

最近更新时间：2024.02.04 18:31:06首次发布时间：2023.07.08 17:33:01

该接口用于列举桶中的多版本对象。每次请求返回桶的部分多版本对象（单次请求最多 1000 个），可以使用请求参数作为选择标准来返回桶中对象的子集。

注意事项

为了避免在浏览器环境中暴露您的火山引擎账号密钥信息（即 AccessKey ID 和 AccessKey Secret），强烈建议您使用临时访问凭证的方式执行 TOS 相关操作，详细说明，请参见使用 STS 临时 AK/SK+Token 访问火山引擎 TOS。
Endpoint 为 TOS 对外服务的访问域名。TOS 支持的 Endpoint 信息，请参见访问域名 Endpoint。
列举多版本对象前，您需要具有 tos:ListBucket 权限，详细信息，请参见 IAM 策略概述。

参数说明

参数	描述
prefix	本次查询结果的前缀。
delimiter	对对象名称进行分组的字符。
maxKeys	返回列举对象的最大数，默认值为 1000。取值：（0，1000]
encodingType	对返回的内容进行编码并指定编码的类型。默认值：None
keyMarker	列举多版本对象的起始位置。设定从该值之后按字母排序返回对象列表。通常为上次请求返回的 `next_marker` 值。
versionIdMarker	与 `KeyMarker` 配合使用，设定从该值之后按字典排序返回对版本对象列表。从上次列举结果中 `VersionIdMarker` 获取。

示例代码

简单列举

以下代码用于列举指定存储桶中最多10个多版本对象。

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <title>Document</title>
  </head>

  <body>
    <button id="upload">上传</button>
    <input id="file" type="file" />
    <!-- 导入 SDK 文件 -->
    <script src="https://tos-public.volccdn.com/obj/volc-tos-public/@volcengine/tos-sdk@latest/browser/tos.umd.production.min.js"></script>
    <script src="./const.js"></script>
    <script type="text/javascript">
      const client = new TOS({
        // yourRegion 填写 Bucket 所在地域。以华北2（北京)为例，yourRegion 填写为 cn-beijing。
        region: yourRegion,
        // 填写 endpoint 名称。
        endpoint: yourEndpoint,
        // 从 STS 服务获取的临时访问密钥（AccessKey ID 和 AccessKey Secret）。
        accessKeyId: yourAccessKey,
        accessKeySecret: yourSecretKey,
        // 从 STS 服务获取的安全令牌（SecurityToken）。
        stsToken: yourSecurityToken,
        // 填写 Bucket 名称。
        bucket: examplebucket,
      });

      const listObjects = async () => {
        const data = await client.listObjectVersions({
          bucket: examplebucket,
          maxKeys: 10,
        });
        console.log('data', data.data);
      };

      listObjects();
    </script>
  </body>
</html>

列举指定前缀的所有对象

以下代码用于列举指定存储桶指定前缀下所有多版本对象和删除标记。

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <title>Document</title>
  </head>

  <body>
    <button id="upload">上传</button>
    <input id="file" type="file" />
    <!-- 导入 SDK 文件 -->
    <script src="https://tos-public.volccdn.com/obj/volc-tos-public/@volcengine/tos-sdk@latest/browser/tos.umd.production.min.js"></script>
    <script type="text/javascript">
      const client = new TOS({
        // yourRegion 填写 Bucket 所在地域。以华北2（北京)为例，yourRegion 填写为 cn-beijing。
        region: yourRegion,
        // 填写 endpoint 名称。
        endpoint: yourEndpoint,
        // 从 STS 服务获取的临时访问密钥（AccessKey ID 和 AccessKey Secret）。
        accessKeyId: yourAccessKey,
        accessKeySecret: yourSecretKey,
        // 从 STS 服务获取的安全令牌（SecurityToken）。
        stsToken: yourSecurityToken,
        // 填写 Bucket 名称。
        bucket: examplebucket,
      });

      const listObjects = async () => {
        const data = await client.listObjectVersions({
          bucket: examplebucket,
          prefix: '1',
        });
        console.log('data', data.data);
      };

      listObjects();
    </script>
  </body>
</html>

列举所有对象

以下代码用于列举制定桶内所有多版本对象和删除标记。

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <title>Document</title>
  </head>

  <body>
    <button id="upload">上传</button>
    <input id="file" type="file" />
    <!-- 导入 SDK 文件 -->
    <script src="https://tos-public.volccdn.com/obj/volc-tos-public/@volcengine/tos-sdk@latest/browser/tos.umd.production.min.js"></script>
    <script src="./const.js"></script>
    <script type="text/javascript">
      const client = new TOS({
        // yourRegion 填写 Bucket 所在地域。以华北2（北京)为例，yourRegion 填写为 cn-beijing。
        region: yourRegion,
        // 填写 endpoint 名称。
        endpoint: yourEndpoint,
        // 从 STS 服务获取的临时访问密钥（AccessKey ID 和 AccessKey Secret）。
        accessKeyId: yourAccessKey,
        accessKeySecret: yourSecretKey,
        // 从 STS 服务获取的安全令牌（SecurityToken）。
        stsToken: yourSecurityToken,
        // 填写 Bucket 名称。
        bucket: examplebucket,
      });

      const listObjects = async () => {
        const data = await client.listObjectVersions({
          bucket: examplebucket,
        });
        console.log('data', data.data);
      };

      listObjects();
    </script>
  </body>
</html>