文档首页/ 高性能弹性文件服务 SFS Turbo/ API参考/ API/ 目录管理/ 查询目录资源使用情况 - ShowFsDirUsage
更新时间：2026-09-30 GMT+08:00
查看PDF
分享

查询目录资源使用情况 - ShowFsDirUsage

功能介绍

查询目录资源使用情况（包括子目录的资源）。后端有5min的缓存时间，查询的数据可能有延迟。

接口约束

在2023年8月1号之后创建的文件系统支持该API操作。该接口仅适用于标准型、标准型-增强版、性能型、性能型-增强版、20MB/s/TiB、40MB/s/TiB、125MB/s/TiB、250MB/s/TiB、500MB/s/TiB、1000MB/s/TiB、HPC缓存型的SFS Turbo文件系统，请使用“创建文件系统异步任务”接口。该接口并发请求数过大可能会影响文件系统性能，建议同时提交的查询请求不要超过 4 个。查询超大目录耗时较久，请不要重复提交。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/dir-usage

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，用于标识资源所属的IAM项目空间，实现项目级资源隔离与权限管控。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

share_id

是

String

参数解释：

文件系统ID，用于唯一标识SFS Turbo文件系统实例。

获取方法请参见查询文件系统列表接口。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

path

是

String

参数解释：

需要查询资源使用情况的目录全路径。

约束限制：

  • 必须以斜杠“/”开头，表示绝对路径。

  • 不能包含“/./”或“/../”等特殊路径符号。

  • 单层目录名称长度不能超过255个字符。

  • 全路径总长度不能超过4096个字符。

  • 路径必须指向一个已存在的目录，如果路径不存在则返回404错误，如果路径不是目录则返回400错误。

取值范围：

文件系统内的合法目录全路径字符串，例如“/data/test”。

默认取值：

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token，用于鉴权认证。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

Content-Type

是

String

参数解释：

请求消息体MIME类型，用于标识请求正文的数据格式。

约束限制：

不涉及。

取值范围：

application/json

默认取值：

application/json

响应参数

状态码：200

表4 响应Header参数

参数

参数类型

描述

X-request-id

String

参数解释：

请求ID，用于唯一标识和追踪本次请求。

取值范围：

不涉及。
表5 响应Body参数

参数

参数类型

描述

dir_usage

FsDirUasge object

参数解释：

目录资源使用详情，包含目录（含子目录）的已使用容量信息。

取值范围：

不涉及。
表6 FsDirUasge

参数

参数类型

描述

used_capacity

Long

参数解释：

目录已使用的容量大小，单位为字节（Byte），包含子目录的容量。

取值范围：

大于或等于0的整数。

状态码：400

表7 响应Header参数

参数

参数类型

描述

X-request-id

String

参数解释：

请求ID，用于唯一标识和追踪本次请求。

取值范围：

不涉及。
表8 响应Body参数

参数

参数类型

描述

errCode

String

参数解释：

错误码，用于标识请求失败的原因。详细错误码请参见错误码。

取值范围：

不涉及。

errMsg

String

参数解释：

错误描述，用于描述请求失败的具体原因，便于排查问题。请参见错误码。

取值范围：

不涉及。

状态码：500

表9 响应Header参数

参数

参数类型

描述

X-request-id

String

参数解释：

请求ID，用于唯一标识和追踪本次请求。

取值范围：

不涉及。
表10 响应Body参数

参数

参数类型

描述

errCode

String

参数解释：

错误码，用于标识请求失败的原因。详细错误码请参见错误码。

取值范围：

不涉及。

errMsg

String

参数解释：

错误描述，用于描述请求失败的具体原因，便于排查问题。请参见错误码。

取值范围：

不涉及。

请求示例

标准型文件系统ID为"77ba6f4b-6365-4895-8dda-bc7142af4dde"，查询资源使用情况

GET HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares/77ba6f4b-6365-4895-8dda-bc7142af4dde/fs/dir-usage?path=/date/test

响应示例

状态码：200

{
  "dir_usage" : {
    "used_capacity" : 1024000
  }
}

状态码：400

{
  "errCode" : "SFS.TURBO.0102",
  "errMsg" : "Path is not directory"
}

状态码：500

{
  "errCode" : "SFS.TURBO.0005",
  "errMsg" : "Internal server error"
}

状态码

状态码

描述

200

目录资源使用情况

400

错误响应

500

错误响应

错误码

请参见错误码。

父主题： 目录管理

相关文档