C#获取文件元数据

本文介绍如何在受版本控制的存储空间(Bucket)中获取文件(Object)元数据。

注意事项

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

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

示例代码

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

您可以通过以下代码使用HeadObjectAsync方法获取指定对象版本的所有元数据。

using OSS = AlibabaCloud.OSS.V2;  // 为阿里云OSS SDK创建别名,简化后续使用

var region = "cn-hangzhou";  // 必须项,设置Bucket所在的区域(Region)。以华东1(杭州)为例,Region填写为cn-hangzhou
var endpoint = null as string;  // 可选项,指定访问OSS服务的域名。以华东1(杭州)为例,Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com
var bucket = "your bucket name";  // 必须项,Bucket名称
var key = "your object key";  // 必须项,目标对象名称

// 加载OSS SDK的默认配置,此配置会自动从环境变量中读取凭证信息(如AccessKey)
var cfg = OSS.Configuration.LoadDefault();
// 显式设置使用环境变量获取凭证,用于身份验证(格式:OSS_ACCESS_KEY_ID、OSS_ACCESS_KEY_SECRET)
cfg.CredentialsProvider = new OSS.Credentials.EnvironmentVariableCredentialsProvider();
// 设置配置的Bucket区域
cfg.Region = region;   
// 若已指定了endpoint,则覆盖默认的endpoint 
if(endpoint != null) 
{
    cfg.Endpoint = endpoint;
} 

// 使用配置信息创建OSS客户端实例
using var client = new OSS.Client(cfg);

// 调用HeadObjectAsync方法获取目标对象所有元数据信息
var result = await client.HeadObjectAsync(new OSS.Models.HeadObjectRequest()
{
    Bucket = bucket,
    Key = key,
});

// 打印结果信息
Console.WriteLine("HeadObject done");  // 提示操作完成
Console.WriteLine($"StatusCode: {result.StatusCode}");  // HTTP状态码
Console.WriteLine($"RequestId: {result.RequestId}");  // RequestId,用于阿里云排查问题
Console.WriteLine("Response Headers:");  // 响应头信息
result.Headers.ToList().ForEach(x => Console.WriteLine(x.Key + " : " + x.Value));  // 遍历并打印所有响应头

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

说明

使用GetObjectMetaAsync方法仅可以获取部分的对象元数据,包括:返回内容的长度(Content-Length)、实体标签(ETag)、返回的对象最后一次被修改的时间(Last-Modified)、对象的版本ID(x-oss-version-id)、对象的 64 位 CRC 值(x-oss-hash-crc64ecma)。

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

using OSS = AlibabaCloud.OSS.V2;  // 为阿里云OSS SDK创建别名,简化后续使用

var region = "cn-hangzhou";  // 必须项,设置Bucket所在的区域(Region)。以华东1(杭州)为例,Region填写为cn-hangzhou
var endpoint = null as string;  // 可选项,指定访问OSS服务的域名。以华东1(杭州)为例,Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com
var bucket = "your bucket name";  // 必须项,Bucket名称
var key = "your object key";  // 必须项,Bucket名称


// 加载OSS SDK的默认配置,此配置会自动从环境变量中读取凭证信息(如AccessKey)
var cfg = OSS.Configuration.LoadDefault();
// 显式设置使用环境变量获取凭证,用于身份验证(格式:OSS_ACCESS_KEY_ID、OSS_ACCESS_KEY_SECRET)
cfg.CredentialsProvider = new OSS.Credentials.EnvironmentVariableCredentialsProvider();
// 设置配置的Bucket区域
cfg.Region = region;   
// 若已指定了endpoint,则覆盖默认的endpoint 
if(endpoint != null) 
{
    cfg.Endpoint = endpoint;
} 

// 使用配置信息创建OSS客户端实例
using var client = new OSS.Client(cfg); 

// 调用GetObjectMetaAsync方法获取目标object部分元数据
var result = await client.GetObjectMetaAsync(new OSS.Models.GetObjectMetaRequest()
{
    Bucket = bucket,
    Key = key,
});

// 打印结果信息
Console.WriteLine("GetObjectMeta done");  // 提示操作完成
Console.WriteLine($"StatusCode: {result.StatusCode}");  // HTTP状态码
Console.WriteLine($"RequestId: {result.RequestId}");  // RequestId,用于阿里云排查问题
Console.WriteLine("Response Headers:");  // 响应头信息
result.Headers.ToList().ForEach(x => Console.WriteLine(x.Key + " : " + x.Value));   // 遍历并打印所有响应头

相关文档

  • 关于获取对象完整元数据示例代码,请参见HeadObject.cs

  • 关于获取对象部分元数据示例代码,请参见GetObjectMeta.cs