DescribeFileSystems - 列举文件系统--文件存储 NAS-火山引擎

文档中心

立即注册

导航

DescribeFileSystems - 列举文件系统

最近更新时间：2025.04.27 17:14:16首次发布时间：2023.07.10 11:11:52

列举文件系统实例

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeFileSystems	要执行的操作，取值：DescribeFileSystems。
Version	String	是	2022-01-01	API的版本，取值：2022-01-01。
PageSize	Integer	否	10	查询结果分页展示时，此参数用于表示每页的数据量。取值范围为 1~100。
PageNumber	Integer	否	1	查询结果分页展示时，此参数用于表示页码。支持的最小值为 1。
FileSystemIds	String	否	enas-cnbj1234****	需要列举的文件系统 ID，支持多选，用英文逗号（,）分隔。
TagFilters	Array of Object	否	详情请参见示例值	筛选符合标签条件的文件系统信息。
Filters	Array of Object	否	详情请参见示例值	筛选符合条件的文件系统信息。
SortByType	String	是	CreateTime	排序类型。
SortOrderType	String	是	Desc	排序依据
FileSystemType	String	否	Extreme	文件系统类型。取值说明如下： `Extreme`：NAS 极速型。 `Capacity`：NAS 容量型。 `Cache`：NAS 缓存型。
ProjectName	String	否	default	项目名称。

返回参数

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

参数	类型	示例值	描述
TotalCount	Integer	1	文件系统总个数。
PageSize	Integer	10	查询结果分页展示时，表示每页的数据量。
PageNumber	Integer	1	查询结果分页展示时，表示页码。
FileSystems	Array of Object	详情请参见返回示例	文件系统信息。

请求示例

POST /?Action=DescribeFileSystems&Version=2022-01-01 HTTP/1.1
Host: filenas.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241126T034511Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241126/cn-beijing/FileNAS/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241126114514039063146054F58344",
    "Action": "DescribeFileSystems",
    "Version": "2022-01-01",
    "Service": "FileNAS",
    "Region": "cn-beijing"
  },
  "Result": {
    "TotalCount": 1,
    "PageSize": 10,
    "PageNumber": 1,
    "FileSystems": [
      {
        "Description": "test",
        "ZoneName": "cn-beijing-a \n",
        "SnapshotCount": 1,
        "StorageType": "Standard",
        "Version": "1.1.7.0",
        "Tags": [
          {
            "Key": "tagkey",
            "Value": "tagvalue",
            "Type": "Custom"
          }
        ],
        "FileSystemId": "enas-cnbjd2b4f43b****",
        "FileSystemName": "lytest",
        "Status": "Running",
        "ProtocolType": "NFS",
        "ChargeType": "PayAsYouGo",
        "ProjectName": "dafault",
        "RegionId": "cn-beijing",
        "ZoneId": "cn-beijing-a",
        "CreateTime": "2022-08-14T13:15:39+08:00",
        "UpdateTime": "2023-04-21T15:26:14+08:00",
        "Capacity": {
          "Total": 150,
          "Used": 135
        },
        "FileSystemType": "Extreme",
        "CachePerformance": {
          "BaseBandwidth": 1000,
          "CacheBandwidth": 700,
          "DataFlowBandwidth": 300
        }
      }
    ]
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
500	InternalError	An internal error has occurred.	内部错误。