描述实例信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeInstances

系统规定参数。取值:DescribeInstances。

ClusterId String gws-xxx

列出指定集群 id 中的所有实例。

说明 如果此参数未指定,则列出所有集群中的实例。
InstanceId String i-xxx

列出实例 id 的信息。

说明 如果此参数未指定,则列出所有实例。
UserUid Long 1234

列出分配给指定用户 id 的所有实例。

说明 如果此参数未指定,则列出所有用户的实例。

返回数据

名称 类型 示例值 描述
Instances

实例信息列表。

AppList

应用列表。

说明 工作模式为桌面模式时,此列表为空
AppArgs String c:\temp.txt

应用的运行参数。

AppName String notepad

应用名称。

AppPath String c:\windows\system32\nodepad.exe

应用的运行路径。

ClusterId String gws-xxx

集群 id

CreateTime String 2019-10-12T07:35Z

创建时间。

ExpireTime String 2099-12-31T15:59Z

过期时间。

InstanceChargeType String PostPaid

计费方式:

  • PrePaid:包年包月
  • PostPaid:按量付费
InstanceId String i-xxx

实例 id

InstanceType String ecs.g6.large

实例类型。

MaxBandwidthIn Long 100

公网入带宽最大值,单位为 Mbps

MaxBandwidthOut Long 100

公网出带宽最大值,单位为 Mbps

Name String app-xxx

实例名称。

Status String Stopped

实例状态:

  • Creating
  • Starting
  • Pending
  • Running
  • Stopping
  • Stopped
  • Registering
  • Registered
  • Missing
  • Cloning
UserName String user-xxx

分配的用户名。

说明 实例未分配给指定用户时,此值为空。
UserUid Long 1234

分配的用户 id

说明 实例未分配给指定用户时,此值为空。
WorkMode String Application

工作模式

  • Desktop:桌面模式
  • Application:应用模式
PageNumber Long 1

页码。

PageSize Long 10

每页行数。

RequestId String XXXX

请求 id

TotalCount Long 1

实例总数。

示例

请求示例


http(s)://[Endpoint]/?Action=DescribeInstances
&<公共请求参数>

正常返回示例

XML 格式

<Instances>
    <AppList>
        <AppArgs>c:\temp.txt</AppArgs>
        <AppName>notepad</AppName>
        <AppPath>C:\Windows\system32\notepad.exe</AppPath>
    </AppList>
    <ClusterId>gws-xxx</ClusterId>
    <CreateTime>2019-10-12T07:35Z</CreateTime>
    <ExpireTime>2099-12-31T15:59Z</ExpireTime>
    <InstanceChargeType>PostPaid</InstanceChargeType>
    <InstanceId>i-xxx</InstanceId>
    <InstanceType>ecs.g6.large</InstanceType>
    <MaxBandwidthIn>100</MaxBandwidthIn>
    <MaxBandwidthOut>100</MaxBandwidthOut>
    <Name>app-xxx</Name>
    <Status>Stopped</Status>
    <UserName>user-xxx</UserName>
    <WorkMode>Application</WorkMode>
</Instances>
<PageNumber>1</PageNumber>
<PageSize>20</PageSize>
<RequestId>XXXX</RequestId>
<TotalCount>1</TotalCount>

JSON 格式

{
	"PageNumber":1,
	"TotalCount":1,
	"PageSize":20,
	"RequestId":"XXXX",
	"Instances":[
		{
			"WorkMode":"Application",
			"InstanceId":"i-xxx",
			"UserName":"user-xxx",
			"InstanceType":"ecs.g6.large",
			"MaxBandwidthOut":100,
			"Name":"app-xxx",
			"Status":"Stopped",
			"MaxBandwidthIn":100,
			"ClusterId":"gws-xxx",
			"AppList":[
				{
					"AppPath":"C:\\Windows\\system32\\notepad.exe",
					"AppName":"notepad",
					"AppArgs":"c:\\temp.txt"
				}
			],
			"ExpireTime":"2099-12-31T15:59Z",
			"CreateTime":"2019-10-12T07:35Z",
			"InstanceChargeType":"PostPaid"
		}
	]
}

错误码

访问错误中心查看更多错误码。