DescribeUserResources - 查询用户拥有的无影云资源列表

更新时间:
复制 MD 格式

查询用户资源列表。

接口说明

请确保在使用该接口前,已充分了解无影产品的资源类型和产品类型。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

ClientId

string

客户端生成的唯一 ID,参考 UUID。该参数非敏感字段,无需加密。

54c17e1d-2d72-4b87-aa33-25f3b3f2****

ClientType

string

客户端的类型。

枚举值:

  • html5 :

    Web 客户端

  • android :

    Android 客户端

  • windows :

    Windows 客户端

  • ios :

    iOS 客户端

  • macos :

    macOS 客户端

windows

ClientVersion

string

客户端版本。

7.6.0-R-20241112.222305

LoginToken

string

登录凭证。 通过GetLoginToken接口登录获取,或登录后通过更新接口RefreshLoginToken获取。返回参数:LoginToken。

v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****

SessionId

string

会话 ID。调用GetLoginToken接口获取。

cd45e873-650d-4d70-acb9-f996187a****

LoginRegionId

string

登录的地域 ID,用于办公网络 ID 登录场景。组织 ID 登录场景无需填写。

cn-hangzhou

SearchRegionId

string

搜索地域 ID。用于过滤出指定地域的云资源信息。

cn-hangzhou

OfficeSiteIds

array

办公网络 ID 列表。AD 账号登录时填写。

string

办公网络 ID。

cn-hangzhou+dir-5440****

ResourceTypes

array

资源类型列表,为空则查询所有资源类型。

string

资源类型。

枚举值:

  • App :

    云应用(含云应用、云手机、云浏览器)

  • Desktop :

    云电脑

  • DesktopGroup :

    共享型云电脑

  • CloudDrive :

    企业网盘

Desktop

ProductTypes

array

产品类型列表,为空则查询所有产品类型。

string

产品类型。

枚举值:

  • CloudDesktop :

    云电脑(含云电脑和共享型云电脑)

  • CloudApp :

    云应用

  • CloudBrowser :

    云浏览器

  • AndroidCloud :

    云手机

CloudApp

ResourceIds

array

资源 ID 列表。 可设置 0~100 个。

string

资源 ID。

ecd-00001

ResourceName

string

资源名称,支持模糊搜索。

testName

ProtocolType

string

协议类型。该参数仅用于过滤云电脑。

枚举值:

  • HDX :

    HDX 协议

  • ASP :

    阿里巴巴自研 ASP 协议

ASP

AccessType

string

接入类型,不传表示两种都显示。

枚举值:

  • INTERNET :

    互联网接入

  • VPC :

    企业专网接入

INTERNET

Language

string

客户端语言。

枚举值:

  • en_US :

    英语

  • zh_CN :

    简体中文

  • ja_JP :

    日语

zh-CN

CategoryType

integer

资源一级类目。

1

CategoryId

integer

资源二级类目。

0

QueryFotaUpdate

boolean

是否查询云电脑镜像版本信息。

false

RefreshFotaUpdate

boolean

是否实时刷新 OTA 信息。

false

OrderBy

string

排序字段,若不指定则按照创建时间倒序。

枚举值:

  • CreateTime :

    资源创建时间

  • AssignTime :

    资源授权时间

AssignTime

SortType

string

排序方式。

枚举值:

  • ASC :

    升序 [默认值]

  • DESC :

    降序

ASC

MaxResults

integer

分页查询时每页行数。 默认值 500。

500

NextToken

string

下一页 Token。

caeba0bbb2be03f84eb48b699f0a4883

AutoRefresh

boolean

是否立即刷新。

说明

为了保证接口响应速度,建议传入false

枚举值:

  • false :

    不立即刷新

  • true :

    立即刷新

false

Scene

string

客户端场景,用于标识排序。请传入desktop

枚举值:

  • desktop :

    云电脑

desktop

DualCenterForward deprecated

