全部产品
云市场

DescribeGWSInstances

更新时间:2020-02-10 16:28:28

查询桌面实例。

描述

查询创建的桌面实例详细信息。

请求参数

字段 类型 是否必须 默认值 描述
Action String - 操作接口名,系统规定参数,取值:DescribeGWSInstances
InstanceId String - 图形工作站实例ID
RegionId String - 地域ID
PageNumber String 1 查询指定页
PageSize String 10 查询分页大小

返回参数

公共返回参数外,还返回如下参数:

名称 类型 描述
Instances Array < InstanceInfo> 实例详细信息,InstanceInfo 结构见下面的对象描述。
TotalCount Integer 列表条目总数。
PageNumber Integer 当前页码。
PageSize Integer 本页条数。

其中,InstanceInfo 元素包含以下字段:

名称 类型 描述
ClusterId String 集群 ID
InstanceId String 实例ID
Status String 集群状态
InstanceType string 实例类型
InstanceChargeType string 实例付费类型
WorkMode string 工作模式
AppList array 应用程序列表

其中,applist 的对象成员有:

名称 类型 描述
AppName string 应用名称
AppPath string 应用可执行文件路径
AppArgs string 应用执行参数

示例

请求示例

  1. https://ehpc.cn-hangzhou.aliyuncs.com/?Action=DescribeGWSInstances&RegionId=cn-hangzhou&ClusterId=<集群ID>&<公共请求参数>

返回示例

XML格式

  1. <DescribeGWSInstancesResponse>
  2. <?xml version="1.0" encoding="UTF-8" ?>
  3. <RequestId>2777461A-E45E-42F8-8E67-0EBF132E93E0</RequestId>
  4. <PageNumber>1</PageNumber>
  5. <TotalCount>2</TotalCount>
  6. <PageSize>10</PageSize>
  7. <Instances>
  8. <InstanceInfo>
  9. <ClusterId>gws-testclusterid-10086</ClusterId>
  10. <InstanceId>gws-testinstanceid-10086</InstanceId>
  11. <Status>Creating</Status>
  12. <InstanceType>ecs.c5.2xlarge</InstanceType>
  13. <InstanceChargeType>PostPaid</InstanceChargeType>
  14. <WorkMode>Application</WorkMode>
  15. <AppList>
  16. <AppInfo>
  17. <AppName>Chrome</AppName>
  18. <AppPath>C:\Chrome</AppPath>
  19. <AppArgs>--debug</AppArgs>
  20. </AppInfo>
  21. </AppList>
  22. </InstanceInfo>
  23. <InstanceInfo>
  24. <ClusterId>gws-testclusterid-95588</ClusterId>
  25. <InstanceId>gws-testinstanceid-95588</InstanceId>
  26. <Status>Stopped</Status>
  27. <InstanceType>ecs.c5.2xlarge</InstanceType>
  28. <InstanceChargeType>PostPaid</InstanceChargeType>
  29. <WorkMode>Desktop</WorkMode>
  30. </InstanceInfo>
  31. </Instances>
  32. </DescribeGWSInstancesResponse>

JSON格式

  1. {
  2. "RequestId": "2777461A-E45E-42F8-8E67-0EBF132E93E0",
  3. "PageNumber": 1,
  4. "TotalCount": 2,
  5. "PageSize": 10,
  6. "Instances": {
  7. "InstanceInfo": [
  8. {
  9. "ClusterId": "gws-testclusterid-10086",
  10. "InstanceId": "gws-testinstanceid-10086",
  11. "Status": "Creating",
  12. "InstanceType": "ecs.c5.2xlarge",
  13. "InstanceChargeType": "PostPaid",
  14. "WorkMode": "Application",
  15. "AppList": {
  16. "AppInfo": [
  17. {
  18. "AppName": "Chrome",
  19. "AppPath": "C:\\Chrome",
  20. "AppArgs": "--debug"
  21. }
  22. ]
  23. }
  24. },
  25. {
  26. "ClusterId": "gws-testclusterid-95588",
  27. "InstanceId": "gws-testinstanceid-95588",
  28. "Status": "Stopped",
  29. "InstanceType": "ecs.c5.2xlarge",
  30. "InstanceChargeType": "PostPaid",
  31. "WorkMode": "Desktop"
  32. }
  33. ]
  34. }
  35. }

错误码

查询 E-HPC 接口错误码请访问 错误码。更多错误码,请访问 API 错误中心