赛尔校园公共服务平台 Logo
平台使用
阿里云
百度云
移动云
智算服务
教育生态
登录 →
赛尔校园公共服务平台 Logo
平台使用 阿里云 百度云 移动云 智算服务 教育生态
登录
  1. 首页
  2. 阿里云
  3. 无影云电脑企业版
  4. 开发参考
  5. API参考(客户端)
  6. API目录
  7. 云资源管理
  8. DescribeUserResources - 查询用户拥有的无影云资源列表

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

  • 云资源管理
  • 发布于 2025-04-17
  • 0 次阅读
文档编辑
文档编辑

查询用户资源列表。

接口说明

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

调试

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

调试

授权信息

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

请求参数

名称类型必填描述示例值
ClientIdstring是

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

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

客户端的类型。

枚举值:
  • html5:Web客户端。
  • android:Android客户端。
  • windows:Windows客户端。
  • ios:iOS客户端。
  • macos:macOS客户端。
windows
ClientVersionstring否

客户端版本。

7.6.0-R-20241112.222305
LoginTokenstring是

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

v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****
SessionIdstring是

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

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

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

cn-hangzhou
SearchRegionIdstring否

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

cn-hangzhou
OfficeSiteIdsarray否

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

string否

办公网络 ID。

cn-hangzhou+dir-5440****
ResourceTypesarray否

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

string否

资源类型。

枚举值:
  • App:云应用(含云应用、云手机、云浏览器)。
  • Desktop:云电脑。
  • DesktopGroup:共享型云电脑。
  • CloudDrive:企业网盘。
Desktop
ProductTypesarray否

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

string否

产品类型。

枚举值:
  • CloudDesktop:云电脑(含云电脑和共享型云电脑)。
  • CloudApp:云应用。
  • CloudBrowser:云浏览器。
  • AndroidCloud:云手机。
CloudApp
ResourceIdsarray否

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

string否

资源 ID。

ecd-00001
ResourceNamestring否

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

testName
ProtocolTypestring否

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

枚举值:
  • HDX:HDX协议。
  • ASP:阿里巴巴自研ASP协议。
ASP
AccessTypestring否

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

枚举值:
  • INTERNET:互联网接入。
  • VPC:企业专网接入。
INTERNET
Languagestring否

客户端语言。

枚举值:
  • en_US:英语。
  • zh_CN:简体中文。
  • ja_JP:日语。
zh-CN
CategoryTypeinteger否

资源一级类目。

1
CategoryIdinteger否

资源二级类目。

0
QueryFotaUpdateboolean否

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

false
RefreshFotaUpdateboolean否

是否实时刷新 OTA 信息。

false
OrderBystring否

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

枚举值:
  • CreateTime:资源创建时间。
  • AssignTime:资源授权时间。
AssignTime
SortTypestring否

排序方式。

枚举值:
  • ASC:升序 [默认值]。
  • DESC:降序。
ASC
MaxResultsinteger否

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

500
NextTokenstring否

下一页 Token。

caeba0bbb2be03f84eb48b699f0a4883
AutoRefreshboolean否

是否立即刷新。

说明 为了保证接口响应速度,建议传入false。
枚举值:
  • false:不立即刷新。
  • true:立即刷新。
false
Scenestring否

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

枚举值:
  • desktop:云电脑。
desktop
DualCenterForwardboolean否

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

枚举值:
  • false:非双中心转发。
false

返回参数

名称类型描述示例值
object
NextTokenstring

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

AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
RequestIdstring

请求 ID。

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

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

queryFailedResourceTypesstring

资源类型

枚举值:
  • CloudDesktop:云电脑(含云电脑和共享型云电脑)。
  • CloudApp:云应用(含云应用、云手机、云浏览器)。
  • CloudDrive:企业网盘。
CloudDesktop
Resourcesarray<object>

资源详细信息列表。

Desktopobject

资源详细信息。

AliUidlong

阿里云账号 ID。

194101959****
ResourceTypestring

资源类型。

枚举值:
  • App:云应用(含云应用、云手机、云浏览器)。
  • Desktop:云电脑。
  • DesktopGroup:共享型云电脑。
  • CloudDrive:企业网盘。
Desktop
RegionIdstring

地域 ID。

cn-hangzhou
RegionLocationstring

地域位置。

枚举值:
  • Mainland:中国内地地域。
  • Overseas:海外地域(含中国香港)。
Mainland
ResourceGroupIdstring

资源组 ID。

dg-0****
ResourceIdstring

资源 ID。

ecd-d19tya8zi4****
ResourceLevelstring