boolean

是否双中心转发。请传入false

枚举值:

  • false :

    非双中心转发

false

QueryDesktopTimers

boolean

是否查询云电脑定时任务信息,默认为 true。

枚举值:

  • true :

    是,默认值

  • false :

true

QueryDesktopDurationList

boolean

是否查询云桌面套餐包信息,默认为 true。

枚举值:

  • true :

    是,默认值

  • false :

true

Uuid

string

客户端 Uuid。

FE44BAFDD92308BDAFE01217F948XXXX

返回参数

名称

类型

描述

示例值

object

NextToken

string

下一页查询开始的 Token,NextToken 为空表示没有下一页。

AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****

RequestId

string

请求 ID。

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

QueryFailedResourceTypes

array

查询失败的资源类型列表。

string

资源类型

枚举值:

  • CloudDesktop :

    云电脑(含云电脑和共享型云电脑)

  • CloudApp :

    云应用(含云应用、云手机、云浏览器)

  • CloudDrive :

    企业网盘

CloudDesktop

Resources

array<object>

资源详细信息列表。

array<object>

资源详细信息。

AliUid

integer

阿里云账号 ID。

194101959****

ResourceType

string

资源类型。

枚举值:

  • App :

    云应用(含云应用、云手机、云浏览器)

  • Desktop :

    云电脑

  • DesktopGroup :

    共享型云电脑

  • CloudDrive :

    企业网盘

Desktop

RegionId

string

地域 ID。

cn-hangzhou

RegionLocation

string

地域位置。

枚举值:

  • Mainland :

    中国内地地域

  • Overseas :

    海外地域(含中国香港)

Mainland

ResourceGroupId

string

资源组 ID。

dg-0****

ResourceId

string

资源 ID。

ecd-d19tya8zi4****

ResourceLevel

string

资源级别。

枚举值:

  • Center :

    中心化资源

  • Region :

    单元化资源

Center

CenterResourceId

string

中心化资源 ID。

ecds-0****

ResourceName

string

资源名称。

testName01

CreateTime

string

资源创建时间。

2024-12-11T07:12:12Z

ProductType

string

产品类型。

枚举值:

  • CloudDesktop :

    云电脑(含云电脑和共享型云电脑)

  • CloudApp :

    云应用

  • CloudBrowser :

    云浏览器

  • AndroidCloud :

    云手机

AndroidCloud

OfficeSiteId

string

办公网络 ID。

cn-shanghai+dir-3367****

AccessType

string

接入类型。

枚举值:

  • INTERNET :

    互联网接入

  • VPC :

    企业专网接入

  • ANY :

    互联网接入和企业专网接入均可以

INTERNET

ProtocolType

string

协议类型。

枚举值:

  • HDX :

    HDX 协议

  • ASP :

    阿里巴巴自研 ASP 协议

ASP

OsType

string

操作系统类型。

枚举值:

  • Linux :

    Linux

  • Windows :

    Windows

  • Android :

    Android

Windows

Os

string

操作系统平台信息。

Windows Server 2022

OsDescription

string

操作系统平台描述信息。

Windows 正版授权

SupportHibernation

boolean

是否支持休眠。

枚举值:

  • true :

    支持休眠

  • false :

    不支持休眠

true

HibernationBeta

boolean

是否为休眠测试版本。

枚举值:

  • true :

    是休眠测试版本

  • false :

    不是休眠测试版本

false

SessionType

string

会话类型。

枚举值:

  • SINGLE_SESSION :

    单会话

  • MULTIPLE_SESSION :

    多会话

SINGLE_SESSION

ChargeType

string

计费方式。

枚举值:

  • PostPaid :

    按量付费 [默认值]

  • PrePaid :

    包年包月

PrePaid

SubPayType

string

子计费方式。

枚举值:

  • monthPackage :

    按月预付费

  • PrePaid :

    时长包

PrePaid

ExpiredTime

