All Products
Search

This Product

    Elastic Desktop Service:DescribeNASFileSystems

    Document Center

    Elastic Desktop Service:DescribeNASFileSystems

    Last Updated:Jun 11, 2026

    Queries 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 None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The region ID. You can call the DescribeRegions operation to query the regions where Elastic Desktop Service (EDS) 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 pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.

    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 return only NAS file systems that are compatible with User Profile Management (UPM).

    false

    Response elements

    Element

    Type

    Description

    Example

    object

    The response data.

    NextToken

    string

    The token for the next page of results. If this parameter is empty, no more results are available.

    caeba0bbb2be03f84eb48b699f0a4883
    RequestId

    string

    The request ID.

    269BDB16-2CD8-4865-84BD-11C40BC21DB0
    FileSystems

    array<object>

    The details of the NAS file systems.

    array<object>

    The details of a NAS file system.

    Capacity

    integer

    The storage capacity of the NAS file system, in GiB.

    • If the storage type is capacity type, the capacity is 10 PiB (10,485,760 GiB).

    • If the storage type is performance type, the capacity is 1 PiB (1,048,576 GiB).

    10485760
    MountTargetStatus

    string

    The status of the mount target.

    Valid values:

    • Active :

      The mount target is active.

    • Inactive :

      The mount target is inactive.

    • Pending :

      The mount target is being created.

    • Deleting :

      The mount target is being deleted.

    • Invalid :

      The mount target is invalid.

    Active
    CreateTime

    string

    The creation time of the NAS file system.

    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 is supported.

    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 region ID.

    cn-hangzhou
    FileSystemId

    string

    The ID of the NAS file system.

    04f314****
    FileSystemType

    string

    The type of the NAS file system. Currently, only the standard type is supported. The value is always standard.

    Valid values:

    • standard :

      standard type

    standard
    FileSystemName

    string

    The name of the NAS file system.

    testNAS
    MeteredSize

    integer

    The amount of storage used by the NAS file system, in 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.

    cn-hangzhou-f
    FileSystemStatus

    string

    The status of the NAS file system.

    Valid values:

    • Stopped :

      The file system is stopped.

    • Running :

      The file system is running.

    • Deleted :

      The file system is deleted.

    • Pending :

      The file system is being created.

    • Deleting :

      The file system is being deleted.

    • Invalid :

      The 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 computer pools associated with the UPM-supported NAS file system.

    object

    The details of a computer pool.

    DesktopGroupId

    string

    The ID of the computer pool.

    dg-9eeyf15b25nyl****
    DesktopGroupName

    string

    The name of the computer pool.

    test_dg
    Scene

    string

    The use case of the NAS file system.

    Valid values:

    • Upm :

      UPM NAS

    • ShareNas :

      shared NAS file system

    Upm
    AppInstanceGroups

    array<object>

    The application delivery groups associated with the UPM-supported NAS file system.

    object

    The details of an application delivery group.

    AppInstanceGroupId

    string

    The ID of the application delivery group.

    aig-0bz55ibznu9p7****
    AppInstanceGroupName

    string

    The name of the application delivery group.

    DemoDeliveryGroup
    AllowOperateUserDrive

    boolean
    Note

    This parameter is not publicly available.

    SizeQuota

    integer

    OfficeSites

    array<object>

    The office networks associated with the file system.

    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
    ProductType

    string

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

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.