Python SDK V2 を使用してアーカイブオブジェクトにリアルタイムアクセスする方法 - Object Storage Service

このトピックでは、Python SDK V2 を使用してバケットのアーカイブオブジェクトへのリアルタイムアクセスを管理する方法について説明します。

使用上の注意

このトピックのサンプルコードでは、中国 (杭州) リージョンのリージョン ID cn-hangzhou を使用します。デフォルトでは、パブリックエンドポイントを使用してバケット内のリソースにアクセスします。バケットが配置されている同じリージョン内の他の Alibaba Cloud サービスを使用してバケット内のリソースにアクセスする場合は、内部エンドポイントを使用します。OSS がサポートするリージョンとエンドポイントの詳細については、「OSS のリージョンとエンドポイント」をご参照ください。

メソッド定義

バケットのアーカイブオブジェクトへのリアルタイムアクセスを有効にする

put_bucket_archive_direct_read(request: PutBucketArchiveDirectReadRequest, **kwargs) → PutBucketArchiveDirectReadResult

バケットのアーカイブオブジェクトへのリアルタイムアクセスが有効になっているかどうかをクエリする

get_bucket_archive_direct_read(request: GetBucketArchiveDirectReadRequest, **kwargs) → GetBucketArchiveDirectReadResult

リクエストパラメーター

パラメーター	タイプ	説明
request	PutBucketArchiveDirectReadRequest	リクエストパラメーター。詳細については、「PutBucketArchiveDirectReadRequest」をご参照ください。
request	GetBucketArchiveDirectReadRequest	リクエストパラメーター。詳細については、「GetBucketArchiveDirectReadRequest」をご参照ください。

レスポンスパラメーター

タイプ	説明
PutBucketArchiveDirectReadResult	レスポンスパラメーター。詳細については、「PutBucketArchiveDirectReadResult」をご参照ください。
GetBucketArchiveDirectReadResult	レスポンスパラメーター。詳細については、「GetBucketArchiveDirectReadResult」をご参照ください。

バケットのアーカイブオブジェクトへのリアルタイムアクセスを有効にするメソッドの完全な定義については、「put_bucket_archive_direct_read」をご参照ください。

バケットのアーカイブオブジェクトへのリアルタイムアクセスが有効になっているかどうかをクエリするメソッドの完全な定義については、「get_bucket_archive_direct_read」をご参照ください。

サンプルコード

バケットのアーカイブオブジェクトへのリアルタイムアクセスを有効にする

次のコードを使用して、バケットのアーカイブオブジェクトへのリアルタイムアクセスを有効にできます。

import argparse
import alibabacloud_oss_v2 as oss

# コマンドライン引数パーサーを作成し、スクリプトの目的を記述します: バケットのアーカイブオブジェクトへのリアルタイムアクセスの構成を設定します。
parser = argparse.ArgumentParser(description="put bucket archive direct read sample")

# 必要なリージョン、バケット名、エンドポイント、アーカイブオブジェクトへのリアルタイムアクセスを有効にするかどうかなど、コマンドライン引数を定義します。
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')
parser.add_argument('--enabled', help='Specifies whether to enable real-time access of Archive objects for a bucket. Valid values: "true" or "false".', required=True)

def main():
    # コマンドライン引数を解析して、ユーザーが入力した値を取得します。
    args = parser.parse_args()

    # ID 検証のために環境変数からアクセス資格情報情報を読み込みます。
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # デフォルトの SDK 構成を使用して構成オブジェクトを作成し、認証プロバイダーを設定します。
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider

    # ユーザーが指定したコマンドライン引数に基づいて、構成オブジェクトのリージョンプロパティを設定します。
    cfg.region = args.region

    # カスタムエンドポイントが指定されている場合は、構成オブジェクトのエンドポイントプロパティを更新します。
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 前述の構成を使用して、OSS と対話するための OSS クライアントを初期化します。
    client = oss.Client(cfg)

    # 指定されたバケットのアーカイブオブジェクトへのリアルタイムアクセスの構成を設定するリクエストを実行します。
    result = client.put_bucket_archive_direct_read(oss.PutBucketArchiveDirectReadRequest(
            bucket=args.bucket,  # バケット名。
            archive_direct_read_configuration=oss.ArchiveDirectReadConfiguration(
                enabled=args.enabled.lower() == 'true',  # 文字列形式のブール値を Python のブール型に変換します。
            ),
    ))

    # 操作結果のステータスコードとリクエスト ID を出力して、リクエストのステータスを確認します。
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
    )

# このスクリプトが直接実行されると、main 関数を呼び出してロジックの処理を開始します。
if __name__ == "__main__":
    main()  # スクリプトのエントリポイント。 プログラムフローはここから始まります。

バケットのアーカイブオブジェクトへのリアルタイムアクセスが有効になっているかどうかをクエリする

次のコードを使用して、バケットのアーカイブオブジェクトへのリアルタイムアクセスが有効になっているかどうかをクエリできます。

import argparse
import alibabacloud_oss_v2 as oss

# コマンドライン引数パーサーを作成し、スクリプトの目的を記述します: バケットのアーカイブオブジェクトへのリアルタイムアクセスの構成を取得します。
parser = argparse.ArgumentParser(description="get bucket archive direct read sample")

# 必要なリージョン、バケット名、エンドポイントなど、コマンドライン引数を定義します。
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')

def main():
    # コマンドライン引数を解析して、ユーザーが入力した値を取得します。
    args = parser.parse_args()

    # ID 検証のために環境変数からアクセス資格情報情報を読み込みます。
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # デフォルトの SDK 構成を使用して構成オブジェクトを作成し、認証プロバイダーを設定します。
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider

    # ユーザーが指定したコマンドライン引数に基づいて、構成オブジェクトのリージョンプロパティを設定します。
    cfg.region = args.region

    # カスタムエンドポイントが指定されている場合は、構成オブジェクトのエンドポイントプロパティを更新します。
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 前述の構成を使用して、OSS と対話するための OSS クライアントを初期化します。
    client = oss.Client(cfg)

    # 指定されたバケットのアーカイブオブジェクトへのリアルタイムアクセスの構成の詳細を取得するリクエストを実行します。
    result = client.get_bucket_archive_direct_read(oss.GetBucketArchiveDirectReadRequest(
            bucket=args.bucket,  # バケット名。
    ))

    # 操作結果のステータスコードとリクエスト ID を出力して、リクエストのステータスを確認します。
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          f' enabled: {result.archive_direct_read_configuration.enabled if hasattr(result.archive_direct_read_configuration, "enabled") else "Not set"},'  # アーカイブオブジェクトへのリアルタイムアクセスが有効になっているかどうか。 設定されていない場合は、「未設定」と表示されます。
    )

# このスクリプトが直接実行されると、main 関数を呼び出してロジックの処理を開始します。
if __name__ == "__main__":
    main()  # スクリプトのエントリポイント。 プログラムフローはここから始まります。