string

包年包月付费类型资源的到期时间。

2025-02-22T16:00:00Z

AuthMode

string

云应用授权模式。

枚举值:

  • App :

    应用授权

  • AppInstanceGroup :

    交付组授权

  • Session :

    会话授权

App

AppId

string

应用 ID。资源类型为 App 的资源特有参数。

app-0001

Version

string

资源版本。资源类型为 App 的资源特有参数。

资源版本。

CategoryType

integer

资源一级类目。资源类型为 App 的资源特有参数。

1

CategoryId

integer

资源二级类目。资源类型为 App 的资源特有参数。

0

Icon

string

资源图标链接。资源类型为 App 的资源特有参数。

http://example.com/icon.png

ThemeColor

string

资源主题颜色。资源类型为 App 的资源特有参数。

#FFFFFF

CdsName

string

网盘名称。资源类型为 CloudDrive 的资源特有参数。

cn-shanghai+cds-695277****

ExternalDomainId

string

外部 Domain ID。资源类型为 CloudDrive 的资源特有参数。

stg114510

ExternalUserId

string

外部用户 ID。资源类型为 CloudDrive 的资源特有参数。

test001

GlobalStatus

boolean

是否支持跨地域访问。资源类型为 CloudDrive 的资源特有参数。

true

LocalName

string

地域名称。

华东1(杭州)

DesktopTimers

array<object>

云电脑定时任务设置列表。

object

云电脑定时任务设置。

TimerType

string

任务类型。

TimerBoot

CronExpression

string

定时任务的 Cron 表达式。

0 30 13 ? * 1-7

Interval

integer

定时任务间隔时间。

15

Enforce

boolean

是否强制执行。

false

ResetType

string

重置类型。

RESET_TYPE_SYSTEM

AllowClientSetting

string

是否允许客户端设置。

false

OperationType

string

操作类型。

Hibernate

ExecutionTime

string

执行时间。

2025-01-21T11:37Z

Clients

array<object>

资源支持的客户端类型列表。

object

资源支持的单类客户端类型设置信息。

ClientType

string

客户端类型。

windows

Status

string

支持状态。

枚举值:

  • OFF :

    禁用

  • ON :

    启用

ON

ResourceStatus

string

资源状态。

枚举值:

  • Unknown :

    未知

  • Stopped :

    已关机

  • Failed :

    创建失败

  • Starting :

    启动中

  • Rebuilding :

    变更中

  • Running :

    运行中

  • Stopping :

    停止中

  • FotaUpdating :

    镜像升级中

  • Pending :

    等待中

  • Deleting :

    删除中

  • Unavailable :

    不可用

Running

LastStartTime

string

资源上次启动时间。

2025-01-24T03:12:04Z

OrderStatus

string

订单状态。

枚举值:

  • Ceased :

    后付费欠费

  • Released :

    订单关闭

  • Expired :

    预付费停机

  • Normal :

    正常

Normal

ManagementStatuses

array

管理状态列表。

string

管理状态

NoFlag

ResourceSessionStatus

string

会话状态。

枚举值:

  • Unknown :

    未知

  • Connected :

    已连接

  • Disconnected :

    已断开连接

Connected

Sessions

array<object>

资源用户会话信息列表。

object

资源用户会话信息。

UserId

string

登录资源的用户名。

user001

UserPrincipalName

string

绑定资源的用户的 UPN(如果有),只有当前查询用户的 Session 该值才可能有值。

benchmark_test@test.shenzhen

ResourceSessionStartTime

string

资源会话连接的时间。

2025-01-22T11:03:36Z

NickName

string

用户的昵称。

user-001

LastClientIp

string

该用户最后登录的客户端 IP。

1.2.3.4:22068

RealDesktopId

string

【共享型云电脑】真实云电脑 ID,当共享型云电脑存在会话时存在。

ecd-0001

UserCustomName

string

用户自定义名称。

