DescribeGuestApplications - Elastic Desktop Service - Alibaba Cloud Documentation Center

Queries the applications and their processes of an end user.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ecd:DescribeGuestApplications	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.	cn-hangzhou
DesktopId	string	Yes	The ID of the cloud computer.	ecd-asw3giklqvfqe****
EndUserId	string	Yes	The user ID.	demo001

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	272CF39E-B5DE-5BE3-A09B-B43F1026****
Applications	array<object>	The applications.
GuestApplicationModel	object	The application.
ApplicationName	string	The application name.	Google Chrome
ApplicationVersion	string	The application version.	115.0.5790.110
ProcessPath	string	The path to the process.	C:\\Program Files\\Google\\Chrome\\Application\\ch****.exe
Pid	integer	The process ID (PID).	1357
CpuPercent	double	The CPU utilization (%).	89
MemPercent	double	The memory utilization (%).	34
GpuPercent	double	The GPU utilization (%).	15
IoSpeed	double	The I/O read and write performance. Unit: byte/s.	124906.0
IconUrl	string	The icon URL of the application.	https://app-center-icon-prod-shanghai.oss-cn-shanghai.aliyuncs.com/market/preload/default****.png
Status	string	The status of the application. Valid value: Idle: The application is installed in the cloud computer but is not running. Running: The application has been installed in the cloud computer and is running.	Running
ProcessData	array<object>	The processes.
process	object	The process.
ApplicationName	string	The application name.	Google Chrome
ApplicationVersion	string	The application version.	115.0.5790.110
ProcessPath	string	The path to the process.	C:\\Program Files\\Google\\Chrome\\Application\\ch****.exe
Pid	integer	The PID.	1357
CpuPercent	double	The CPU utilization (%).	89
MemPercent	double	The memory usage (%).	34
GpuPercent	double	The GPU usage (%).	15
Iospeed	double	The I/O read and write performance. Unit: byte/s.	124906.0

Examples

Sample success responses

JSONformat

{
  "RequestId": "272CF39E-B5DE-5BE3-A09B-B43F1026****",
  "Applications": [
    {
      "ApplicationName": "Google Chrome",
      "ApplicationVersion": "115.0.5790.110",
      "ProcessPath": "C:\\\\Program Files\\\\Google\\\\Chrome\\\\Application\\\\ch****.exe",
      "Pid": 1357,
      "CpuPercent": 89,
      "MemPercent": 34,
      "GpuPercent": 15,
      "IoSpeed": 124906,
      "IconUrl": "https://app-center-icon-prod-shanghai.oss-cn-shanghai.aliyuncs.com/market/preload/default****.png",
      "Status": "Running",
      "ProcessData": [
        {
          "ApplicationName": "Google Chrome",
          "ApplicationVersion": "115.0.5790.110",
          "ProcessPath": "C:\\\\Program Files\\\\Google\\\\Chrome\\\\Application\\\\ch****.exe",
          "Pid": 1357,
          "CpuPercent": 89,
          "MemPercent": 34,
          "GpuPercent": 15,
          "Iospeed": 124906
        }
      ]
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history