クラウドコンピューターの詳細を照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ecd:DescribeDesktops |
get |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| BusinessChannel |
string |
任意 |
ビジネスチャンネル。有効な値: 列挙値:
|
Enterprise |
| RegionId |
string |
必須 |
リージョン ID。 DescribeRegions を呼び出して、Elastic Desktop サービスでサポートされているリージョンをクエリできます。 |
cn-hangzhou |
| GroupId |
string |
任意 |
クラウドコンピュータープールの ID。 |
dg-boyczi8enfyc5**** |
| DesktopStatus |
string |
任意 |
クラウドコンピューターのステータス。 列挙値:
|
Running |
| MaxResults |
integer |
任意 |
ページングクエリにおける 1 ページあたりの最大値のエントリ数。このパラメーターはページングに使用されます。 |
10 |
| NextToken |
string |
任意 |
次のクエリのページネーショントークン。空の値は、これ以上結果がないことを示します。 |
caeba0bbb2be03f84eb48b699f0a4883 |
| UserName |
string |
任意 |
ユーザー名。 |
Alice |
| DesktopName |
string |
任意 |
クラウドコンピューター名。 |
DemoComputer01 |
| DirectoryId |
string |
任意 |
ディレクトリ ID。オフィスネットワーク ID と同じです。 |
cn-hangzhou+dir-363353**** |
| OfficeSiteId |
string |
任意 |
オフィスネットワーク ID。 |
cn-hangzhou+dir-363353**** |
| OfficeSiteName |
string |
任意 |
オフィスネットワーク名。 |
デフォルト |
| PolicyGroupId |
string |
任意 |
クラウドコンピューターポリシーの ID。 |
system-all-enabled-ポリシー |
| ChargeType |
string |
任意 |
クラウドコンピューターの課金方法。 列挙値:
|
PostPaid |
| ExpiredTime |
string |
任意 |
サブスクリプションクラウドコンピューターの有効期限時間。 |
2022-12-31T15:59:59Z |
| ProtocolType |
string |
任意 |
プロトコルの種類。 列挙値:
|
ASP |
| DesktopId |
array |
任意 |
クラウドコンピューターの ID。1～100 個の ID を指定できます。 |
ecd-gx2x1dhsmucyy**** |
|
string |
任意 |
クラウドコンピューターの ID。 |
ecd-gx2x1dhsmucyy**** |
|
| EndUserId |
array |
任意 |
クラウドコンピューターの許可されるユーザーのリスト。1～100 人のユーザーを指定できます。 説明
一度にクラウドコンピューターに接続して使用できるユーザーは 1 人のみです。 |
alice |
|
string |
任意 |
クラウドコンピューターの許可されるユーザー。 |
alice |
|
| ExcludedEndUserId |
array |
任意 |
除外する許可されるユーザーのリスト。1～100 人のユーザーを指定できます。 |
andy |
|
string |
任意 |
除外する許可されるユーザー。 |
andy |
|
| FilterDesktopGroup |
boolean |
任意 |
プールされたクラウドコンピューター (クラウドコンピュータープール内のクラウドコンピューター) を除外するかどうかを指定します。 列挙値:
|
false |
| ManagementFlag |
string |
任意 |
管理フラグ。 列挙値:
|
NoFlag |
| QueryFotaUpdate |
boolean |
任意 |
クラウドコンピューターのイメージバージョン情報をクエリするかどうかを指定します。 列挙値:
|
false |
| Tag |
array<object> |
任意 |
タグ。タグはキーと値のペアで構成され、リソースを識別するために使用されます。タグを使用してクラウドコンピューターをグループ化および管理することで、検索やバッチ操作が容易になります。詳細については、「タグを使用したクラウドコンピューターの管理」をご参照ください。 |
|
|
object |
任意 |
タグのキーと値のペア。クラウドコンピューターごとに 1～20 個のキーと値のペアを指定できます。各タグキーにはタグ値を 1 つだけ設定できます。 |
||
| Key |
string |
任意 |
タグキー。 |
TestKey |
| Value |
string |
任意 |
タグ値。タグ値の長さは 128 文字以下で、先頭を |
TestValue |
| SnapshotPolicyId |
string |
任意 |
スナップショットポリシーの ID。 |
sp-hb12mclyne09xw*** |
| OnlyDesktopGroup |
boolean |
任意 |
プールされたクラウドコンピューター (クラウドコンピュータープール内のクラウドコンピューター) のみをクエリするかどうかを指定します。 |
true |
| DesktopGroupId |
string |
任意 |
クラウドコンピュータープールの ID。 |
dg-2i8qxpv6t1a03**** |
| OsTypes |
array |
任意 |
オペレーティングシステムの種類。 |
|
|
string |
任意 |
オペレーティングシステムの種類。 列挙値:
|
Windows |
|
| DesktopType |
string |
任意 |
クラウドコンピューターのスペック。 DescribeDesktopTypes を呼び出して、サポートされているスペック ID をクエリできます。 |
eds.general.2c8g |
| ImageId |
array |
任意 |
イメージの ID。 |
|
|
string |
任意 |
イメージの ID。 |
m-2g65ljy3ynrdq**** |
|
| DesktopStatusList |
array |
任意 |
クラウドコンピューターのステータスのリスト。 |
|
|
string |
任意 |
クラウドコンピューターのステータス。 列挙値:
|
Stopped |
|
| GpuInstanceGroupId |
string |
任意 |
エラスティック GPU プールの ID。 |
gp-0bm2iz1v6m6nx**** |
| QosRuleId |
string |
任意 |
インターネット帯域幅調整ルールの ID。 |
qos-5605u0gelk200**** |
| SubPayType |
string |
任意 |
クラウドコンピューターの購入メソッド。 列挙値:
|
monthPackage |
| ResourceGroupId |
string |
任意 |
リソースグループの ID。 |
rg-4hsvzbbmqdzu3s**** |
| FillResourceGroup |
boolean |
任意 |
リソースグループ情報をクエリするかどうかを指定します。 |
true |
| PageNumber |
integer |
任意 |
ページングクエリにおける現在のページのページ番号。このパラメーターはページングに使用されます。 |
1 |
| PageSize |
integer |
任意 |
ページングクエリにおける 1 ページあたりの最大値のエントリ数。このパラメーターはページングに使用されます。 |
10 |
| MultiResource |
boolean |
任意 |
複数のリソースが存在するかどうかを指定します。 |
false |
| IncludeAutoSnapshotPolicy |
boolean |
任意 |
応答に自動スナップショットポリシー情報を含めるかどうかを指定します。 |
|
|
任意 |
||||
|
任意 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
返される情報のコレクション。 |
||
| NextToken |
string |
次のクエリのページネーショントークン。空の値は、これ以上結果がないことを示します。 |
caeba0bbb2be03f84eb48b699f0a4883 |
| RequestId |
string |
リクエスト ID。 |
484256DA-D816-44D2-9D86-B6EE4D5BA78C |
| TotalCount |
integer |
クラウドデスクトップの総数。 |
1 |
| Desktops |
array<object> |
クラウドデスクトップの詳細。 |
|
|
array<object> |
クラウドデスクトップの詳細。 |
||
| CreationTime |
string |
クラウドデスクトップが作成された時間。時間は ISO 8601 標準の協定世界時 (UTC) です。 |
2020-11-06T08:28Z |
| ChargeType |
string |
クラウドデスクトップの課金方法。 列挙値:
|
PostPaid |
| DesktopName |
string |
クラウドコンピューター名。 |
DemoComputer01 |
| PolicyGroupName |
string |
ポリシー名。 |
すべての有効なポリシー |
| SystemDiskSize |
integer |
説明
このパラメーターは招待プレビュー中であり、一般公開されていません。 |
0 |
| PolicyGroupId |
string |
クラウドコンピューターポリシーの ID。 |
system-all-enabled-policy |
| DesktopStatus |
string |
クラウドコンピューターのステータス。 |
Running |
| DesktopType |
string |
クラウドデスクトップタイプ。 |
ecd.basic.large |
| GpuCount |
number |
GPU の数。 |
1 |
| ProtocolType |
string |
プロトコルの種類。 列挙値:
|
ASP |
| Memory |
integer |
メモリサイズ。単位: MiB。 |
4096 |
| GpuSpec |
string |
GPU の仕様。 |
NVIDIA T4 |
| ImageId |
string |
イメージの ID。 |
m-4zfb6zj728hhr**** |
| ImageName |
string |
変更前のイメージ名。 |
Windows server 2019 Mainland |
| DirectoryId |
string |
ディレクトリの ID。ワークスペース ID (OfficeSiteId) と同じです。 |
cn-hangzhou+dir-363353**** |
| ManagementFlag |
string |
管理フラグ。 列挙値:
|
NoFlag |
| DataDiskCategory |
string |
説明
このパラメーターは招待プレビュー中であり、一般公開されていません。 |
cloud_auto |
| SystemDiskCategory |
string |
説明
このパラメーターは招待プレビュー中であり、一般公開されていません。 |
cloud_auto |
| NetworkInterfaceId |
string |
クラウドデスクトップサービスが RAM または AD ユーザー用に作成したセカンダリ ENI の ID。この値は変更できません。 |
123456 |
| OfficeSiteId |
string |
オフィスネットワーク ID。 |
cn-hangzhou+dir-363353**** |
| DataDiskSize |
string |
説明
このパラメーターは招待プレビュー中であり、一般公開されていません。 |
80 |
| DesktopGroupId |
string |
クラウドデスクトップが属するクラウドデスクトッププールの ID。デフォルト値: |
dg-2i8qxpv6t1a03**** |
| DesktopId |
string |
クラウドコンピューターの ID。 |
ecd-gx2x1dhsmucyy**** |
| OfficeSiteName |
string |
オフィスネットワーク名。 |
default |
| StartTime |
string |
クラウドデスクトップが最初に起動された時間。時間は ISO 8601 標準の協定世界時 (UTC) です。 |
2020-11-06T08:31Z |
| DirectoryType |
string |
説明
このパラメーターは招待プレビュー中であり、一般公開されていません。 |
SIMPLE |
| Cpu |
integer |
vCPU の数。 |
2 |
| NetworkInterfaceIp |
string |
クラウドデスクトップサービスが RAM または AD ユーザー用に作成したセカンダリ ENI の IP アドレス。 |
192.168.XX.XX |
| ExpiredTime |
string |
サブスクリプションクラウドデスクトップの有効期限の時間。時間は ISO 8601 標準の協定世界時 (UTC) です。 |
2021-12-31T15:59Z |
| OsType |
string |
オペレーティングシステムの種類。 |
Windows |
| ConnectionStatus |
string |
ユーザーの接続ステータス。 列挙値:
|
Disconnected |
| BundleId |
string |
クラウドデスクトップで使用されているクラウドデスクトップテンプレートの ID。 |
b-2g65ljy4291vl**** |
| BundleName |
string |
クラウドデスクトップで使用されているクラウドデスクトップテンプレートの名前。 |
TemplateName |
| OfficeSiteType |
string |
ワークスペースのアカウントシステムタイプ。 列挙値:
|
SIMPLE |
| HostName |
string |
ホスト名。 |
testName |
| Disks |
array<object> |
ディスク情報。 |
|
|
object |
ディスク情報。 |
||
| DiskType |
string |
ディスクタイプ。 列挙値:
|
SYSTEM |
| DiskId |
string |
ディスク ID。 |
d-jedbpr4sl9l37**** |
| DiskSize |
integer |
ディスクサイズ。単位: GiB。 |
80 |
| PerformanceLevel |
string |
ディスクが ESSD の場合の ESSD のパフォーマンスレベル (PL)。 異なる PL の ESSD の違いの詳細については、「 ESSD 」を参照してください。 列挙値:
|
PL0 |
| DiskCategory |
string |
ディスクタイプ。
列挙値:
|
cloud_auto |
| Tags |
array<object> |
タグ情報。 |
|
|
object |
タグ情報。 |
||
| Key |
string |
タグキー。 |
TestKey |
| Value |
string |
タグ値。 |
TestValue |
| Sessions |
array<object> |
クラウドデスクトップのユーザーセッション情報。 |
|
|
object |
クラウドデスクトップのユーザーセッション情報。 |
||
| EndUserId |
string |
クラウドデスクトップに接続しているユーザーの ID。 |
29615820929547**** |
| EstablishmentTime |
string |
クラウドデスクトップのセッションが確立された時間。時間は ISO 8601 標準の協定世界時 (UTC) です。 |
2021-03-07T08:23Z |
| ExternalUserName |
string |
外部ユーザー名。 |
Testname |
| EndUserIds |
array |
クラウドデスクトップの許可されるユーザーの ID。 |
|
|
string |
クラウドデスクトップの許可されるユーザーの ID。 |
alice |
|
| DowngradeQuota |
integer |
クラウドデスクトップをスペックダウンできる回数。 |
3 |
| DowngradedTimes |
integer |
クラウドデスクトップがスペックダウンされた回数。 |
0 |
| GpuCategory |
integer |
クラウドデスクトップが GPU アクセラレーション対応クラウドデスクトップかどうかを示します。 |
0 |
| GpuDriverVersion |
string |
クラウドデスクトップの GPU ドライバーバージョン。 |
471.68 |
| ZoneType |
string |
ゾーンのタイプ。デフォルト値: AvailabilityZone (通常のクラウドゾーンを示します)。 |
AvailabilityZone |
| FotaUpdate |
object |
クラウドコンピューターのイメージバージョン情報。フォーマット。 |
|
| CurrentAppVersion |
string |
クラウドコンピューター上の現在のイメージのバージョン番号。 |
0.0.0-D-20220102.000000 |
| NewAppVersion |
string |
クラウドコンピューターをスペックアップできるイメージバージョンのバージョン番号。 |
0.0.0-R-20220307.190736 |
| ReleaseNote |
string |
クラウドコンピューターをスペックアップできるイメージバージョンのリリースノート。 |
テスト スペックアップ パッケージ 03-07 |
| Size |
integer |
スペックアップパッケージのサイズ。単位: KB。 |
108815097 |
| ReleaseNoteEn |
string |
クラウドコンピューターをスペックアップできるイメージバージョンの英語リリースノート。 |
What's new |
| ReleaseNoteJp |
string |
クラウドコンピューターをスペックアップできるイメージバージョンの日本語リリースノート。 |
リリースノート |
| Progress |
string |
クラウドコンピューターの作成進捗状況。 |
100% |
| VolumeEncryptionEnabled |
boolean |
ディスク暗号化が有効かどうかを示します。 |
false |
| VolumeEncryptionKey |
string |
ディスク暗号化に使用される Key Management Service (KMS) キーの ID。キー ID を取得するには、 ListKeys 操作を呼び出せます。サービス。 |
08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4**** |
| OfficeSiteVpcType |
string |
オフィスネットワークの VPC タイプ。 列挙値:
|
basic |
| Platform |
string |
オペレーティングシステムのプラットフォーム情報。フォーマット。 列挙値:
|
Ubuntu |
| SessionType |
string |
セッションのタイプ。 列挙値:
|
SINGLE_SESSION |
| ManagementFlags |
array |
管理フラグ。 |
|
|
string |
クラウドコンピューターの管理ステータス。 列挙値:
|
["NoFlag"] |
|
| SnapshotPolicyId |
string |
スナップショットポリシーの ID。 |
sp-gi007jgyc3kce**** |
| SnapshotPolicyName |
string |
スナップショットポリシー名。 |
testSnapshotName |
| BindAmount |
integer |
マルチ会話クラウドコンピュータープールで、クラウドコンピューターごとに許可される同時会話数。 |
2 |
| PolicyGroupIdList |
array |
クラウドコンピューターポリシー ID のコレクション。 |
|
|
string |
クラウドコンピューターポリシーの ID。 |
pg-dasffjkdf***** |
|
| PolicyGroupNameList |
array |
クラウドコンピューターポリシー名のリスト。 |
|
|
string |
クラウドコンピューターポリシー名。 |
TestPolicy01 |
|
| HibernationOptionsConfigured |
boolean |
説明
このパラメーターは招待プレビュー中であり、一般公開されていません。 |
true |
| SupportHibernation |
boolean |
休止状態がサポートされているかどうかを示します。 |
true |
| HibernationBeta |
boolean |
説明
このパラメーターは招待プレビュー中であり、一般公開されていません。 |
true |
| ResourceGroups |
array<object> |
リソースグループ情報のリスト。フォーマット。 |
|
|
object |
リソースグループ情報。フォーマット。 |
||
| Name |
string |
リソースグループ名。 |
ResourceGroup01 |
| Id |
string |
リソースグループの ID。 |
rg-4hsvzbbmqdzu3s**** |
| StandardStartTime |
string |
クエリの開始時刻。時間は協定世界時 (UTC) の ISO 8601 標準で、yyyy-mm-ddthh:mm:ssz のフォーマットです。 |
2025-01-27T02:20:10Z |
| OsUpdate |
object |
クラウドコンピューターのオペレーティングシステム更新情報。フォーマット。 |
|
| CheckId |
string |
ヘルスチェックタスクの ID。 |
ck-8f2a1b**** |
| PackageCount |
integer |
保留中の更新パッチの数。 |
3 |
| Packages |
array<object> |
システムパッチのリスト。 |
|
|
object |
|||
| Kb |
string |
システムパッチの KB 番号。 |
KB5032190 |
| Title |
string |
脆弱性名。 |
2021-05 Servicing Stack Update for Windows Server 2019 for x64-based Systems (KB5003243) |
| Description |
string |
NAS ファイルシステムの説明。 |
newDescription |
| IsLdap |
boolean |
ディレクトリが LDAP ディレクトリであるかどうかを示します。 |
|
| DomainType |
string |
クラウドコンピューターが属するディレクトリのドメインタイプ。 |
AD |
| SerialNumber |
string |
端末のシリアル番号。 |
96c530bc-6095-4014-8bbc-d461b8ac**** |
| AccountType |
string |
アカウントタイプ。 |
SIMPLE |
| EntraDomainName |
string |
Microsoft Entra ID のドメイン名。 |
contoso.onmicrosoft.com |
| EnvType |
string |
環境タイプ。このパラメーターは一般公開されていません。 |
Private |
| EnvId |
string |
環境 ID。このパラメーターは一般公開されていません。 |
adifa**** |
| AgentProviderList |
array |
現在のクラウドコンピューターがサポートするエージェントのリスト。 |
|
|
string |
現在のクラウドコンピューターがサポートするエージェント。 |
Wuying |
|
| SubnetId |
string |
サブネットの ID。 |
vsw-dgea1***** |
| DesktopDurationList |
クラウドコンピューターの持続時間パッケージ情報のリスト。フォーマット。 |
||
| PageNumber |
integer |
ページングクエリにおける現在のページのページ番号。 |
1 |
| PageSize |
integer |
ページングクエリにおける 1 ページあたりの行数の最大値。 |
10 |
例
成功レスポンス
JSONJSON
{
"NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
"RequestId": "484256DA-D816-44D2-9D86-B6EE4D5BA78C",
"TotalCount": 1,
"Desktops": [
{
"CreationTime": "2020-11-06T08:28Z",
"ChargeType": "PostPaid",
"DesktopName": "DemoComputer01",
"PolicyGroupName": "すべての有効なポリシー",
"SystemDiskSize": 0,
"PolicyGroupId": "system-all-enabled-policy",
"DesktopStatus": "Running",
"DesktopType": "ecd.basic.large",
"GpuCount": 1,
"ProtocolType": "ASP",
"Memory": 4096,
"GpuSpec": "NVIDIA T4",
"ImageId": "m-4zfb6zj728hhr****",
"ImageName": "Windows server 2019 Mainland",
"DirectoryId": "cn-hangzhou+dir-363353****",
"ManagementFlag": "NoFlag",
"DataDiskCategory": "cloud_auto",
"SystemDiskCategory": "cloud_auto",
"NetworkInterfaceId": "123456",
"OfficeSiteId": "cn-hangzhou+dir-363353****",
"DataDiskSize": "80",
"DesktopGroupId": "dg-2i8qxpv6t1a03****",
"DesktopId": "ecd-gx2x1dhsmucyy****",
"OfficeSiteName": "default",
"StartTime": "2020-11-06T08:31Z",
"DirectoryType": "SIMPLE",
"Cpu": 2,
"NetworkInterfaceIp": "192.168.XX.XX",
"ExpiredTime": "2021-12-31T15:59Z",
"OsType": "Windows",
"ConnectionStatus": "Disconnected",
"BundleId": "b-2g65ljy4291vl****",
"BundleName": "TemplateName",
"OfficeSiteType": "SIMPLE",
"HostName": "testName",
"Disks": [
{
"DiskType": "SYSTEM",
"DiskId": "d-jedbpr4sl9l37****",
"DiskSize": 80,
"PerformanceLevel": "PL0",
"DiskCategory": "cloud_auto"
}
],
"Tags": [
{
"Key": "TestKey",
"Value": "TestValue"
}
],
"Sessions": [
{
"EndUserId": "29615820929547****",
"EstablishmentTime": "2021-03-07T08:23Z",
"ExternalUserName": "Testname"
}
],
"EndUserIds": [
"alice"
],
"DowngradeQuota": 3,
"DowngradedTimes": 0,
"GpuCategory": 0,
"GpuDriverVersion": "471.68",
"ZoneType": "AvailabilityZone",
"FotaUpdate": {
"CurrentAppVersion": "0.0.0-D-20220102.000000",
"NewAppVersion": "0.0.0-R-20220307.190736",
"ReleaseNote": "テスト スペックアップ パッケージ 03-07",
"Size": 108815097,
"ReleaseNoteEn": "What's new",
"ReleaseNoteJp": "リリースノート"
},
"Progress": "100%",
"VolumeEncryptionEnabled": false,
"VolumeEncryptionKey": "08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****",
"OfficeSiteVpcType": "basic",
"Platform": "Ubuntu",
"SessionType": "SINGLE_SESSION",
"ManagementFlags": [
"[\"NoFlag\"]"
],
"SnapshotPolicyId": "sp-gi007jgyc3kce****",
"SnapshotPolicyName": "testSnapshotName",
"BindAmount": 2,
"PolicyGroupIdList": [
"pg-dasffjkdf*****"
],
"PolicyGroupNameList": [
"TestPolicy01"
],
"HibernationOptionsConfigured": true,
"SupportHibernation": true,
"HibernationBeta": true,
"ResourceGroups": [
{
"Name": "ResourceGroup01",
"Id": "rg-4hsvzbbmqdzu3s****"
}
],
"StandardStartTime": "2025-01-27T02:20:10Z",
"OsUpdate": {
"CheckId": "ck-8f2a1b****",
"PackageCount": 3,
"Packages": [
{
"Kb": "KB5032190",
"Title": "2021-05 Servicing Stack Update for Windows Server 2019 for x64-based Systems (KB5003243)",
"Description": "newDescription"
}
]
},
"IsLdap": false,
"DomainType": "AD",
"SerialNumber": "96c530bc-6095-4014-8bbc-d461b8ac****",
"AccountType": "SIMPLE",
"EntraDomainName": "contoso.onmicrosoft.com",
"EnvType": "Private",
"EnvId": "adifa****",
"AgentProviderList": [
"Wuying"
],
"SubnetId": "vsw-dgea1*****"
}
],
"PageNumber": 1,
"PageSize": 10
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。