资源级别。

枚举值:
  • Center:中心化资源。
  • Region:单元化资源。
Center
CenterResourceIdstring

中心化资源 ID。

ecds-0****
ResourceNamestring

资源名称。

testName01
CreateTimestring

资源创建时间。

2024-12-11T07:12:12Z
ProductTypestring

产品类型。

枚举值:
  • CloudDesktop:云电脑(含云电脑和共享型云电脑)。
  • CloudApp:云应用。
  • CloudBrowser:云浏览器。
  • AndroidCloud:云手机。
AndroidCloud
OfficeSiteIdstring

办公网络 ID。

cn-shanghai+dir-3367****
AccessTypestring

接入类型。

枚举值:
  • INTERNET:互联网接入。
  • VPC:企业专网接入。
  • ANY:互联网接入和企业专网接入均可以。
INTERNET
ProtocolTypestring

协议类型。

枚举值:
  • HDX:HDX协议。
  • ASP:阿里巴巴自研ASP协议。
ASP
OsTypestring

操作系统类型。

枚举值:
  • Linux:Linux。
  • Windows:Windows。
  • Android:Android。
Windows
Osstring

操作系统平台信息。

Windows Server 2022
OsDescriptionstring

操作系统平台描述信息。

Windows 正版授权
SupportHibernationboolean

是否支持休眠。

枚举值:
  • true:支持休眠。
  • false:不支持休眠。
true
HibernationBetaboolean

是否为休眠测试版本。

枚举值:
  • true:是休眠测试版本。
  • false:不是休眠测试版本。
false
SessionTypestring

会话类型。

枚举值:
  • SINGLE_SESSION:单会话。
  • MULTIPLE_SESSION:多会话。
SINGLE_SESSION
ChargeTypestring

计费方式。

枚举值:
  • PostPaid:按量付费 [默认值]。
  • PrePaid:包年包月。
PrePaid
SubPayTypestring

子计费方式。

枚举值:
  • monthPackage:按月预付费。
  • PrePaid:时长包。
PrePaid
ExpiredTimestring

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

2025-02-22T16:00:00Z
AuthModestring

云应用授权模式。

枚举值:
  • App:应用授权。
  • AppInstanceGroup:交付组授权。
  • Session:会话授权。
App
AppIdstring

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

app-0001
Versionstring

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

资源版本。
CategoryTypeinteger

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

1
CategoryIdinteger

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

0
Iconstring

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

http://example.com/icon.png
ThemeColorstring

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

#FFFFFF
CdsNamestring

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

cn-shanghai+cds-695277****
ExternalDomainIdstring

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

stg114510
ExternalUserIdstring

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

test001
GlobalStatusboolean

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

true
LocalNamestring

地域名称。

华东1(杭州)
DesktopTimersarray<object>

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

DesktopTimerobject

云电脑定时任务设置。

TimerTypestring

任务类型。

TimerBoot
CronExpressionstring

定时任务的 Cron 表达式。

0 30 13 ? * 1-7
Intervalinteger

定时任务间隔时间。

15
Enforceboolean

是否强制执行。

false
ResetTypestring

重置类型。

RESET_TYPE_SYSTEM
AllowClientSettingstring

是否允许客户端设置。

false
OperationTypestring

操作类型。

Hibernate
ExecutionTimestring

执行时间。

2025-01-21T11:37Z
Clientsarray<object>

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

Clientsobject

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

ClientTypestring

客户端类型。

windows
Statusstring

支持状态。

枚举值:
  • OFF:禁用。
  • ON:启用。
ON
ResourceStatusstring

资源状态。

枚举值:
  • Unknown:未知。
  • Stopped:已关机。
  • Failed:创建失败。
  • Starting:启动中。
  • Rebuilding:变更中。
  • Running:运行中。
  • Stopping:停止中。
  • FotaUpdating:镜像升级中。
  • Pending:等待中。
  • Deleting:删除中。
  • Unavailable:不可用。
Running
LastStartTimestring

资源上次启动时间。

2025-01-24T03:12:04Z
OrderStatusstring

订单状态。

枚举值:
  • Ceased:后付费欠费。
  • Released:订单关闭。
  • Expired:预付费停机。
  • Normal:正常。
Normal
ManagementStatusesarray

管理状态列表。

ManagementStatusesstring

管理状态

NoFlag
ResourceSessionStatusstring

会话状态。

枚举值:
  • Unknown:未知。
  • Connected:已连接。
  • Disconnected:已断开连接。
Connected
Sessionsarray<object>

资源用户会话信息列表。

Sessionobject

