CreateCloudDriveService-阿里云帮助中心

Create a PDS (formerly Wuying Cloud Disk)

Operation description

Before using this interface, make sure you understand the billing methods and pricing of Drive and Photo Service. For more information, see Overview of Drive and Photo Service.

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the regions supported by Elastic Desktop Service.	cn-hangzhou
Name	string	No	The name of the cloud drive.	wuying-cds
OfficeSiteType	string	No	The type of the office site. Valid values: SIMPLE : A simple office site. AD_CONNECTOR : An AD connector-based office site.	SIMPLE
OfficeSiteId	string	No	The ID of the office site. This parameter applies only when `OfficeSiteType` is set to `AD_CONNECTOR`.	cn-hangzhou+dir-400695****
CenId	string	No	The ID of the Cloud Enterprise Network (CEN) instance. This parameter is required when `OfficeSiteType` is set to `AD_CONNECTOR` and you do not specify `OfficeSiteId`.	cen-g4ba1mkji8nj6****
DomainName	string	No	The name of the domain controller. This parameter is required when `OfficeSiteType` is set to `AD_CONNECTOR` and you do not specify `OfficeSiteId`.	test.local
UserMaxSize	integer	No	The maximum size of the personal disk for each user, in bytes.	104857600
MaxSize	integer	Yes	The total capacity of the cloud drive. For pay-as-you-go cloud drives, the unit is bytes. For subscription cloud drives, the unit is GiB. For example, set the value to 500 for 500 GiB, or to 2048 for 2 TiB.	536870912000
EndUserId	array	No	A list of user IDs.
	string	No	The user ID.	alice
BizType	integer	No	Note This parameter is not publicly available.	null
SolutionId	string	No	Note This parameter is not publicly available.	null
CdsChargeType	string	No	The billing method of the cloud drive. Valid values: PostPaid : Pay-as-you-go PrePaid : Subscription	PostPaid
AutoPay	boolean	No	Specifies whether to enable automatic payment. Valid values: true : The order is automatically paid. Make sure that your account has a sufficient balance, or an unpaid order will be generated. false : An unpaid order is generated. To pay for the order, log on to the console, go to User Center > My Orders, and use the order ID returned in the response. (Default)	false
AutoRenew	boolean	No	Specifies whether to enable auto-renewal. This parameter applies only when `CdsChargeType` is set to `PrePaid`. Valid values: true : Auto-renewal is enabled. false : Auto-renewal is disabled. (Default)	false
Period	integer	No	The subscription duration. The unit is specified by `PeriodUnit`. This parameter is required only when `CdsChargeType` is set to `PrePaid`. Valid values: 1 : 2 : 3 :	1
PeriodUnit	string	No	The unit of the subscription duration. This parameter is required only when `CdsChargeType` is set to `PrePaid`. Valid values: Year : year	Year
UserCount	integer	No	The maximum number of users for a subscription cloud drive. This parameter is required only when `CdsChargeType` is set to `PrePaid`. Valid values: 5 : For a `MaxSize` of 500 GiB. 20 : For a `MaxSize` of 2 TiB. 50 : For a `MaxSize` of 5 TiB.	5
ResellerOwnerUid	integer	No

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	062B1439-709A-580E-85DF-CE97A156****
CdsId	string	The ID of the enterprise network disk.	cn-hangzhou+cds-778205****
CdsName	string	The name of the cloud storage service.	CDS_Windows_1126
MaxSize	string	The maximum storage usage of the enterprise network disk. Unit: bytes.	5368709120
OfficeSiteType	string	The office network type. Valid values: SIMPLE : convenience office network AD_CONNECTOR : AD office network	AD_CONNECTOR
CenId	string	The ID of the Cloud Enterprise Network (CEN) instance. Note If you want to connect to a cloud desktop through a VPC, you can add the office network to a CEN instance. This CEN instance connects to your on-premises network through a VPN or a dedicated line.	cen-638u3wxds9snyc****
DomainName	string	The name of the Active Directory (AD) domain corresponding to the AD office network.	test1.local
OrderId	string	The order ID. You can obtain the order ID on the Order Management page in the Alibaba Cloud User Center.	214552063030752
ErrorCode	string	The error code.	ExistConflictCds
ConflictCdsAndOrder	object	The existing enterprise network disks or orders for enterprise network disks that conflict with the enterprise network disk that you want to create.
ConflictCds	array<object>	The information of conflicting enterprise network disks.
	object
CdsId	string	The ID of the enterprise network disk.	cn-hangzhou+cds-778205****
RegionId	string	The region ID. You can call the DescribeRegions operation to query the regions that are supported by Elastic Desktop Service.	cn-hangzhou
ConflictOrder	array<object>	The information of conflicting unpaid orders for enterprise network disks (orders for subscription enterprise network disks).
	object
CdsId	string	The ID of the enterprise network disk (The order is not paid, and the enterprise network disk cannot be used).	cn-hangzhou+cds-778205****
OrderId	string	The order ID. You can obtain the order ID on the Order Management page in the Alibaba Cloud User Center.	22442411898****
RegionId	string	The region ID.	cn-hangzhou

Examples

Success response

JSON format

{
  "RequestId": "062B1439-709A-580E-85DF-CE97A156****",
  "CdsId": "cn-hangzhou+cds-778205****",
  "CdsName": "CDS_Windows_1126",
  "MaxSize": "5368709120",
  "OfficeSiteType": "AD_CONNECTOR",
  "CenId": "cen-638u3wxds9snyc****",
  "DomainName": "test1.local",
  "OrderId": "214552063030752",
  "ErrorCode": "ExistConflictCds",
  "ConflictCdsAndOrder": {
    "ConflictCds": [
      {
        "CdsId": "cn-hangzhou+cds-778205****",
        "RegionId": "cn-hangzhou"
      }
    ],
    "ConflictOrder": [
      {
        "CdsId": "cn-hangzhou+cds-778205****",
        "OrderId": "22442411898****",
        "RegionId": "cn-hangzhou"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.