Queries the details about Apsara File Storage NAS 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 DescribeNASFileSystems

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

OfficeSiteId String Yes cn-hangzhou+dir-363353****

The ID of the workspace.

RegionId String Yes cn-hangzhou

The ID of the region.

FileSystemId.N RepeatList No 04f314****

The ID of NAS file system N.

MaxResults Integer No 10

The number of entries to return on each page.

Maximum value: 100.

Default value: 10.

NextToken String No caeba0bbb2be03f84eb48b699f0a4883

The token used to start the next query.

Response parameters

Parameter Type Example Description
FileSystems Array of FileSystem

Details about the NAS file systems.

Capacity Long 10485760

The total capacity of the NAS file system. Unit: GiB. Valid value: 10 PiB (10,485,760 GiB).

CreateTime String 2021-05-10T11:39Z

The time when the NAS file system was created.

Description String testDescription

The description of the NAS file system.

FileSystemId String 04f314****

The ID of the NAS file system.

FileSystemName String testNAS

The name of the NAS file system.

FileSystemStatus String Running

The status of the NAS file system. Valid values:

  • Pending: The NAS file system is being created.
  • Running: The NAS file system is running.
  • Stopped: The NAS file system is stopped.
  • Deleting: The NAS file system is being deleted.
  • Deleted: The NAS file system is deleted.
  • Invalid: The NAS file system is invalid.
FileSystemType String standard

The type of the NAS file system. Valid value: standard. This value indicates that the NAS file system is a General-purpose one.

MeteredSize Long 0

The used storage of the NAS file system. Unit: byte.

MountTargetDomain String 04f314****-at***.cn-hangzhou.nas.aliyuncs.com

The domain name of the mount target.

MountTargetStatus String Active

The status of the mount target. Valid values:

  • Pending: The mount target is being created.
  • Active: The mount target is enabled.
  • Inactive: The mount target is disabled.
  • Deleting: The mount target is being deleted.
  • Invalid: The mount target is invalid.
OfficeSiteId String cn-hangzhou+dir-363353****

The ID of the workspace.

RegionId String cn-hangzhou

The ID of the region.

StorageType String Capacity

The storage type of the NAS file system. Valid value: Capacity. This value indicates that the NAS file system is a Capacity one.

SupportAcl Boolean false

Indicates whether the Server Message Block (SMB) access control list (ACL) feature is enabled.

ZoneId String cn-hangzhou-f

The ID of the zone.

NextToken String caeba0bbb2be03f84eb48b699f0a4883

The token used to start the next query. If this parameter is empty, all results are returned.

RequestId String 269BDB16-2CD8-4865-84BD-11C40BC21DB0

The ID of the request.

Examples

Sample requests

https://ecd.cn-hangzhou.aliyuncs.com/?Action=DescribeNASFileSystems
&OfficeSiteId=cn-hangzhou+dir-363353****
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

<DescribeNASFileSystems>
      <FileSystems>
            <SupportAcl>false</SupportAcl>
            <StorageType>Capacity</StorageType>
            <Description>testDescription</Description>
            <ZoneId>cn-hangzhou-f</ZoneId>
            <CreateTime>2021-05-10T11:39Z</CreateTime>
            <MountTargetStatus>Active</MountTargetStatus>
            <MeteredSize>0</MeteredSize>
            <OfficeSiteId>cn-hangzhou+dir-363353****</OfficeSiteId>
            <MountTargetDomain>04f314****-at***.cn-hangzhou.nas.aliyuncs.com</MountTargetDomain>
            <Capacity>10485760</Capacity>
            <FileSystemType>standard</FileSystemType>
            <FileSystemStatus>Running</FileSystemStatus>
            <FileSystemName>testNAS</FileSystemName>
            <FileSystemId>04f314****</FileSystemId>
            <RegionId>cn-hangzhou</RegionId>
      </FileSystems>
      <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
      <RequestId>269BDB16-2CD8-4865-84BD-11C40BC21DB0</RequestId>
</DescribeNASFileSystems>

JSON format

{
	"FileSystems": [{
		"SupportAcl": "false",
		"StorageType": "Capacity",
		"Description": "testDescription",
		"ZoneId": "cn-hangzhou-f",
		"CreateTime": "2021-05-10T11:39Z",
		"MountTargetStatus": "Active",
		"MeteredSize": "0",
		"OfficeSiteId": "cn-hangzhou+dir-363353****",
		"MountTargetDomain": "04f314****-at***.cn-hangzhou.nas.aliyuncs.com",
		"Capacity": "10485760",
		"FileSystemType": "standard",
		"FileSystemStatus": "Running",
		"FileSystemName": "testNAS",
		"FileSystemId": "04f314****",
		"RegionId": "cn-hangzhou"
	}],
	"NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
	"RequestId": "269BDB16-2CD8-4865-84BD-11C40BC21DB0"
}

Error codes

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