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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeFileSystems

操作接口名,系统规定参数,取值:DescribeFileSystems。

FileSystemId String 109c04****

文件系统ID。

FileSystemType String standard

文件系统类型。

  • 可选值:all(所有类型)、standard(通用型NAS)、extreme(极速型NAS)、cpfs(CPFS)。
  • 默认值:all。
VpcId String vpc-bp1sevsgtqvk5gxbl****

专有网络ID。

必须与待挂载的云服务器ECS选择一样的VPC网络。

PageSize Integer 1

分页查询时,每个分页包含的文件系统个数。

  • 最大值:100。
  • 默认值:10。
PageNumber Integer 1

列表的分页页码。

  • 起始值:1。
  • 默认值:1。

返回数据

名称 类型 示例值 描述
PageNumber Integer 1

文件系统列表的分页页码。

PageSize Integer 1

每个分页包含的文件系统个数。

RequestId String 035B3A3A-E514-4B41-B906-5D906CFBD65F

请求ID。

TotalCount Integer 1

文件系统的总个数。

FileSystems Array

文件系统的描述信息。

FileSystem
Bandwidth Long 150

文件系统的带宽(单位:MB/s)。通用型NAS没有该字段。

Capacity Long 1

文件系统的容量(单位:GB)。

ChargeType String PayAsYouGo

付费类型:

  • Subscription:包年包月。
  • PayAsYouGo:按量付费。
  • Package:已绑定存储包。
CreateTime String 2017-05-27T15:43:06CST

文件系统的创建时间。

Description String 此文件系统的描述信息。

文件系统的描述信息。

EncryptType Integer 1

加密类型:

  • 0:不加密。
  • 1:加密。
ExpiredTime String 1572174830000

文件系统到期时间。

FileSystemId String 109c04****

文件系统ID。

FileSystemType String all

文件系统类型。

KMSKeyId String 0e478b7a-4262-4802-b8cb-00d3fb40****

KMS密钥ID。

Ldap Struct

LDAP配置,仅CPFS文件系统返回该节点。

BindDN String cn=alibaba,dc=com

绑定LDAP的指定条目。

SearchBase String dc=example

LDAP搜索起始点。

URI String ldap://ldap.example.example

LDAP服务地址。

MeteredIASize Long 362832

生命周期管理低频存储用量。

MeteredSize Long 1611661312

文件系统已使用量,为上一小时最大使用量,非当前值(单位:Byte)。

MountTargets Array

挂载点信息。

MountTarget
AccessGroupName String test-001

挂载点使用的权限组名称。

MountTargetDomain String 109c042666-w****.cn-hangzhou.nas.aliyuncs.com

挂载点域名。

NetworkType String vpc

网络类型,包括VPC和Classic。

Status String active

通用型NAS挂载点状态,包括active和inactive。

VpcId String vpc-bp1sevsgtqvk5gxbl****

专有网络ID。

VswId String vsw-bp1omfzsszekkvaxn****

交换机ID。

Packages Array

存储包信息。

Package
ExpiredTime String 2020-01-05T16:00:00Z

存储包到期时间。

PackageId String naspackage-0be9c4b624-37****

存储包ID。

PackageType String hybrid

存储包类型。

Size Long 107374182400

存储包容量大小。

StartTime String 2019-12-05T01:40:56Z

存储包起始时间。

ProtocolType String NFS

协议类型,包括NFS和SMB。

RegionId String cn-hangzhou

地域ID。

Status String Pending

文件系统状态,仅极速型NAS返回该字段。

  • Pending:表示当前文件系统正在处理中。
  • Running:表示当前文件系统可用,当状态为Running时才可以进行后续操作(例如:创建挂载点等)。
  • Stopped:表示当前文件系统不可用。
StorageType String Performance

存储类型:

  • 通用型NAS:Capacity(容量型)、Performance(性能型)。
  • 极速型NAS:standard(标准型)、advance(高级型)。
SupportedFeatures List Lifecycle

文件系统支持的功能。

Version String 1

文件系统版本号。仅适用于极速型NAS。

ZoneId String cn-hangzhou-b

文件系统所在的可用区。

示例

请求示例

GET https://nas.cn-hangzhou.aliyuncs.com/?Action=DescribeFileSystems
&FileSystemId=109c04****
&<公共请求参数>

正常返回示例

XML 格式

<DescribeFileSystemsResponse>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <PageSize>1</PageSize>
    <RequestId>035B3A3A-E514-4B41-B906-5D906CFBD65F</RequestId>
    <FileSystems>
        <FileSystem>
            <FileSystemId>109c04****</FileSystemId>
            <ProtocolType>NFS</ProtocolType>
            <RegionId>cn-hangzhou</RegionId>
            <CreateTime>2017-05-27T15:43:06CST</CreateTime>
            <Destription></Destription>
            <MountTargets>
                <MountTarget>
                    <MountTargetDomain>109c042666-w****.cn-hangzhou.nas.aliyuncs.com</MountTargetDomain>
                </MountTarget>
            </MountTargets>
            <StorageType>Performance</StorageType>
            <MeteredSize>1611661312</MeteredSize>
        </FileSystem>
    </FileSystems>
</DescribeFileSystemsResponse>

JSON 格式

{
  "PageNumber": 1,
  "TotalCount": 1,
  "PageSize": 1,
  "RequestId": "BC7C825C-5F65-4B56-BEF6-98C56C7C546E",
  "FileSystems": {
    "FileSystem": [
      {
        "FileSystemId": "31a8e4****",
        "Description": "31a8e48eda",
        "Packages": {
          "Package": [
            {
              "PackageId": ""
            }
          ]
        },
        "ProtocolType": "NFS",
        "RegionId": "cn-shanghai",
        "CreateTime": "2017-04-18T00:22:56CST",
        "Destription": "31a8e48eda",
        "ZoneId": "cn-shanghai-b",
        "MountTargets": {
          "MountTarget": [
            {
              "Status": "active",
              "NetworkType": "vpc",
              "VswId": "vsw-uf64zi0nn71ntvkbz****",
              "AccessGroupName": "DEFAULT_VPC_GROUP_NAME",
              "VpcId": "vpc-uf65wx2khu08h4dlw****",
              "MountTargetDomain": "31a8e48eda-y****.cn-shanghai.nas.aliyuncs.com"
            }
          ]
        },
        "StorageType": "Performance",
        "MeteredSize": 4295639040
      }
    ]
  }
}

错误码

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