You need to enable JavaScript to run this app.
文档中心
弹性文件存储

弹性文件存储

复制全文
下载 pdf
文件系统
DescribeFileSystems - 列举文件系统
复制全文
下载 pdf
DescribeFileSystems - 列举文件系统
调用 DescribeFileSystems 接口列举文件系统。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:DescribeFileSystems​
要执行的操作,取值:DescribeFileSystems。​
​
Version string 必选 示例值:2025-01-01​
API的版本,取值:2025-01-01。​
​
PageSize integer 可选 示例值:10​
分页查询每页个数。​
​
PageNumber integer 可选 示例值:1​
分页查询页码。​
​
FileSystemId string 可选 示例值:efs-cncqb627aa118****​
文件系统 ID。​
​
ProjectName string 可选 示例值:projectname_test​
项目名称。​
​
SortOrder string 可选 示例值:Desc​
排序顺序,取值说明如下:​
  • Desc:降序​
  • Asc:升序​
​
SortBy string 可选 示例值:CreateTime​
排序类型,取值说明如下:​
  • CreateTime:文件系统的创建时间​
  • ProvisionedBandwidth:文件系统的预置带宽​
  • BurstBandwidth:文件系统的突发带宽​
​
FileSystemName string 可选 示例值:filesystem_test​
文件系统名称。​
​
ZoneId string 可选 示例值:cn-beijing-b​
可用区 ID。​
​
BandwidthMode string 可选 示例值:Provisioned​
带宽类型,取值说明如下:​
  • Baseline:基线带宽模式​
  • Provisioned:预置带宽模式​
​
InstanceType string 可选 示例值:Premium​
文件系统类型,取值说明如下:​
  • Basic:基础型​
  • Premium:高级型​
​
ChargeType string 可选 示例值:PayAsYouGo​
计费类型。仅支持取值为PayAsYouGo,表示按量计费。​
​
Statuses string[] 可选 示例值:Creating​
文件系统状态。取值说明如下:​
  • Creating:创建中​
  • CreateError:创建失败​
  • Running:运行中​
  • Updating:更新中​
  • Deleting:删除中​
  • DeleteError:删除失败​
  • Deleted:已删除​
  • Stopped:已关停​
​
TagFilters object[] 可选 示例值:详情请参见示例代码​
标签筛选详细信息。​
Key string 必选 示例值:key_test​
标签键。​
​
Values string[] 可选 示例值:value_test​
标签值。​
​
​
PerformanceDensity string 可选 示例值:Premium_125​
文件系统性能密度,取值说明如下:​
  • Basic_50:基础型 50MB/s/TiB​
  • Premium_125:高级型 125MB/s/TiB​
​
Language string 可选 示例值:ZH​
显示的语言类型,取值说明如下:​
  • ZH:中文​
  • EN:英文​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
TotalCount integer 示例值:1​
文件系统总个数。​
​
PageSize integer 示例值:10​
分页查询每页个数。​
​
PageNumber integer 示例值:1​
分页查询页码。​
​
FileSystems object[] 示例值:详情请参见示例代码​
文件系统详细信息。​
FileSystemId string 示例值:efs-cncqb627aa118****​
文件系统 ID。​
​
FileSystemName string 示例值:filesystem_test​
文件系统名称。​
​
Status string 示例值:Creating​
文件系统状态。取值说明如下:​
  • Creating:创建中​
  • CreateError:创建失败​
  • Running:运行中​
  • Updating:更新中​
  • Deleting:删除中​
  • DeleteError:删除失败​
  • Deleted:已删除​
  • Stopped:已关停​
​
InstanceType string 示例值:Premium​
文件系统类型,取值说明如下:​
  • Basic:基础型​
  • Premium:高级型​
​
PerformanceDensity string 示例值:Premium_125​
文件系统性能密度,取值说明如下:​
  • Basic_50:基础型 50MB/s/TiB​
  • Premium_125:高级型 125MB/s/TiB​
​
ProjectName string 示例值:projectname_test​
项目名称。​
​
ZoneId string 示例值:cn-beijing-b​
可用区 ID。​
​
ZoneName string 示例值:可用区B​
可用区名称。​
​
Description string 示例值:for_test​
文件系统描述信息。​
​
CreateTime string 示例值:2025-09-01T20:51:03+08:00​
文件系统创建时间。​
​
UpdateTime string 示例值:2025-09-02T15:26:41+08:00​
文件系统更新时间。​
​
Storage object 示例值:详情请参见示例代码​
文件系统容量信息。​
CapacityLimit long 示例值:1000000​
容量上限,单位为 MiB。​
​
CapacityUsed long 示例值:1000​
已用容量,单位为 MiB。​
​
InodeLimit long 示例值:1000​
文件数上限。​
​
InodeUsed long 示例值:100​
已用文件数。​
​
​
ChargeConfig object 示例值:详情请参见示例代码​
文件系统计费配置。​
ChargeType string 示例值:PayAsYouGo​
计费类型。仅支持取值为PayAsYouGo,表示按量计费。​
​
ChargeStatus string 示例值:Normal​
计费状态,取值说明如下:​
  • WaitingPaid:等待支付​
  • Pending:创建中​
  • Modifying:更配中​
  • Failed:失败​
  • Normal:正常​
  • Expired:过期​
  • Overdue:欠费​
  • Reclaimed:回收​
  • Terminated:退订​
