Queries the information of 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 system), extreme (Extreme NAS file system), and cpfs (Cloud Paralleled File System).
  • Default value: all.
VpcId String No vpc-bp1sevsgtqvk5gxbl****

The ID of the virtual private cloud (VPC).

You must specify the VPC where the Elastic Compute Service (ECS) instance resides. This is the same ECS instance that is used to mount the file system.

PageSize Integer No 1

The number of entries to return on each page.

  • Maximum value: 100.
  • Default value: 10
PageNumber Integer No 1

The number of the page to return.

  • Pages start from page 1.
  • Default value: 1

Response parameters

Parameter Type Example Description
PageNumber Integer 1

The page number of the returned page.

PageSize Integer 1

The number of entries returned per page.

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

The ID of the request.

TotalCount Integer 1

The total number of file systems.

FileSystems Array

The description of file systems.

FileSystem
Bandwidth Long 150

The bandwidth of the file system. Unit: Mbit/s. This parameter is unavailable for General-purpose NAS file systems.

Capacity Long 1

The capacity of the file system. Unit: GB.

ChargeType String PayAsYouGo

The billing method of the file system. Valid values:

  • Subscription
  • PayAsYouGo
  • Package: storage plan
CreateTime String 2017-05-27T15:43:06CST

The creation time of the file system.

Description String The description of the file system.

The description of the file system.

EncryptType Integer 1

Indicates whether data that is stored in the file system is encrypted. Valid values:

  • 0: The data is not encrypted.
  • 1: The data is encrypted.
ExpiredTime String 1572174830000

The expiration time of the file system.

FileSystemId String 109c04****

The ID of the file system.

FileSystemType String all

The type of the file system.

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

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

Ldap Struct

The configurations of the Lightweight Directory Access Protocol (LDAP) service. These configurations are available only for CPFS file systems.

BindDN String cn=alibaba,dc=com

The LDAP entry.

SearchBase String dc=example

The LDAP search base.

URI String ldap://ldap.example.example

The LDAP Uniform Resource Identifier (URI).

MeteredIASize Long 362832

The used storage space of the Infrequent Access (IA) storage class.

MeteredSize Long 1611661312

The used storage space of the file system. The value of this parameter indicates the maximum used storage space over the last hour. Unit: byte.

MountTargets Array

The information of mount targets.

MountTarget
AccessGroupName String test-001

The name of the permission group that applies to the mount target.

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

The domain name of the mount target.

NetworkType String vpc

The network type of the mount target. Valid values: VPC and Classic.

Status String active

The status of the mount target. This parameter is available only for General-purpose NAS file systems. Valid values: active and inactive.

VpcId String vpc-bp1sevsgtqvk5gxbl****

The ID of the VPC.

VswId String vsw-bp1omfzsszekkvaxn****

The ID of the VSwitch.

Packages Array

The information of storage plans.

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

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

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

The ID of the storage plan.

PackageType String hybrid

The type of the storage plan.

Size Long 107374182400

The storage capacity that is provided by the storage plan.

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

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

ProtocolType String NFS

The protocol that the file system uses. Valid values: NFS and SMB.

RegionId String cn-hangzhou

The region ID of the instance.

Status String Pending

The status of the file system. This parameter is available only for Extreme NAS file systems.

  • Pending: An operation on the file system is in progress.
  • Running: The file system is available. Note: Before you perform subsequent operations such as creating mount targets, you must make sure that the file system is in the Running state.
  • Stopped: The file system is unavailable.
StorageType String Performance

The subtype of the file system.

  • Valid values for General-purpose NAS file systems: Capacity and Performance.
  • Valid values for Extreme NAS file systems: standard and advance.
SupportedFeatures List Lifecycle

The features that are supported by the file system.

Version String 1

The version number of the file system. This parameter is available only for Extreme NAS file system.

ZoneId String cn-hangzhou-b

The ID of the zone where the file system resides.

Examples

Sample requests

GET https://nas.cn-hangzhou.aliyuncs.com/?Action=DescribeFileSystems
&FileSystemId=109c04****
&<Common request parameters>

Sample success responses

XML format

<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 format

{
  "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
      }
    ]
  }
}

Error codes

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