Queries file systems and mount targets.

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 ListFileSystemWithMountTargets

The operation that you want to perform. Set the value to ListFileSystemWithMountTargets.

PageNumber Integer No 1

The page number of the page to return.

Page numbers start from 1.

Default value: 1

PageSize Integer No 10

The number of entries to return on each page. Valid values: 1 to 50.

Default value: 10

Response parameters

Parameter Type Example Description
FileSystemList Array of FileSystems

The list of file systems.

FileSystems
BandWidth Integer 150

The bandwidth of the file system. Unit: MB/s.

Capacity Integer 1

The capacity of the file system. Unit: GiB.

CreateTime String 2018-05-31T10:44:21CST

The time when the file system was created.

Destription String exampleDescription

The description of the file system.

EncryptType Integer 1

Indicates whether the file system is encrypted. Valid values:

  • 0: The file system is not encrypted.
  • 1: The file system is encrypted.
FileSystemId String 088b****

The ID of the file system.

FileSystemType String NAS

The type of the file system. Valid values:

  • standard: General-purpose NAS file system
  • extreme: Extreme NAS file system
MeteredSize Integer 1216816455

The used capacity of the file system. Unit: bytes.

MountTargetList Array of MountTargets

The list of mount targets.

MountTargets
AccessGroup String DEFAULT_VPC_GROUP_NAME

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

MountTargetDomain String 088b****-lj2.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: virtual private cloud (VPC)
  • Classic: the classic network
Status String Active

The status of the mount target. Valid values:

  • Active: The mount target is available.
  • Inactive: The mount target is inactive.
  • Pending: The mount target is being created or modified.
  • Deleting: The mount target is being deleted.
VpcId String vpc-bp1evs****

The ID of the VPC.

VswId String vsw-bp10wq****

The ID of the vSwitch.

PackageList Array of Packages

The list of storage plans.

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

The ID of the storage plan.

ProtocolType String NFS

The protocol type of the file system. Valid values:

  • NFS
  • SMB
RegionId String cn-hangzhou

The ID of the region.

Status String Running

The status of the file system. Valid values:

  • Pending: The file system is being created or modified.
  • Running: The file system is available.
  • Stopped: The file system is stopped.
  • Extending: The file system is being scaled out.
  • Stopping: The file system is being stopped.
  • Deleting: The file system is being deleted.
StorageType String Performance

The storage type of the file system.

  • If FileSystemType is set to standard, the StorageType parameter has the following valid values: Capacity and Performance.
  • If FileSystemType is set to extreme, the StorageType parameter has the following valid values: standard and advance.
PageNumber Integer 1

The page number of the returned page.

PageSize Integer 1

The number of entries returned per page.

RequestId String 22025129-3BB9-4250-9949-E468AF3A****

The ID of the request.

TotalCount Integer 1

The total number of entries.

Examples

Sample requests

https://ehpc.cn-hangzhou.aliyuncs.com/?Action=ListFileSystemWithMountTargets
&<Common request parameters>

Sample success responses

XML format

<ListFileSystemWithMountTargetsResponse>
      <TotalCount>1</TotalCount>
      <PageSize>1</PageSize>
      <RequestId>22025129-3BB9-4250-9949-E468AF3A****</RequestId>
      <PageNumber>1</PageNumber>
      <FileSystemList>
            <FileSystes>
                  <StorageType>Performance</StorageType>
                  <ProtocolType>NFS</ProtocolType>
                  <CreateTime>2018-05-31T10:44:21CST</CreateTime>
                  <Destription>exampleDescription</Destription>
                  <FileSystemId>088b****</FileSystemId>
                  <FileSystemType>NAS</FileSystemType>
                  <RegionId>cn-hangzhou</RegionId>
                  <MeteredSize>1216816455680</MeteredSize>
            </FileSystes>
            <FileSystes>
                  <MountTargetList>
                        <MountTargets>
                              <Status>Active</Status>
                              <VpcId>vpc-bp1evs****</VpcId>
                              <VswId>vsw-bp10wq****</VswId>
                              <MountTargetDomain>088b****-lj2.cn-hangzhou.nas.aliyuncs.com</MountTargetDomain>
                              <AccessGroup>DEFAULT_VPC_GROUP_NAME</AccessGroup>
                              <NetworkType>Vpc</NetworkType>
                        </MountTargets>
                  </MountTargetList>
                  <PackageList>
                        <Packages>
                              <PackageId>naspackage-0be9c4b624-37****</PackageId>
                        </Packages>
                  </PackageList>
            </FileSystes>
      </FileSystemList>
</ListFileSystemWithMountTargetsResponse>

JSON format

{
    "TotalCount":"1",
    "PageSize":"1",
    "RequestId":"22025129-3BB9-4250-9949-E468AF3A****",
    "PageNumber":"1",
    "FileSystemList":{
        "FileSystes":[
            {
                "StorageType":"Performance",
                "ProtocolType":"NFS",
                "CreateTime":"2018-05-31T10:44:21CST",
                "Destription":"exampleDescription",
                "FileSystemId":"088b****",
                "FileSystemType":"NAS",
                "RegionId":"cn-hangzhou",
                "MeteredSize":"1216816455680"
            },
            {
                "MountTargetList":{
                    "MountTargets":[
                        {
                            "Status":"Active",
                            "VpcId":"vpc-bp1evs****",
                            "VswId":"vsw-bp10wq****",
                            "MountTargetDomain":"088b****-lj2.cn-hangzhou.nas.aliyuncs.com",
                            "AccessGroup":"DEFAULT_VPC_GROUP_NAME",
                            "NetworkType":"Vpc"
                        }
                    ]
                },
                "PackageList":{
                    "Packages":[
                        {
                            "PackageId":"naspackage-0be9c4b624-37****"
                        }
                    ]
                }
            }
        ]
    }
}

Error codes

HttpCode Error code Error message Description
503 ServiceUnavailable The request has failed due to a temporary failure of the server The error message returned because the request has failed. The service is temporarily unavailable.

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