Object Storage Service (OSS) に保存されているオブジェクトは、キー、データ、およびオブジェクトメタデータで構成されます。 オブジェクトメタデータは、オブジェクト属性を記述する。 オブジェクトメタデータには、標準HTTPヘッダーとユーザーメタデータが含まれます。 標準のHTTPヘッダーを設定することで、オブジェクトキャッシュポリシーや強制オブジェクトダウンロードポリシーなどのカスタムHTTPリクエストポリシーを作成できます。 オブジェクトのユーザーメタデータを設定して、オブジェクトの目的や属性を識別することもできます。
使用上の注意
このトピックでは、中国 (杭州) リージョンのパブリックエンドポイントを使用します。 OSSと同じリージョンにある他のAlibaba CloudサービスからOSSにアクセスする場合は、内部エンドポイントを使用します。 OSSリージョンとエンドポイントの詳細については、「リージョンとエンドポイント」をご参照ください。
このトピックでは、OSSエンドポイントを使用してOSSClientインスタンスを作成します。 カスタムドメイン名またはSTS (Security Token Service) を使用してOSSClientインスタンスを作成する場合は、「初期化」をご参照ください。
オブジェクトメタデータを設定するには、
oss:PutObject
権限が必要です。 オブジェクトメタデータを照会するには、oss:GetObject
権限が必要です。 詳細については、「RAMユーザーへのカスタムポリシーのアタッチ」をご参照ください。
サンプルコード
次のコードは、オブジェクトメタデータを設定、変更、および照会する方法の例を示しています。
Aliyun.OSSを使用した
Aliyun.OSS.Common; を使用
Aliyun.OSS.Utilを使用します。// バケットが配置されているリージョンのエンドポイントを指定します。 たとえば、バケットが中国 (杭州) リージョンにある場合、エンドポイントを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");
// バケットの名前を指定します。
var bucketName = "examplebucket";
// オブジェクトのフルパスを指定します。 バケット名をフルパスに含めないでください。
var objectName = "exampleobject.txt";
// アップロードするローカルオブジェクトのフルパスを指定します。 デフォルトでは、ローカルオブジェクトのフルパスを指定しない場合、サンプルプログラムが属するプロジェクトのパスからローカルオブジェクトがアップロードされます。
var localFilename = "D :\\ localpath\\examplefile.txt";
// OSSClientインスタンスを作成します。
var client = new OssClient (エンドポイント、accessKeyId、accessKeySecret);
トライ
{
using (var fs = File.Open(localFilename, FileMode.Open))
{
// オブジェクトのメタデータを作成します。 オブジェクトのHTTPヘッダーを設定できます。
var metadata = new ObjectMetadata()
{
// オブジェクトのコンテンツタイプを指定します。
ContentType = "text/html",
// キャッシュの有効期限をUTCで指定します。
ExpirationTime = DateTime.Parse("2025-10-12T00:00:00.000Z"),
};
// アップロードするオブジェクトコンテンツの長さを指定します。 実際のオブジェクトの長さが指定された長さより大きい場合、オブジェクトは切り捨てられます。 指定された長さのコンテンツのみがアップロードされます。 実際のオブジェクトの長さが指定された長さより小さい場合、オブジェクトのすべてのコンテンツがアップロードされます。
metadata.ContentLength = fs.Length;
// オブジェクトのダウンロード時のwebページのキャッシュ動作を指定します。
metadata.CacheControl = "No-Cache";
// mykey1をmyval1に設定します。
metadata.UserMetadata.Add("mykey1", "myval1");
// mykey2をmyval2に設定します。
metadata.UserMetadata.Add("mykey2", "myval2");
var saveAsFilename = "Filetest123.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);
}
}
キャッチ (例外ex)
{
Console.WriteLine("Put object failed, {0}", ex.Message);
}
参考資料
オブジェクトメタデータの設定、変更、および取得に使用される完全なサンプルコードについては、GitHubをご覧ください。
シンプルアップロード中にオブジェクトメタデータを設定するために呼び出すことができるAPI操作の詳細については、「PutObject」をご参照ください。
オブジェクトをコピーするときにオブジェクトメタデータを変更するために呼び出すことができるAPI操作の詳細については、「CopyObject」をご参照ください。
オブジェクトメタデータを照会するために呼び出すAPI操作の詳細については、「GetObjectMeta」および「HeadObject」をご参照ください。