Queries the information about file systems.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeFileSystems

The operation that you want to perform.

Set the value to DescribeFileSystems.

FileSystemId String No 109c04****

The ID of the file system.

FileSystemType String No standard

The type of the file system.

Valid values:

  • all: all file systems
  • standard: General-purpose NAS file systems
  • extreme: Extreme NAS file systems
  • cpfs: CPFS file systems
VpcId String No vpc-bp1sevsgtqvk5gxbl****

The ID of the virtual private cloud (VPC).

If you want to mount the file system on an Elastic Compute Service (ECS) instance, the file system and the ECS instance must reside in the same VPC.

PageSize Integer No 1

The number of entries to return on each page.

Valid values: 1 to 100.

Default value: 10.

PageNumber Integer No 1

The number of the page to return.

Pages start from page 1. Default value: 1.

Tag.N.Key String No None

The key of the tag.

Limits:

  • Valid values of N: 1 to 20.
  • The tag key must be 1 to 128 characters in length.
  • The tag key cannot start with aliyun or acs:.
  • The tag key cannot contain http:// or https://.
Tag.N.Value String No None

The value of the tag.

Limits:

  • Valid values of N: 1 to 20.
  • The key value must be 1 to 128 characters in length.
  • The key value cannot start with aliyun or acs:.
  • The key value cannot contain http:// or https://.

Response parameters

Parameter Type Example Description
FileSystems Array of FileSystem

The file systems.

FileSystem
Status String Pending

The status of the file system.

This parameter is returned for Extreme NAS and CPFS file systems. Valid values:

  • Pending: The file system is being created or modified.
  • Running: The file system is available. Before you create a mount target for the file system, make sure that the file system is in the Running state.
  • Stopped: The file system is unavailable.
  • Extending: The file system is being scaled out.
  • Stopping: The file system is being disabled.
  • Deleting: The file system is being deleted.
MeteredIASize Long 362832

The storage usage of the Infrequent Access (IA) storage medium.

Unit: bytes.

Capacity Long 1

The capacity of the file system.

Unit: GiB.

CreateTime String 2017-05-27T15:43:06CST

The time when the file system was created.

ChargeType String PayAsYouGo

The billing method.

Valid values:

  • Subscription: The subscription billing method is used.
  • PayAsYouGo: The pay-as-you-go billing method is used.
  • Package: A storage plan is attached to the file system.
Tags Array of Tag

The tags that are attached to the file system.

Tag
Key String sdf

The tag key.

Value String asd123

The tag value.

StorageType String Performance

The type of the storage.

Valid values:

  • Valid values for General-purpose NAS file systems: Capacity and Performance.
  • Valid values for Extreme NAS file systems: standard and advance.
  • Valid values for CPFS file systems: advance_100 (100 MB/s/TiB baseline) and advance_200 (200 MB/s/TiB baseline).
MeteredSize Long 1611661312

The storage usage of the file system.

The value of this parameter is the maximum storage usage of the file system within the previous hour. Unit: byte.

Description String 31a8e48eda

The description of the file system.

Bandwidth Long 150

The bandwidth of the file system.

Unit: MB/s. This parameter is unavailable for General-purpose NAS file systems.

SupportedFeatures Array of String Lifecycle

The features that are supported by the file system.

Valid values:

  • Lifecycle: the lifecycle management feature.
  • ACL: the access control list feature.
  • Ipv6: the IPv6 feature.
Note IPv6 is supported by Extreme NAS files systems only in the Chinese mainland regions.
Version String 1

The version number of the file system.

This parameter is available only for Extreme NAS file systems.

ProtocolType String NFS

The type of the protocol.

Valid values:

  • NFS: Network File System (NFS) protocol.
  • SMB: Server Message Block (SMB) protocol.
  • cpfs: protocols supported by CPFS file systems.
MountTargets Array of MountTarget

The mount targets.

MountTarget
VpcId String vpc-bp1sevsgtqvk5gxbl****

The ID of the virtual private cloud (VPC).

Status String active

The status of the mount target.

Valid values:

  • Active: The mount target is available.
  • Inactive: The mount target is unavailable.
  • Pending: The mount target is being created or modified.
  • Deleting: The mount target is being deleted.
ClientMasterNodes Array of ClientMasterNode

The information about the client management nodes.

ClientMasterNode
EcsId String i-hp3i3odi5ory1buo****

