CreateDrive - Elastic Desktop Service - Alibaba Cloud Documentation Center

Creates a user-level storage resource.

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:CreateDrive	create	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
AliUid	long	No	The ID of your Alibaba Cloud account.	1202****
UserId	string	No	The user ID.	user01
DomainId	string	No	The ID of the storage resource. Note Call the DescribeDrives operation to retrieve the storage resource ID.	dom-aaaa****
ExternalDomainId	string	No	The ID of the external storage resource. Note Call the DescribeDrives operation to retrieve the external storage resource ID.	1234****
ResourceType	string	No	The type of the storage resource. Valid values: NAS: File Storage NAS PDS: Drive and Photo Service	NAS
Type	string	No	The usage of the storage resource. Valid values: DESKTOP: data disk space USER_PROFILE: space for personal data of the user	USER_PROFILE
DriveName	string	No	The name of the user-level storage resource.	test01
Description	string	No	The description of the user-level storage resource.	test01
ProfileRoaming	boolean	No	Note This parameter is deprecated.	-

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	B7AA****
Message	string	The response message.	successful
Code	string	The response code. The value 200 indicates that the request was successful.	200
Success	boolean	Indicates whether the request was successful.	true
Drive	object	The user-level storage resource.
Id	string	The ID.	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 last modified.	2025-07-07T02:46:04.000+00:00
AliUid	string	The ID of the Alibaba Cloud account.	1202****
DomainId	string	The ID of the storage resource.	dom-aaaa****
DriveId	string	The ID of the user-level storage resource.	dri-aaaa****
ExternalDriveId	string	The ID of the external user-level storage resource. Note A value is returned for this parameter only if ResourceType is set to PDS.	1100****
UserId	string	The user ID.	user01
ExternalUserId	string	The ID of the external user.	user01@cn-hangzhou.120****
Name	string	The name of the storage resource.	test****
Description	string	The description of the storage resource.	test****
TotalSize	long	The total amount of the user-level storage resource capacity. Note Unit: bytes.	536870912000
UsedSize	long	The amount of user-level storage resource capacity used. Note Unit: bytes.	243175936
Status	string	The status of the user-level storage resource. Valid values: INIT: initializing MAINTAIN: maintaining DELETING INVALID NORMAL FAIL: failed	NORMAL
Type	string	The usage of the storage resource. Valid values: DESKTOP: data disk space USER_PROFILE: space for personal data of the user	USER_PROFILE
ProfileRoaming	boolean	Note This parameter is deprecated.	-

Examples

Sample success responses

JSONformat

{
  "RequestId": "B7AA****",
  "Message": "successful",
  "Code": 200,
  "Success": true,
  "Drive": {
    "Id": 1,
    "GmtCreate": "2025-07-02T08:42:26.000+00:00",
    "GmtModified": "2025-07-07T02:46:04.000+00:00",
    "AliUid": "1202****",
    "DomainId": "dom-aaaa****",
    "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
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history