文档中心

DescribeFileSystems

最近更新时间：2024.03.13 17:22:33

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

调用 DescribeFileSystems 接口查询文件系统。

请求参数

参数	类型	是否必选	示例值	描述
PageSize	Integer	否	10	每个分页包含的文件系统个数。
PageNumber	Integer	否	1	文件系统列表的分页页码。
OrderBy	String	否	CreateTimeDesc	文件系统排序类型，默认为按照创建时间降序。取值说明如下： `CreateTimeDesc`：按照文件系统的创建时间降序。 `CreateTimeAsc`：按照文件系统的文件系统的创建时间升序。 `CapacityDesc`：按照总容量降序。 `CapacityAsc`：按照文件系统的总容量升序。 `IdDesc`：按照文件系统 ID降序。 `IdAsc`：按照文件系统 ID升序。
Filters	Array of FileSystemFilter	否	详情请参见请求示例	文件系统过滤信息，筛选符合条件的文件系统信息。
Project	String	否	default	按照项目名筛选。
FileSystemIds	String	否	vepfs-cnbj4386bc8a****	按照实例 ID 筛选，多个 ID 的话用英文逗号（,）分割。

FileSystemFilter

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

参数	类型	是否必选	示例值	描述
Key	String	是	FileSystemName	根据特性筛选指定特征的实例。支持筛选的参数如下： `ChargeType`：根据计费类型精确筛选，不支持多选。 `FileSystemType`：根据文件系统类型精确筛选，不支持多选。 `StoreType`：根据存储规格精确筛选，不支持多选。 `FileSystemName`：根据文件系统名称进行模糊筛选，不支持多选。 `Status`：根据文件系统状态精确筛选，支持多选，使用英文逗号（,）分割。 `ZoneId`：根据文件系统可用区精确筛选，不支持多选。 `Protocol`：根据文件系统协议精确筛选，不支持多选。 `AccountId`：根据文件系统所属账户 ID 精确筛选，不支持多选。
Value	String	是	aaa	筛选项目的值。

Key

String

是

FileSystemName

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

ChargeType：根据计费类型精确筛选，不支持多选。
FileSystemType：根据文件系统类型精确筛选，不支持多选。
StoreType：根据存储规格精确筛选，不支持多选。
FileSystemName：根据文件系统名称进行模糊筛选，不支持多选。
Status：根据文件系统状态精确筛选，支持多选，使用英文逗号（,）分割。
ZoneId：根据文件系统可用区精确筛选，不支持多选。
Protocol：根据文件系统协议精确筛选，不支持多选。
AccountId：根据文件系统所属账户 ID 精确筛选，不支持多选。

Value String 是 aaa 筛选项目的值。

返回参数

参数	类型	示例值	描述
TotalCount	Integer	1	文件系统个数。
PageSize	Integer	10	每个分页包含的文件系统个数。
PageNumber	Integer	1	文件系统列表的分页页码。
FileSystems	Array of FileSystem	-	文件系统详情。

FileSystem

