You need to enable JavaScript to run this app.
导航
文件存储 vePFS
  • 文档首页
    • /
  • 文件存储 vePFS

DescribeFilesets

最近更新时间：2023.10.19 15:51:39

首次发布时间：2022.09.19 20:54:29

我的收藏

调用 DescribeFilesets 接口查询 Fileset 列表。

请求参数

参数类型是否必选示例值描述
FileSystemIdString是vepfs-cnbjbf3c46b6****文件系统 ID。

Filters

Array of FilesetFilter

否

{
    "Key": "FilesetName",
    "Value": "fileset1"
  }

Fileset 查询过滤器。

OrderBy

String

否

CreateTimeDesc

Fileset 列表排序方式，取值说明如下：

  • CreateTimeDesc：按时间降序，默认排序方式。
  • CreateTimeAsc：按时间升序。
  • NameDesc：按 Fileset 系统命名降序。
  • NameAsc：按 Fileset 系统命名升序。
PageSizeInteger否10每个分页包含的 Fileset 个数。
PageNumberInteger否1Fileset 列表的分页页码。

FilesetFilter

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

Key

String

是

FilesetName

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

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

返回参数

参数类型示例值描述
TotalCountInteger2Fileset 个数。
FilesetsArray of Fileset详情请参见返回示例Fileset 详细信息。
PageSizeInteger10每个分页包含的 Fileset 个数。
PageNumberInteger1Fileset 列表的分页页码。

Fileset

参数类型示例值描述

Status

String

Running

Fileset 状态，取值说明如下：

  • Creating：创建中
  • CreateError：创建失败
  • Running：运行中
  • Updating：更新中
  • UpdateError：更新失败
  • Deleting：删除中
  • DeleteError：删除失败
  • Deleted：已删除
  • Error：错误
IOPSQosInteger0IOPS Qos。
FileUsedLong3已用文件数量。
InodeNumLong10000000预分配的 Inode 数量上限。
FileLimitLong0文件数限制。
FilesetIdStringfset-5fa4****Fileset ID。
CreateTimeString2023-08-17T14:49:37+08:00Fileset 创建时间。
FilesetNameStringfileset1Fileset 名称。
FilesetPathString/aaaFileset 绝对路径。
BandwidthQosInteger0带宽 Qos。
CapacityUsedInteger156已用容量，单位为 GiB。
FileSystemIdStringvepfs-cnbjbf3c46b6****文件系统 ID。
CapacityLimitInteger500容量上限，单位为 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****",
  "PageSize": 10,
  "Filters": [
      {
        "Key": "FilesetName", 
        "Value": "fileset1"
    }
  ],
  "PageNumber": 1,
  "OrderBy": "CreateTimeDesc"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20231017194428E2BC5FF28BA2282AFC6A",
    "Action": "DescribeFilesets",
    "Version": "2022-01-01",
    "Service": "vepfs",
    "Region": "cn-beijing"
  },
  "Result": {
    "Filesets": [
      {
        "BandwidthQos": 0,
        "CapacityLimit": 0,
        "CapacityUsed": 0,
        "CreateTime": "2023-08-30T23:47:59+08:00",
        "FileLimit": 0,
        "FileSystemId": "vepfs-cnbjbf3c46b6****",
        "FileUsed": 1,
        "FilesetId": "fset-fafd****",
        "FilesetName": "b",
        "FilesetPath": "/b",
        "IOPSQos": 0,
        "MaxInodeNum": 10000000,
        "Status": "Running"
      },
      {
        "BandwidthQos": 0,
        "CapacityLimit": 500,
        "CapacityUsed": 156,
        "CreateTime": "2023-08-17T14:49:37+08:00",
        "FileLimit": 0,
        "FileSystemId": "vepfs-cnbjbf3c46b6****",
        "FileUsed": 3,
        "FilesetId": "fset-5fa4****",
        "FilesetName": "fileset1",
        "FilesetPath": "/aaa",
        "IOPSQos": 0,
        "MaxInodeNum": 10000000,
        "Status": "Running"
      }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 2
  }
}