我的云电脑

FotaUpdate

object

云电脑升级信息。

Project

string

项目名称。

wuying-asp_single_session_desktop_win_x64

Channel

string

通道。

aliyun

CurrentAppVersion

string

云电脑当前镜像的版本号。

2.7.0-R-20250122.154826

NewAppVersion

string

云电脑可升级的版本号。

2.7.0-R-20250125.154826

Force

boolean

是否强制升级。

false

ReleaseNote

string

可升级的版本描述。

新版本

Size

string

可升级的版本安装包大小。单位:KB。

474981930

ReleaseNoteEn

string

可升级的版本英文描述。

new version

ReleaseNoteJp

string

可升级的版本日文描述。

新バージョン

NewDcdVersion

string

可升级的组件盘版本号。

2.6.9-R-20250123.153415

OsUpdate

object

操作系统升级信息。

CheckId

string

校验 ID。

wua-1740652957251743***

PackageCount

integer

包数量。

1

Packages

array<object>

补丁包信息列表。

object

补丁包信息。

Kb

string

补丁号。

KB2267***

Title

string

补丁标题。

用于****的补丁。

Description

string

补丁描述。

安装此更新可修改用于检测病毒、间谍软件和其他潜在不需要的软件的文件。此项一旦安装,便无法删除。

KbListString

string

补丁号列表信息。

KB2267***

UpdateCatalogUrl

string

更新分类 URL。

https://catalog.update.microsoft.com/home.aspx

HasUpgrade

boolean

是否存在更新。

true

DesktopDurationList

array<object>

云电脑套餐包信息列表。

object

云电脑套餐包信息。

PackageCreationTime

string

创建时间。

2025-01-17T07:01Z

PackageStatus

string

状态。

Available

UsedDuration

integer

已使用时长。

16850

PackageExpiredTime

string

过期时间。

2025-02-17T15:59Z

PackageId

string

套餐包 ID。

mdp-0bxls4qpi6bl6****

TotalDuration

integer

总时长。

432000

PackageType

string

时长包类型。

枚举值:

  • FREE_PACKAGE :

    免费包

  • NORMAL_PACKAGE :

    付费包(120 小时包)

  • POSTPAID_PACKAGE :

    用于记录后付费额度包(200 小时包)

  • Duration :

    时长包

NORMAL_PACKAGE

PeriodStartTime

string

当月包开始时间。

2025-01-17T07:01Z

PeriodEndTime

string

当月包结束时间。

2025-02-17T15:59Z

PostPaidLimitFee

number

第二阶段包的封顶金额。

说明

仅 ResourceType 为POSTPAID_PACKAGFREE_PACKAGE时会返回。

199

OrderInstanceId

string

订单实例 ID。

mdp-0bxls4qpi6bl6****

PackageUsedUpStrategy

string

套餐当月额度使用完毕后的云电脑状态策略。

枚举值:

  • Shutdown :

    关机或休眠

  • Postpaid :

    继续使用并按量付费

Postpaid

ConnectionProperties

string

连接属性,JSON 字符串,客户端无需关心内容,当应用资源建联时直接传递给中心资源管控。

{"authMode":"App"}

SupportedActions

array

支持的操作类型列表,目前只支持云手机和云电脑(含共享型云电脑)。

string

操作类型。

枚举值:

  • WakeUp :

    唤醒

  • Hibernate :

    休眠

  • Start :

    开机

  • Stop :

    关机

  • Restart :

    重启

Start

SupportAgentIm

boolean

是否支持 AgentIM。

AgentImUrl

string

AgentIm 页面的 URL。

https://wuying.aliyun.com/OpenIM/chat?desktopId=ecd-xxxxx

Cpu

integer

CPU 核数。

4

Memory

integer

内存,单位为 M。

4096

GpuSpec

string

GPU 规格。

40GiB

Disks

array<object>

磁盘信息列表。

object

磁盘信息。

