DescribeNASFileSystems - Elastic Desktop Service - Alibaba Cloud Documentation Center

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region.	cn-hangzhou
OfficeSiteId	string	No	The ID of the workspace.	cn-hangzhou+dir-363353****
MaxResults	integer	No	The number of entries to return on each page. Maximum value: 100. Default value: 10.	10
NextToken	string	No	The token that determines the start point of the query. Set the value to the NextToken value that is returned from the last call.	caeba0bbb2be03f84eb48b699f0a4883
FileSystemId	array	No	The IDs of the NAS file systems.
	string	No	The ID of the NAS file system.	04f314****
MatchCompatibleProfile	boolean	No	Specifies whether to filter NAS file systems that only support the user profile management (UPM) feature.	false

Response parameters

Parameter	Type	Description	Example
	object	The information that is returned.
NextToken	string	The token that is used for the next query. If this parameter is left empty, all results are returned.	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	The ID of the request.	269BDB16-2CD8-4865-84BD-11C40BC21DB0
FileSystems	array	Details of the NAS file systems.
	object	Details of the NAS file system.
Capacity	long	The total capacity of the NAS file system. Unit: GiB. The Capacity type has 10 PiB of storage, which is equal to 10,485,760 GiB. The Performance type has 1 PiB of storage, which is equal to 1,048,576 GiB.	10485760
MountTargetStatus	string	The status of the mount target.	Active
CreateTime	string	The time when the NAS file system was created.	2021-05-10T11:39Z
OfficeSiteId	string	The ID of the workspace.	cn-hangzhou+dir-363353****
SupportAcl	boolean	Indicates whether the Server Message Block (SMB) access control list (ACL) feature is enabled.	false
StorageType	string	The storage type of the NAS file system.	Capacity
OfficeSiteName	string	The name of the workspace.	test
RegionId	string	The ID of the region.	cn-hangzhou
FileSystemId	string	The ID of the NAS file system.	04f314****
FileSystemType	string	The type of the NAS file system. Valid value: `standard`.	standard
FileSystemName	string	The name of the NAS file system.	testNAS
MeteredSize	long	The used storage of the NAS file system. Unit: byte.	0
MountTargetDomain	string	The domain name of the mount target.	04f314**-at*.cn-hangzhou.nas.aliyuncs.com
Description	string	The description of the NAS file system.	testDescription
ZoneId	string	The zone.	cn-hangzhou-f
FileSystemStatus	string	The status of the NAS file system.	Running
EncryptionEnabled	boolean	Indicates whether disk encryption is enabled.	false
ProfileCompatible	boolean	Indicates whether the UPM feature is supported.	false
DesktopGroups	array	The desktop groups that are associated with the NAS file systems that support the UPM feature.
	object	The desktop group.
DesktopGroupId	string	The ID of the desktop group.	dg-9eeyf15b25nyl****
DesktopGroupName	string	The name of the desktop group.	test_dg

Example

Normal return example

JSONFormat

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

Error codes

For a list of error codes, visit the API error center.