如何Harmony SDK管理文件元数据_对象存储(OSS)-阿里云帮助中心

本文介绍如何使用OSS Harmony SDK设置和获取文件元数据。

注意事项

关于OSS支持的Region与Endpoint的对应关系，请参见OSS地域和访问域名。
要设置文件元数据，您必须具有oss:PutObject权限；要获取文件元数据，您必须具有oss:GetObject权限。具体操作，请参见为RAM用户授权自定义的权限策略。

上传文件时设置元数据

以下代码使用上传文件为例，在上传文件时设置文件为公共读。

import Client, { EObjectAcl, RequestError } from '@aliyun/oss';

// 创建OSS客户端实例
const client = new Client({
  // 请替换为STS临时访问凭证的Access Key ID
  accessKeyId: 'yourAccessKeyId',
  // 请替换为STS临时访问凭证的Access Key Secret
  accessKeySecret: 'yourAccessKeySecret',
  // 请替换为STS临时访问凭证的Security Token
  securityToken: 'yourSecurityToken',
  // 填写Bucket所在地域。以华东1（杭州）为例，Region填写为oss-cn-hangzhou
  region: 'oss-cn-hangzhou',
});

const bucket = 'yourBucketName'; // 请替换为您想要使用的Bucket名称

const key = 'yourObjectName'; // 请替换为您想要上传的对象（文件）名称

const putObject = async () => {
  try {
    // 调用putObject方法上传数据到指定的Bucket和Key，并传入数据作为参数
    const res = await client.putObject({
      bucket, // Bucket名称
      key, // 对象（文件）名称
      data: 'hello world', // 要上传的数据，这里是一个简单的字符串
      objectAcl: EObjectAcl.PRIVATE
    });

    // 打印上传结果
    console.log(JSON.stringify(res));
  } catch (err) {
    // 捕获请求过程中的异常信息
    if (err instanceof RequestError) {
      // 如果是已知类型的错误，则打印错误代码、错误消息、请求ID、状态码、EC码等信息
      console.log('code: ', err.code);
      console.log('message: ', err.message);
      console.log('requestId: ', err.requestId);
      console.log('status: ', err.status);
      console.log('ec: ', err.ec);
    } else {
      // 打印其他未知类型的错误
      console.log('unknown error: ', err);
    }
  }
}

// 调用putObject函数执行上传操作
putObject();

获取文件元数据

使用HeadObject方法获取对象的所有元数据

您可以通过以下代码使用HeadObject方法获取指定Object的所有元数据。

import Client, { RequestError } from '@aliyun/oss';

// 创建OSS客户端实例
const client = new Client({
  // 请替换为STS临时访问凭证的Access Key ID
  accessKeyId: 'yourAccessKeyId',
  // 请替换为STS临时访问凭证的Access Key Secret
  accessKeySecret: 'yourAccessKeySecret',
  // 请替换为STS临时访问凭证的Security Token
  securityToken: 'yourSecurityToken',
  // 填写Bucket所在地域。以华东1（杭州）为例，Region填写为oss-cn-hangzhou
  region: 'oss-cn-hangzhou',
});

// 指定要操作的Bucket名称，请替换为您实际使用的Bucket名称
const bucket = 'yourBucketName';
// 指定要查询的对象（文件）名称，请替换为您实际要查询的对象名称
const key = 'yourObjectName';

/**
 * 获取对象的元信息。
 * 使用headObject方法获取指定对象的元信息，而不下载对象内容。
 */
const headObject = async () => {
  try {
    // 调用headObject方法获取指定对象的元信息
    const res = await client.headObject({
      bucket, // Bucket名称
      key,    // 对象（文件）名称
    });

    // 打印对象的元信息
    console.log(JSON.stringify(res));
  } catch (err) {
    // 捕获请求过程中的异常信息
    if (err instanceof RequestError) {
      // 如果是已知类型的错误，则打印错误代码、错误消息、请求ID、状态码、EC码等信息
      console.log('code: ', err.code); // 错误代码
      console.log('message: ', err.message); // 错误消息
      console.log('requestId: ', err.requestId); // 请求ID
      console.log('status: ', err.status); // HTTP状态码
      console.log('ec: ', err.ec); // 错误码
    } else {
      // 打印其他未知类型的错误
      console.log('unknown error: ', err);
    }
  }
};

// 调用headObject函数执行获取对象元信息的操作
headObject();

使用GetObjectMeta方法获取对象的部分元数据

说明

使用GetObjectMeta方法仅可以获取部分的对象元数据，包括：返回内容的长度（ContentLength）、实体标签（ETag）、返回的对象最后一次被修改的时间（LastModified）、对象最后一次被访问的时间（LastAccessTime）、对象的版本ID（VersionId）、对象的 64 位 CRC 值（HashCRC64）。

您可以通过以下代码使用GetObjectMeta方法获取指定对象的部分元数据。

import Client, { RequestError } from '@aliyun/oss';

// 创建OSS客户端实例
const client = new Client({
  // 请替换为STS临时访问凭证的Access Key ID
  accessKeyId: 'yourAccessKeyId',
  // 请替换为STS临时访问凭证的Access Key Secret
  accessKeySecret: 'yourAccessKeySecret',
  // 请替换为STS临时访问凭证的Security Token
  securityToken: 'yourSecurityToken',
  // 填写Bucket所在地域。以华东1（杭州）为例，Region填写为oss-cn-hangzhou
  region: 'oss-cn-hangzhou',
});

// 指定要操作的Bucket名称，请替换为您实际使用的Bucket名称
const bucket = 'yourBucketName';
// 指定要查询的对象（文件）名称，请替换为您实际要查询的对象名称
const key = 'yourObjectName';

/**
 * 获取对象的元信息。
 * 使用getObjectMeta方法获取指定对象的元信息，包括HTTP头部信息。
 */
const getObjectMeta = async () => {
  try {
    // 调用getObjectMeta方法获取指定对象的元信息
    const res = await client.getObjectMeta({
      bucket, // Bucket名称
      key,    // 对象（文件）名称
    });

    // 打印对象的元信息
    console.log(JSON.stringify(res));
  } catch (err) {
    // 捕获请求过程中的异常信息
    if (err instanceof RequestError) {
      // 如果是已知类型的错误，则打印错误代码、错误消息、请求ID、状态码、EC码等信息
      console.log('code: ', err.code); // 错误代码
      console.log('message: ', err.message); // 错误消息
      console.log('requestId: ', err.requestId); // 请求ID
      console.log('status: ', err.status); // HTTP状态码
      console.log('ec: ', err.ec); // 错误码
    } else {
      // 打印其他未知类型的错误
      console.log('unknown error: ', err);
    }
  }
};

// 调用getObjectMeta函数执行获取对象元信息的操作
getObjectMeta();