Referensi API DescribeUserResources & Parameter - Elastic Desktop Service - Alibaba Cloud - Elastic Desktop Service

Mengkueri daftar sumber daya pengguna.

Deskripsi operasi

Before you call this operation, ensure that you understand the resource and product types of Wuying Workspace.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Parameter permintaan

Parameter	Type	Required	Description	Example
ClientId	string	Yes	ID unik yang dihasilkan oleh klien, mirip dengan UUID. Parameter ini tidak sensitif dan tidak memerlukan enkripsi.	54c17e1d-2d72-4b87-aa33-25f3b3f2****
ClientType	string	No	Tipe klien. Valid values: html5 : Klien web. android : Klien Android. windows : Klien Windows. ios : Klien iOS. macos : Klien macOS.	windows
ClientVersion	string	No	Versi klien.	7.6.0-R-20241112.222305
LoginToken	string	Yes	Kredensial logon. Dapatkan token ini dengan memanggil operasi `GetLoginToken`. Setelah Anda logon, Anda juga dapat memanggil operasi `RefreshLoginToken` untuk mendapatkan token yang diperbarui. Token dikembalikan dalam parameter `LoginToken`.	v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****
SessionId	string	No	ID sesi. Dapatkan ID ini dengan memanggil operasi `GetLoginToken`.	cd45e873-650d-4d70-acb9-f996187a****
LoginRegionId	string	No	ID wilayah tempat Anda logon. Parameter ini diperlukan saat Anda logon menggunakan ID jaringan kantor. Anda tidak perlu menentukan parameter ini saat Anda logon menggunakan ID organisasi.	cn-hangzhou
SearchRegionId	string	No	ID wilayah untuk pencarian. Parameter ini memfilter informasi sumber daya cloud di wilayah yang ditentukan.	cn-hangzhou
OfficeSiteIds	array	No	Daftar ID jaringan kantor. Tentukan parameter ini saat Anda logon dengan akun Direktori Aktif (AD).
	string	No	The office network ID.	cn-hangzhou+dir-5440****
ResourceTypes	array	No	Daftar tipe sumber daya. Jika Anda membiarkannya kosong, semua tipe sumber daya akan dikueri.
	string	No	The resource type. Valid values: App : cloud application (including cloud apps, cloud phones, and cloud browsers) Desktop : cloud desktop DesktopGroup : shared cloud desktop CloudDrive : enterprise cloud drive	Desktop
ProductTypes	array	No	Daftar tipe produk. Jika Anda membiarkannya kosong, semua tipe produk akan dikueri.
	string	No	The product type. Valid values: CloudDesktop : cloud desktop (including standard and shared cloud desktops) CloudApp : cloud application CloudBrowser : cloud browser AndroidCloud : cloud phone	CloudApp
ResourceIds	array	No	Daftar ID sumber daya. Anda dapat menentukan 0 hingga 100 ID.
	string	No	The resource ID.	ecd-00001