​
ExpireTime string 示例值:2025-09-27T15:59:59.000Z​
到期时间。​
​
StopTime string 示例值:2025-10-22T13:10:15.000Z​
关停时间。​
​
ReclaimTime string 示例值:2025-10-29T13:10:15.000Z​
回收时间。​
​
​
Tags object[] 示例值:详情请参见示例代码​
文件系统标签信息。​
Type string 示例值:System​
标签类型,取值说明如下:​
  • System:系统标签​
  • Custom:自定义标签​
​
Key string 示例值:key_test​
标签键。​
​
Value string 示例值:value_test​
标签值。​
​
​
Performance object 示例值:详情请参见示例代码​
文件系统性能信息。​
BandwidthMode string 示例值:Provisioned​
带宽模式,取值说明如下:​
  • Baseline:基线带宽模式​
  • Provisioned:预置带宽模式​
​
BaselineBandwidth integer 示例值:30000​
基准带宽。​
​
BaselineIops integer 示例值: 900000​
基准 IOPS。​
​
ProvisionedBandwidth integer 示例值:200000​
预置带宽。​
​
ProvisionedIops integer 示例值:1800000​
预置 IOPS。​
​
BurstBandwidth integer 示例值: 60000​
突发带宽。​
​
BurstIops integer 示例值:1800000​
突发 IOPS。​
​
​
MountPointLimit integer 示例值:3​
挂载点上限。​
​
AccessPointLimit integer 示例值:10​
接入点上限。​
​
DowngradeUnlockTime string 示例值:2025-10-20T10:30:00Z​
文件系统带宽可以降配的时间。​
​
​
​
​
请求示例​
​
POST /?Action=DescribeFileSystems&Version=2025-01-01 HTTP/1.1​
Host: efs.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20260127T095521Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260127/cn-beijing/efs/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
{​
"PageSize": 10,​
"PageNumber": 1,​
"FileSystemId": "efs-cncqb627aa118****",​
"ProjectName": "projectname_test",​
"SortOrder": "Desc",​
"SortBy": "CreateTime",​
"FileSystemName": "filesystem_test",​
"ZoneId": "cn-beijing-b",​
"BandwidthMode": "Provisioned",​
"InstanceType": "Premium",​
"ChargeType": "PayAsYouGo",​
"Statuses": [​
"Creating"​
],​
"TagFilters": [​
{​
"Key": "key_test",​
"Values": [​
"value_test"​
]​
}​
],​
"PerformanceDensity": "Premium_125",​
"Language": "ZH"​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "2026012717553102403308505201****",​
"Action": "DescribeFileSystems",​
"Version": "2025-01-01",​
"Service": "efs",​
"Region": "cn-beijing"​
},​
"Result": {​
"TotalCount": 1,​
"PageSize": 10,​
"PageNumber": 1,​
"FileSystems": [​
{​
"FileSystemId": "efs-cncqb627aa118****",​
"FileSystemName": "filesystem_test",​
"Status": "Creating",​
"InstanceType": "Premium",​
"PerformanceDensity": "Premium_125",​
"ProjectName": "projectname_test",​
"ZoneId": "cn-beijing-b",​
"ZoneName": "可用区B",​
"Description": "for_test",​
"CreateTime": "2025-09-01T20:51:03+08:00",​
"UpdateTime": "2025-09-02T15:26:41+08:00",​
"Storage": {​
"CapacityLimit": 1000000,​
"CapacityUsed": 1000,​
"InodeLimit": 1000,​
"InodeUsed": 100​
},​
"ChargeConfig": {​
"ChargeType": "PayAsYouGo",​
"ChargeStatus": "Normal",​
"ExpireTime": "2025-09-27T15:59:59.000Z",​
"StopTime": "2025-10-22T13:10:15.000Z",​
"ReclaimTime": "2025-10-29T13:10:15.000Z"​
},​
"Tags": [​
{​
"Type": "System",​
"Key": "key_test",​
"Value": "value_test"​
}​
],​
"Performance": {​
"BandwidthMode": "Provisioned",​
"BaselineBandwidth": 30000,​
"BaselineIops": 900000,​
"ProvisionedBandwidth": 200000,​
"ProvisionedIops": 1800000,​
"BurstBandwidth": 60000,​
"BurstIops": 1800000​
},​
"MountPointLimit": 3,​
"AccessPointLimit": 10,​
"DowngradeUnlockTime": "2025-10-20T10:30:00Z"​
}​
]​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
500​
InternalError​
An internal error has occurred.​
内部错误。​
​
​
最近更新时间:2026.02.05 17:53:58
这个页面对您有帮助吗?
有用
有用
无用
无用