Object Storage Service (OSS) は、OSS バケットに保存されているリソースへのアクセスを記録するためにアクセスログを生成します。バケットのロギングを有効にして設定すると、OSS は事前に定義された命名規則に基づいて 1 時間ごとにアクセスログを生成し、特定のバケットにログを保存します。
注意事項
このトピックでは、中国 (杭州) リージョンのパブリックエンドポイントを使用します。OSS と同じリージョンにある他の Alibaba Cloud サービスから OSS にアクセスする場合は、内部エンドポイントを使用してください。OSS のリージョンとエンドポイントの詳細については、「リージョンとエンドポイント」をご参照ください。
このトピックでは、OSS エンドポイントを使用して OssClient インスタンスを作成します。カスタムドメイン名または Security Token Service (STS) を使用して OssClient インスタンスを作成する場合は、「初期化」をご参照ください。
ロギングを有効にするには、
oss:PutBucketLogging権限が必要です。ロギング設定を表示するには、oss:GetBucketLogging権限が必要です。ロギングを無効にするには、oss:DeleteBucketLogging権限が必要です。詳細については、「RAM ユーザーへのカスタムアクセスポリシーの付与」をご参照ください。
バケットのロギングの有効化
次のサンプルコードは、バケットのロギングを有効にする方法の例を示しています。
using Aliyun.OSS;
using Aliyun.OSS.Common;
// エンドポイントを設定します。この例では、中国 (杭州) リージョンのパブリックエンドポイントである https://oss-cn-hangzhou.aliyuncs.com を使用します。他のリージョンについては、エンドポイントを実際の値に設定します。
var endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 環境変数からアクセス認証情報を取得します。このサンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
var accessKeyId = Environment.GetEnvironmentVariable("OSS_ACCESS_KEY_ID");
var accessKeySecret = Environment.GetEnvironmentVariable("OSS_ACCESS_KEY_SECRET");
// ロギングを有効にするバケットの名前 (例: examplebucket) を設定します。
var bucketName = "examplebucket";
// ログファイルを保存する宛先バケットを設定します。宛先バケットは、ソースバケットと同じでも異なっていてもかまいません。
var targetBucketName = "destbucket";
// バケットが配置されているリージョンを設定します。この例では、中国 (杭州) リージョンの ID である cn-hangzhou を使用します。
const string region = "cn-hangzhou";
// ClientConfiguration インスタンスを作成し、必要に応じてデフォルトパラメーターを変更します。
var conf = new ClientConfiguration();
// 署名バージョン 4 を使用します。
conf.SignatureVersion = SignatureVersion.V4;
// OssClient インスタンスを作成します。
var client = new OssClient(endpoint, accessKeyId, accessKeySecret, conf);
client.SetRegion(region);
try
{
// ログファイルが保存されるフォルダを log/ に設定します。このフォルダを指定すると、ログファイルは宛先バケットの指定されたフォルダに保存されます。このフォルダを指定しない場合、ログファイルは宛先バケットのルートディレクトリに保存されます。
var request = new SetBucketLoggingRequest(bucketName, targetBucketName, "log/");
// ロギング機能を有効にします。
client.SetBucketLogging(request);
Console.WriteLine("Set bucket:{0} Logging succeeded ", bucketName);
}
catch (OssException ex)
{
Console.WriteLine("Failed with error code: {0}. Error message: {1}. \nRequestID:{2}\tHostID:{3}",
ex.ErrorCode, ex.Message, ex.RequestId, ex.HostId);
}
catch (Exception ex)
{
Console.WriteLine("Failed with error message: {0}", ex.Message);
}バケットのロギング設定のクエリ
次のサンプルコードは、バケットのロギング設定をクエリする方法の例を示しています。
using Aliyun.OSS;
using Aliyun.OSS.Common;
// エンドポイントを設定します。この例では、中国 (杭州) リージョンのパブリックエンドポイントである https://oss-cn-hangzhou.aliyuncs.com を使用します。他のリージョンについては、エンドポイントを実際の値に設定します。
var endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 環境変数からアクセス認証情報を取得します。このサンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
var accessKeyId = Environment.GetEnvironmentVariable("OSS_ACCESS_KEY_ID");
var accessKeySecret = Environment.GetEnvironmentVariable("OSS_ACCESS_KEY_SECRET");
// バケット名 (例: examplebucket) を設定します。
var bucketName = "examplebucket";
// バケットが配置されているリージョンを設定します。この例では、中国 (杭州) リージョンの ID である cn-hangzhou を使用します。
const string region = "cn-hangzhou";
// ClientConfiguration インスタンスを作成し、必要に応じてデフォルトパラメーターを変更します。
var conf = new ClientConfiguration();
// 署名バージョン 4 を使用します。
conf.SignatureVersion = SignatureVersion.V4;
// OssClient インスタンスを作成します。
var client = new OssClient(endpoint, accessKeyId, accessKeySecret, conf);
client.SetRegion(region);
try
{
// ロギング設定を表示します。
var result = client.GetBucketLogging(bucketName);
Console.WriteLine("Get bucket:{0} Logging succeeded, prefix:{1}", bucketName, result.TargetPrefix);
}
catch (OssException ex)
{
Console.WriteLine("Failed with error code: {0}. Error message: {1}. \nRequestID:{2}\tHostID:{3}",
ex.ErrorCode, ex.Message, ex.RequestId, ex.HostId);
}
catch (Exception ex)
{
Console.WriteLine("Failed with error message: {0}", ex.Message);
}バケットのロギングの無効化
次のサンプルコードは、バケットのロギングを無効にする方法の例を示しています。
using Aliyun.OSS;
using Aliyun.OSS.Common;
// エンドポイントを設定します。この例では、中国 (杭州) リージョンのパブリックエンドポイントである https://oss-cn-hangzhou.aliyuncs.com を使用します。他のリージョンについては、エンドポイントを実際の値に設定します。
var endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 環境変数からアクセス認証情報を取得します。このサンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
var accessKeyId = Environment.GetEnvironmentVariable("OSS_ACCESS_KEY_ID");
var accessKeySecret = Environment.GetEnvironmentVariable("OSS_ACCESS_KEY_SECRET");
// バケット名 (例: examplebucket) を設定します。
var bucketName = "examplebucket";
// バケットが配置されているリージョンを設定します。この例では、中国 (杭州) リージョンの ID である cn-hangzhou を使用します。
const string region = "cn-hangzhou";
// ClientConfiguration インスタンスを作成し、必要に応じてデフォルトパラメーターを変更します。
var conf = new ClientConfiguration();
// 署名バージョン 4 を使用します。
conf.SignatureVersion = SignatureVersion.V4;
// OssClient インスタンスを作成します。
var client = new OssClient(endpoint, accessKeyId, accessKeySecret, conf);
client.SetRegion(region);
try
{
// ロギング機能を無効にします。
client.DeleteBucketLogging(bucketName);
Console.WriteLine("Delete bucket:{0} Logging succeeded ", bucketName);
}
catch (OssException ex)
{
Console.WriteLine("Failed with error code: {0}. Error message: {1}. \nRequestID:{2}\tHostID:{3}",
ex.ErrorCode, ex.Message, ex.RequestId, ex.HostId);
}
catch (Exception ex)
{
Console.WriteLine("Failed with error message: {0}", ex.Message);
}関連ドキュメント
ロギングの完全なサンプルコードについては、「GitHub の例」をご参照ください。
バケットのロギングを有効にするために呼び出すことができる API 操作の詳細については、「PutBucketLogging」をご参照ください。
バケットのロギング設定をクエリするために呼び出すことができる API 操作の詳細については、「GetBucketLogging」をご参照ください。
バケットのロギングを無効にするために呼び出すことができる API 操作の詳細については、「DeleteBucketLogging」をご参照ください。