DescribeNASFileSystems - Elastic Desktop Service - Alibaba Cloud Documentation Center

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecd:DescribeNASFileSystems

list

*All Resource

*

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.	04f314****
	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 elements

Element	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.
	array<object>	The NAS file system.
Capacity	integer	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. Valid values: Active : The mount target is enabled. Inactive : The mount target is disabled. Pending : The mount target is being created. 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 : Capacity type Performance : Performance type	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. Valid values: standard : Standard type	standard
FileSystemName	string	The name of the NAS file system.	testNAS
MeteredSize	integer	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. Valid values: Stopped : The NAS file system is stopped. Running : The NAS file system is running. Deleted : The NAS file system is deleted. Pending : The NAS file system is being created. Deleting : The NAS file system is being 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.
	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.	Upm
AppInstanceGroups	array<object>	The application delivery groups that are associated with the UPM-supported NAS file systems.
	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.
	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

Success response

JSON format

{
  "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": false,
      "OfficeSites": [
        {
          "OfficeSiteId": "cn-hangzhou+dir-363353****",
          "OfficeSiteName": "DemoOfficeNetwork"
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.