rclone about 命令指南用一行命令获取云端存储配额与用量【免费下载链接】rclonersync for cloud storage - Google Drive, S3, Dropbox, Backblaze B2, One Drive, Swift, Hubic, Wasabi, Google Cloud Storage, Azure Blob, Azure Files, Yandex Files项目地址: https://gitcode.com/GitHub_Trending/rc/rclonerclone about是 rclone 中用于查询远端remote配额信息的标准命令它会向存储服务请求容量数据并在终端输出总容量、已用、剩余、回收站与其他占用等信息。本文基于 rclone 仓库中该命令的官方命令文档 docs/content/commands/rclone_about.md并结合命令实现 cmd/about/about.go、可选接口定义 fs/features.go 与返回结构体 fs/types.go 等源码完整讲解该命令的用法、输出字段含义、--full与--json标志、底层实现原理与各后端的支持差异帮助你用它做容量监控与脚本化配额检查。命令概述rclone about 能做什么rclone about的命令作用是从远端获取配额信息quota information。执行后它会将该远端的总容量与用量数据打印到标准输出典型输出包含 used、free、quota配额和 trash回收站等容量内容。该命令的实现位于 cmd/about/about.go其命令定义为rclone about remote: [flags]其中remote:是一个已通过rclone config配置好的远端如gdrive:、onedrive:命令只接受一个参数源码中通过cmd.CheckArgs(1, 1, command, args)强制校验必须且只能传入一个远端参数cmd/about/about.go。从版本信息看该命令自v1.41起引入命令的 Annotations 中声明versionIntroduced: v1.41见 cmd/about/about.go。需要说明的是该命令的官方命令文档是由cmd/about/下的源码自动生成的——文档头部标注了# autogenerated - DO NOT EDIT, instead edit the source code in cmd/about/因此cmd/about/about.go中的Long描述文本才是本命令用法的权威出处。基本用法与典型输出在配置好远端后直接执行rclone about remote:一个典型的输出示例为Total: 17 GiB Used: 7.444 GiB Free: 1.315 GiB Trashed: 100.000 MiB Other: 8.241 GiB输出中的每一行对应一项容量数据各字段含义如下Total可用总容量Total size available。Used已使用容量Total size used。Free该用户可用的剩余空间Total space available to this user。Trashed回收站占用的空间Total space used by trash。Other其他存储占用的空间Total amount in other storage例如 Google Drive 中由 Gmail、Google Photos 占用的空间。Objects存储系统中的对象总数Total number of objects in the storage。注意两点关键约定原文档与源码一致所有尺寸均以字节bytes为基本单位只是默认展示时会被格式化为人类可读单位默认的“人类可读”单位遵循 Go 的二进制单位规范例如GiB1 GiB 1024³ 字节源码中使用fs.SizeSuffix(*uv).ByteUnit()完成格式化见 cmd/about/about.go。输出字段并非总是齐全原文档明确强调并不是所有后端都会打印全部字段。规则如下某个字段未被后端提供时该行不会被输出当某个值被视为“无限”unlimited时该字段同样会被省略。这一行为在源码层面得到精确印证返回结构体中的每一项都是指针类型指针为nil即表示该后端不支持此项数据详见下文“Usage 结构体”一节而 cmd/about/about.go 中的printValue函数在值为nil时直接return不会打印该行。此外部分后端完全不支持rclone about命令。完整的支持情况可在仓库的 overview功能总览类文档中查看 optional features可选特性列表。命令行层面对此的处理是若后端未实现该能力会直接报错并提示例如xxx doesnt support about错误信息来自 cmd/about/about.go。用 --full 输出完整字节数默认输出将字节数格式化为人类可读单位如17 GiB。如果希望拿到精确到字节的原始数字例如用于程序内部计算或核对存储账单可追加--full标志rclone about remote: --full输出示例Total: 18253611008 Used: 7993453766 Free: 1411001220 Trashed: 104857602 Other: 8849156022从源码看--full标志在命令注册时通过flags.BoolVarP(cmdFlags, fullOutput, full, , false, Full numbers instead of human-readable, )绑定cmd/about/about.go。格式化逻辑位于printValuecmd/about/about.go当fullOutput为真时使用fmt.Sprintf(%d, *uv)直接输出整数否则对容量字段调用fs.SizeSuffix(...).ByteUnit()。用 --json 输出机器可读结果对于脚本化集成、定时任务与监控系统而言文本格式并不友好此时可以使用--json标志生成易于程序解析的 JSON 输出rclone about remote: --json输出示例{ total: 18253611008, used: 7993453766, trashed: 104857602, other: 8849156022, free: 1411001220 }注意 JSON 中出现的字段与文本模式一一对应total/used/free/trashed/other并且当某个字段缺失后端不支持或无限时对应键会因omitempty而被省略。JSON 模式下的键顺序与文本输出顺序不同JSON 编码顺序遵循结构体字段定义顺序。从源码看JSON 输出使用json.NewEncoder(os.Stdout)并设置了缩进\tcmd/about/about.go保证输出美观且可直接重定向到文件或管道交给jq等工具处理。另外可以组合使用--json与--full此时 JSON 中呈现的同样是与全字节等价的整数值字节本身就是整数无格式差异。支持的标志一览以下是rclone about命令自身的标志来自 docs/content/commands/rclone_about.md 与原文档 Options 一节--full Full numbers instead of human-readable -h, --help help for about --json Format output as JSON其中-h, --help是 Cobra 命令框架自动提供的帮助标志--full与--json均为布尔开关不接收参数值。除以上三个命令级标志外该命令同样接受 rclone 的全局标志如--config、--log-level、--rc等在仓库的全局 flags 相关文档中有完整罗列。源码级原理Abouter 接口与可选特性机制rclone about之所以“有的后端支持、有的后端不支持”其根源在于 rclone 的可选特性optional features机制存储后端Fs并非必须实现查询配额的能力只有实现了对应接口的后端才会暴露该功能。Abouter 接口定义接口定义位于 fs/features.go// Abouter is an optional interface for Fs type Abouter interface { // About gets quota information from the Fs About(ctx context.Context) (*Usage, error) }任何一个后端若实现了About(ctx) (*Usage, error)方法就表明它支持配额查询。在 rclone 构造 Fs 的功能特性表Features时会通过类型断言自动探测后端是否实现了该接口fs/features.goif do, ok : f.(Abouter); ok { ft.About do.About }命令侧的执行链路rclone about的执行流程见 cmd/about/about.go可以概括为校验参数数量必须恰好 1 个 remote通过cmd.NewFsSrc(args)解析并打开远端文件系统取出f.Features().About函数指针若指针为nil说明该后端不支持直接返回类似xxx doesnt support about的错误否则调用About(context.Background())获取*Usage若返回的Usage为nil返回nil usage returned错误最后根据是否指定--json选择 JSON 编码输出或逐行打印文本。Usage 结构体与 omitempty查询结果统一封装在fs.Usage结构体中定义见 fs/types.go// Usage is returned by the About call // // If a value is nil then it isnt supported by that backend type Usage struct { Total *int64 json:total,omitempty // quota of bytes that can be used Used *int64 json:used,omitempty // bytes in use Trashed *int64 json:trashed,omitempty // bytes in trash Other *int64 json:other,omitempty // other usage e.g. gmail in drive Free *int64 json:free,omitempty // bytes which can be uploaded before reaching the quota Objects *int64 json:objects,omitempty // objects in the storage system }这段代码直接解释了前面提到的两条输出规则注释明确指出“如果某个值为 nil说明该后端不支持该字段”而每个字段的 JSON 标签都带有omitempty所以 JSON 模式下缺失字段的键会被自动省略文本模式下则表现为不打印对应行。字段的格式化差异大小与计数值得留意的是Total、Used、Free、Trashed、Other属于“容量大小”而Objects属于“对象计数”。printValue的第三个参数isSize精确区分了这两种语义cmd/about/about.go容量字段使用fs.SizeSuffix(...).ByteUnit()格式化为GiB、MiB等单位计数类型的Objects字段则使用fs.CountSuffix(*uv).String()不按二进制单位换算字节而是输出对象个数。后端支持情况与代表性实现在 rclone 数十个存储后端中有相当一部分实现了About涵盖主流云盘、对象存储与协议型后端例如仅列举源码中已确认存在的实现Google Drivebackend/drive/drive.go、Dropboxbackend/dropbox/dropbox.go、Boxbackend/box/box.go、OneDrivebackend/onedrive/onedrive.go、SFTPbackend/sftp/sftp.go、WebDAVbackend/webdav/webdav.go、Jottacloud、Yandex、Filen、Mega、Seafile、pCloud、Put.io 等。每类存储服务能够提供的配额字段取决于其自身 API 的能力因此不同后端输出的字段组合不尽相同——例如只有部分网盘类服务才报告回收站容量或“其他”用量。local 后端磁盘空间查询对于本地文件系统后端local配额查询借助操作系统提供的文件系统统计接口完成。在 Unix/Linux 上对应 backend/local/about_unix.gofunc (f *Fs) About(ctx context.Context) (*fs.Usage, error) { var s syscall.Statfs_t err : syscall.Statfs(f.root, s) ... usage : fs.Usage{ Total: fs.NewUsageValue(bs * int64(s.Blocks)), // quota of bytes that can be used Used: fs.NewUsageValue(bs * int64(s.Blocks-s.Bfree)), // bytes in use Free: fs.NewUsageValue(bs * int64(s.Bavail)), // bytes which can be uploaded before reaching the quota } return usage, nil }可见它通过statfs读取磁盘块总数、空闲块数与可用块数换算成字节后填入Total、Used、Free三个字段不同平台有对应的平台实现文件如 Windows 平台实现见 backend/local/about_windows.go。这也解释了为何对本地目录执行rclone about只会输出这三项——本地磁盘没有“回收站”与“其他”这类云存储概念。另外当目标目录不存在时该实现会返回fs.ErrorDirNotFound。封装类后端透传式实现从源码结构看crypt、compress、union、combine、hasher、chunker等封装/虚拟类后端也都实现了About方法。可以推断这类后端通常并不自行维护配额而是将请求转发给其底层真实后端把底层查询结果原样返回从而让用户对同一逻辑目录下的多种底层存储统一执行配额检查。常见使用场景rclone about的输出简洁、稳定非常适合以下场景容量告警与监控定时执行rclone about remote: --json用jq或脚本解析free/total在剩余空间低于阈值时触发告警多网盘容量一览将多个remote逐个传入快速对比不同账号的配额与用量配额审计通过trashed字段掌握回收站占用情况判断是否需要清理或调整回收站策略对接脚本与自动化任务在上传大批数据前先用--full拿到精确剩余字节数决定是否执行迁移。小结rclone about是一个轻量却非常实用的“遥感测配额”命令文本输出适合人眼阅读--full适合精确字节计算--json适合程序消费它通过 rclone 的可选特性机制Abouter接口 运行时类型断言实现了对几十种不同存储后端的统一查询。理解其底层Usage结构体“nil 即不支持、unlimited 即省略”的设计就能准确解读任意后端上该命令的输出差异。若需查看 rclone 其他命令的文档可继续查阅仓库 docs/content/commands 目录下的命令文档集合。【免费下载链接】rclonersync for cloud storage - Google Drive, S3, Dropbox, Backblaze B2, One Drive, Swift, Hubic, Wasabi, Google Cloud Storage, Azure Blob, Azure Files, Yandex Files项目地址: https://gitcode.com/GitHub_Trending/rc/rclone创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考