All Products
Search
Document Center

Elastic Desktop Service:DescribeDrives

Last Updated:Nov 14, 2025

Queries user-level storage resources.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
ecd:DescribeDrives
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

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
UserIdstringNo

The user ID.

user01
DomainIdsarrayNo

The IDs of the storage resources.

stringNo

The ID of the storage resource.

dom-aaaa****
ResourceTypestringNo

The type of the storage resource.

Valid values:

  • NAS: NAS storage
  • PDS: PDS storage
NAS
MaxResultsintegerNo

The number of entries per page.

  • Maximum value: 500.
  • Default value: 20.
20
NextTokenstringNo

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 parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

B7AA****
Successboolean

Indicates whether the request was successful.

true
Codestring

The response code. The value 200 indicates that the request was successful.

200
Messagestring

The returned message.

successful
Countinteger

The total number of storage resources.

2
NextTokenstring

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****
Drivesarray<object>

The user-level storage resources.

Driveobject

The user-level storage resource.

Idstring

The user ID.

Note You can ignore this parameter.
1
GmtCreatestring

The time when the storage resource was created.

2025-07-02T08:42:26.000+00:00
GmtModifiedstring

The time when the storage resource was modified.

2025-07-07T02:46:04.000+00:00
AliUidlong

The ID of the Alibaba Cloud account.

1202****
DomainIdstring

The ID of the storage resource.

dom-aaaa****
ExternalDomainIdstring

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****
DriveIdstring

The ID of the user-level storage resource.

dri-aaaa****
ExternalDriveIdstring

The ID of the storage resource at the external user level.

Note This parameter is returned only if ResourceType is set to PDS.
1100****
UserIdstring

The user ID.

user01
ExternalUserIdstring

The ID of the external user.

Note This parameter is returned only if ResourceType is set to PDS.
user01@cn-hangzhou.120****
Namestring

The name of the storage resource.

test****
Descriptionstring

The introduction to the storage resource.

test****
TotalSizelong

The total amount of user-level storage capacity.

536870912000
UsedSizelong

The amount of user-level storage capacity used.

243175936
Statusstring

The status of the user-level storage resource.

Valid values:

  • INIT: initializing
  • MAINTAIN: maintaining
  • DELETING: deleting
  • INVALID: invalid
  • NORMAL: normal
  • FAIL: failed
NORMAL
Typestring

The usage of the storage resource.

Valid values:

  • DESKTOP: data disk space
  • USER_PROFILE: personal data space
USER_PROFILE
ProfileRoamingboolean
Note This parameter is deprecated.
-
DesktopGroupCountinteger

The number of associated cloud computer pools.

Note This parameter is returned only if ResourceType is set to NAS and Type is set to USER_PROFILE.
1
DesktopGroupsarray<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.
DesktopGroupobject

The details of the cloud computer pool.

DesktopGroupIdstring

The ID of the cloud computer pool.

dg-aaaa****
DesktopGroupNamestring

The name of the cloud computer pool.

group01
EnableProfileManagementboolean

Indicates whether the UPM feature is enabled.

true

Examples

Sample success responses

JSONformat

{
  "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

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