DescribeCloudDriveUsers-阿里云帮助中心

Retrieves a list of personal drives and their basic information for all users in an enterprise network drive.

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:DescribeCloudDriveUsers

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. To obtain a list of supported regions, call DescribeRegions.	cn-hangzhou
CdsId	string	Yes	The ID of the enterprise network drive.	cn-hangzhou+cds-066224****
EndUserId	string	No	The end user ID. If specified, the query returns only the personal drive of that user. If left empty, the query returns the personal drives of all users.	alice
MaxResults	integer	No	The number of entries per page. Maximum: 100. Default: 10.	10
NextToken	string	No	The token for the next page of results. This is the `NextToken` value from the previous response. Leave this parameter empty for the first request.	aGN4YzAxQGNuLWhhbmd6aG91LjExNzU5NTMyNjgzMTQ1****

Response elements

Element	Type	Description	Example
	object
NextToken	string	The token for the next page of results. An empty value indicates that all results have been returned.	aGN4YzAxQGNuLWhhbmd6aG91LjExNzU5NTMyNjgzMTQ1****
RequestId	string	The request ID.	F083AAE5-7AA9-53BB-9060-AFFB2C18****
CloudDriveUsers	array<object>	A list of user personal drives.
	object	A user personal drive.
UsedSize	integer	The used storage space, in bytes.	10485760
Status	string	The status of the user personal drive. Valid values: disabled : Disabled enabled : Enabled	enabled
DriveId	string	The ID of the user personal drive.	8
TotalSize	integer	Maximum storage capacity for the user’s personal drive, in bytes.	104857600
UserId	string	The internal ID of the user.	alice@cn-shanghai.148875033399****
UserName	string	The name of the end user.	alice
EndUserId	string	The ID of the end user.	alice

Examples

Success response

JSON format

{
  "NextToken": "aGN4YzAxQGNuLWhhbmd6aG91LjExNzU5NTMyNjgzMTQ1****",
  "RequestId": "F083AAE5-7AA9-53BB-9060-AFFB2C18****",
  "CloudDriveUsers": [
    {
      "UsedSize": 10485760,
      "Status": "enabled",
      "DriveId": "8",
      "TotalSize": 104857600,
      "UserId": "alice@cn-shanghai.148875033399****",
      "UserName": "alice",
      "EndUserId": "alice"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.