DescribeFileSystems--文件存储 NAS-火山引擎

文档中心

导航

DescribeFileSystems

最近更新时间：2024.06.20 19:04:18首次发布时间：2023.07.10 11:11:52

调用 DescribeFileSystems 接口列举文件系统。

请求参数

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

FileSystemFilter

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

参数	类型	是否必选	示例值	描述
Key	String	是	Status	根据特性筛选指定特征的实例。支持筛选的参数如下： `Status`：根据文件系统状态精确筛选，支持多选，使用英文逗号（,）分割。 `FileSystemName`：根据文件系统名称模糊筛选，不支持多选。 `ZoneId`：根据可用区 ID 精确筛选，不支持多选。 `ProtocolType`：根据文件系统协议精确筛选，不支持多选。 `StorageType`：根据存储规格精确筛选，不支持多选。 `ChargeType`：根据计费类型精确筛选，不支持多选。 `PermissionGroupId`：根据权限组 ID 精确筛选，不支持多选。 `MountPointId`：根据挂载点 ID 精确筛选，不支持多选。
Value	String	是	Running	筛选项目的值。

Key

String

是

Status

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

Status：根据文件系统状态精确筛选，支持多选，使用英文逗号（,）分割。
FileSystemName：根据文件系统名称模糊筛选，不支持多选。
ZoneId：根据可用区 ID 精确筛选，不支持多选。
ProtocolType：根据文件系统协议精确筛选，不支持多选。
StorageType：根据存储规格精确筛选，不支持多选。
ChargeType：根据计费类型精确筛选，不支持多选。
PermissionGroupId：根据权限组 ID 精确筛选，不支持多选。
MountPointId：根据挂载点 ID 精确筛选，不支持多选。

Value String 是 Running 筛选项目的值。

TagFilter

参数	类型	是否必选	示例值	描述
Key	String	是	tagkey	标签键。
Value	String	否	tagvalue	标签值。

返回参数

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

FileSystem

参数	类型	示例值	描述
Tags	Array of Tag	详情请参见返回示例	文件系统的标签信息。
Status	String	Running	文件系统状态。取值说明如下： `Unknown`：状态未知。 `Running`：文件系统运行中。 `Creating`：文件系统创建中。 `Expanding`：文件系统升级中。 `Error`：文件系统错误。 `Deleting`：文件系统删除中。 `DeleteError`：文件系统删除失败。 `Deleted`：文件系统已删除。 `Stopped`：文件系统已停服。
ZoneId	String	cn-beijing-a	可用区 ID。
Version	String	1.1.7.0	版本号。
Capacity	Object of Capacity	{ "Total": 102400, "Used": 135 }	容量信息。
RegionId	String	cn-beijing	地域 ID。
ZoneName	String	华北2（北京）-可用区A	可用区名称。
ChargeType	String	PayAsYouGo	计费状态，取值说明如下： `PayAsYouGo`：按量计费。
CreateTime	String	2022-08-14T13:15:39+08:00	文件系统创建时间。
InodeLimit	Long	undefined	idl-lint-ignoreinode使用上限
UpdateTime	String	2023-04-21T15:26:14+08:00	文件系统更新时间。
Description	String	test	文件系统描述信息。
ProjectName	String	default	文件系统所属项目。
StorageType	String	Standard	文件系统存储类型。取值说明如下： `Standard`：标准型。
EvictionType	String	undefined	淘汰策略类型
FileSystemId	String	enas-cnbjd2b4f43b****	文件系统 ID。
ProtocolType	String	NFS	文件系统协议类型。取值说明如下： `NFS`：NFS 协议，常用于 Linux 客户端。
SnapshotCount	Integer	1	快照数量。
FileSystemName	String	lytest	文件系统名称。
FileSystemType	String	Extreme	文件系统类型。取值说明如下： `Extreme`：NAS 极速型。 `Capacity`：NAS 容量型。
ElasticCapacity	Boolean	undefined	是否开启弹性容量
AutoExpandPolicy	Object of AutoExpandFileSystemPolicy	undefined	自动扩容策略信息
EvictionDuration	Integer	undefined	时间粒度
EvictionProtectionPaths	Array of String	undefined	淘汰保护目录列表

参数	类型	示例值	描述
Key	String	tagkey	标签键。
Type	String	Custom	标签类型，说明如下： `Custom`: 用户自定义标签。 `System`: 系统标签。
Value	String	tagvalue	标签值。

Capacity

参数	类型	示例值	描述
Used	Long	135	文件系统已使用容量，单位为 MiB。
Total	Long	100	文件系统可用总容量，单位为 GiB。

AutoExpandFileSystemPolicy

参数	类型	示例值	描述
Step	Integer	undefined	扩容步长
Limit	Integer	undefined	自动扩容上限
Threshold	Integer	undefined	扩容阈值

示例

请求示例

POST /?Action=DescribeFileSystems&Version=2022-01-01 HTTP/1.1
Host: filenas.volcengineapi.com
Authorization: HMAC-SHA256 Credential=AKLTOGJhY2E1NTdkZGFmNDg0Yjk0ZDFiNjE5Y2NjZjI****/20230907/cn-beijing/filenas/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
{
    "PageSize" : 10,
    "PageNumber" : 1,
    "Filters": [
        {
            "Key": "FileSystemName",
            "Value": "fs1"
        }
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202209071953130101742491480669BB14",
        "Action": "DescribeFileSystems",
        "Version": "2022-01-01",
        "Service": "FileNAS",
        "Region": "cn-beijing"
    },
    "Result": {
        "FileSystems": [
            {
                "Capacity": {
                    "Total": 102400,
                    "Used": 135
                },
                "ChargeType": "PayAsYouGo",
                "CreateTime": "2023-06-12T15:25:44+08:00",
                "Description": "APItest",
                "FileSystemId": "enas-cnbja8cecb87****",
                "FileSystemName": "APItest",
                "FileSystemType": "Extreme",
                "ProjectName": "default",
                "ProtocolType": "NFS",
                "RegionId": "cn-beijing",
                "SnapshotCount": 0,
                "Status": "Running",
                "StorageType": "Standard",
                "Tags": [
                    {
                        "Key": "key",
                        "Type": "Custom",
                        "Value": "value"
                    }
                ],
                "UpdateTime": "2023-06-12T15:26:10+08:00",
                "Version": "2.4.2.1",
                "ZoneId": "cn-beijing-a",
                "ZoneName": "可用区A"
            },
            {
                "Capacity": {
                    "Total": 102400,
                    "Used": 135
                },
                "ChargeType": "PayAsYouGo",
                "CreateTime": "2023-04-13T16:34:08+08:00",
                "Description": "test-213",
                "FileSystemId": "enas-cnbj1e61c68f****",
                "FileSystemName": "thallo_极速",
                "FileSystemType": "Extreme",
                "ProjectName": "",
                "ProtocolType": "NFS",
                "RegionId": "cn-beijing",
                "SnapshotCount": 1,
                "Status": "Running",
                "StorageType": "Standard",
                "Tags": [
                    {
                        "Key": "test",
                        "Type": "Custom",
                        "Value": "test"
                    }
                ],
                "UpdateTime": "2023-04-13T16:34:44+08:00",
                "Version": "2.4.2.1",
                "ZoneId": "cn-beijing-a",
                "ZoneName": "可用区A"
            },
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 2
    }
}