The ID of the ECS instance on the client management node.

DefaultPasswd String 123456

The default logon password of the ECS instance on the client management node.

EcsIp String 192.168.1.0

The IP address of the ECS instance on the client management node.

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

The mount target.

AccessGroupName String test-001

The name of the permission group that is attached to the mount target.

DualStackMountTargetDomain String 174494b666-x****.dualstack.cn-hangzhou.nas.aliyuncs.com

The mount target that supports IPv4 and IPv6.

VswId String vsw-bp1omfzsszekkvaxn****

The ID of the vSwitch.

Tags Array of Tag

The tags that are attached to the mount target.

Tag
Key String adasfsdfd

The tag key.

Value String afsa

The tag value.

NetworkType String vpc

The network type.

Valid values:

  • vpc: VPC
  • classic: classic network
KMSKeyId String 0e478b7a-4262-4802-b8cb-00d3fb40****

The ID of the key that is managed by Key Management Service (KMS).

RegionId String cn-hangzhou

The region ID.

FileSystemType String all

The type of the file system.

Valid values:

  • standard: General-purpose NAS file system
  • extreme: Extreme NAS file system
  • cpfs: CPFS file system
FileSystemId String 109c04****

The ID of the file system.

EncryptType Integer 1

The encryption type.

Valid values:

  • 0: The data in the file system is not encrypted.
  • 1: NAS-managed keys are used to encrypt the data in the file system.
  • 2: User-managed keys are used to encrypt the data in the file system.
Ldap Object

The configuration of the Lightweight Directory Access Protocol (LDAP).

This parameter is available only for CPFS file systems.

BindDN String cn=alibaba,dc=com

An LDAP entry.

SearchBase String dc=example

An LDAP search base.

URI String ldap://ldap.example.example

An LDAP URI.

ExpiredTime String 2017-08-27T15:43:06CST

The time when the file system expires.

ZoneId String cn-hangzhou-b

The ID of the zone where the file system resides.

Packages Array of Package

The storage plans.

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

The start time of the validity period for the storage plan.

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

The end time of the validity period for the storage plan.

Size Long 107374182400

The capacity of the storage plan.

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

The ID of the storage plan.

PackageType String hybrid

The type of the storage plan.

Valid values:

  • ssd: the storage plan for Performance NAS file systems.
  • hybrid: the storage plan for Capacity NAS file systems.
TotalCount Integer 1

The total number of file systems.

RequestId String 035B3A3A-E514-4B41-B906-5D906CFB****

The ID of the request.

PageSize Integer 1

The number of entries returned per page.

PageNumber Integer 1

The page number of the returned page.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeFileSystems
&FileSystemId=109c04****
&FileSystemType=standard
&VpcId=vpc-bp1sevsgtqvk5gxbl****
&PageSize=1
&PageNumber=1
&Tag=[{"Key":"None","Value":"None"}]
&<Common request parameters>

