Elastic Desktop Service (EDS) インスタンスの詳細情報を取得します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ecd:DescribeDesktops |
get |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| BusinessChannel |
string |
任意 |
|
|
| RegionId |
string |
必須 |
リージョン ID です。Elastic Desktop Service がサポートするリージョンを確認するには、DescribeRegions 操作を呼び出してください。 |
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 はオフィスサイト ID と同じです。 |
cn-hangzhou+dir-363353**** |
| OfficeSiteId |
string |
任意 |
オフィスサイトの ID です。 |
cn-hangzhou+dir-363353**** |
| OfficeSiteName |
string |
任意 |
オフィスサイトの名前です。 |
default |
| PolicyGroupId |
string |
任意 |
ポリシーの ID です。 |
system-all-enabled-policy |
| ChargeType |
string |
任意 |
デスクトップの課金方法です。 列挙値:
|
PostPaid |
| ExpiredTime |
string |
任意 |
サブスクリプションデスクトップの有効期限です。 |
2022-12-31T15:59:59Z |
| ProtocolType |
string |
任意 |
プロトコルタイプです。 列挙値:
|
ASP |
| DesktopId |
array |
任意 |
1 ~ 100 個のデスクトップ ID の配列です。 |
ecd-gx2x1dhsmucyy**** |
|
string |
任意 |
デスクトップの ID です。 |
ecd-gx2x1dhsmucyy**** |
|
| EndUserId |
array |
任意 |
1 ~ 100 個の許可されたユーザー ID の配列です。 説明
1 つのデスクトップに同時に接続して使用できるユーザーは 1 名のみです。 |
alice |
|
string |
任意 |
デスクトップの許可されたユーザーです。 |
alice |
|
| ExcludedEndUserId |
array |
任意 |
1 ~ 100 個の除外するユーザー ID の配列です。 |
andy |
|
string |
任意 |
除外する許可されたユーザーです。 |
andy |
|
| FilterDesktopGroup |
boolean |
任意 |
デスクトッププール内のデスクトップを除外するかどうかを指定します。 列挙値:
|
false |
| ManagementFlag |
string |
任意 |
管理フラグです。 列挙値:
|
NoFlag |
| QueryFotaUpdate |
boolean |
任意 |
デスクトップのイメージ更新情報を照会するかどうかを指定します。 列挙値:
|
false |
| Tag |
array<object> |
任意 |
リソースをフィルターするためのタグです。タグはキーと値のペアで、デスクトップをグループ化および管理し、検索やバッチ操作を容易にするために使用できます。詳細については、「タグを使用したデスクトップの管理」をご参照ください。 |
|
|
object |
任意 |
タグのキーと値のペアです。各デスクトップに対して 1 ~ 20 個のキーと値のペアを指定できます。各タグキーは一意である必要があります。 |
||
| 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 |
任意 |
デスクトップのインスタンスタイプです。サポートされているインスタンスタイプ ID を確認するには、DescribeDesktopTypes 操作を呼び出してください。 |
eds.general.2c8g |
| ImageId |
array |
任意 |
イメージ ID の配列です。 |
|
|
string |
任意 |
イメージの ID です。 |
m-2g65ljy3ynrdq**** |
|
| DesktopStatusList |
array |
任意 |
デスクトップステータスの配列です。 |
|
|
string |
任意 |
デスクトップのステータスです。 列挙値:
|
Stopped |
|
| GpuInstanceGroupId |
string |
任意 |
エラスティック GPU インスタンスグループの ID です。 |
gp-0bm2iz1v6m6nx**** |
| QosRuleId |
string |
任意 |
QoS ルールの 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 |
デスクトップの作成時刻です。 |
2020-11-06T08:28Z |
| ChargeType |
string |
デスクトップの課金方法です。 列挙値:
|
PostPaid |
| DesktopName |
string |
デスクトップの名前です。 |
DemoComputer01 |
| PolicyGroupName |
string |
ポリシーの名前です。 |
All enabled policy |
| 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**** |
| DirectoryId |
string |
ディレクトリ ID です。このパラメーターはオフィスサイト ID ( |
cn-hangzhou+dir-363353**** |
| ManagementFlag |
string |
管理フラグです。 列挙値:
|
NoFlag |
| DataDiskCategory |
string |
説明
このパラメーターは招待プレビューであり、公開されていません。 |
null |
| SystemDiskCategory |
string |
説明
このパラメーターは招待プレビューであり、公開されていません。 |
null |
| NetworkInterfaceId |
string |
RAM ユーザーまたは Active Directory (AD) ユーザー向けにデスクトップサービスによって作成されたセカンダリネットワークインターフェースの ID です。この値は変更できません。 |
123456 |
| OfficeSiteId |
string |
オフィスサイトの ID です。 |
cn-hangzhou+dir-363353**** |
| DataDiskSize |
string |
説明
このパラメーターは招待プレビューであり、公開されていません。 |
null |
| DesktopGroupId |
string |
デスクトップが属するデスクトッププールの ID です。デスクトップがデスクトッププールに属していない場合、値は |
null |
| DesktopId |
string |
デスクトップの ID です。 |
ecd-gx2x1dhsmucyy**** |
| OfficeSiteName |
string |
オフィスサイトの名前です。 |
default |
| StartTime |
string |
デスクトップが初めて起動された時刻です。 |
2020-11-06T08:31Z |
| DirectoryType |
string |
説明
このパラメーターは招待プレビューであり、公開されていません。 |
SIMPLE |
| Cpu |
integer |
vCPU の数です。 |
2 |
| NetworkInterfaceIp |
string |
RAM ユーザーまたは AD ユーザー向けにデスクトップサービスによって作成されたセカンダリネットワークインターフェースの IP アドレスです。 |
192.168.XX.XX |
| ExpiredTime |
string |
サブスクリプションデスクトップの有効期限です。 |
2021-12-31T15:59Z |
| OsType |
string |
OS です。 |
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 |
Enhanced SSD (ESSD) のパフォーマンスレベルです。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 |
セッションが確立された時刻です。 |
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 ドライバーのバージョンです。 |
null |
| ZoneType |
string |
ゾーンタイプです。デフォルト値は |
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 |
OS プラットフォームです。 列挙値:
|
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 |
ポリシー名です。 |
测试策略01 |
|
| HibernationOptionsConfigured |
boolean |
説明
このパラメーターは招待プレビューであり、公開されていません。 |
true |
| SupportHibernation |
boolean |
休止状態がサポートされているかどうかを示します。 |
true |
| HibernationBeta |
boolean |
説明
このパラメーターは招待プレビューであり、公開されていません。 |
true |
| ResourceGroups |
array<object> |
リソースグループの詳細情報です。 |
|
|
object |
リソースグループの詳細情報です。 |
||
| Name |
string |
リソースグループの名前です。 |
资源组01 |
| Id |
string |
リソースグループの ID です。 |
rg-4hsvzbbmqdzu3s**** |
| StandardStartTime |
string |
||
| OsUpdate |
object |
||
| CheckId |
string |
||
| PackageCount |
integer |
||
| Packages |
array<object> |
||
|
object |
|||
| Kb |
string |
||
| Title |
string |
||
| Description |
string |
||
| IsLdap |
boolean |
||
| DomainType |
string |
||
| SerialNumber |
string |
||
| AccountType |
string |
||
| EntraDomainName |
string |
||
| EnvType |
string |
||
| EnvId |
string |
||
| AgentProviderList |
array |
||
|
string |
|||
| 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": "All enabled policy",
"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****",
"DirectoryId": "cn-hangzhou+dir-363353****",
"ManagementFlag": "NoFlag",
"DataDiskCategory": "null",
"SystemDiskCategory": "null",
"NetworkInterfaceId": "123456",
"OfficeSiteId": "cn-hangzhou+dir-363353****",
"DataDiskSize": "null",
"DesktopGroupId": "null",
"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": "null",
"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": [
"测试策略01"
],
"HibernationOptionsConfigured": true,
"SupportHibernation": true,
"HibernationBeta": true,
"ResourceGroups": [
{
"Name": "资源组01",
"Id": "rg-4hsvzbbmqdzu3s****"
}
],
"StandardStartTime": "",
"OsUpdate": {
"CheckId": "",
"PackageCount": 0,
"Packages": [
{
"Kb": "",
"Title": "",
"Description": ""
}
]
},
"IsLdap": false,
"DomainType": "",
"SerialNumber": "",
"AccountType": "",
"EntraDomainName": "",
"EnvType": "",
"EnvId": "",
"AgentProviderList": [
""
]
}
],
"PageNumber": 1,
"PageSize": 10
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。