DescribeFileSystems - 查询文件系统--大数据文件存储-火山引擎

文档中心

立即注册

导航

DescribeFileSystems - 查询文件系统

最近更新时间：2025.01.23 11:36:24首次发布时间：2025.01.23 11:36:24

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

调试

API Explorer

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

去调试

请求参数

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

Query

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeFileSystems	要执行的操作，取值：DescribeFileSystems。
Version	String	是	2024-08-01	API的版本，取值：2024-08-01。

Body

参数	类型	是否必填	示例值	描述
FileSystemIds	Array of String	否	["1801439850948**","1801439850948**"]	文件系统 ID 列表。
FileSystemNames	Array of String	否	["test","test1"]	文件系统名称列表。
Status	String	否	UP	文件系统状态，取值说明如下： INIT：创建中 CREATING：创建中 UP：运行中 SCALING_UP_CACHE：扩容中 DELETING：删除中 DELETED：已删除 CREATE_FAILED：创建失败 SCALE_UP_CACHE_FAILED：扩容失败 DELETE_FAILED：删除失败 ERROR：错误 UNKNOWN：未知
OrderBy	String	否	FileSystemNameAsc	排序方式，取值说明如下： FileSystemNameAsc：根据文件系统名称升序。 FileSystemNameDesc：根据文件系统名称降序。 CreatedTimeAsc：根据文件系统创建时间升序。 CreatedTimeDesc：根据文件系统创建时间降序。
PageNumber	Integer	否	1	实例信息列表的页码，取值为不超过 Integer 数据类型的最大值，起始值为 1。
PageSize	Integer	否	10	每页记录数。取值为 1~100 间的整数，默认为 10。

返回参数

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

参数	类型	示例值	描述
FileSystems	Array of Object	详情请参见返回示例	文件系统列表信息。
PageNumber	Integer	1	实例信息列表的页码，取值为不超过 Integer 数据类型的最大值，起始值为 1。
PageSize	Integer	10	每页记录数。取值为 1~100 间的整数，默认为 10。
TotalCount	Integer	1	文件系统总数。

请求示例

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

{
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241223115301016207181037CE2102",
    "Action": "DescribeFileSystems",
    "Version": "2024-08-01",
    "Service": "cfs",
    "Region": "cn-beijing"
  },
  "Result": {
    "FileSystems": [
      {
        "FileSystemId": "123456",
        "FileSystemName": "test",
        "RegionId": "cn-beijing",
        "ZoneId": "cn-beijing-a",
        "ZoneName": "华北2（北京）-可用区A",
        "FileSystemMode": "ACC",
        "FileSystemModeCN": "数据湖场景",
        "FollowPermissions": false,
        "CacheCapacityGiB": "10240",
        "CreatedTime": "2024-08-01T00:00:00+08:00",
        "NamespaceQuota": 50,
        "NamespaceCount": 2,
        "VpcId": "vpc-xxxx",
        "SubnetId": "subnet-xxxx",
        "SecurityGroupId": "sg-xxxx",
        "MountPoint": "test.cfs-cn-beijing.cfs.ivolces.com",
        "Status": "UP",
        "Description": "测试",
        "CachePlanCN": "性能1型",
        "CachePlan": "SaaS_T2",
        "CacheMode": "V_1_4_DISCOUNT"
      }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 1
  }
}

错误码

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

状态码	错误码	错误信息	说明
400	InvalidRequest	Invalid request in request body: %s.	请求体无效。
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	内部错误。