Sample responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeFileSystemsResponse>
    <FileSystems>
        <Status>Pending</Status>
        <MeteredIASize>362832</MeteredIASize>
        <Capacity>1</Capacity>
        <CreateTime>2017-05-27T15:43:06CST</CreateTime>
        <ChargeType>PayAsYouGo</ChargeType>
        <Tags>
            <Key>sdf</Key>
            <Value>asd123</Value>
        </Tags>
        <StorageType>Performance</StorageType>
        <MeteredSize>1611661312</MeteredSize>
        <Description>31a8e48eda</Description>
        <Bandwidth>150</Bandwidth>
        <SupportedFeatures>Lifecycle</SupportedFeatures>
        <Version>1</Version>
        <ProtocolType>NFS</ProtocolType>
        <MountTargets>
            <VpcId>vpc-bp1sevsgtqvk5gxbl****</VpcId>
            <Status>active</Status>
            <ClientMasterNodes>
                <EcsId>i-hp3i3odi5ory1buo****</EcsId>
                <DefaultPasswd>123456</DefaultPasswd>
                <EcsIp>192.168.1.0</EcsIp>
            </ClientMasterNodes>
            <MountTargetDomain>109c042666-w****.cn-hangzhou.nas.aliyuncs.com</MountTargetDomain>
            <AccessGroupName>test-001</AccessGroupName>
            <DualStackMountTargetDomain>174494b666-x****.dualstack.cn-hangzhou.nas.aliyuncs.com</DualStackMountTargetDomain>
            <VswId>vsw-bp1omfzsszekkvaxn****</VswId>
            <Tags>
                <Key>adasfsdfd</Key>
                <Value>afsa</Value>
            </Tags>
            <NetworkType>vpc</NetworkType>
        </MountTargets>
        <KMSKeyId>0e478b7a-4262-4802-b8cb-00d3fb40****</KMSKeyId>
        <RegionId>cn-hangzhou</RegionId>
        <FileSystemType>all</FileSystemType>
        <FileSystemId>109c04****</FileSystemId>
        <EncryptType>1</EncryptType>
        <Ldap>
            <BindDN>cn=alibaba,dc=com</BindDN>
            <SearchBase>dc=example</SearchBase>
            <URI>ldap://ldap.example.example</URI>
        </Ldap>
        <ExpiredTime>2017-08-27T15:43:06CST</ExpiredTime>
        <ZoneId>cn-hangzhou-b</ZoneId>
        <Packages>
            <StartTime>2019-12-05T01:40:56Z</StartTime>
            <ExpiredTime>2020-01-05T16:00:00Z</ExpiredTime>
            <Size>107374182400</Size>
            <PackageId>naspackage-0be9c4b624-37****</PackageId>
            <PackageType>hybrid</PackageType>
        </Packages>
    </FileSystems>
    <TotalCount>1</TotalCount>
    <RequestId>035B3A3A-E514-4B41-B906-5D906CFB****</RequestId>
    <PageSize>1</PageSize>
    <PageNumber>1</PageNumber>
</DescribeFileSystemsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "FileSystems" : [ {
    "Status" : "Pending",
    "MeteredIASize" : 362832,
    "Capacity" : 1,
    "CreateTime" : "2017-05-27T15:43:06CST",
    "ChargeType" : "PayAsYouGo",
    "Tags" : [ {
      "Key" : "sdf",
      "Value" : "asd123"
    } ],
    "StorageType" : "Performance",
    "MeteredSize" : 1611661312,
    "Description" : "31a8e48eda",
    "Bandwidth" : 150,
    "SupportedFeatures" : [ "Lifecycle" ],
    "Version" : "1",
    "ProtocolType" : "NFS",
    "MountTargets" : [ {
      "VpcId" : "vpc-bp1sevsgtqvk5gxbl****",
      "Status" : "active",
      "ClientMasterNodes" : [ {
        "EcsId" : "i-hp3i3odi5ory1buo****",
        "DefaultPasswd" : "123456",
        "EcsIp" : "192.168.1.0"
      } ],
      "MountTargetDomain" : "109c042666-w****.cn-hangzhou.nas.aliyuncs.com",
      "AccessGroupName" : "test-001",
      "DualStackMountTargetDomain" : "174494b666-x****.dualstack.cn-hangzhou.nas.aliyuncs.com",
      "VswId" : "vsw-bp1omfzsszekkvaxn****",
      "Tags" : [ {
        "Key" : "adasfsdfd",
        "Value" : "afsa"
      } ],
      "NetworkType" : "vpc"
    } ],
    "KMSKeyId" : "0e478b7a-4262-4802-b8cb-00d3fb40****",
    "RegionId" : "cn-hangzhou",
    "FileSystemType" : "all",
    "FileSystemId" : "109c04****",
    "EncryptType" : 1,
    "Ldap" : {
      "BindDN" : "cn=alibaba,dc=com",
      "SearchBase" : "dc=example",
      "URI" : "ldap://ldap.example.example"
    },
    "ExpiredTime" : "2017-08-27T15:43:06CST",
    "ZoneId" : "cn-hangzhou-b",
    "Packages" : [ {
      "StartTime" : "2019-12-05T01:40:56Z",
      "ExpiredTime" : "2020-01-05T16:00:00Z",
      "Size" : 107374182400,
      "PackageId" : "naspackage-0be9c4b624-37****",
      "PackageType" : "hybrid"
    } ]
  } ],
  "TotalCount" : 1,
  "RequestId" : "035B3A3A-E514-4B41-B906-5D906CFB****",
  "PageSize" : 1,
  "PageNumber" : 1
}

Error codes

HttpCode Error code Error message Description
404 InvalidFileSystem.NotFound The specified file system does not exist. The error message returned because the specified file system does not exist.

For a list of error codes, visit the API Error Center.