Python获取存储空间的存储容量

本文介绍如何获取指定存储空间(Bucket)的存储容量以及Bucket内不同存储类型文件(Object)的数量及其存储容量。

注意事项

  • 本文以华东1(杭州)外网Endpoint为例。如果您希望通过与OSS同地域的其他阿里云产品访问OSS,请使用内网Endpoint。关于OSS支持的Region与Endpoint的对应关系,请参见OSS地域和访问域名

  • 本文以从环境变量读取访问凭证为例。如何配置访问凭证,请参见配置访问凭证

  • 本文以OSS域名新建OSSClient为例。如果您希望通过自定义域名、STS等方式新建OSSClient,请参见初始化

  • 要获取存储空间的存储容量,您必须有oss:GetBucketStat权限。具体操作,请参见为RAM用户授权自定义的权限策略

示例代码

以下代码用于获取examplebucket的存储容量以及该Bucket内不同存储类型Object的数量及其存储容量。

重要

仅Python SDK 2.16.0及以上版本支持返回以下示例代码中包含的所有属性。

# -*- coding: utf-8 -*-
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider

# 从环境变量中获取访问凭证。运行本代码示例之前,请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
auth = oss2.ProviderAuthV4(EnvironmentVariableCredentialsProvider())

# 填写Bucket所在地域对应的Endpoint。以华东1(杭州)为例,Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com。
endpoint = "https://oss-cn-hangzhou.aliyuncs.com"

# 填写Endpoint对应的Region信息,例如cn-hangzhou。注意,v4签名下,必须填写该参数
region = "cn-hangzhou"

# yourBucketName填写存储空间名称。
bucket = oss2.Bucket(auth, endpoint, "yourBucketName", region=region)

# 获取存储空间的统计信息。
result = bucket.get_bucket_stat()
# 获取Bucket的总存储量,单位为字节。
print(result.storage_size_in_bytes)
# 获取Bucket中总的Object数量。
print(result.object_count)
# 获取Bucket中已经初始化但还未完成(Complete)或者还未中止(Abort)的Multipart Upload数量。
print(result.multi_part_upload_count)
# 获取Bucket中Live Channel的数量。
print(result.live_channel_count)
# 此次调用获取到的存储信息的时间点,格式为时间戳,单位为秒。
print(result.last_modified_time)
# 获取标准存储类型Object的存储量,单位为字节。
print(result.standard_storage)
# 获取标准存储类型的Object数量。
print(result.standard_object_count)
# 获取低频存储类型Object的计费存储量,单位为字节。
print(result.infrequent_access_storage)
# 获取低频存储类型Object的实际存储量,单位为字节。
print(result.infrequent_access_real_storage)
# 获取低频存储类型的object数量。
print(result.infrequent_access_object_count)
# 获取归档存储类型Object的计费存储量,单位为字节。
print(result.archive_storage)
# 获取归档存储类型Object的实际存储量,单位为字节。
print(result.archive_real_storage)
# 获取归档存储类型的Object数量。
print(result.archive_object_count)
# 获取冷归档存储类型Object的计费存储量,单位为字节。
print(result.cold_archive_storage)
# 获取冷归档存储类型Object的实际存储量,单位为字节。
print(result.cold_archive_real_storage)
# 获取冷归档存储类型的Object数量。
print(result.cold_archive_object_count)

相关文档

关于获取指定Bucket的存储容量以及该Bucket内不同存储类型Object的数量及其存储容量的API接口说明,请参见GetBucketStat