资源用户会话信息。

UserIdstring

登录资源的用户名。

user001
UserPrincipalNamestring

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

benchmark_test@test.shenzhen
ResourceSessionStartTimestring

资源会话连接的时间。

2025-01-22T11:03:36Z
RealDesktopIdstring

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

ecd-0001
UserCustomNamestring

用户自定义名称。

我的云电脑
FotaUpdateobject

云电脑升级信息。

Projectstring

项目名称。

wuying-asp_single_session_desktop_win_x64
Channelstring

通道。

aliyun
CurrentAppVersionstring

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

2.7.0-R-20250122.154826
NewAppVersionstring

云电脑可升级的版本号。

2.7.0-R-20250125.154826
Forceboolean

是否强制升级。

false
ReleaseNotestring

可升级的版本描述。

新版本
Sizestring

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

474981930
ReleaseNoteEnstring

可升级的版本英文描述。

new version
ReleaseNoteJpstring

可升级的版本日文描述。

新バージョン
NewDcdVersionstring

可升级的组件盘版本号。

2.6.9-R-20250123.153415
OsUpdateobject

操作系统升级信息。

CheckIdstring

校验 ID。

wua-1740652957251743***
PackageCountinteger

包数量。

1
Packagesarray<object>

补丁包信息列表。

Packageobject

补丁包信息。

Kbstring

补丁号。

KB2267***
Titlestring

补丁标题。

用于****的补丁。
Descriptionstring

补丁描述。

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

补丁号列表信息。

KB2267***
UpdateCatalogUrlstring

更新分类 URL。

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

是否存在更新。

true
DesktopDurationListarray<object>

云电脑套餐包信息列表。

desktopDurationobject

云电脑套餐包信息。

PackageCreationTimestring

创建时间。

2025-01-17T07:01Z
PackageStatusstring

状态。

Available
UsedDurationlong

已使用时长。

16850
PackageExpiredTimestring

过期时间。

2025-02-17T15:59Z
PackageIdstring

套餐包 ID。

mdp-0bxls4qpi6bl6****
TotalDurationlong

总时长。

432000
PackageTypestring

时长包类型。

枚举值:
  • FREE_PACKAGE:免费包。
  • NORMAL_PACKAGE:付费包(120小时包)。
  • POSTPAID_PACKAGE:用于记录后付费额度包(200小时包)。
  • Duration:时长包。
NORMAL_PACKAGE
PeriodStartTimestring

当月包开始时间。

2025-01-17T07:01Z
PeriodEndTimestring

当月包结束时间。

2025-02-17T15:59Z
PostPaidLimitFeefloat

第二阶段包的封顶金额。

说明 仅 ResourceType 为POSTPAID_PACKAG和FREE_PACKAGE时会返回。
199
OrderInstanceIdstring

订单实例 ID。

mdp-0bxls4qpi6bl6****
PackageUsedUpStrategystring

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

枚举值:
  • Shutdown:关机或休眠。
  • Postpaid:继续使用并按量付费。
Postpaid
ConnectionPropertiesstring

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

{"authMode":"App"}
SupportedActionsarray

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

SupportedActionsstring

操作类型。

枚举值:
  • WakeUp:唤醒。
  • Hibernate:休眠。
  • Start:开机。
  • Stop:关机。
  • Restart:重启。
Start
RankVersionlong

排序数据版本号。

1732869815062

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

示例

正常返回示例

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"
        }
      ],
      "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"
      ]
    }
  ],
  "RankVersion": 1732869815062
}

错误码

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

变更历史

变更时间变更内容概要操作
2025-02-25OpenAPI 返回结构发生变更查看变更详情
相关文章

DescribeRegions - 查看可选的地域和可用区 2025-04-17 11:20

DescribeDirectories - 查询目录详细信息 2025-04-17 11:20

查询目录详细信息。

DescribeOfficeSites - 查询办公网络详细信息 2025-04-17 11:20

查询办公网络的详细信息。

DescribeGlobalDesktops - 查询全地域云电脑详细信息 2025-04-17 11:20

查询多个地域的云电脑详细信息。目前仅支持中国内地对应的地域查询(不包含南京本地地域)。

DescribeUserResources - 查询用户拥有的无影云资源列表 2025-04-17 11:20

查询用户资源列表。 接口说明

UnbindUserDesktop - 将用户与云电脑解绑 2025-04-17 11:20

将用户与云电脑解绑。

目录
Copyright © 2025 your company All Rights Reserved. Powered by 赛尔网络.
京ICP备14022346号-15
gongan beian 京公网安备11010802041014号