ListFileSystems - 批量获取文件系统详细信息

批量获取文件系统详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dfs:ListFileSystemslist
  • FileSystem
    acs:dfs:{#regionId}:{#accountId}:filesystem/*

请求参数

名称类型必填描述示例值
NextTokenstring

下一页标识。

如果一次查询结果并没有完整返回所有的目录,则返回 NextToken 不为空。您可以在查询中上传正确的 NextToken 继续查询。

tCSKxtX5z_fW0-Q0ug8Df1oSXGiamAjmrtaDFAj6sZW-YhN1lRC7TEIkcFfMuj-6uR9wSW4b_PS2ze70k269qy8bMVHDfRW0Tvhmyh-****
StartOffsetinteger

指定查询起始位置。

默认值:1

10
Limitinteger

每页返回结果的行数。

默认值:10

10
OrderBystring

返回结果排序字段。

取值:

  • CreateTime(默认值):按创建时间排序。
  • FileSystemName:按文件系统名称排序。
  • SpaceCapacity:按文件系统容量预算排序。
  • UsedSpaceSize:按文件系统使用量排序。
CreateTime
OrderTypestring

返回结果排序方式。

取值:

  • ASC(默认值):升序
  • DESC:降序
ASC
InputRegionIdstring

地域 ID。

cn-hangzhou

返回参数

名称类型描述示例值
object
TotalCountinteger

返回结果的数量。

1
RequestIdstring

请求 ID。

55C5FFD6-BF99-41BD-9C66-FFF39189****
NextTokenstring

tCSKxtX5z_fW0-Q0ug8Df1oSXGiamAjmrtaDFAj6sZW-YhN1lRC7TEIkcFfMuj-6uR9wSW4b_PS2ze70k269qy8bMVHDfRW0Tvhmyh-k47g

tCSKxtX5z_fW0-Q0ug8Df1oSXGiamAjmrtaDFAj6sZW-YhN1lRC7TEIkcFfMuj-6uR9wSW4b_PS2ze70k269qy8bMVHDfRW0Tvhmyh-****
FileSystemsarray<object>

文件系统信息集合。

object
CreateTimestring

文件系统的创建时间。

2022-04-18T06:03:15.836222Z
ProvisionedThroughputInMiBpslong

预置吞吐量。 单位:MB/s。

1024
SpaceCapacitylong

文件系统容量。

单位:GB

1024
StorageTypestring

存储介质类型。

包括:

  • STANDARD:标准型
  • PERFORMANCE:性能型
STANDARD
UsedSpaceSizefloat

已使用空间容量。

单位:GB

100
RegionIdstring

地域 ID。

cn-hangzhou
FileSystemIdstring

文件系统 ID。

37af8f42-2abc-4e74-889d-664f5163****
FileSystemNamestring

文件系统名称。

MyFirstHDFS
Descriptionstring

文件系统的描述信息。

这是我公司的第一个文件存储HDFS版实例。
MountPointCountlong

挂载点数量。

2
ThroughputModestring

吞吐模式。

包括:

  • Standard:标准吞吐
  • Provisioned:预置吞吐
Standard
ZoneIdstring

可用区 ID。

cn-hangzhou-b
NumberOfFileslong

文件数量。

1000
StoragePackageIdstring

存储包 ID。

1
NumberOfDirectorieslong

目录数量。

100
ProtocolTypestring

协议类型。

仅支持 HDFS(Hadoop Distributed File System)。

HDFS
Versionstring

阿里云文件存储 HDFS 版的版本,非 hadoop 版本。

1.0.0
MeteringSpaceSizefloat

文件系统的计费容量。单位:字节(byte)。

计费容量=MAX[(文件数+目录数)*5MiB,使用容量]。

统计数据,不作为计费数据,仅作参考。HDFS 按照上一小时计费容量峰值进行计费。若您希望查询更详细的计量数据,请参见查看消费明细

107374182400

示例

正常返回示例

JSON格式

{
  "TotalCount": 1,
  "RequestId": "55C5FFD6-BF99-41BD-9C66-FFF39189****",
  "NextToken": "tCSKxtX5z_fW0-Q0ug8Df1oSXGiamAjmrtaDFAj6sZW-YhN1lRC7TEIkcFfMuj-6uR9wSW4b_PS2ze70k269qy8bMVHDfRW0Tvhmyh-****",
  "FileSystems": [
    {
      "CreateTime": "2022-04-18T06:03:15.836222Z",
      "ProvisionedThroughputInMiBps": 1024,
      "SpaceCapacity": 1024,
      "StorageType": "STANDARD",
      "UsedSpaceSize": 100,
      "RegionId": "cn-hangzhou",
      "FileSystemId": "37af8f42-2abc-4e74-889d-664f5163****",
      "FileSystemName": "MyFirstHDFS",
      "Description": "这是我公司的第一个文件存储HDFS版实例。",
      "MountPointCount": 2,
      "ThroughputMode": "Standard",
      "ZoneId": "cn-hangzhou-b",
      "NumberOfFiles": 1000,
      "StoragePackageId": "1",
      "NumberOfDirectories": 100,
      "ProtocolType": "HDFS",
      "Version": "1.0.0",
      "MeteringSpaceSize": 107374182400
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-07-03OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情