.NET管理文件元数据

对象存储OSS存储的文件(Object)信息包含Key、DataObject Meta。Object Meta是对文件的属性描述,包括HTTP标准属性(HTTP Header)和用户自定义元数据(User Meta)两种。您可以通过设置HTTP标准属性来自定义HTTP请求的策略,例如文件(Object)缓存策略、强制下载策略等。您还可以通过设置用户自定义元数据来标识Object的用途或属性等。

注意事项

  • 本文以华东1(杭州)外网Endpoint为例。如果您希望通过与OSS同地域的其他阿里云产品访问OSS,请使用内网Endpoint。关于OSS支持的RegionEndpoint的对应关系,请参见OSS地域和访问域名

  • 本文以OSS域名新建OSSClient为例。如果您希望通过自定义域名、STS等方式新建OSSClient,请参见初始化

  • 要设置文件元数据,您必须具有oss:PutObject权限;要获取文件元数据,您必须具有oss:GetObject权限。具体操作,请参见RAM用户授权自定义的权限策略

示例代码

以下代码用于设置、修改和获取文件元数据:

using Aliyun.OSS;
using Aliyun.OSS.Common;
using Aliyun.OSS.Util;

// yourEndpoint填写Bucket所在地域对应的Endpoint。以华东1(杭州)为例,Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com。
var endpoint = "yourEndpoint";
// 从环境变量中获取访问凭证。运行本代码示例之前,请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
var accessKeyId = Environment.GetEnvironmentVariable("OSS_ACCESS_KEY_ID");
var accessKeySecret = Environment.GetEnvironmentVariable("OSS_ACCESS_KEY_SECRET");
// 填写Bucket名称。
var bucketName = "examplebucket";
// 填写Object完整路径。Object完整路径中不能包含Bucket名称。
var objectName = "exampleobject.txt";
// 填写本地文件的完整路径。如果未指定本地路径,则默认从示例程序所属项目对应本地路径中上传文件。
var localFilename = "D:\\localpath\\examplefile.txt";
// 填写Bucket所在地域对应的Region。以华东1(杭州)为例,Region填写为cn-hangzhou。
const string region = "cn-hangzhou";

// 创建ClientConfiguration实例,按照您的需要修改默认参数。
var conf = new ClientConfiguration();

// 设置v4签名。
conf.SignatureVersion = SignatureVersion.V4;

// 创建OssClient实例。
var client = new OssClient(endpoint, accessKeyId, accessKeySecret, conf);
c.SetRegion(region);
try
{
    using (var fs = File.Open(localFilename, FileMode.Open))
    {
        // 创建上传文件的元数据,可以通过文件元数据设置HTTP header。
        var metadata = new ObjectMetadata()
        {
            // 指定文件类型。
            ContentType = "text/html",
            // 设置缓存过期时间,格式是格林威治时间(GMT)。
            ExpirationTime = DateTime.Parse("2025-10-12T00:00:00.000Z"),
        };
        // 设置上传文件的长度。如超过此长度,则会被截断为设置的长度。如不足,则为上传文件的实际长度。
        metadata.ContentLength = fs.Length;
        // 设置文件被下载时网页的缓存行为。
        metadata.CacheControl = "No-Cache";
        // 设置元数据mykey1值为myval1。
        metadata.UserMetadata.Add("mykey1", "myval1");
        // 设置元数据mykey2值为myval2。
        metadata.UserMetadata.Add("mykey2", "myval2");
        var saveAsFilename = "文件名测试123.txt";
        var contentDisposition = string.Format("attachment;filename*=utf-8''{0}", HttpUtils.EncodeUri(saveAsFilename, "utf-8"));
        // 把请求所得的内容存为一个文件的时候提供一个默认的文件名。
        metadata.ContentDisposition = contentDisposition;
        // 上传文件并设置文件元数据。
        client.PutObject(bucketName, objectName, fs, metadata);
        Console.WriteLine("Put object succeeded");
        // 获取文件元数据。
        var oldMeta = client.GetObjectMetadata(bucketName, objectName);
        // 设置新的文件元数据。
        var newMeta = new ObjectMetadata()
        {
            ContentType = "application/octet-stream",
            ExpirationTime = DateTime.Parse("2035-11-11T00:00:00.000Z"),
            // 指定文件被下载时的内容编码格式。
            ContentEncoding = null,
            CacheControl = ""
        };
        // 增加自定义元数据。
        newMeta.UserMetadata.Add("author", "oss");
        newMeta.UserMetadata.Add("flag", "my-flag");
        newMeta.UserMetadata.Add("mykey2", "myval2-modified-value");
        // 通过ModifyObjectMeta方法修改文件元数据。
        client.ModifyObjectMeta(bucketName, objectName, newMeta);
    }
}
catch (Exception ex)
{
    Console.WriteLine("Put object failed, {0}", ex.Message);
}

相关文档

  • 关于设置、修改和获取文件元数据的完整示例代码,请参见GitHub示例

  • 关于在简单上传过程中设置文件元数据的API接口说明,请参见PutObject

  • 关于在拷贝文件过程中修改文件元数据的API接口说明,请参见CopyObject

  • 关于获取文件元数据的API接口说明,请参见GetObjectMetaHeadObject