.NET管理文件元信息
文件元信息(Object Meta)包括HTTP Header和自定义元信息。本文介绍如何在上传文件时设置元信息。
注意事项
- 本文以华东1(杭州)外网Endpoint为例。如果您希望通过与OSS同地域的其他阿里云产品访问OSS,请使用内网Endpoint。关于OSS支持的Region与Endpoint的对应关系,请参见访问域名和数据中心。
- 本文以OSS域名新建OSSClient为例。如果您希望通过自定义域名、STS等方式新建OSSClient,请参见.NET初始化。
要设置文件元信息,您必须具有
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";
// 创建OssClient实例。
var client = new OssClient(endpoint, accessKeyId, accessKeySecret);
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接口说明,请参见GetObjectMeta和HeadObject。