DescribeFileSystems - 查询文件系统信息

调用DescribeFileSystems查询NAS文件系统信息。

调试

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

授权信息

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

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

请求参数

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

节点 ID。

cn-beijing-cmcc
FileSystemIdstring

NAS 文件系统 ID。

c50f8*****
FileSystemNamestring

NAS 文件系统名称。

FileSystem1
PageNumberinteger

页码,起始值为 1。默认值:1

1
PageSizeinteger

每页行数,最大值为 100 行。默认值:10

10

返回参数

名称类型描述示例值
object

Schema of Response

PageNumberinteger

页码。

1
PageSizeinteger

单页行数。

2
TotalCountinteger

总数。

1
FileSystemsarray<object>

文件系统信息集合。

FileSystemsobject
FileSystemIdstring

文件系统 ID。

c50f8*****
FileSystemNamestring

文件系统名称。

FileSystem1
EnsRegionIdstring

地域 ID。

cn-beijing-cmcc
StorageTypestring

存储类型。取值:

  • capacity:容量型
  • performance:极速型
capacity
ProtocolTypestring

文件系统协议类型。取值:

  • NFS:NFS 文件协议
  • SMB:SMB 文件协议
NFS
Capacitylong

容量。单位:MiB。

100000
MeteredSizelong

文件系统的使用量。 非实时使用量,为上一小时最大使用量,单位:Byte。

102400
Statusstring

文件系统状态

  • pending:当前文件系统正在处理任务中。
  • running:当前文件系统可用,当状态为 running 时才可以进行后续操作(例如:创建挂载点等)。
  • stopped:当前文件系统不可用。
  • extending:当前文件系统扩容中。
  • stopping:当前文件系统停机中。
  • deleting:当前文件系统删除中。
running
PayTypestring

付费类型。取值:PostPaid(后付费)。

PostPaid
CreationTimestring

文件系统创建时间。

2022-08-31 12:00:00
MountTargetsarray<object>

挂载点信息集合

MountTargetsobject
MountTargetDomainstring

挂载点路径。

*.*.*.*:/${FileSystemName}/{MountTargetName}
MountTargetNamestring

挂载点名称。

target1
NetWorkIdstring

网络 ID。

n-****
Statusstring

挂载点状态。取值:

  • active:可用
  • inactive:不可用
  • pending:任务处理中
  • deleting:删除中
active
RequestIdstring

请求 ID。

762DD527-358B-1E48-8005-CCE3ED4EB9E0

示例

正常返回示例

JSON格式

{
  "PageNumber": 1,
  "PageSize": 2,
  "TotalCount": 1,
  "FileSystems": [
    {
      "FileSystemId": "c50f8*****",
      "FileSystemName": "FileSystem1",
      "EnsRegionId": "cn-beijing-cmcc",
      "StorageType": "capacity",
      "ProtocolType": "NFS",
      "Capacity": 100000,
      "MeteredSize": 102400,
      "Status": "running",
      "PayType": "PostPaid",
      "CreationTime": "2022-08-31 12:00:00",
      "MountTargets": [
        {
          "MountTargetDomain": "*.*.*.*:/${FileSystemName}/{MountTargetName}",
          "MountTargetName": "target1",
          "NetWorkId": "n-****",
          "Status": "active"
        }
      ]
    }
  ],
  "RequestId": "762DD527-358B-1E48-8005-CCE3ED4EB9E0"
}

错误码

HTTP status code错误码错误信息描述
400NoPermissionPermission denied.没有足够的权限,请联系云账号管理员授予您相应权限。
400ens.interface.errorFailed to call API.接口调用发生异常。
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

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

变更历史

变更时间变更内容概要操作
2024-06-13OpenAPI 错误码发生变更查看变更详情