ResourceName	string	No	Nama sumber daya. Pencarian fuzzy didukung.	testName
ProtocolType	string	No	Jenis protokol. Parameter ini hanya digunakan untuk memfilter desktop cloud. Valid values: HDX : Protokol HDX. ASP : Protokol ASP internal Alibaba Cloud.	ASP
AccessType	string	No	Tipe akses. Jika Anda tidak menentukan parameter ini, sumber daya dari kedua tipe akses akan dikembalikan. Valid values: INTERNET : Akses internet. VPC : Akses VPC.	INTERNET
Language	string	No	Bahasa klien. Valid values: en_US : Inggris. zh_CN : Bahasa Mandarin Sederhana. ja_JP : Bahasa Jepang.	zh-CN
CategoryType	integer	No	Kategori sumber daya tingkat atas.	1
CategoryId	integer	No	Kategori sumber daya tingkat kedua.	0
QueryFotaUpdate	boolean	No	Apakah akan mengkueri informasi versi gambar desktop cloud.	false
RefreshFotaUpdate	boolean	No	Apakah akan menyegarkan informasi over-the-air (OTA) secara real pengatur waktu.	false
OrderBy	string	No	Bidang yang digunakan untuk pengurutan. Jika Anda tidak menentukan parameter ini, hasil akan diurutkan berdasarkan pengatur waktu pembuatan dalam Pesanan menurun. Valid values: CreateTime : pengatur waktu pembuatan sumber daya. AssignTime : pengatur waktu otorisasi sumber daya.	AssignTime
SortType	string	No	Pesanan pengurutan. Valid values: ASC : Pesanan menaik [Default]. DESC : Pesanan menurun.	ASC
MaxResults	integer	No	Jumlah entri yang dikembalikan pada setiap halaman untuk kueri berhalaman. Nilai default: 500.	500
NextToken	string	No	Token untuk halaman berikutnya.	caeba0bbb2be03f84eb48b699f0a4883
AutoRefresh	boolean	No	Apakah akan menyegarkan segera. Catatan Untuk memastikan tanggapan yang cepat, atur parameter ini menjadi `false`. Valid values: false : Tidak menyegarkan segera. true : Menyegarkan segera.	false
Scene	string	No	Skenario klien, digunakan untuk mengidentifikasi Pesanan pengurutan. Atur nilai menjadi `desktop`. Valid values: desktop : desktop cloud.	desktop
DualCenterForward `deprecated`	boolean	No	Apakah akan menggunakan penerusan dual-center. Atur nilai menjadi `false`. Valid values: false : Penerusan dual-center tidak digunakan.	false
QueryDesktopTimers	boolean	No	Apakah akan mengkueri informasi tentang tugas terjadwal untuk desktop cloud. Nilai default adalah true. Valid values: true : Ya. Ini adalah nilai default. false : No.	true
QueryDesktopDurationList	boolean	No	Apakah akan mengkueri informasi tentang paket desktop cloud. Nilai default adalah true. Valid values: true : Ya. Ini adalah nilai default. false : No.	true

Elemen respons

Element	Type	Description	Example
	object
NextToken	string	The token that marks the start of the next page of a paged query. If this parameter is empty, no more data is returned.	AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
QueryFailedResourceTypes	array	A list of resource types for which the query failed.
	string	The resource type. Valid values: CloudDesktop : cloud desktop (including standard and shared cloud desktops) CloudApp : cloud application (including cloud apps, cloud phones, and cloud browsers) CloudDrive : enterprise cloud drive	CloudDesktop
Resources	array<object>	A list of resource details.
	array<object>	The resource details.
AliUid	integer	The Alibaba Cloud account ID.	194101959****
ResourceType	string	The resource type. Valid values: App : cloud application (including cloud apps, cloud phones, and cloud browsers) Desktop : cloud desktop DesktopGroup : shared cloud desktop CloudDrive : enterprise cloud drive	Desktop
RegionId	string	The region ID.	cn-hangzhou
RegionLocation	string	The location of the region. Valid values: Mainland : a region in the Chinese mainland Overseas : a region outside the Chinese mainland (including Hong Kong (China))	Mainland
ResourceGroupId	string	The resource group ID.	dg-0****
ResourceId	string	The resource ID.	ecd-d19tya8zi4****
ResourceLevel	string	The resource level. Valid values: Center : centralized resource Region : unitized resource	Center
CenterResourceId	string	The centralized resource ID.	ecds-0****
ResourceName	string	The resource name.	testName01
CreateTime	string	The time the resource was created.	2024-12-11T07:12:12Z
ProductType	string	The product type. Valid values: CloudDesktop : cloud desktop (including standard and shared cloud desktops) CloudApp : cloud application CloudBrowser : cloud browser AndroidCloud : cloud phone	AndroidCloud
OfficeSiteId	string	The office network ID.	cn-shanghai+dir-3367****
AccessType	string	The access type. Valid values: INTERNET : Internet access VPC : VPC access ANY : Both Internet and VPC access are supported.	INTERNET
ProtocolType	string	The protocol type. Valid values: HDX : HDX protocol ASP : Alibaba Cloud in-house ASP protocol	ASP
OsType	string	The operating system type. Valid values: Linux : Linux Windows : Windows Android : Android	Windows
Os	string	Information about the operating system platform.	Windows Server 2022
OsDescription	string	A description of the operating system platform.	Windows 正版授权
SupportHibernation	boolean	Indicates whether hibernation is supported. Valid values: true : Hibernation is supported. false : Hibernation is not supported.	true
HibernationBeta	boolean	Indicates whether this is a beta version for hibernation testing. Valid values: true : This is a beta version for hibernation testing. false : This is not a beta version for hibernation testing.	false
SessionType	string	The session type. Valid values: SINGLE_SESSION : single-session MULTIPLE_SESSION : multi-session	SINGLE_SESSION
ChargeType	string	The billing method. Valid values: PostPaid : pay-as-you-go [Default] PrePaid : subscription	PrePaid
SubPayType	string	The sub-billing method. Valid values: monthPackage : monthly subscription PrePaid : duration plan	PrePaid
ExpiredTime	string	The expiration time for subscription resources.	2025-02-22T16:00:00Z
AuthMode	string	The authorization mode for the cloud application. Valid values: App : application authorization AppInstanceGroup : delivery group authorization Session : session authorization	App
AppId	string	The application ID. This parameter is specific to resources of the `App` type.	app-0001
Version	string	The resource version. This parameter is specific to resources of the `App` type.	资源版本。
CategoryType	integer	The top-level resource category. This parameter is specific to resources of the `App` type.	1
CategoryId	integer	The second-level resource category. This parameter is specific to resources of the `App` type.	0
Icon	string	The URL of the resource icon. This parameter is specific to resources of the `App` type.	http://example.com/icon.png
ThemeColor	string	The theme color of the resource. This parameter is specific to resources of the `App` type.	#FFFFFF
CdsName	string	The name of the cloud drive. This parameter is specific to resources of the `CloudDrive` type.	cn-shanghai+cds-695277****
ExternalDomainId	string	The external domain ID. This parameter is specific to resources of the `CloudDrive` type.	stg114510
ExternalUserId	string	The external user ID. This parameter is specific to resources of the `CloudDrive` type.	test001
GlobalStatus	boolean	Indicates whether cross-region access is supported. This parameter is specific to resources of the `CloudDrive` type.	true
LocalName	string	The region name.	华东1（杭州）
DesktopTimers	array<object>	A list of scheduled task settings for the cloud desktop.
	object	The scheduled task settings for the cloud desktop.
