更新时间:2024-11-12 GMT+08:00
分享

查询目录资源使用情况

功能介绍

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

接口约束

在2023年8月1号之后创建的文件系统支持该API操作。该接口仅适用于SFS Turbo上一代文件系统规格类型(标准型、标准型-增强版、性能型、性能型-增强版)。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代码示例调试功能。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目id

share_id

String

文件系统id

表2 Query参数

参数

是否必选

参数类型

描述

path

String

文件系统内合法的目录全路径

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

账号的token

Content-Type

String

MIME类型, application/json

响应参数

状态码: 200

表4 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID

表5 响应Body参数

参数

参数类型

描述

dir_usage

FsDirUasge object

消息描述

表6 FsDirUasge

参数

参数类型

描述

used_capacity

Long

占用容量,单位:byte

状态码: 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

响应示例

状态码: 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

错误响应

错误码

请参见错误码

相关文档