ListDesktopAgentRuntime - App Streaming - Alibaba Cloud Documentation Center

Queries the list of desktop agent runtimes.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AgentProvider	string	Yes	The name of the agent provider.	OpenClaw
ModelTemplateId	string	No	The model group ID.	mt-xxxx
DesktopIds	array	No	The list of agent runtime IDs.	jvs-xxxxx
	string	Yes	The agent runtime ID. The ID mapping is as follows: JVS Computer: JVS Computer ID, in the format of jvs-xxxx. OpenClaw: Cloud computer ID, in the format of ecd-xxxx. Hermes Agent: Hermes Agent ID, in the format of jvs-xxxx.	ecd-xxxx
ResourceIds	array	No	The list of resource IDs (underlying real resource IDs).	ecd-xxxxx
	string	No	The resource ID.	ecd-xxxx
DesktopStatuses	array	No	The list of cloud computer statuses.	Running
	string	Yes	The cloud computer status. Valid values: Stopped : Stopped Starting : Starting Rebuilding : Rebuilding Running : Running Stopping : Stopping Expired : Expired Deleted : Deleted Pending : Pending	Running
AuthUsers	array	No	The list of authorized users.	user001
	string	Yes	The authorized user.	user-001
AgentInstanceVersions	array	No	The list of agent instance versions.	OpenClaw 2026.4.15
	string	Yes	The agent instance version.	2026.3.13
AgentInstanceStatuses	array	No	The list of agent instance statuses.	Running
	string	Yes	The agent instance status. Valid values: Undeployed : Undeployed Deploying : Deploying Stopped : Stopped Starting : Starting Running : Running Stopping : Stopping Deleted : Deleted Deployed : Deployed Unavailable : Unavailable	Running
DeploymentSource	string	No	The deployment source. Valid values: User : User deployment Admin : Admin deployment	Admin
ModelConfigure	boolean	No	Specifies whether the model is configured. Valid values: true : Yes false : No	true
ChannelConfigure	boolean	No	Specifies whether the third-party channel is configured. Valid values: true : Yes false : No	true
ResourceGroupId	string	No	The resource group ID.	rg-xxxx
DesktopNames	array	No	The list of agent runtime names.	Desktop001
	string	Yes	The agent runtime name.	Agent-001
BizType	integer	No	The business type. Valid values: 1 : Enterprise Edition	1
AgentPlatform	string	No	The agent platform. Valid values: ENTERPRISE : Enterprise Edition ENTERPRISE_JVS : Enterprise Edition JVS Computer, Enterprise Edition Hermes Agent	ENTERPRISE
HasAuthUser	boolean	No	Specifies whether authorized users exist. Valid values: true : Yes false : false	true
IncludeRiskInfo	boolean	No	Specifies whether to query and return risk information. Default value: false. When set to true, the response includes the RiskInfo field, and the HasRisk filter condition takes effect. Valid values: true : Yes false : No	true
HasRisk	boolean	No	Specifies whether a risk exists. Used to filter cloud computers with or without risks. This parameter takes effect only when IncludeRiskInfo is set to true. Set to true to return only records with risks. Set to false to return only records without risks. If not specified, no filtering is applied. Valid values: true : Yes false : No	true
PageSize	integer	No	The number of entries per page.	20
PageNumber	integer	No	The number of entries per page.	1
		No	The page number, starting from 1. Values 0 and 1 return the same result.

Response elements

Element	Type	Description	Example
	object	The query result.
PageSize	integer	The number of entries per page.	20
PageNumber	integer	The page number.	1
Data	array<object>	The list of returned result objects.
	array<object>	The returned result object.
DesktopId	string	The agent runtime ID.	ecd-xxxx
ResourceId	string	The resource ID, which is the cloud computer ID.	ecd-xxxx
RegionId	string	The region ID.	cn-hangzhou
RegionLocation	string	The region location (domestic/overseas). Valid values: Mainland : Chinese Mainland Overseas : Overseas (including Hong Kong, China)	Mainland
DesktopName	string	The agent runtime name.	Agent-001
DesktopStatus	string	The cloud computer status. Valid values: Stopped : Stopped Starting : Starting Rebuilding : Rebuilding Running : Running Stopping : Stopping Expired : Expired Deleted : Deleted Pending : Pending	Running
OsType	string	The operating system type. Valid values: Linux : Linux Windows : Windows	Windows
AuthUsers	array	The list of authorized users.
	string	The authorized user.	user-001
HasAuthUser	boolean	Indicates whether authorized users exist. Valid values: true : Yes false : No	true
AgentInstanceInfoList	array<object>	The list of agent instance information.
	object	The agent instance information object.
