本文介绍如何获取指定存储空间(Bucket)的存储容量以及Bucket内不同存储类型文件(Object)的数量及其存储容量。
注意事项
本文示例代码以华东1(杭州)的地域ID
cn-hangzhou
为例,默认使用外网Endpoint,如果您希望通过与OSS同地域的其他阿里云产品访问OSS,请使用内网Endpoint。关于OSS支持的Region与Endpoint的对应关系,请参见OSS地域和访问域名。
方法定义
get_bucket_stat(request: GetBucketStatRequest, **kwargs) → GetBucketStatResult
请求参数列表
参数名 | 类型 | 说明 |
参数名 | 类型 | 说明 |
request | GetBucketStatRequest | 设置请求参数,具体请参见GetBucketStatRequest |
返回值列表
类型 | 说明 |
类型 | 说明 |
GetBucketStatResult | 返回值,具体请参见GetBucketStatResult |
关于获取存储空间存储容量的完整方法定义,请参见get_bucket_stat。
示例代码
您可以使用以下代码获取存储空间的存储容量信息。
import argparse
import alibabacloud_oss_v2 as oss
# 创建命令行参数解析器,描述此脚本用于获取指定Bucket的统计信息。
parser = argparse.ArgumentParser(description="Get statistical 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 statistics 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.GetBucketStatRequest(bucket=args.bucket)
# 发送请求并获取响应结果
result = client.get_bucket_stat(request)
# 打印响应结果中的各种统计信息
print(f'status code: {result.status_code},'
f' request id: {result.request_id},'
f' storage: {result.storage},'
f' object count: {result.object_count},'
f' multi part upload count: {result.multi_part_upload_count},'
f' live channel count: {result.live_channel_count},'
f' last modified time: {result.last_modified_time},'
f' standard storage: {result.standard_storage},'
f' standard object count: {result.standard_object_count},'
f' infrequent access storage: {result.infrequent_access_storage},'
f' infrequent access real storage: {result.infrequent_access_real_storage},'
f' infrequent access object count: {result.infrequent_access_object_count},'
f' archive storage: {result.archive_storage},'
f' archive real storage: {result.archive_real_storage},'
f' archive object count: {result.archive_object_count},'
f' cold archive storage: {result.cold_archive_storage},'
f' cold archive real storage: {result.cold_archive_real_storage},'
f' cold archive object count: {result.cold_archive_object_count},'
f' deep cold archive storage: {result.deep_cold_archive_storage},'
f' deep cold archive real storage: {result.deep_cold_archive_real_storage},'
f' deep cold archive object count: {result.deep_cold_archive_object_count},'
f' delete marker count: {result.delete_marker_count},'
)
if __name__ == "__main__":
main() # 脚本入口,当文件被直接运行时调用main函数
常用存储容量信息列表
参数 | 描述 |
参数 | 描述 |
Storage | 存储空间总存储量,单位为字节 |
ObjectCount | 存储空间中总的Object数量 |
MultipartUploadCount | 存储空间中已经初始化但还未完成或者还未中止的分片上传数量 |
LiveChannelCount | 存储空间中Live Channel的数量 |
LastModifiedTime | 此次调用获取到的存储信息的时间点,格式为时间戳,单位为秒 |
StandardStorage | 标准存储类型Object的存储量,单位为字节 |
StandardObjectCount | 标准存储类型Object数量 |
InfrequentAccessStorage | 低频存储类型Object的计费存储量,单位为字节 |
InfrequentAccessRealStorage | 低频存储类型Object的实际存储量,单位为字节 |
InfrequentAccessObjectCount | 低频存储类型Object数量 |
ArchiveStorage | 归档存储类型Object的计费存储量,单位为字节 |
ArchiveRealStorage | 归档存储类型Object的实际存储量,单位为字节 |
ArchiveObjectCount | 归档存储类型Object数量 |
ColdArchiveStorage | 冷归档存储类型Object的计费存储量,单位为字节 |
ColdArchiveRealStorage | 冷归档存储类型Object的实际存储量,单位为字节 |
ColdArchiveObjectCount | 冷归档存储类型Object数量 |
相关文档
关于获取存储空间信息的完整示例代码,请参见get_bucket_stat.py。
- 本页导读 (1)
- 注意事项
- 方法定义
- 示例代码
- 常用存储容量信息列表
- 相关文档