DescribeDrives - Elastic Desktop Service - Alibaba Cloud Documentation Center

Queries user-level storage resources.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	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
UserId	string	No	The user ID.	user01
DomainIds	array	No	The IDs of the storage resources.
	string	No	The ID of the storage resource.	dom-aaaa****
ResourceType	string	No	The type of the storage resource. Valid values: NAS: NAS storage PDS: PDS storage Valid values: NAS : PDS :	NAS
MaxResults	integer	No	The number of entries per page. Maximum value: 500. Default value: 20.	20
NextToken	string	No	A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.	AAAA****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	B7AA****
Success	boolean	Indicates whether the request was successful.	true
Code	string	The response code. The value 200 indicates that the request was successful.	200
Message	string	The returned message.	successful
Count	integer	The total number of storage resources.	2
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.	AAAA****
Drives	array<object>	The user-level storage resources.
	array<object>	The user-level storage resource.
Id	string	The user ID. Note You can ignore this parameter.	1
GmtCreate	string	The time when the storage resource was created.	2025-07-02T08:42:26.000+00:00
GmtModified	string	The time when the storage resource was modified.	2025-07-07T02:46:04.000+00:00
AliUid	integer	The ID of the Alibaba Cloud account.	1202****
DomainId	string	The ID of the storage resource.	dom-aaaa****
ExternalDomainId	string	The ID of the external storage resource. If ResourceType is set to NAS, the NAS ID is returned for this parameter. If ResourceType is set to PDS, the PDS ID is returned for this parameter.	0976****
DriveId	string	The ID of the user-level storage resource.	dri-aaaa****
ExternalDriveId	string	The ID of the storage resource at the external user level. Note This parameter is returned only if ResourceType is set to PDS.	1100****
UserId	string	The user ID.	user01
ExternalUserId	string	The ID of the external user. Note This parameter is returned only if ResourceType is set to PDS.	user01@cn-hangzhou.120****
Name	string	The name of the storage resource.	test****
Description	string	The introduction to the storage resource.	test****
TotalSize	integer	The total amount of user-level storage capacity.	536870912000
UsedSize	integer	The amount of user-level storage capacity used.	243175936
Status	string	The status of the user-level storage resource. Valid values: INIT: initializing MAINTAIN: maintaining DELETING: deleting INVALID: invalid NORMAL: normal FAIL: failed Valid values: INIT : MAINTAIN : DELETING : INVALID : NORMAL : FAIL :	NORMAL
Type	string	The usage of the storage resource. Valid values: DESKTOP: data disk space USER_PROFILE: personal data space Valid values: DESKTOP : USER_PROFILE :	USER_PROFILE
ProfileRoaming	boolean	Note This parameter is deprecated.	-
DesktopGroupCount	integer	The number of associated computer pools. Note This parameter is returned only if ResourceType is set to NAS and Type is set to USER_PROFILE.	1
DesktopGroups	array<object>	The details of the associated cloud computers. Note This parameter is returned only if ResourceType is set to NAS and Type is set to USER_PROFILE.
	object	The details of the computer pool.
DesktopGroupId	string	The ID of the computer pool.	dg-aaaa****
DesktopGroupName	string	The name of the computer pool.	group01
EnableProfileManagement	boolean	Indicates whether the UPM feature is enabled.	true

Examples

Success response

JSON format

{
  "RequestId": "B7AA****",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "Count": 2,
  "NextToken": "AAAA****",
  "Drives": [
    {
      "Id": "1",
      "GmtCreate": "2025-07-02T08:42:26.000+00:00",
      "GmtModified": "2025-07-07T02:46:04.000+00:00",
      "AliUid": 0,
      "DomainId": "dom-aaaa****",
      "ExternalDomainId": "0976****",
      "DriveId": "dri-aaaa****",
      "ExternalDriveId": "1100****",
      "UserId": "user01",
      "ExternalUserId": "user01@cn-hangzhou.120****",
      "Name": "test****",
      "Description": "test****",
      "TotalSize": 536870912000,
      "UsedSize": 243175936,
      "Status": "NORMAL",
      "Type": "USER_PROFILE",
      "ProfileRoaming": true,
      "DesktopGroupCount": 1,
      "DesktopGroups": [
        {
          "DesktopGroupId": "dg-aaaa****",
          "DesktopGroupName": "group01"
        }
      ],
      "EnableProfileManagement": true
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.