参数	类型	示例值	描述
Tags	Array of Tag	详情请参见返回示例	文件系统的标签信息，创建文件系统的同时添加标签时返回。
VpcId	String	vpc-13f24t16guqdc3n6nu4k5****	私有网络 ID。
Status	String	Running	文件系统状态。取值说明如下： `Running`：实例运行中。 `Creating`：实例创建中。 `CreateError`：实例创建失败。 `Updating`：实例更新中。 `UpdateError`：实例更新失败。 `Expanding`：实例扩容中。 `ExpandError`：实例扩容失败。 `Deleting`：实例删除中。 `DeleteError`：实例删除失败。 `Stopped`：实例已关停。 `Error`：实例处于错误状态。
ZoneId	String	cn-beijing-a	可用区 ID。
Project	String	vepfs-test	文件系统所属项目。
Version	String	5.1.2.4	文件系统版本。
FreeTime	String	2022-12-22T00:00:00+08:00	文件系统释放时间。
RegionId	String	cn-beijing	地域 ID。
SubnetId	String	subnet-rrz4zdgdv20wv0x58hl****	子网 ID。
ZoneName	String	华北2（北京）-可用区A	可用区名称。
AccountId	String	210004****	账户 ID。
Bandwidth	Integer	600	vePFS 文件系统吞吐上限。
StoreType	String	Advance_100	文件系统规格，取值说明如下： `Advance_100`：100MB/s/TiB
ChargeType	String	PayAsYouGo	计费类型。取值说明如下： `PayAsYouGo`：按量计费。
CreateTime	String	2022-09-15T18:17:09+08:00	文件系统创建时间。
ExpireTime	String	2022-12-15T23:59:59+08:00	文件系统到期时间。
Description	String	test	文件系统描述信息。
CapacityInfo	Object of CapacityInfo	{ "TotalTiB": 6, "UsedGiB"：20 }	容量信息。
ChargeStatus	String	Normal	计费状态，默认为 `Normal`，表示正常计费。
FileSystemId	String	vepfs-sw07b082188a****	文件系统 ID。
ProtocolType	String	VePFS	文件系统协议类型。
FileSystemName	String	test	文件系统名称。
FileSystemType	String	VePFS	文件系统类型，默认为 `VePFS`。
LastModifyTime	String	2022-09-15T18:25:22+08:00	文件系统更新时间。
StopServiceTime	String	2022-12-16T12:00:00+08:00	文件系统关停时间。
FileSystemGrafanaUrl	String		文件系统大盘监控，文档不对外展示

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

CapacityInfo

参数	类型	示例值	描述
UsedGiB	Integer	117	文件系统使用容量，单位为 GiB。
TotalTiB	Integer	28	文件系统总容量，单位为 TiB。

示例

请求示例

POST /?Action=DescribeFileSystems&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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "DescribeFileSystems",
        "Version": "2022-01-01",
        "Service": "vepfs",
        "Region": "cn-beijing"
    },
    "Result": {
        "TotalCount": 1,
        "PageSize": 10,
        "PageNumber": 1,
        "FileSystems": [
            {
                "FileSystemId": "vepfs-sw07b082188a****",
                "FileSystemName": "test",
                "RegionId": "cn-beijing",
                "ZoneId": "cn-beijing-a",
                "FileSystemType": "VePFS",
                "StoreType": "Advance_100",
                "ProtocolType": "VePFS",
                "ChargeType": "PayAsYouGo",
                "Status": "Running",
                "CapacityInfo": {
                    "TotalTiB": 6,
                    "UsedGiB": 20
                },
                "CreateTime": "2022-09-15T18:17:09+08:00",
                "LastModifyTime": "2022-09-15T18:25:22+08:00",
                "ZoneName": "华北2（北京）-可用区A",
                "ChargeStatus": "Normal",
                "VpcId": "vpc-13f24t16guqdc3n6nu4k5****",
                "Project": "vepfs-test",
                "AccountId": "210004****",
                "SubnetId": "subnet-rrz4zdgdv20wv0x58hl****",
                "Bandwidth": 600,
                "StopServiceTime": "2022-12-16T12:00:00+08:00",
                "Tags": [
                    {
                        "Key": "key",
                        "Type": "Custom",
                        "Value": "value"
                    }
                ],
                "Description": "test",
                "FreeTime": "2022-12-22T00:00:00+08:00",
                "Version": "5.1.2.4",
                "ExpireTime": "2022-12-15T23:59:59+08:00"
            }
        ]
    }
}

请求参数

FileSystemFilter

返回参数

FileSystem

Tag

CapacityInfo

示例

请求示例

返回示例

文件存储 vePFS

DescribeFileSystems

请求参数

FileSystemFilter

返回参数

FileSystem

Tag

CapacityInfo

示例

请求示例

返回示例