TimerType	string	The task type.	TimerBoot
CronExpression	string	The Cron expression for the scheduled task.	0 30 13 ? * 1-7
Interval	integer	The interval for the scheduled task.	15
Enforce	boolean	Specifies whether to enforce execution.	false
ResetType	string	The reset type.	RESET_TYPE_SYSTEM
AllowClientSetting	string	Specifies whether client-side settings are allowed.	false
OperationType	string	The operation type.	Hibernate
ExecutionTime	string	The execution time.	2025-01-21T11:37Z
Clients	array<object>	A list of client types supported by the resource.
	object	Settings for a single client type supported by the resource.
ClientType	string	The client type.	windows
Status	string	The support status. Valid values: OFF : Disabled ON : Enabled	ON
ResourceStatus	string	The resource status. Valid values: Unknown : Unknown Stopped : Stopped Failed : Creation failed Starting : Starting Rebuilding : Rebuilding Running : Running Stopping : Stopping FotaUpdating : Image is being upgraded. Pending : Pending Deleting : Deleting Unavailable : Unavailable	Running
LastStartTime	string	The last time the resource was started.	2025-01-24T03:12:04Z
OrderStatus	string	The order status. Valid values: Ceased : Overdue payment for a pay-as-you-go resource. Released : The order is closed. Expired : The subscription resource is stopped due to expiration. Normal : Normal	Normal
ManagementStatuses	array	A list of management statuses.
	string	The management status.	NoFlag
ResourceSessionStatus	string	The session status. Valid values: Unknown : Unknown Connected : Connected Disconnected : Disconnected	Connected
Sessions	array<object>	A list of user session information for the resource.
	object	The user session information for the resource.
UserId	string	The username that logged on to the resource.	user001
UserPrincipalName	string	The UPN of the user bound to the resource (if any). This value is populated only for the current querying user's session.	benchmark_test@test.shenzhen
ResourceSessionStartTime	string	The time when the resource session was connected.	2025-01-22T11:03:36Z
NickName	string	The user's nickname.	user-001
RealDesktopId	string	[Shared cloud desktop] The actual cloud desktop ID. This parameter is returned when a session exists on the shared cloud desktop.	ecd-0001
UserCustomName	string	The custom name defined by the user.	我的云电脑
FotaUpdate	object	The cloud desktop upgrade information.
Project	string	The project name.	wuying-asp_single_session_desktop_win_x64
Channel	string	The channel.	aliyun
CurrentAppVersion	string	The version number of the current cloud desktop image.	2.7.0-R-20250122.154826
NewAppVersion	string	The version number available for upgrading the cloud desktop.	2.7.0-R-20250125.154826
Force	boolean	Specifies whether to force the upgrade.	false
ReleaseNote	string	The description of the upgradable version.	新版本
Size	string	The size of the upgradable version installation package. Unit: KB.	474981930
ReleaseNoteEn	string	The English description of the upgradable version.	new version
ReleaseNoteJp	string	The Japanese description of the upgradable version.	新バージョン
NewDcdVersion	string	The version number of the upgradable component disk.	2.6.9-R-20250123.153415
OsUpdate	object	The operating system upgrade information.
CheckId	string	The verification ID.	wua-1740652957251743***
PackageCount	integer	The number of packages.	1
Packages	array<object>	The list of patch package information.
	object	Patch package information.