AgentPlatform	string
AgentProvider	string
AgentInstanceVersion	string	The agent instance version.	2026.3.13
AgentInstanceStatus	string	The agent instance status. Valid values: Undeployed : Not deployed. Deploying : Deploying. Stopped : Stopped. Starting : Starting. Running : Running. Stopping : Stopping. Deleted : Deleted. Deployed : Deployed. Unavailable : Unavailable.	Running
ModelConfigure	boolean	Indicates whether a model is configured for the agent instance. Valid values: true : yes. false : no.	true
ChannelConfigure	boolean	Indicates whether a third-party channel is configured for the agent instance. Valid values: true : yes. false : no.	true
ChannelConfiguredList	array	The list of third-party channels configured for the agent instance.
	string	The third-party channel configured for the agent instance. Valid values: dingtalk-connector : DingTalk. wechat : WeChat. feishu : Lark. qqbot : QQ wecom : WeCom.	dingtalk-connector
DeploymentSource	string	The deployment source. Valid values: User : User deployment. Admin : Administrator deployment.	Admin
ModelTemplateId	string	The configured model group ID.	mt-xxxx
ModelConfigure	boolean	Indicates whether the agent runtime has a configured model. Valid values: true : Yes false : false	true
ModelTemplateId	string	The effective model template ID (returned only when modelConfigure=true).	mt-xxxx
ModelTemplateName	string	The effective model template name (returned only when modelConfigure=true).	model-template-001
ChannelConfigure	boolean	Indicates whether the agent runtime has a configured third-party channel. Valid values: true : Yes false : No	true
ChannelConfiguredList	array	The list of third-party channels configured for the agent runtime.
	string	The third-party channel configured for the agent runtime. Valid values: dingtalk-connector : DingTalk wechat : WeChat feishu : Lark qqbot : QQ wecom : WeCom	dingtalk-connector
QrCodeConfiguringList	array	The list of channels in QR code configuration.
	string	The channel in QR code configuration.	wechat
AgentImInfo	object	The agent IM information.
AgentImStatus	string	The agent IM status. Valid values: Enabled : Enabled. Disabled : Disabled.	Enabled
CloudSpaceStatus	string	The CloudSpace status. Valid values: Enabled : Enabled. Disabled : Disabled.	Enabled
RiskInfo	object	The risk information (returned only when the request parameter IncludeRiskInfo is set to true, otherwise null).
ModelModified	boolean	Indicates whether the model configuration has been modified (inconsistent with the configuration delivered by the administrator). Valid values: true : yes. false : no.	true
ChannelModified	boolean	Indicates whether the third-party channel configuration has been modified (inconsistent with the configuration delivered by the administrator). Valid values: true : yes. false : no.	true
AgentUninstalled	boolean	Indicates whether the agent has been uninstalled. Valid values: true : yes. false : no.	true
ResourceGroup	object	The resource group information.
ResourceGroupId	string	The resource group ID.	rg-xxxx
ResourceGroupName	string	The resource group name.	resource-group-001
ManagementStatuses	array
	string
TotalCount	integer	The total number of entries.	30
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****

Examples

Success response

JSON format

{
  "PageSize": 20,
  "PageNumber": 1,
  "Data": [
    {
      "DesktopId": "ecd-xxxx",
      "ResourceId": "ecd-xxxx",
      "RegionId": "cn-hangzhou",
      "RegionLocation": "Mainland",
      "DesktopName": "Agent-001",
      "DesktopStatus": "Running",
      "OsType": "Windows",
      "AuthUsers": [
        "user-001"
      ],
      "HasAuthUser": true,
      "AgentInstanceInfoList": [
        {
          "AgentPlatform": "",
          "AgentProvider": "",
          "AgentInstanceVersion": "2026.3.13",
          "AgentInstanceStatus": "Running",
          "ModelConfigure": true,
          "ChannelConfigure": true,
          "ChannelConfiguredList": [
            "dingtalk-connector"
          ],
          "DeploymentSource": "Admin",
          "ModelTemplateId": "mt-xxxx"
        }
      ],
      "ModelConfigure": true,
      "ModelTemplateId": "mt-xxxx",
      "ModelTemplateName": "model-template-001",
      "ChannelConfigure": true,
      "ChannelConfiguredList": [
        "dingtalk-connector"
      ],
      "QrCodeConfiguringList": [
        "wechat"
      ],
      "AgentImInfo": {
        "AgentImStatus": "Enabled",
        "CloudSpaceStatus": "Enabled"
      },
      "RiskInfo": {
        "ModelModified": true,
        "ChannelModified": true,
        "AgentUninstalled": true
      },
      "ResourceGroup": {
        "ResourceGroupId": "rg-xxxx",
        "ResourceGroupName": "resource-group-001"
      },
      "ManagementStatuses": [
        ""
      ]
    }
  ],
  "TotalCount": 30,
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.