DiskType

string

磁盘类型。

SYSTEM

DiskSize

integer

磁盘大小,单位为 G。

300

AgentProviderList

array

Agent 提供商列表。

string

Agent 提供商。

AgenticComputer

RankVersion

integer

排序数据版本号。

1732869815062

TotalCount

integer

总数。

10

MaxResults

integer

返回最大数量。

100

AgentBriefSummary

object

Agent 概要汇总信息。

TotalCount

integer

Agent 实例总数。

10

AgentBriefs

array<object>

包含的 Agent 实例类型概要信息列表。

object

Agent 实例类型概要信息。

AgentPlatform

string

Agent 平台

ENTERPRISE_JVS

AgentProvider

string

Agent 提供商。

OpenClaw

Count

integer

数量。

2

AvatarUrl

string

该类型 Agent 的通用头像下载链接。 后端根据 ClientType 自动返回不同的头像。匹配不到返回通用的头像。

https://abc.com/efg.png

Url

string

Agent 管理页 URL。

https://test.png

DisplayName

string

显示名,如 JVS Claw。 后端根据 Language 自动返回不同的显示名。

JVS Claw

SubTitle

string

副标题,如:智在进化 快乐养虾 后端根据 Language 自动返回不同的副标题。

智在进化,快乐养虾

AvatarNoResourceUrl

string

无云资源时该类型 Agent 的通用头像下载链接。 后端根据 ClientType 自动返回不同的头像。匹配不到返回通用的头像。

https://xxx.png

PcAvatarUrl

string

该类型 Agent 的 PC 端通用头像下载链接。

https://xxx.png

Watermark

string

该类型 Agent 根据客户端类型选择的头像水印链接。

https://xxxx.png

返回参数并不是所有资源都拥有,请确保清楚每种资源拥有哪些参数字段。

示例

正常返回示例

JSON格式

