Create a RAM directory via CreateRAMDirectory - Elastic Desktop Service - Alibaba Cloud - Elastic Desktop Service

Operation description

Before creating a RAM-type directory, complete the following preparations:

Call CreateVpc to create a virtual private cloud (VPC) in a region supported by cloud computers.
Call CreateVSwitch to create a vSwitch in the same VPC. The zone of the vSwitch must be a zone supported by cloud computers in that region. Call DescribeZones to query the zones supported by Elastic Desktop Service in a specific region.

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. Call DescribeRegions to query the regions supported by Elastic Desktop Service.	cn-hangzhou
DirectoryName	string	Yes	The directory name. The name must be 2 to 255 characters in length and can contain letters and Chinese characters. The name must start with a letter or a Chinese character and cannot start with `http://` or `https://`. The name can contain digits, colons (:), underscores (_), and hyphens (-).	testDirectoryName
EnableInternetAccess	boolean	No	Specifies whether to enable public network access. Valid values: true : enables public network access. false : disables public network access.	false
EnableAdminAccess	boolean	No	Specifies whether to grant local administrator permissions to users who use cloud computers. Valid values: true : grants local administrator permissions [default] false : does not grant local administrator permissions.	true
DesktopAccessType	string	No	The method allowed for connecting to cloud computers. Valid values: VPC : VPC connection. Internet : public network connection [default] Any : both public network and VPC connections.	Internet
VSwitchId	array	Yes	The vSwitch ID. Only one vSwitch can be specified.
	string	No	The vSwitch ID.	vsw-uf62w3qzt4aigvlcb****

Response elements

Element	Type	Description	Example
	object	The response parameters.
DirectoryId	string	The ID of the RAM-type directory.	dri-uf62w3qzt4aigvlcb****
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****

Examples

Success response

JSON format

{
  "DirectoryId": "dri-uf62w3qzt4aigvlcb****",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.