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

调试

API Explorer

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

去调试

请求参数

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

Query

Action string 必选示例值：DescribeFileSystems

要执行的操作，取值：DescribeFileSystems。

Version string 必选示例值：2024-08-01

API的版本，取值：2024-08-01。

Body

FileSystemIds string[] 可选示例值：["1801439850948****","1801439850948****"]

文件系统 ID 列表。

FileSystemNames 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 object[] 示例值：详情请参见返回示例

文件系统列表信息。

FileSystemId string 示例值：1801439850948****

文件系统 ID。

FileSystemName string 示例值：test

文件系统名称。

RegionId string 示例值：cn-beijing

地域 ID。

ZoneId string 示例值：cn-beijing-a

可用区 ID。

ZoneName string 示例值：华北2（北京）-可用区A

可用区名称。

FileSystemMode string 示例值：ACC

文件系统模式，取值说明如下：

HDFS：文件存储场景

ACC：数据湖场景

FileSystemModeCN string 示例值：数据湖场景

文件系统模式描述信息。

TosBucket string 示例值：test

文件存储场景所使用的 TOS 桶。

TosPrefix string 示例值：prefix/

文件存储场景所使用的 TOS 前缀。

FollowPermissions boolean 示例值：true

是否开启权限同步，取值说明如下：

true：开启权限同步。

false：不开启权限同步。

CacheCapacityGiB string 示例值：10240

缓存空间大小，单位 GiB。

CreatedTime string 示例值：2024-08-01T00:00:00+08:00

文件系统创建时间。

NamespaceQuota integer 示例值：50

该文件系统中的命名空间配额。

NamespaceCount integer 示例值：2

该文件系统中的命名空间数量。

VpcId string 示例值：vpc-xxxx

开启缓存加速时所接入的 VPC ID。

SubnetId string 示例值：subnet-xxxx

开启缓存加速时所接入的子网 ID。

SecurityGroupId string 示例值：sg-xxxx

开启缓存加速时所接入的安全组 ID。

MountPoint string 示例值：test.cfs-cn-beijing.cfs.ivolces.com

文件系统挂载点。

DatanodeCount string 示例值：10

半托管型文件系统的 Datanode 数量。

Description string 示例值：测试

文件系统描述信息。

Project string 示例值：default

文件系统所属项目。

Tags string[] 示例值：详情请参加返回示例

文件系统标签信息。

CachePlanCN string 示例值：半托管型

缓存规格中文名称。

CachePlan string 示例值：SemiManaged

缓存规格，取值说明如下：

SaaS_Disabled：关闭缓存加速

SaaS_T2：性能 1 型

SaaS_T4：性能 2 型

SemiManaged：半托管型

CacheMode string 示例值：V_1_4_DISCOUNT

缓存模式。

Status string 示例值：UP

文件系统状态。

UsageBytes string

block 模式实例存储容量

PageNumber integer 示例值：1

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

PageSize integer 示例值：10

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

TotalCount integer 示例值：1

文件系统总数。

请求示例

返回示例

错误码

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

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

大数据文件存储