{
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "QueryFailedResourceTypes": [
    "CloudDesktop"
  ],
  "Resources": [
    {
      "AliUid": 0,
      "ResourceType": "Desktop",
      "RegionId": "cn-hangzhou",
      "RegionLocation": "Mainland",
      "ResourceGroupId": "dg-0****",
      "ResourceId": "ecd-d19tya8zi4****",
      "ResourceLevel": "Center",
      "CenterResourceId": "ecds-0****",
      "ResourceName": "testName01",
      "CreateTime": "2024-12-11T07:12:12Z",
      "ProductType": "AndroidCloud",
      "OfficeSiteId": "cn-shanghai+dir-3367****",
      "AccessType": "INTERNET",
      "ProtocolType": "ASP",
      "OsType": "Windows",
      "Os": "Windows Server 2022",
      "OsDescription": "Windows 正版授权",
      "SupportHibernation": true,
      "HibernationBeta": false,
      "SessionType": "SINGLE_SESSION",
      "ChargeType": "PrePaid",
      "SubPayType": "PrePaid",
      "ExpiredTime": "2025-02-22T16:00:00Z",
      "AuthMode": "App",
      "AppId": "app-0001",
      "Version": "资源版本。",
      "CategoryType": 1,
      "CategoryId": 0,
      "Icon": "http://example.com/icon.png",
      "ThemeColor": "#FFFFFF",
      "CdsName": "cn-shanghai+cds-695277****",
      "ExternalDomainId": "stg114510",
      "ExternalUserId": "test001",
      "GlobalStatus": true,
      "LocalName": "华东1(杭州)",
      "DesktopTimers": [
        {
          "TimerType": "TimerBoot",
          "CronExpression": "0 30 13 ? * 1-7",
          "Interval": 15,
          "Enforce": false,
          "ResetType": "RESET_TYPE_SYSTEM",
          "AllowClientSetting": "false",
          "OperationType": "Hibernate",
          "ExecutionTime": "2025-01-21T11:37Z"
        }
      ],
      "Clients": [
        {
          "ClientType": "windows",
          "Status": "ON"
        }
      ],
      "ResourceStatus": "Running",
      "LastStartTime": "2025-01-24T03:12:04Z",
      "OrderStatus": "Normal",
      "ManagementStatuses": [
        "NoFlag"
      ],
      "ResourceSessionStatus": "Connected",
      "Sessions": [
        {
          "UserId": "user001",
          "UserPrincipalName": "benchmark_test@test.shenzhen",
          "ResourceSessionStartTime": "2025-01-22T11:03:36Z",
          "NickName": "user-001",
          "LastClientIp": "1.2.3.4:22068"
        }
      ],
      "RealDesktopId": "ecd-0001",
      "UserCustomName": "我的云电脑",
      "FotaUpdate": {
        "Project": "wuying-asp_single_session_desktop_win_x64",
        "Channel": "aliyun",
        "CurrentAppVersion": "2.7.0-R-20250122.154826",
        "NewAppVersion": "2.7.0-R-20250125.154826",
        "Force": false,
        "ReleaseNote": "新版本",
        "Size": "474981930",
        "ReleaseNoteEn": "new version",
        "ReleaseNoteJp": "新バージョン",
        "NewDcdVersion": "2.6.9-R-20250123.153415"
      },
      "OsUpdate": {
        "CheckId": "wua-1740652957251743***",
        "PackageCount": 1,
        "Packages": [
          {
            "Kb": "KB2267***",
            "Title": "用于****的补丁。",
            "Description": "安装此更新可修改用于检测病毒、间谍软件和其他潜在不需要的软件的文件。此项一旦安装,便无法删除。"
          }
        ],
        "KbListString": "KB2267***",
        "UpdateCatalogUrl": "https://catalog.update.microsoft.com/home.aspx"
      },
      "HasUpgrade": true,
      "DesktopDurationList": [
        {
          "PackageCreationTime": "2025-01-17T07:01Z",
          "PackageStatus": "Available",
          "UsedDuration": 16850,
          "PackageExpiredTime": "2025-02-17T15:59Z",
          "PackageId": "mdp-0bxls4qpi6bl6****",
          "TotalDuration": 432000,
          "PackageType": "NORMAL_PACKAGE",
          "PeriodStartTime": "2025-01-17T07:01Z",
          "PeriodEndTime": "2025-02-17T15:59Z",
          "PostPaidLimitFee": 199,
          "OrderInstanceId": "mdp-0bxls4qpi6bl6****",
          "PackageUsedUpStrategy": "Postpaid"
        }
      ],
      "ConnectionProperties": "{\"authMode\":\"App\"}",
      "SupportedActions": [
        "Start"
      ],
      "SupportAgentIm": true,
      "AgentImUrl": "https://wuying.aliyun.com/OpenIM/chat?desktopId=ecd-xxxxx",
      "Cpu": 4,
      "Memory": 4096,
      "GpuSpec": "40GiB",
      "Disks": [
        {
          "DiskType": "SYSTEM",
          "DiskSize": 300
        }
      ],
      "AgentProviderList": [
        "AgenticComputer"
      ]
    }
  ],
  "RankVersion": 1732869815062,
  "TotalCount": 10,
  "MaxResults": 100,
  "AgentBriefSummary": {
    "TotalCount": 10,
    "AgentBriefs": [
      {
        "AgentPlatform": "ENTERPRISE_JVS",
        "AgentProvider": "OpenClaw",
        "Count": 2,
        "AvatarUrl": "https://abc.com/efg.png",
        "Url": "https://test.png",
        "DisplayName": "JVS Claw",
        "SubTitle": "智在进化,快乐养虾",
        "AvatarNoResourceUrl": "https://xxx.png",
        "PcAvatarUrl": "https://xxx.png",
        "Watermark": "https://xxxx.png"
      }
    ]
  }
}

错误码

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

变更历史

更多信息,参考变更详情