Kb	string	The patch number.	KB2267***
Title	string	The patch title.	用于****的补丁。
Description	string	The patch description.	安装此更新可修改用于检测病毒、间谍软件和其他潜在不需要的软件的文件。此项一旦安装，便无法删除。
KbListString	string	The list of patch numbers.	KB2267***
UpdateCatalogUrl	string	The update catalog URL.	https://catalog.update.microsoft.com/home.aspx
HasUpgrade	boolean	Indicates whether an update exists.	true
DesktopDurationList	array<object>	A list of cloud desktop plan information.
	object	The cloud desktop plan information.
PackageCreationTime	string	The creation time.	2025-01-17T07:01Z
PackageStatus	string	The status.	Available
UsedDuration	integer	The used duration.	16850
PackageExpiredTime	string	The expiration time.	2025-02-17T15:59Z
PackageId	string	The package ID.	mdp-0bxls4qpi6bl6****
TotalDuration	integer	The total duration.	432000
PackageType	string	The duration package type. Valid values: FREE_PACKAGE : Free package NORMAL_PACKAGE : Paid package (120-hour package) POSTPAID_PACKAGE : Records pay-as-you-go quota package (200-hour package) Duration : Duration package	NORMAL_PACKAGE
PeriodStartTime	string	The start time of the monthly package.	2025-01-17T07:01Z
PeriodEndTime	string	The end time of the monthly package.	2025-02-17T15:59Z
PostPaidLimitFee	number	The spending cap for the second-phase package. Catatan This parameter is returned only when ResourceType is `POSTPAID_PACKAG` or `FREE_PACKAGE`.	199
OrderInstanceId	string	The order instance ID.	mdp-0bxls4qpi6bl6****
PackageUsedUpStrategy	string	The strategy for cloud desktop status after the monthly package quota is exhausted. Valid values: Shutdown : Shut down or hibernate Postpaid : Continue using and pay as you go	Postpaid
ConnectionProperties	string	The connection properties, which is a JSON string. The client does not need to parse the content. When an application resource establishes a connection, this string is directly passed to the central resource control.	{"authMode":"App"}
SupportedActions	array	A list of supported operation types. Currently, this is supported only for cloud phones and cloud desktops (including shared cloud desktops).
	string	The operation type. Valid values: WakeUp : Wake up Hibernate : Hibernate Start : Start Stop : Stop Restart : Restart	Start
SupportAgentIm	boolean
AgentImUrl	string		https://wuying.aliyun.com/OpenIM/chat?desktopId=ecd-xxxxx
RankVersion	integer	The version number of the sorting data.	1732869815062
TotalCount	integer	The total number.	10
MaxResults	integer	The maximum number of returned entries.	100
AgentBriefSummary	object
TotalCount	integer		10
AgentBriefs	array<object>
	object
AgentPlatform	string		ENTERPRISE_JVS
AgentProvider	string		OpenClaw
Count	integer		2
AvatarUrl	string		https://abc.com/efg.png
Url	string		https://test.png
DisplayName	string		JVS Claw
SubTitle	string		智在进化，快乐养虾
AvatarNoResourceUrl	string		https://xxx.png

Tidak semua parameter tanggapan tersedia untuk setiap sumber daya. Pastikan Anda mengetahui parameter mana yang dikembalikan untuk setiap tipe sumber daya.

Contoh

Respons sukses

JSONformat

{
  "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"
        }
      ],
      "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": false,
      "AgentImUrl": "https://wuying.aliyun.com/OpenIM/chat?desktopId=ecd-xxxxx"
    }
  ],
  "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"
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.