ListDesktopAgentRuntime - 查询Agent运行时列表

更新时间:
复制 MD 格式

查询桌面Agent运行时列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

appstreaming:ListDesktopAgentRuntime

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

AgentProvider

string

Agent 提供商名称。

OpenClaw

ModelTemplateId

string

模型分组 ID。

mt-xxxx

DesktopIds

array

Agent 运行时 ID 列表。

string

Agent 运行时 ID ,ID 对应关系如下:

JVS Computer:JVS Computer ID,格式如 jvs-xxxx。

OpenClaw:云电脑 ID,格式如 ecd-xxxx。

Hermes Agent:Hermes Agent ID,格式如 jvs-xxxx。

ecd-xxxx

ResourceIds

array

资源 ID 列表(底层真实资源 ID)

string

资源 ID。

ecd-xxxx

DesktopStatuses

array

云电脑状态列表。

string

云电脑状态。

枚举值:

  • Stopped :

    已关机

  • Starting :

    启动中

  • Rebuilding :

    重建中

  • Running :

    运行中

  • Stopping :

    停止中

  • Expired :

    已过期

  • Deleted :

    已删除

  • Pending :

    等待中

Running

AuthUsers

array

授权用户列表。

string

授权用户。

user-001

AgentInstanceVersions

array

Agent 实例版本列表。

string

Agent 实例版本。

2026.3.13

AgentInstanceStatuses

array

Agent 实例状态列表。

string

Agent 实例状态。

枚举值:

  • Undeployed :

    未部署

  • Deploying :

    部署中

  • Stopped :

    已停止

  • Starting :

    启动中

  • Running :

    运行中

  • Stopping :

    停止中

  • Deleted :

    已删除

  • Deployed :

    已部署

  • Unavailable :

    不可用

Running

DeploymentSource

string

部署来源。

枚举值:

  • User :

    用户部署

  • Admin :

    管理员部署

Admin

ModelConfigure

boolean

是否已配置模型。

枚举值:

  • true :

  • false :

true

ChannelConfigure

boolean

是否已配置三方通道。

枚举值:

  • true :

  • false :

true

ResourceGroupId

string

资源组 ID。

rg-xxxx

DesktopNames

array

Agent 运行时名称列表。

string

Agent 运行时名称。

Agent-001

BizType

integer

业务类型。

枚举值:

  • 1 :

    企业版

1

AgentPlatform

string

Agent 平台。

枚举值:

  • ENTERPRISE :

    企业版

  • ENTERPRISE_JVS :

    企业版 JVS Computer、企业版 Hermes Agent

ENTERPRISE

HasAuthUser

boolean

是否已授权用户。

枚举值:

  • true :

  • false :

    false

true

IncludeRiskInfo

boolean

是否查询并返回风险信息。默认为 false。设置为 true 时,响应中将包含 RiskInfo 字段,同时 HasRisk 筛选条件才会生效。

枚举值:

  • true :

  • false :

true

HasRisk

boolean

是否存在风险。用于过滤有风险或无风险的云电脑,仅当 IncludeRiskInfo 为 true 时生效。

设置为 true 表示仅返回存在风险的记录,设置为 false 表示仅返回无风险的记录,不传则不做过滤。

枚举值:

  • true :

  • false :

true

PageSize

integer

每页大小。

20

PageNumber

integer

页码,从 1 开始,0 和 1 返回相同结果。

1

返回参数

名称

类型

描述

示例值

object

查询结果。

PageSize

integer

每页大小。

20

PageNumber

integer

页码。

1

Data

array<object>

返回的结果对象列表。

array<object>

返回的结果对象。

DesktopId

string

Agent 运行时 ID。

ecd-xxxx

ResourceId

string

资源 ID,即云电脑 ID。

ecd-xxxx

RegionId

string

地域 ID。

cn-hangzhou

RegionLocation

string

地域位置(国内/海外)

枚举值:

  • Mainland :

    中国大陆

  • Overseas :

    海外(含中国香港)

Mainland

DesktopName

string

Agent 运行时名称。

Agent-001

DesktopStatus

string

