查询目标文件夹配额 - ShowFsDirQuota
功能介绍
查询目标文件夹配额。查询的used_capacity、used_inode数据可能有延迟。
接口约束
该接口不适用于100MB/s/TiB-智算型、200MB/s/TiB-智算型文件系统。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/dir-quota
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,用于标识资源所属的IAM项目空间,实现项目级资源隔离与权限管控。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| share_id | 是 | String | 参数解释: 文件系统ID,用于唯一标识SFS Turbo文件系统实例。 获取方法请参见查询文件系统列表接口。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于鉴权认证。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| Content-Type | 是 | String | 参数解释: 请求消息体MIME类型,用于标识请求正文的数据格式。 约束限制: 不涉及。 取值范围: application/json 默认取值: application/json |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| path | String | 参数解释: 已设置配额的目录全路径。 取值范围: 文件系统内已设置配额的合法目录全路径字符串,例如“/data/test”。 |
| capacity | Integer | 参数解释: 目录的容量配额大小,单位为MB。 取值范围: 正整数。 |
| inode | Integer | 参数解释: 目录的inode数量配额限制。 取值范围: 正整数。 |
| used_capacity | Integer | 参数解释: 目录已使用的容量大小,单位为MB。仅SFS Turbo 20MB/s/TiB、40MB/s/TiB、125MB/s/TiB、250MB/s/TiB、500MB/s/TiB、1000MB/s/TiB文件系统返回该字段。数据可能有延迟。 取值范围: 非负整数,单位为MB。 |
| used_inode | Integer | 参数解释: 目录已使用的inode数量。仅SFS Turbo 20MB/s/TiB、40MB/s/TiB、125MB/s/TiB、250MB/s/TiB、500MB/s/TiB、1000MB/s/TiB文件系统返回该字段。数据可能有延迟。 取值范围: 非负整数。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| errCode | String | 参数解释: 错误码,用于标识请求失败的原因。详细错误码请参见错误码。 取值范围: 不涉及。 |
| errMsg | String | 参数解释: 错误描述,用于描述请求失败的具体原因,便于排查问题。请参见错误码。 取值范围: 不涉及。 |
状态码:500
请求示例
文件系统ID为"77ba6f4b-6365-4895-8dda-bc7142af4dd0",目录的全路径是“/data/test”,查询该目录的quota值
GET HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares/77ba6f4b-6365-4895-8dda-bc7142af4dd0/fs/dir-quota?path=/data/test 响应示例
状态码:200
{
"path" : "/data/test",
"capacity" : 1024,
"inode" : 100000
} 状态码:400
{
"errCode" : "SFS.TURBO.0102",
"errMsg" : "Path is not directory"
} 状态码:500
{
"errCode" : "SFS.TURBO.0005",
"errMsg" : "Internal server error"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询目录的配额信息成功 |
| 400 | 错误响应 |
| 500 | 错误响应 |
错误码
请参见错误码。