ユーザーのリソースを照会します。
操作説明
この操作を呼び出す前に、Alibaba Cloud Workspace でサポートされているリソースタイプおよびサービスタイプをご確認ください。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ClientId |
string |
必須 |
クライアント ID。システムは各クライアントに対して一意の ID を自動生成します。このパラメーターは非機密であり、暗号化する必要はありません。 |
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。最大 100 個のリソース ID を指定できます。 |
|
|
string |
任意 |
リソース ID。 |
ecd-00001 |
|
| ResourceName |
string |
任意 |
リソース名。あいまい検索がサポートされています。 |
testName |
| ProtocolType |
string |
任意 |
プロトコルタイプ。このパラメーターを指定することで、クラウドコンピューターをフィルター処理できます。 有効な値:
列挙値:
|
ASP |
| AccessType |
string |
任意 |
アクセスタイプ。このパラメーターを空のままにした場合、両方のタイプが表示されます。 有効な値:
列挙値:
|
INTERNET |
| Language |
string |
任意 |
クライアントの言語。 有効な値:
列挙値:
|
zh-CN |
| CategoryType |
integer |
任意 |
レベル 1 のリソースカテゴリ。 |
1 |
| CategoryId |
integer |
任意 |
レベル 2 のリソースカテゴリ。 |
0 |
| QueryFotaUpdate |
boolean |
任意 |
クラウドコンピューターのイメージバージョン情報を返すかどうかを指定します。 |
false |
| RefreshFotaUpdate |
boolean |
任意 |
OTA (Over-the-Air) 情報をリアルタイムで更新するかどうかを指定します。 |
false |
| OrderBy |
string |
任意 |
並べ替えフィールド。このパラメーターを指定しない場合、デフォルトで作成時刻で並べ替えられます。 有効な値:
列挙値:
|
AssignTime |
| SortType |
string |
任意 |
並べ替え方法。 有効な値:
列挙値:
|
ASC |
| MaxResults |
integer |
任意 |
1 ページあたりのエントリー数。デフォルト値: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 |
ページネーショントークン。次のリクエストで新しいページの結果を取得するために使用できます。NextToken が空の場合、次のページは存在しません。 |
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 |
OS の種類。 有効な値:
列挙値:
|
Windows |
| Os |
string |
OS プラットフォーム。 |
Windows Server 2022 |
| OsDescription |
string |
OS プラットフォームの説明。 |
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-0001 |
| Version |
string |
リソースのバージョン。このパラメーターはアプリケーションのみに適用されます。 |
资源版本。 |
| CategoryType |
integer |
レベル 1 のリソースカテゴリ。このパラメーターはアプリケーションのみに適用されます。 |
1 |
| CategoryId |
integer |
レベル 2 のリソースカテゴリ。このパラメーターはアプリケーションのみに適用されます。 |
0 |
| Icon |
string |
リソースのアイコン。このパラメーターはアプリケーションのみに適用されます。 |
http://example.com/icon.png |
| ThemeColor |
string |
リソースのテーマカラー。このパラメーターはアプリケーションのみに適用されます。 |
#FFFFFF |
| CdsName |
string |
ドライブ名。このパラメーターはエンタープライズドライブのみに適用されます。 |
cn-shanghai+cds-695277**** |
| ExternalDomainId |
string |
外部ドメインの ID。このパラメーターはエンタープライズドライブのみに適用されます。 |
stg114510 |
| ExternalUserId |
string |
外部ユーザーの ID。このパラメーターはエンタープライズドライブのみに適用されます。 |
test001 |
| GlobalStatus |
boolean |
クロスリージョンアクセスがサポートされているかどうかを示します。このパラメーターはエンタープライズドライブのみに適用されます。 |
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 |
OS の更新情報。 |
|
| 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 |
|
| RankVersion |
integer |
ランキングデータのバージョン番号。 |
1732869815062 |
| TotalCount |
integer |
合計数。 |
10 |
| MaxResults |
integer |
返される最大数。 |
100 |
このレスポンスパラメーターはすべてのリソースに対して利用可能ではありません。各リソースのフィールドを確認してください。
例
成功レスポンス
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"
]
}
],
"RankVersion": 1732869815062,
"TotalCount": 10,
"MaxResults": 100
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。