ユーザーリソースのリストをクエリします。
操作説明
この操作を呼び出す前に、Wuying Workspace のリソースタイプとプロダクトタイプを理解していることを確認してください。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ClientId |
string |
必須 |
クライアントによって生成される一意の ID (UUID など) です。このパラメーターは機密情報ではなく、暗号化は不要です。 |
54c17e1d-2d72-4b87-aa33-25f3b3f2**** |
| ClientType |
string |
任意 |
クライアントタイプ。 列挙値:
|
windows |
| ClientVersion |
string |
任意 |
クライアントバージョン。 |
7.6.0-R-20241112.222305 |
| LoginToken |
string |
必須 |
ログイン認証情報。
このトークンは、 |
v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b**** |
| SessionId |
string |
任意 |
セッション ID。この ID は |
cd45e873-650d-4d70-acb9-f996187a**** |
| LoginRegionId |
string |
任意 |
ログインするリージョンの ID。このパラメーターは、オフィスネットワーク ID を使用してログインする場合に必須です。組織 ID を使用してログインする場合は、このパラメーターを指定する必要はありません。 |
cn-hangzhou |
| SearchRegionId |
string |
任意 |
検索するリージョンの ID。このパラメーターは、指定されたリージョン内のクラウドリソース情報をフィルタリングします。 |
cn-hangzhou |
| OfficeSiteIds |
array |
任意 |
オフィスネットワーク ID のリスト。Active Directory (AD) アカウントでログインする場合にこのパラメーターを指定します。 |
|
|
string |
任意 |
オフィスネットワーク ID。 |
cn-hangzhou+dir-5440**** |
|
| ResourceTypes |
array |
任意 |
リソースタイプのリスト。空のままにすると、すべてのリソースタイプがクエリされます。 |
|
|
string |
任意 |
リソースタイプ。 列挙値:
|
Desktop |
|
| ProductTypes |
array |
任意 |
プロダクトタイプのリスト。空のままにすると、すべてのプロダクトタイプがクエリされます。 |
|
|
string |
任意 |
プロダクトタイプ。 列挙値:
|
CloudApp |
|
| ResourceIds |
array |
任意 |
リソース ID のリスト。 0 から 100 個の ID を指定できます。 |
|
|
string |
任意 |
リソース ID。 |
ecd-00001 |
|
| ResourceName |
string |
任意 |
リソース名。あいまい検索がサポートされています。 |
testName |
| ProtocolType |
string |
任意 |
プロトコルタイプ。このパラメーターは、クラウドデスクトップのフィルタリングにのみ使用されます。 列挙値:
|
ASP |
| AccessType |
string |
任意 |
アクセスタイプ。このパラメーターを指定しない場合、両方のアクセスタイプのリソースが返されます。 列挙値:
|
INTERNET |
| Language |
string |
任意 |
クライアント言語。 列挙値:
|
zh-CN |
| CategoryType |
integer |
任意 |
トップレベルのリソースカテゴリ。 |
1 |
| CategoryId |
integer |
任意 |
第 2 レベルのリソースカテゴリ。 |
0 |
| QueryFotaUpdate |
boolean |
任意 |
クラウドデスクトップのイメージバージョン情報をクエリするかどうかを指定します。 |
false |
| RefreshFotaUpdate |
boolean |
任意 |
OTA (Over-The-Air) 情報をリアルタイムでリフレッシュするかどうかを指定します。 |
false |
| OrderBy |
string |
任意 |
ソートに使用するフィールド。このパラメーターを指定しない場合、結果は作成時刻の降順でソートされます。 列挙値:
|
AssignTime |
| SortType |
string |
任意 |
ソート順。 列挙値:
|
ASC |
| MaxResults |
integer |
任意 |
ページングクエリで各ページに返すエントリ数。デフォルト値:500。 |
500 |
| NextToken |
string |
任意 |
次のページ用のトークン。 |
caeba0bbb2be03f84eb48b699f0a4883 |
| AutoRefresh |
boolean |
任意 |
即時にリフレッシュするかどうかを指定します。 説明 迅速な応答を確保するには、このパラメーターを 列挙値:
|
false |
| Scene |
string |
任意 |
クライアントシナリオ。ソート順を識別するために使用されます。値を 列挙値:
|
desktop |
DualCenterForward
deprecated
|
boolean |
任意 |
デュアルセンター転送を使用するかどうかを指定します。値を 列挙値:
|
false |
| QueryDesktopTimers |
boolean |
任意 |
クラウドデスクトップの定期タスクに関する情報をクエリするかどうかを指定します。デフォルト値は true です。 列挙値:
|
true |
| QueryDesktopDurationList |
boolean |
任意 |
クラウドデスクトッププランに関する情報をクエリするかどうかを指定します。デフォルト値は true です。 列挙値:
|
true |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|
||
| NextToken |
string |
ページングクエリの次のページを開始するためのトークン。このパラメーターが空の場合、それ以上のデータは返されません。 |
AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL**** |
| RequestId |
string |
リクエスト ID。 |
1CBAFFAB-B697-4049-A9B1-67E1FC5F**** |
| QueryFailedResourceTypes |
array |
クエリが失敗したリソースタイプのリスト。 |
|
|
string |
リソースタイプ。 列挙値:
|
CloudDesktop |
|
| Resources |
array<object> |
リソース詳細のリスト。 |
|
|
array<object> |
リソース詳細。 |
||
| AliUid |
integer |
Alibaba Cloud アカウント ID。 |
194101959**** |
| ResourceType |
string |
リソースタイプ。 列挙値:
|
Desktop |
| RegionId |
string |
リージョン ID。 |
cn-hangzhou |
| RegionLocation |
string |
リージョンの場所。 列挙値:
|
Mainland |
| ResourceGroupId |
string |
リソースグループ ID。 |
dg-0**** |
| ResourceId |
string |
リソース ID。 |
ecd-d19tya8zi4**** |
| ResourceLevel |
string |
リソースレベル。 列挙値:
|
Center |
| CenterResourceId |
string |
集中型リソース ID。 |
ecds-0**** |
| ResourceName |
string |
リソース名。 |
testName01 |
| CreateTime |
string |
リソースが作成された時刻。 |
2024-12-11T07:12:12Z |
| ProductType |
string |
プロダクトタイプ。 列挙値:
|
AndroidCloud |
| OfficeSiteId |
string |
オフィスネットワーク ID。 |
cn-shanghai+dir-3367**** |
| AccessType |
string |
アクセスタイプ。 列挙値:
|
INTERNET |
| ProtocolType |
string |
プロトコルタイプ。 列挙値:
|
ASP |
| OsType |
string |
オペレーティングシステムタイプ。 列挙値:
|
Windows |
| Os |
string |
オペレーティングシステムプラットフォームに関する情報。 |
Windows Server 2022 |
| OsDescription |
string |
オペレーティングシステムプラットフォームの説明。 |
Windows 正版授权 |
| SupportHibernation |
boolean |
休止状態がサポートされているかどうかを示します。 列挙値:
|
true |
| HibernationBeta |
boolean |
これが休止状態テスト用のベータ版であるかどうかを示します。 列挙値:
|
false |
| SessionType |
string |
セッションタイプ。 列挙値:
|
SINGLE_SESSION |
| ChargeType |
string |
課金方法。 列挙値:
|
PrePaid |
| SubPayType |
string |
サブ課金方法。 列挙値:
|
PrePaid |
| ExpiredTime |
string |
サブスクリプションリソースの有効期限。 |
2025-02-22T16:00:00Z |
| AuthMode |
string |
クラウドアプリケーションの権限付与モード。 列挙値:
|
App |
| AppId |
string |
アプリケーション ID。このパラメーターは `App` タイプのリソースに固有です。 |
app-0001 |
| Version |
string |
リソースバージョン。このパラメーターは `App` タイプのリソースに固有です。 |
资源版本。 |
| CategoryType |
integer |
トップレベルのリソースカテゴリ。このパラメーターは `App` タイプのリソースに固有です。 |
1 |
| CategoryId |
integer |
第 2 レベルのリソースカテゴリ。このパラメーターは `App` タイプのリソースに固有です。 |
0 |
| Icon |
string |
リソースアイコンの URL。このパラメーターは `App` タイプのリソースに固有です。 |
http://example.com/icon.png |
| ThemeColor |
string |
リソースのテーマカラー。このパラメーターは `App` タイプのリソースに固有です。 |
#FFFFFF |
| CdsName |
string |
クラウドドライブの名前。このパラメーターは `CloudDrive` タイプのリソースに固有です。 |
cn-shanghai+cds-695277**** |
| ExternalDomainId |
string |
外部ドメイン 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 |
サポートステータス。 列挙値:
|
ON |
| ResourceStatus |
string |
リソースステータス。 列挙値:
|
Running |
| LastStartTime |
string |
リソースが最後に起動された時刻。 |
2025-01-24T03:12:04Z |
| OrderStatus |
string |
注文ステータス。 列挙値:
|
Normal |
| ManagementStatuses |
array |
管理ステータスのリスト。 |
|
|
string |
管理ステータス。 |
NoFlag |
|
| ResourceSessionStatus |
string |
セッションステータス。 列挙値:
|
Connected |
| Sessions |
array<object> |
リソースのユーザーセッション情報のリスト。 |
|
|
object |
リソースのユーザーセッション情報。 |
||
| UserId |
string |
リソースにログインするために使用されるユーザー名。 |
user001 |
| UserPrincipalName |
string |
リソースがバインドされているユーザーのユーザープリンシパル名 (UPN) (利用可能な場合)。このパラメーターは、クエリを実行している現在のユーザーのセッションに対してのみ値を持ちます。 |
benchmark_test@test.shenzhen |
| ResourceSessionStartTime |
string |
リソースセッションが接続された時刻。 |
2025-01-22T11:03:36Z |
| NickName |
string |
ユーザーのニックネーム。 |
user-001 |
| 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 |
期間プランタイプ。 列挙値:
|
NORMAL_PACKAGE |
| PeriodStartTime |
string |
月間プランの開始時刻。 |
2025-01-17T07:01Z |
| PeriodEndTime |
string |
月間プランの終了時刻。 |
2025-02-17T15:59Z |
| PostPaidLimitFee |
number |
第2段階プランの上限額。 説明 このパラメーターは、`ResourceType` が |
199 |
| OrderInstanceId |
string |
注文インスタンス ID。 |
mdp-0bxls4qpi6bl6**** |
| PackageUsedUpStrategy |
string |
プランの月間クォータを使い切った後のクラウドデスクトップのステータスに関するポリシー。 列挙値:
|
Postpaid |
| ConnectionProperties |
string |
接続プロパティ。JSON 文字列です。クライアントは内容を解析する必要はありません。アプリケーションリソースが接続を確立するとき、この文字列は中央のリソースコントロールに直接渡されます。 |
{"authMode":"App"} |
| SupportedActions |
array |
サポートされる操作タイプのリスト。現在、これはクラウドフォンとクラウドデスクトップ (共有クラウドデスクトップを含む) でのみサポートされています。 |
|
|
string |
操作タイプ。 列挙値:
|
Start |
|
| SupportAgentIm |
boolean |
|
|
| AgentImUrl |
string |
|
https://wuying.aliyun.com/OpenIM/chat?desktopId=ecd-xxxxx |
| RankVersion |
integer |
ソートデータのバージョン番号。 |
1732869815062 |
| TotalCount |
integer |
合計数。 |
10 |
| MaxResults |
integer |
返されるエントリの最大数。 |
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 |
すべてのレスポンスパラメーターがすべてのリソースで利用できるわけではありません。各リソースタイプでどのパラメーターが返されるかを確認してください。
例
成功レスポンス
JSONJSON
{
"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"
}
]
}
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。