DescribeNASFileSystems - Elastic Desktop Service - Alibaba Cloud Documentation Center

Queries the information about File Storage NAS (NAS) file systems.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ecd:DescribeNASFileSystems	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.	cn-hangzhou
OfficeSiteId	string	No	The ID of the office network.	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.	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 include only NAS file systems that support the User Profile Management (UPM) feature in the query results.	false

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
NextToken	string	The token that determines the start point of the next query. This parameter is empty if no additional results exist.	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	The ID of the request.	269BDB16-2CD8-4865-84BD-11C40BC21DB0
FileSystems	array<object>	The NAS file systems.
FileSystem	object	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. The possible values include: 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.	Active
CreateTime	string	The time when the NAS file system was created.	2021-05-10T11:39Z
OfficeSiteId	string	The ID of the office network.	cn-hangzhou+dir-363353****
SupportAcl	boolean	Indicates whether the Server Message Block (SMB) access control list (ACL) feature was enabled.	false
StorageType	string	The storage type of the NAS file system. Valid values: Capacity Performance	Capacity
OfficeSiteName	string	The name of the office network.	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. The only valid value is `standard`.	standard
FileSystemName	string	The name of the NAS file system.	testNAS
MeteredSize	long	The used capacity of the NAS file system. Unit: bytes.	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 ID of the zone where the NAS file system resides.	cn-hangzhou-f
FileSystemStatus	string	The status of the NAS file system. The possible values include: 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.	Running
EncryptionEnabled	boolean	Indicates whether disk encryption is enabled.	false
ProfileCompatible	boolean	Indicates whether the User Profile Management (UPM) feature is supported.	false
DesktopGroups	array<object>	The cloud computer shares that are associated with the UPM-supported NAS file systems.
DesktopGroup	object	The cloud computer share.
DesktopGroupId	string	The ID of the cloud computer share.	dg-9eeyf15b25nyl****
DesktopGroupName	string	The name of the cloud computer share.	test_dg
Scene	string	The storage type of the NAS file system. Valid values: Upm: the UPM-supported NAS file system. ShareNas: the shared NAS file system. Enumeration Value: Upm: UPM NAS. ShareNas: .	Upm
AppInstanceGroups	array<object>	The application delivery groups that are associated with the UPM-supported NAS file systems.
AppInstanceGroup	object	The application delivery group that is associated with the UPM-supported NAS file system.
AppInstanceGroupId	string	The ID of the delivery group.	aig-0bz55ibznu9p7****
AppInstanceGroupName	string	The name of the delivery group.	DemoDeliveryGroup
AllowOperateUserDrive	boolean	Note This parameter is not publicly available.
OfficeSites	array<object>	The office networks.
OfficeSite	object	The office network.
OfficeSiteId	string	The ID of the office network.	cn-hangzhou+dir-363353****
OfficeSiteName	string	The name of the office network.	DemoOfficeNetwork

Examples

Sample success responses

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": false,
      "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": false,
      "ProfileCompatible": false,
      "DesktopGroups": [
        {
          "DesktopGroupId": "dg-9eeyf15b25nyl****",
          "DesktopGroupName": "test_dg"
        }
      ],
      "Scene": "Upm",
      "AppInstanceGroups": [
        {
          "AppInstanceGroupId": "aig-0bz55ibznu9p7****",
          "AppInstanceGroupName": "DemoDeliveryGroup"
        }
      ],
      "AllowOperateUserDrive": true,
      "OfficeSites": [
        {
          "OfficeSiteId": "cn-hangzhou+dir-363353****",
          "OfficeSiteName": "DemoOfficeNetwork"
        }
      ]
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-12-19	The response structure of the API has changed	View Change Details