获取对象元数据

GetObjectMetadata操作用于获取对象的元数据信息。执行HeadObject操作需要具有对该对象的READ权限。GetObjectMetadata操作可以用于判断是否存在。

示例代码:

using System;
using System.Threading.Tasks;
using Amazon.Runtime;
using Amazon.S3;
using Amazon.S3.Model;

namespace DotNetSDK.ObjectOperation
{
    public class GetObjectMetadataExample
    {
        public static async Task GetObjectMetadata()
        {
            var accessKey = "YOUR_ACCESS_KEY";
            var secretKey = "YOUR_SECRET_KEY";
            var endpoint = "YOUR_ENDPOINT";
            var bucketName = "EXAMPLE_BUCKET";
            var key = "EXAMPLE_KEY";
            try
            {
                var credentials = new BasicAWSCredentials(accessKey, secretKey);
                var conf = new AmazonS3Config
                {
                    ServiceURL = endpoint
                };
                var s3Client = new AmazonS3Client(credentials, conf);
                var getObjectMetadataRequest = new GetObjectMetadataRequest()
                {
                    BucketName = bucketName,
                    Key = key
                };

                var result = await s3Client.GetObjectMetadataAsync(getObjectMetadataRequest);
                if (result.HttpStatusCode != System.Net.HttpStatusCode.OK)
                {
                    Console.WriteLine("fail to get metadata of object {0}, HttpStatusCode:{1}, ErrorCode:{2}.", key, (int) result.HttpStatusCode, result.HttpStatusCode);
                    return;
                }

                Console.WriteLine("get object metadata response: {0}", (int) result.HttpStatusCode);
                Console.WriteLine("object ETag:{0}, object versionId:{1}", result.ETag, result.VersionId);
            }
            catch (Exception e)
            {
                Console.WriteLine(e.Message);
            }
        }
    }
}

GetObjectMetadataRequest可设置的参数如下:

参数 类型 说明 是否必要
BucketName string bucket的名称。
EtagToMatch string 用于指定只有在对象的ETag和该参数值匹配的情况下才返回对象数据,否则返回412错误码。
ModifiedSinceDateUtc DateTime 用于只有当对象在指定时间后被修改的情况下才返回该对象,否则返回304错误码。
EtagToNotMatch string 用于指定只有在对象的ETag和该参数值不匹配的情况下才返回对象数据,否则返回304错误码。
UnmodifiedSinceDateUtc DateTime 用于仅当对象自指定时间以来未被修改的情况下才返回对象数据,否则返回412错误码。
Key string 对象的key。
PartNumber int 读取对象指定的片段,该参数大于等于1,小于等于10000。
VersionId string 当bucket开启版本控制的时候,用于指定获取指定版本的对象数据,当不指定该参数的时候,默认获取最新版本的对象数据。

GetObjectMetadata返回的结果如下:

参数 类型 说明
ETag string 对象的Entity Ttag。
VersionId string 对象最新的版本ID。

响应结果:

HTTP状态码 响应码 描述
200 OK 操作成功。
304 NotModified ModifiedSinceDateUtc或EtagToNotMatch条件不匹配。
403 Forbidden 用户没有权限执行操作。
404 NotFound 操作指定的bucket不存在或者key对应的对象不存在。
412 PreconditionFailed EtagToMatch或者UnmodifiedSinceDateUtc条件不匹配。