このトピックでは、バージョン管理が有効なバケット内のオブジェクトのメタデータをクエリする方法について説明します。
注意事項
このトピックのサンプルコードでは、中国 (杭州) リージョンのリージョン ID
cn-hangzhouを使用します。デフォルトでは、パブリックエンドポイントを使用してバケット内のリソースにアクセスします。バケットが配置されているのと同じリージョンにある他の Alibaba Cloud サービスを使用してバケット内のリソースにアクセスする場合は、内部エンドポイントを使用します。OSS がサポートするリージョンとエンドポイントの詳細については、「OSS のリージョンとエンドポイント」をご参照ください。オブジェクトのメタデータをクエリするには、
oss:GetObject権限が必要です。詳細については、「RAM ユーザーへのカスタムポリシーの付与」をご参照ください。
サンプルコード
HeadObject メソッドを使用してオブジェクトのすべてのメタデータをクエリする
HeadObject メソッドを使用して、オブジェクトの特定のバージョンのすべてのメタデータをクエリするには、次のコードを使用します。
import argparse
import alibabacloud_oss_v2 as oss
# コマンドラインパラメータパーサーを作成し、スクリプトの目的を記述します。この例では、オブジェクトのヘッダーをクエリする方法について説明します。
parser = argparse.ArgumentParser(description="head object sample")
# --region パラメータを指定して、バケットが配置されているリージョンを示します。このパラメータは必須です。
parser.add_argument('--region', help='バケットが配置されているリージョン。', required=True)
# --bucket パラメータを指定します。これは、バケットの名前を指定します。このコマンドラインパラメータは必須です。
parser.add_argument('--bucket', help='バケットの名前。', required=True)
# --endpoint パラメータを指定して、バケットが配置されているリージョンのエンドポイントを示します。このパラメータはオプションです。
parser.add_argument('--endpoint', help='他のサービスが OSS にアクセスするために使用できるドメイン名')
# --key パラメータを指定します。これは、オブジェクトの名前を指定します。このコマンドラインパラメータは必須です。
parser.add_argument('--key', help='オブジェクトの名前。', required=True)
# --source_version_id パラメータを指定します。これは、ソースオブジェクトのバージョン ID を指定します。このコマンドラインパラメータは必須です。
parser.add_argument('--version_id', help='オブジェクトのバージョン ID。', required=True)
def main():
# コマンドライン引数を解析します。
args = parser.parse_args()
# 認証のために環境変数からアクセス認証情報を取得します。
credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()
# デフォルト構成を使用して cfg オブジェクトを作成し、認証情報プロバイダーを指定します。
cfg = oss.config.load_default()
cfg.credentials_provider = credentials_provider
# cfg オブジェクトの region 属性を、コマンドラインで指定されたリージョンに設定します。
cfg.region = args.region
# カスタムエンドポイントが指定されている場合は、cfg オブジェクトの endpoint 属性を指定されたエンドポイントで更新します。
if args.endpoint is not None:
cfg.endpoint = args.endpoint
# 前述の設定を使用して、OSSClient インスタンスを初期化します。
client = oss.Client(cfg)
# オブジェクトのヘッダーをクエリするリクエストを送信します。
result = client.head_object(oss.HeadObjectRequest(
bucket=args.bucket, # バケットの名前を指定します
key=args.key, # オブジェクトの名前を指定します
version_id=args.version_id, # オブジェクトのバージョン ID を指定します
))
# 操作結果のさまざまなメタデータ情報を表示します。
print(f'status code: {result.status_code},'
f' request id: {result.request_id},'
f' content length: {result.content_length},'
f' content type: {result.content_type},'
f' etag: {result.etag},'
f' last modified: {result.last_modified},'
f' content md5: {result.content_md5},'
f' cache control: {result.cache_control},'
f' content disposition: {result.content_disposition},'
f' content encoding: {result.content_encoding},'
f' expires: {result.expires},'
f' hash crc64: {result.hash_crc64},'
f' storage class: {result.storage_class},'
f' object type: {result.object_type},'
f' version id: {result.version_id},'
f' tagging count: {result.tagging_count},'
f' server side encryption: {result.server_side_encryption},'
f' server side data encryption: {result.server_side_data_encryption},'
f' server side encryption key id: {result.server_side_encryption_key_id},'
f' next append position: {result.next_append_position},'
f' expiration: {result.expiration},'
f' restore: {result.restore},'
f' process status: {result.process_status},'
f' request charged: {result.request_charged},'
f' allow origin: {result.allow_origin},'
f' allow methods: {result.allow_methods},'
f' allow age: {result.allow_age},'
f' allow headers: {result.allow_headers},'
f' expose headers: {result.expose_headers},'
)
# スクリプトが直接実行されたときに処理ロジックを開始するために、main 関数を呼び出します。
if __name__ == "__main__":
main() # スクリプトのエントリポイントを指定します。制御フローはここから開始されます。GetObjectMeta メソッドを使用してオブジェクトの部分メタデータをクエリする
説明
GetObjectMeta メソッドを使用して、返されるコンテンツの長さ (ContentLength)、エンティティタグ (ETag)、最終更新時刻 (LastModified)、最終アクセス時刻 (LastAccessTime)、バージョン ID (VersionId)、CRC-64 ハッシュ (HashCRC64) などのオブジェクトの部分メタデータのみをクエリできます。
GetObjectMeta メソッドを使用して、特定のオブジェクトバージョンの部分メタデータをクエリするには、次のコードを使用します。
import argparse
import alibabacloud_oss_v2 as oss
# コマンドラインパラメータパーサーを作成し、スクリプトの目的を記述します。この例では、オブジェクトのメタデータをクエリする方法について説明します。
parser = argparse.ArgumentParser(description="get object meta sample")
# --region パラメータを指定して、バケットが配置されているリージョンを示します。このパラメータは必須です。
parser.add_argument('--region', help='バケットが配置されているリージョン。', required=True)
# --bucket パラメータを指定します。これは、バケットの名前を指定します。このコマンドラインパラメータは必須です。
parser.add_argument('--bucket', help='バケットの名前。', required=True)
# --endpoint パラメータを指定して、バケットが配置されているリージョンのエンドポイントを示します。このパラメータはオプションです。
parser.add_argument('--endpoint', help='他のサービスが OSS にアクセスするために使用できるドメイン名')
# --key パラメータを指定します。これは、オブジェクトの名前を指定します。このコマンドラインパラメータは必須です。
parser.add_argument('--key', help='オブジェクトの名前。', required=True)
# --source_version_id パラメータを指定します。これは、ソースオブジェクトのバージョン ID を指定します。このコマンドラインパラメータは必須です。
parser.add_argument('--version_id', help='オブジェクトのバージョン ID。', required=True)
def main():
# コマンドライン引数を解析します。
args = parser.parse_args()
# 認証のために環境変数からアクセス認証情報を取得します。
credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()
# デフォルト構成を使用して cfg オブジェクトを作成し、認証情報プロバイダーを指定します。
cfg = oss.config.load_default()
cfg.credentials_provider = credentials_provider
# cfg オブジェクトの region 属性を、コマンドラインで指定されたリージョンに設定します。
cfg.region = args.region
# カスタムエンドポイントが指定されている場合は、cfg オブジェクトの endpoint 属性を指定されたエンドポイントで更新します。
if args.endpoint is not None:
cfg.endpoint = args.endpoint
# 前述の設定を使用して、OSSClient インスタンスを初期化します。
client = oss.Client(cfg)
# オブジェクトのメタデータをクエリするリクエストを送信します。
result = client.get_object_meta(oss.GetObjectMetaRequest(
bucket=args.bucket, # バケットの名前を指定します
key=args.key, # オブジェクトの名前を指定します
version_id=args.version_id, # オブジェクトのバージョン ID を指定します
))
# 操作結果のステータスコード、リクエスト ID、コンテンツの長さ、ETag、最終更新時刻、最終アクセス時刻、バージョン ID、およびハッシュ CRC64 を表示して、リクエストステータスを確認します。
print(f'status code: {result.status_code},'
f' request id: {result.request_id},'
f' content length: {result.content_length},'
f' etag: {result.etag},'
f' last modified: {result.last_modified},'
f' last access time: {result.last_access_time},'
f' version id: {result.version_id},'
f' hash crc64: {result.hash_crc64},'
)
# スクリプトが直接実行されたときに処理ロジックを開始するために、main 関数を呼び出します。
if __name__ == "__main__":
main() # スクリプトのエントリポイントを指定します。制御フローはここから開始されます。