调试
您可以在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 Claw:JVS Claw ID,格式如 jvs-xxxx。 OpenClaw:云电脑 ID,格式如 ecd-xxxx。 | ecd-xxxx | |
| DesktopStatuses | array | 否 | 云电脑状态列表。 | |
| string | 是 | 云电脑状态。 枚举值:
| Running | |
| AuthUsers | array | 否 | 授权用户列表。 | |
| string | 是 | 授权用户。 | user-001 | |
| AgentInstanceVersions | array | 否 | Agent 实例版本列表。 | |
| string | 是 | Agent 实例版本。 | 2026.3.13 | |
| AgentInstanceStatuses | array | 否 | Agent 实例状态列表。 | |
| string | 是 | Agent 实例状态。 枚举值:
| Running | |
| DeploymentSource | string | 否 | 部署来源。 枚举值:
| Admin |
| ModelConfigure | boolean | 否 | 是否已配置模型。 | true |
| ChannelConfigure | boolean | 否 | 是否已配置三方通道。 | true |
| ResourceGroupId | string | 否 | 资源组 ID。 | rg-xxxx |
| DesktopNames | array | 否 | Agent 运行时名称列表。 | |
| string | 是 | Agent 运行时名称。 | Agent-001 | |
| BizType | integer | 否 | 业务类型。 枚举值:
| 1 |
| AgentPlatform | string | 否 | Agent 平台。 枚举值:
| ENTERPRISE |
| IncludeRiskInfo | boolean | 否 | 是否查询并返回风险信息。默认为 false。设置为 true 时,响应中将包含 RiskInfo 字段,同时 HasRisk 筛选条件才会生效。 | true |
| HasRisk | boolean | 否 | 是否存在风险。用于过滤有风险或无风险的云电脑,仅当 IncludeRiskInfo 为 true 时生效。 设置为 true 表示仅返回存在风险的记录,设置为 false 表示仅返回无风险的记录,不传则不做过滤。 | true |
| HasAuthUser | boolean | 否 | 是否已授权用户。 枚举值:
| true |
| PageSize | integer | 否 | 每页大小。 | 20 |
| PageNumber | integer | 否 | 页码,从 1 开始,0 和 1 返回相同结果。 | 1 |
返回参数
示例
正常返回示例
JSON格式
{
"PageSize": 20,
"PageNumber": 1,
"Data": [
{
"DesktopId": "ecd-xxxx",
"RegionId": "cn-hangzhou",
"ResourceId": "ecd-xxxx",
"DesktopName": "Agent-001",
"DesktopStatus": "Running",
"AuthUsers": [
"user-001"
],
"AgentInstanceInfoList": [
{
"AgentInstanceVersion": "2026.3.13",
"AgentInstanceStatus": "Running",
"ModelConfigure": true,
"ChannelConfigure": true,
"ChannelConfiguredList": [
"dingtalk-connector"
],
"DeploymentSource": "Admin",
"ModelTemplateId": "mt-xxxx"
}
],
"ModelConfigure": true,
"ChannelConfigure": true,
"ChannelConfiguredList": [
"dingtalk-connector"
],
"AgentImInfo": {
"AgentImStatus": "Enabled",
"CloudSpaceStatus": "Enabled"
},
"RiskInfo": {
"ModelModified": true,
"ChannelModified": true,
"AgentUninstalled": true
},
"ResourceGroup": {
"ResourceGroupId": "rg-xxxx",
"ResourceGroupName": "resource-group-001"
},
"HasAuthUser": true
}
],
"TotalCount": 30,
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2026-05-01 | 新增 OpenAPI | 查看变更详情 |
