文件存储查询文件系统配额-文件系统相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： cfs.tencentcloudapi.com 。

查询文件系统配额（仅部分Turbo实例能使用，若需要调用请提交工单与我们联系）

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeUserQuota。
Version	是	String	公共参数，本接口取值：2019-07-19。
Region	是	String	公共参数，详见产品支持的地域列表。
FileSystemId	是	String	文件系统 ID 示例值：cfs-12345
Filters.N	否	Array of Filter	过滤条件。 UserType - Array of String - 是否必填：否 -（过滤条件）按配额类型过滤。(Uid\|Gid\|Dir ) UserId- Array of String - 是否必填：否 -（过滤条件）按id过滤。
Offset	否	Integer	Offset 分页码示例值：0
Limit	否	Integer	Limit 页面大小，可填范围为大于0的整数示例值：10

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	UserQuota条目总数示例值：1
UserQuotaInfo	Array of UserQuota	UserQuota条目
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询文件系统配额

输入示例

POST / HTTP/1.1
Host: cfs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUserQuota
<公共请求参数>

{
    "FileSystemId": "cfs-12345"
}

输出示例

{
    "Response": {
        "UserQuotaInfo": [
            {
                "UserType": "Uid",
                "UserId": "1000",
                "FileSystemId": "cfs-12345",
                "CapacityHardLimit": 10,
                "FileHardLimit": 10000,
                "Status": "available",
                "DirectoryPath": "/cfs/abc",
                "CapacityUsed": 1,
                "FileUsed": 1
            }
        ],
        "TotalCount": 1,
        "RequestId": "fjo8aejo-fjei-32eu-2je9-fhue83nd81"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InvalidParameterValue.QuotaUserTypeError	配额类型错误。
ResourceNotFound.FileSystemNotFound	该文件系统不存在。
UnsupportedOperation	操作不支持。

查询文件系统配额

本页目录：