DescribeFilesets - DescribeFilesets--文件存储 vePFS-火山引擎

文档中心

立即注册

导航

DescribeFilesets - DescribeFilesets

最近更新时间：2025.05.16 14:11:37首次发布时间：2022.09.19 20:54:29

调用 DescribeFilesets 接口查询 Fileset 列表。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeFilesets	要执行的操作，取值：DescribeFilesets。
Version	String	是	2022-01-01	API的版本，取值：2022-01-01。
Filters	Array of Object	否	{ "Key": "FilesetName", "Value": "fileset1" }	Fileset 查询过滤器。
OrderBy	String	否	CreateTimeDesc	Fileset 列表排序方式，取值说明如下： `CreateTimeDesc`：按照 Fileset 的创建时间降序，默认排序方式。 `CreateTimeAsc`：按照 Fileset 的创建时间升序。 `NameDesc`：按照 Fileset 的名称降序。 `NameAsc`：按 Fileset 的名称升序。
PageSize	Integer	否	10	每个分页展示的 Fileset 记录数。取值为 1～100 的整数，默认取值为 10。
PageNumber	Integer	否	1	Fileset 列表的页码，取值为不超过 Integer 数据类型的最大值，起始值为 1。
FileSystemId	String	是	vepfs-cnbjbf3c46b6****	文件系统 ID。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
TotalCount	Integer	2	Fileset 个数。
Filesets	Array of Object	详情请参见返回示例	Fileset 详细信息。
PageSize	Integer	10	每页记录数。取值为 1～100 间的整数，默认取值为 10。
PageNumber	Integer	1	Fileset 列表的页码，取值为不超过 Integer 数据类型的最大值，起始值为 1。

请求示例

POST /?Action=DescribeFilesets&Version=2022-01-01 HTTP/1.1
Host: open.volcengineapi.com
Authorization: HMAC-SHA256 Credential=AKLTOGJhY2E1NTdkZGFmNDg0Yjk0ZDFiNjE5Y2NjZjI****/20230907/cn-beijing/vepfs/request, SignedHeaders=host;x-date;x-content-sha256;content-type, Signature=7f1119a75111535b1d6e7929700f22e1474af0fb4fe26c59f5ac5cdba0cc****
Content-Type: application/json; charset=utf-8
X-Content-Sha256: 567112abe45bd6a09504fd244237f14c0ba120491da0d35097afd54d87bd****
X-Date: 20230907T124910Z
{
    "FileSystemId": "vepfs-cnbjbf3c46b6****",
    "Filters": [
        {
            "Key": "FilesetName",
            "Value": "fileset1"
        }
    ],
    "OrderBy": "CreateTimeDesc",
    "PageSize": 10,
    "PageNumber": 1
}

返回示例

{
    "ResponseMetadata": {
        "Action": "DescribeFilesets",
        "Region": "cn-beijing",
        "Service": "vepfs",
        "Version": "2022-01-01",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "TotalCount": 2,
        "Filesets": [
            {
                "Status": "Running",
                "IOPSQos": 0,
                "FileUsed": 3,
                "FileLimit": 0,
                "FilesetId": "fset-5fa4****",
                "CreateTime": "2023-08-17T14:49:37+08:00",
                "DataFlowId": "dataflow-cn*****",
                "FilesetName": "fileset1",
                "FilesetPath": "/aaa",
                "MaxInodeNum": 100000,
                "BandwidthQos": 0,
                "CapacityUsed": 156,
                "FileSystemId": "vepfs-cnbjbf3c46b6****",
                "CapacityLimit": 500,
                "FilesetAllocUsage": 10
            }
        ],
        "PageSize": 10,
        "PageNumber": 1
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。