You need to enable JavaScript to run this app.
导航
DescribeFileSystems - 列举文件系统
最近更新时间:2025.05.16 14:13:50首次发布时间:2022.09.19 20:54:28
我的收藏
有用
有用
无用
无用

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

调试

请求参数

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

参数
类型
是否必填
示例值
描述
Action
String

DescribeFileSystems

要执行的操作,取值:DescribeFileSystems。

Version
String

2022-01-01

API的版本,取值:2022-01-01。

PageSize
Integer

10

每页记录数。取值为 1~100 间的整数,默认为 10。

PageNumber
Integer

1

实例信息列表的页码,取值为不超过 Integer 数据类型的最大值,起始值为 1。

OrderBy
String

CreateTimeDesc

文件系统排序类型,默认为按照创建时间降序。取值说明如下:

  • CreateTimeDesc:按照文件系统的创建时间降序。
  • CreateTimeAsc:按照文件系统的创建时间升序。
  • CapacityDesc:按照文件系统的总容量降序。
  • CapacityAsc:按照文件系统的总容量升序。
  • IdDesc:按照文件系统 ID降序。
  • IdAsc:按照文件系统 ID升序。
Filters
Array of Object

详情请参见请求示例

文件系统过滤信息,筛选符合条件的文件系统信息。

FileSystemIds
String

vepfs-cnbj4386bc8a****

按照实例 ID 筛选,多个 ID 的话用英文逗号(,)分割。

Project
String

default

按照项目名筛选。

返回参数

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

参数
类型
示例值
描述
TotalCount
Integer

1

文件系统个数。

PageSize
Integer

10

每页记录数。取值为 1~100 间的整数,默认为10。

PageNumber
Integer

1

实例信息列表的页码,取值为不超过 Integer 数据类型的最大值,起始值为 1。

FileSystems
Array of Object

详情请参见返回示例

文件系统详情。

请求示例

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": "202209152018450102251460630715****",
          "Action": "DescribeFileSystems",
          "Version": "2022-01-01",
          "Service": "vepfs",
          "Region": "cn-beijing"
     },
     "Result": {
          "FileSystems": [
               {
                    "AccountId": "210004****",
                    "AutoRenew": false,
                    "Bandwidth": 600,
                    "CapacityInfo": {
                         "TotalTiB": 6,
                         "UsedGiB": 20
                    },
                    "ChargeStatus": "Normal",
                    "ChargeType": "PayAsYouGo",
                    "CreateTime": "2022-09-15T18:17:09+08:00",
                    "Description": "",
                    "ExpireTime": "2022-12-15T23:59:59+08:00",
                    "FileSystemId": "vepfs-sw07b082188a****",
                    "FileSystemName": "ztest",
                    "FileSystemType": "VePFS",
                    "FreeTime": "2022-12-22T00:00:00+08:00",
                    "LastModifyTime": "2022-09-15T18:25:22+08:00",
                    "Month": 3,
                    "Project": "vepfs-test",
                    "ProtocolType": "VePFS",
                    "RegionId": "cn-beijing",
                    "ReplicasNum": 1,
                    "Status": "Running",
                    "StopServiceTime": "2022-12-16T12:00:00+08:00",
                    "Storage": {},
                    "StoreType": "Advance_100",
                    "Tags": [
                        {
                             "Key": "tag_00",
                             "Value": "tag_value_00",
                             "Type": "Custom"
                        },
                        {
                             "Key": "tag_01",
                             "Value": "tag_value_01",
                             "Type": "Custom"
                        }
                     ]
                    "Version": "5.1.2.4",
                    "ZoneId": "cn-beijing-a",
                    "ZoneName": "华北2(北京)-可用区A"
               },
               {
                    "AccountId": "210004****",
                    "AutoRenew": false,
                    "Bandwidth": 600,
                    "CapacityInfo": {
                         "TotalTiB": 6,
                         "UsedGiB": 20
                    },
                    "ChargeStatus": "Normal",
                    "ChargeType": "PayAsYouGo",
                    "CreateTime": "2022-09-15T18:06:12+08:00",
                    "Description": "",
                    "ExpireTime": "2022-12-15T23:59:59+08:00",
                    "FileSystemId": "vepfs-cnbj4386bc8a****",
                    "FileSystemName": "test",
                    "FileSystemType": "VePFS",
                    "FreeTime": "2022-12-22T00:00:00+08:00",
                    "LastModifyTime": "2022-09-15T18:14:24+08:00",
                    "Month": 3,
                    "Project": "vepfs-test",
                    "ProtocolType": "VePFS",
                    "RegionId": "cn-beijing",
                    "ReplicasNum": 1,
                    "Status": "Running",
                    "StopServiceTime": "2022-12-16T12:00:00+08:00",
                    "Storage": {},
                    "StoreType": "Advance_100",
                    "Tags": [
                        {
                             "Key": "tag_00",
                             "Value": "tag_value_00",
                             "Type": "Custom"
                        },
                        {
                             "Key": "tag_01",
                             "Value": "tag_value_01",
                             "Type": "Custom"
                        }
                     ]
                    "Version": "5.1.2.4",
                    "ZoneId": "cn-beijing-a",
                    "ZoneName": "华北2(北京)-可用区A"
               }
          ],
          "PageNumber": 1,
          "PageSize": 10,
          "TotalCount": 2
     }
}

错误码

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

状态码
错误码
错误信息
说明
500
InternalError

Service has some internal Error. Pls Contact With Admin.

内部错误。