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

文档中心

导航

DescribeFilesets

最近更新时间：2024.11.18 15:24:50首次发布时间：2022.09.19 20:54:29

调用 DescribeFilesets 接口查询 Fileset 列表。

请求参数

参数	类型	是否必选	示例值	描述
FileSystemId	String	是	vepfs-cnbjbf3c46b6****	文件系统 ID。
Filters	Array of FilesetFilter	否	{ "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。

FilesetFilter

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
Key	String	是	FilesetName	根据特性筛选指定特征的 Fileset。支持筛选的参数如下： `FilesetName`：按照 Fileset 名称筛选，模糊匹配。 `FilesetId`：按照 Fileset ID 精确筛选。 `FilesetPath`：按照文件系统中的路径筛选，模糊匹配。 `Status`：按照 Fileset 状态筛选。
Value	String	是	filset1	筛选项目的值。

Key

String

是

FilesetName

根据特性筛选指定特征的 Fileset。支持筛选的参数如下：

FilesetName：按照 Fileset 名称筛选，模糊匹配。
FilesetId：按照 Fileset ID 精确筛选。
FilesetPath：按照文件系统中的路径筛选，模糊匹配。
Status：按照 Fileset 状态筛选。

Value String 是 filset1 筛选项目的值。

返回参数

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

Fileset

参数	类型	示例值	描述
Status	String	Running	Fileset 状态，取值说明如下： `Creating`：创建中 `CreateError`：创建失败 `Running`：运行中 `Updating`：更新中 `UpdateError`：更新失败 `Deleting`：删除中 `DeleteError`：删除失败 `Deleted`：已删除 `Error`：错误
IOPSQos	Integer	0	IOPS Qos。
FileUsed	Long	3	已用文件数量。
FileLimit	Long	0	文件或目录数量配额。返回 `0` 表示未设置文件或目录数量配额。
FilesetId	String	fset-5fa4****	Fileset ID。
CreateTime	String	2023-08-17T14:49:37+08:00	Fileset 创建时间。
FilesetName	String	fileset1	Fileset 名称。
FilesetPath	String	/aaa	Fileset 绝对路径。
MaxInodeNum	Long	100000	Fileset Inode 数量上限。
BandwidthQos	Integer	0	带宽 Qos。
CapacityUsed	Integer	156	已用容量，单位为 GiB。
FileSystemId	String	vepfs-cnbjbf3c46b6****	文件系统 ID。
CapacityLimit	Integer	500	容量配额上限，单位为 GiB。

示例

请求示例

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
    }
}