ListWuyingServer API Overview for App Streaming Workstations - App Streaming - Alibaba Cloud - App Streaming

Queries the list of workstations.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	The page size.	100
PageNumber	integer	No	The page number.	1
ProductType	string	No		wuying_server
BizType	integer	No		1
WuyingServerNameOrId	string	No	The workstation name or workstation ID.	exampleServerName
WuyingServerIdList	array	No	The list of workstation IDs.	aig-bp1234567890abcde
	string	No	The workstation ID.	ws-0bydg****2lwi
ServerInstanceType	string	No	The workstation instance type.	eds.proworkstation_flagship_elite.32c64g.48g1x
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-172301****
ChargeType	string	No	The billing type.	PrePaid
VirtualNodePoolId	string	No	The virtual node pool ID.	vnp-bp1234567890abcde
AddVirtualNodePoolStatusList	array	No	The list of statuses for joining a virtual node pool.	Added
	string	No
Status	string	No	The workstation status.	RUNNING
Users	array	No		user1
	string	No

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
TotalCount	integer	The total number of entries.	15
PageSize	integer	The page size.	10
PageNumber	integer	The page number.	1
WuyingServerList	array<object>	The list of workstation information.
	array<object>
AliUid	integer		1234567890123456
WuyingServerId	string	The workstation ID.	ws-0byd****8wn2lwi
WuyingServerName	string	The workstation name.	exampleServerName
Status	string	The workstation status.	RUNNING
ServerInstanceTypeInfo	object	The instance type information.
ServerInstanceType	string	Workstation specifications.	eds.proworkstation_flagship_elite_ne.96c384g.192g4x
Cpu	string	The number of vCPUs.	96
Memory	integer	The memory size. Unit: MB.	393,216
Gpu	string	The number of GPUs.	4
GpuMemory	integer	The memory size. Unit: MB.	196,608
GpuSpec	string		NVIDIA T4
SystemDiskSize	integer	The system cloud disk size. Unit: GB.	100
SystemDiskCategory	string	The system cloud disk type.	cloud_auto
SystemDiskPerformanceLevel	string	The performance level of the system cloud disk.	PL0
DataDisk	array<object>	The list of data cloud disks.
	object	The data cloud disk information.
DataDiskSize	integer	The size of the data disk. Unit: GB.	200
DataDiskCategory	string	The category of data disk.	cloud_auto
DataDiskPerformanceLevel	string	The PL of the data disk.	PL0
DataDiskId	string		d-bp1234567890abcde
DataDiskNo	string		1
ImageId	string	The image ID.	imgc-06****oagaev
ImageName	string	The image name.	Alibaba Cloud Linux 3.2104 LTS 64位
OsType	string	The operating system type.	Linux
BizRegionId	string	The region.	cn-hangzhou
OfficeSiteId	string	The office network ID.	cn-hangzhou+dir-1b****ayv2
OfficeSiteName	string	The office network name.	exampleOfficeSite
OfficeSiteType	string	The office network type.	SIMPLE
NetworkInterfaceIp	string	The internal IP address.	10.80.21.149
ChargeType	string	The billing method.	PrePaid
CreateTime	string	The creation time.	2025-08-02T16:52:11.000+00:00
ExpiredTime	string	The expiration time.	2025-09-03T16:00:00.000+00:00
VirtualNodePoolId	string	The virtual node pool ID.	vnp-bp1234567890abcde
AddVirtualNodePoolStatus	string	The status of joining a virtual node pool.	Added
SubPayType	string		spot
MaxPrice	number		0.5
VirtualKubeletIp	string		10.0.0.100
ResourceSessionStatus	string		Connected
Bandwidth	integer		10
FotaVersion	string		2.0.0
TimerGroupId	string		tg-bp1234567890abcde
SystemDiskId	string		d-bp1234567890abcde
InstanceInfoList	array<object>	The list of workstation instance information.
	object	The instance information.
InstanceId	string	The ID of the instance.	p-0ceitx****c5
NetworkInterfaceId	string	The ID of the ENI.	eni-uf65b****dfnt3wb
SecurityGroupIds	array	The list of security group IDs.
	string
Users	array
	string
Sessions	array<object>
	object
ResourceSessionStartTime	string		2026-01-01T08:00:00Z
UserId	string		user1
PolicyGroupIdList	array
	string
VkVersion	string		1.0.0
VkUpgradeNeeded	boolean
EniPrivateIpAddressQuantity	integer		10
PrivateIpSets	array<object>
	object
PrivateIpAddress	string		10.0.0.1
Primary	boolean		true

Examples

Success response

JSON format

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "TotalCount": 15,
  "PageSize": 10,
  "PageNumber": 1,
  "WuyingServerList": [
    {
      "AliUid": 1234567890123456,
      "WuyingServerId": "ws-0byd****8wn2lwi",
      "WuyingServerName": "exampleServerName",
      "Status": "RUNNING",
      "ServerInstanceTypeInfo": {
        "ServerInstanceType": "eds.proworkstation_flagship_elite_ne.96c384g.192g4x",
        "Cpu": "96",
        "Memory": 0,
        "Gpu": "4",
        "GpuMemory": 0,
        "GpuSpec": "NVIDIA T4"
      },
      "SystemDiskSize": 100,
      "SystemDiskCategory": "cloud_auto",
      "SystemDiskPerformanceLevel": "PL0",
      "DataDisk": [
        {
          "DataDiskSize": 200,
          "DataDiskCategory": "cloud_auto",
          "DataDiskPerformanceLevel": "PL0",
          "DataDiskId": "d-bp1234567890abcde",
          "DataDiskNo": "1"
        }
      ],
      "ImageId": "imgc-06****oagaev",
      "ImageName": "Alibaba Cloud Linux 3.2104 LTS 64位",
      "OsType": "Linux",
      "BizRegionId": "cn-hangzhou",
      "OfficeSiteId": "cn-hangzhou+dir-1b****ayv2",
      "OfficeSiteName": "exampleOfficeSite",
      "OfficeSiteType": "SIMPLE",
      "NetworkInterfaceIp": "10.80.21.149",
      "ChargeType": "PrePaid",
      "CreateTime": "2025-08-02T16:52:11.000+00:00",
      "ExpiredTime": "2025-09-03T16:00:00.000+00:00",
      "VirtualNodePoolId": "vnp-bp1234567890abcde",
      "AddVirtualNodePoolStatus": "Added",
      "SubPayType": "spot",
      "MaxPrice": 0.5,
      "VirtualKubeletIp": "10.0.0.100",
      "ResourceSessionStatus": "Connected",
      "Bandwidth": 10,
      "FotaVersion": "2.0.0",
      "TimerGroupId": "tg-bp1234567890abcde",
      "SystemDiskId": "d-bp1234567890abcde",
      "InstanceInfoList": [
        {
          "InstanceId": "p-0ceitx****c5",
          "NetworkInterfaceId": "eni-uf65b****dfnt3wb"
        }
      ],
      "SecurityGroupIds": [
        ""
      ],
      "Users": [
        ""
      ],
      "Sessions": [
        {
          "ResourceSessionStartTime": "2026-01-01T08:00:00Z",
          "UserId": "user1"
        }
      ],
      "PolicyGroupIdList": [
        ""
      ],
      "VkVersion": "1.0.0",
      "VkUpgradeNeeded": false,
      "EniPrivateIpAddressQuantity": 10,
      "PrivateIpSets": [
        {
          "PrivateIpAddress": "10.0.0.1",
          "Primary": true
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.