Provision Workstations in Batch via CreateWuyingServer API - App Streaming - Alibaba Cloud - App Streaming

Creates one or more workstations.

Operation description

A project corresponds to the resource configuration module in the CloudFlow console.
If the ContentId specified in the request parameters has multiple versions, this API operation
Important uses the default version
for binding.
This operation succeeds only when the default version of the content is in an available state.

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

appstreaming:CreateWuyingServer

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
WuyingServerName	string	No	The workstation name. When you create multiple workstations, a numeric suffix is automatically appended.	exampleServerName
Amount	integer	No	The number of workstations to create.	1
ServerInstanceType	string	No	The workstation instance type.	eds.proworkstation_flagship_elite_ne.96c384g.192g4x
SystemDiskSize	integer	No	The size of the system cloud disk. Unit: GB.	100
SystemDiskCategory	string	No	The type of the system cloud disk. Valid values: cloud_auto : cloud_auto	cloud_auto
SystemDiskPerformanceLevel	string	No	The performance level of the system cloud disk.	PL0
DataDisk	array<object>	No	The list of data cloud disks.
	object	No	The data cloud disk information.
DataDiskSize	integer	No	The size of the data cloud disk.	100
DataDiskCategory	string	No	The type of the data cloud disk. Valid values: cloud_auto : cloud_auto	cloud_auto
DataDiskPerformanceLevel	string	No	The performance level of the data cloud disk.	PL0
ImageId	string	No	The image ID.	img-bp13mu****
BizRegionId	string	No	The region ID.	cn-hangzhou
OfficeSiteId	string	No	The office network ID.	cn-hangzhou+dir-643067****
Password	string	No	The logon password of the workstation.	YourPassword123
ChargeType	string	No	The billing method. Valid values: PrePaid : subscription.	PrePaid
Period	integer	No	The subscription duration.	1
PeriodUnit	string	No	The unit of the subscription duration. Valid values: Month : month. Year : year.	Month
AutoPay	boolean	No	Specifies whether to enable automatic payment.	false
AutoRenew	boolean	No	Specifies whether to enable auto-renewal.	false
PromotionId	string	No	The promotion ID. Note If PromotionId is specified, the corresponding discount is applied.	17440009****
VSwitchIds	array	No	The list of vSwitches in the office network.
	string	No	The vSwitch ID.	vsw-55vk6****5vatze7jg
VirtualNodePoolId	string	No		vnp-0b************gyw
NetworkStrategyType	string	No	The network policy type (in invitational preview).	DirectIp
Bandwidth	integer	No	The bandwidth value. This parameter takes effect only when NetworkStrategyType is set to DirectIp. Unit: Mbit/s. Valid values: 2 to 100.	10
IdempotenceToken	string	No	The idempotence token that ensures the uniqueness of the operation.	6a1b8c3d
ServerPortRange	string	No
SavingPlanId	string	No
HostName	string	No	The hostname. The following limits apply: A period (.) or hyphen (-) cannot be used as the first or last character, and consecutive periods or hyphens are not allowed. Windows workstations: The hostname must be 2 to 15 characters in length. It cannot contain periods (.), consecutive hyphens, or consist entirely of digits. It can contain uppercase and lowercase letters, digits, and hyphens (-). Linux workstations: The hostname must be 2 to 64 characters in length and can contain multiple periods (.). Each segment separated by a period can contain uppercase and lowercase letters, digits, and hyphens (-). You can use the placeholder `${instance_id}` to include the instance ID in the HostName parameter. For example, if you set `HostName=k8s-${instance_id}` and the ECS instance ID is `i-123abc**`, the hostname is `k8s-i-123abc**`. When you create multiple workstation instances at a time, you can use the `name_prefix[begin_number,bits]name_suffix` format to assign sequential hostnames. For example, if you set HostName to `ecd-[1,4]-test`, the hostname of the first workstation is `ecd-0001-test`, the hostname of the second workstation is `ecd-0002-test`, and so on. `name_prefix`: the prefix of the hostname. `[begin_number,bits]`: the sequential number in the hostname. `begin_number`: the starting number. Valid values: 0 to 999999. Default value: 0. If the value is invalid, 0 is used. `bits`: the number of digits. Valid values: 1 to 6. Default value: 6. If the value is invalid, 6 is used. `name_suffix`: the suffix of the hostname.	testhost
SubPayType	string	No
MaxPrice	number	No

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
Data	object	The response data.
OrderId	string	The order ID.	23429322113****
WuyingServerIdList	array	The list of workstation IDs.
	string	The workstation ID.	ws-0byd****2lwi

Examples

Success response

JSON format

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "Data": {
    "OrderId": "23429322113****",
    "WuyingServerIdList": [
      "ws-0byd****2lwi"
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.