Object Storage Service：擷取儲存空間的資訊（Python SDK V2）

注意事項

• 本文範例程式碼以華東1（杭州）的地區IDcn-hangzhou為例，預設使用外網Endpoint，如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS，請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係，請參見OSS地區和訪問網域名稱。

• 本文以從環境變數讀取存取憑證為例。如何配置訪問憑證，請參見配置訪問憑證。

• 要擷取儲存空間的資訊，您必須具有oss:GetBucketInfo許可權。具體操作，請參見為RAM使用者授予自訂的權限原則。

方法定義

get_bucket_info(request: GetBucketInfoRequest, **kwargs) → GetBucketInfoResult

請求參數列表

傳回值列表

關於擷取儲存空間的資訊的完整方法定義，請參見get_bucket_info。

範例程式碼

您可以使用以下代碼擷取儲存空間的資訊。

import argparse
import alibabacloud_oss_v2 as oss

# 建立命令列參數解析器，描述此指令碼用於擷取指定Bucket的詳細資料。
parser = argparse.ArgumentParser(description="Get detailed information about a specified OSS bucket.")

# 添加命令列參數 --region，表示儲存空間所在的地區，必需參數
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)

# 添加命令列參數 --bucket，表示儲存空間的名稱，必需參數
parser.add_argument('--bucket', help='The name of the bucket to get information for.', required=True)

# 添加命令列參數 --endpoint，表示其他服務可用來訪問OSS的網域名稱，非必需參數
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS.')

def main():
    """
    主函數，用於解析命令列參數並擷取指定Bucket的詳細資料。
    """

    args = parser.parse_args()  # 解析命令列參數

    # 從環境變數中載入憑證資訊，用於身分識別驗證
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 使用SDK的預設配置，並設定憑證提供者和地區資訊
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider
    cfg.region = args.region

    # 如果提供了endpoint參數，則設定配置中的endpoint
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 使用配置好的資訊建立OSS用戶端
    client = oss.Client(cfg)

    # 構造請求以擷取指定Bucket的詳細資料
    request = oss.GetBucketInfoRequest(bucket=args.bucket)

    # 發送請求並擷取響應結果
    result = client.get_bucket_info(request)

    # 列印響應結果中的各種資訊
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          f' name: {result.bucket_info.name},'
          f' access monitor: {result.bucket_info.access_monitor},'
          f' location: {result.bucket_info.location},'
          f' creation date: {result.bucket_info.creation_date},'
          f' extranet endpoint: {result.bucket_info.extranet_endpoint},'
          f' intranet endpoint: {result.bucket_info.intranet_endpoint},'
          f' acl: {result.bucket_info.acl},'
          f' data redundancy type: {result.bucket_info.data_redundancy_type},'
          f' owner id: {result.bucket_info.owner.id},'
          f' owner display name: {result.bucket_info.owner.display_name},'
          f' storage class: {result.bucket_info.storage_class},'
          f' resource group id: {result.bucket_info.resource_group_id},'
    )

if __name__ == "__main__":
    main()  # 指令碼入口，當檔案被直接運行時調用main函數

常用儲存空間資訊列表

相關文檔

• 關於儲存空間的更多資訊，請參見儲存空間（Bucket）概述。

• 關於擷取儲存空間資訊的完整範例程式碼，請參見get_bucket_info.py。