云电脑状态。

枚举值:

  • Stopped :

    已关机

  • Starting :

    启动中

  • Rebuilding :

    重建中

  • Running :

    运行中

  • Stopping :

    停止中

  • Expired :

    已过期

  • Deleted :

    已删除

  • Pending :

    等待中

Running

OsType

string

操作系统类型

枚举值:

  • Linux :

    Linux

  • Windows :

    Windows

Windows

AuthUsers

array

授权用户列表。

string

授权用户。

user-001

HasAuthUser

boolean

是否已授权用户。

枚举值:

  • true :

  • false :

true

AgentInstanceInfoList

array<object>

Agent 实例信息列表。

object

Agent 实例信息对象。

AgentInstanceVersion

string

Agent 实例版本。

2026.3.13

AgentInstanceStatus

string

Agent 实例状态。

枚举值:

  • Undeployed :

    未部署

  • Deploying :

    部署中

  • Stopped :

    已停止

  • Starting :

    启动中

  • Running :

    运行中

  • Stopping :

    停止中

  • Deleted :

    已删除

  • Deployed :

    已部署

  • Unavailable :

    不可用

Running

ModelConfigure

boolean

Agent 实例是否已配置模型。

枚举值:

  • true :

  • false :

true

ChannelConfigure

boolean

Agent 实例是否已配置三方通道。

枚举值:

  • true :

  • false :

true

ChannelConfiguredList

array

Agent 实例已配置的三方通道列表。

string

Agent 实例已配置的三方通道。

枚举值:

  • dingtalk-connector :

    钉钉

  • wechat :

    微信

  • feishu :

    飞书

  • qqbot :

    QQ

  • wecom :

    企业微信

dingtalk-connector

DeploymentSource

string

部署来源。

枚举值:

  • User :

    用户部署

  • Admin :

    管理员部署

Admin

ModelTemplateId

string

已配置的模型分组 ID。

mt-xxxx

ModelConfigure

boolean

Agent 运行时是否已配置模型。

枚举值:

  • true :

  • false :

    false

true

ModelTemplateId

string

已生效的模型模板 ID(仅 modelConfigure=true 时返回)

mt-xxxx

ModelTemplateName

string

已生效的模型模板名称(仅 modelConfigure=true 时返回)

model-template-001

ChannelConfigure

boolean

Agent 运行时是否已配置三方通道。

枚举值:

  • true :

  • false :

true

ChannelConfiguredList

array

Agent 运行时已配置的三方通道列表。

string

Agent 运行时已配置的三方通道。

枚举值:

  • dingtalk-connector :

    钉钉

  • wechat :

    微信

  • feishu :

    飞书

  • qqbot :

    QQ

  • wecom :

    企业微信

dingtalk-connector

QrCodeConfiguringList

array

扫码配置中的通道编码列表

string

扫码配置中的通道编码

wechat

AgentImInfo

object

Agent IM 信息。

AgentImStatus

string

Agent IM 状态。

枚举值:

  • Enabled :

    已启用

  • Disabled :

    已禁用

Enabled

CloudSpaceStatus

string

CloudSpace 状态。

枚举值:

  • Enabled :

    已启用

  • Disabled :

    已禁用

Enabled

RiskInfo

object

风险信息(仅当请求参数 IncludeRiskInfo 为 true 时返回,否则为 null)

ModelModified

boolean

模型配置是否被修改(与管理员下发的配置不一致)。

枚举值:

  • true :

  • false :

true

ChannelModified

boolean

三方通道配置是否被修改(与管理员下发的配置不一致)。

枚举值:

  • true :

  • false :

true

AgentUninstalled

boolean

Agent 是否被卸载。

枚举值:

  • true :

  • false :

true

ResourceGroup

object

资源组信息。

ResourceGroupId

string

资源组 ID。

rg-xxxx

ResourceGroupName

string

资源组名称。

resource-group-001

TotalCount

integer

总数量。

30

RequestId

string

请求 ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****

示例

正常返回示例

JSON格式

{
  "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": [
        {
          "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"
      }
    }
  ],
  "TotalCount": 30,
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情