调用DescribeGWSInstances查询可视化集群实例信息。

调试

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

请求参数

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

系统规定参数。取值:DescribeGWSInstances

ClusterId String gws-rhz99q8rc****

可视化集群ID。

InstanceId String i-bp1bzqq1ddeemuddn****

可视化实例ID。

PageNumber Integer 1

当前页码。

起始值:1

默认值:1

PageSize Integer 10

每页显示的条数。取值范围:1~50

默认值:10

UserUid Long 1234567890

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

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

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

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

返回数据

名称 类型 示例值 描述
Instances Array of InstanceInfo

可视化实例信息列表。

InstanceInfo
AppList Array of AppInfo

应用程序列表信息。

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

应用运行参数。

AppName String notepad

应用程序名称。

AppPath String /home/test/notepad.exe

应用程序运行路径。

ClusterId String gws-rhz99q8rc****

可视化集群ID。

CreateTime String 2020-02-03T14:03Z

可视化实例创建时间。

ExpireTime String 2099-12-31T15:59Z

可视化实例到期时间。

InstanceId String i-bp1bzqq1ddeemuddn****

可视化实例ID。

InstanceType String ecs.g6.large

可视化实例类型。

Name String c0-i01-1-g6-2c8g

可视化实例名称。

Status String Creating

可视化实例的状态。可能值:

  • Creating:创建中
  • Starting:启动中
  • Stopping:停止中
  • Stopped:已停止
  • Initializing:初始化
  • Unregistered:未注册
  • Registered:已注册
  • InUse:使用中
  • Missing:丢失
  • Cloning:镜像制作中
UserName String user-****

可视化实例分配的用户名。

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

可视化实例工作模式。可能值:

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

显示当前页。

PageSize Integer 10

显示每页条数。

RequestId String 2777461A-E45E-42F8-8E67-0EBF132E93E0

请求ID。

TotalCount Integer 1

列表信息总数。

示例

请求示例

https://ehpc.cn-hangzhou.aliyuncs.com/?Action=DescribeGWSInstances
&ClusterId=gws-rhz99q8rc****
&<公共请求参数>

正常返回示例

XML格式

</DescribeGWSInstancesResponse>
    <Instances>
        <InstanceInfo>
            <Status>Creating</Status>
            <UserName>user-****</UserName>
            <InstanceId>i-bp1bzqq1ddeemuddn****</InstanceId>
            <ClusterId>gws-rhz99q8rc****</ClusterId>
            <CreateTime>2020-02-03T14:03Z</CreateTime>
            <ExpireTime>2099-12-31T15:59Z</ExpireTime>
            <InstanceType>ecs.g6.large</InstanceType>
            <WorkMode>Desktop</WorkMode>
            <Name>c0-i01-1-g6-2c8g</Name>
        </InstanceInfo>
        <InstanceInfo>
            <AppList>
                <AppInfo>
                    <AppArgs>temp.txt</AppArgs>
                    <AppPath>/home/test/notepad.exe</AppPath>
                    <AppName>notepad</AppName>
                </AppInfo>
            </AppList>
        </InstanceInfo>
    </Instances>
    <TotalCount>1</TotalCount>
    <PageSize>10</PageSize>
    <RequestId>2777461A-E45E-42F8-8E67-0EBF132E93E0</RequestId>
    <PageNumber>1</PageNumber>
</DescribeGWSInstancesResponse>

JSON格式

{
    "Instances":{
        "InstanceInfo":[
            {
                "Status":"Creating",
                "UserName":"user-****",
                "InstanceId":"i-bp1bzqq1ddeemuddn****",
                "ClusterId":"gws-rhz99q8rc****",
                "CreateTime":"2020-02-03T14:03Z",
                "ExpireTime":"2099-12-31T15:59Z",
                "InstanceType":"ecs.g6.large",
                "WorkMode":"Desktop",
                "Name":"c0-i01-1-g6-2c8g"
            },
            {
                "AppList":{
                    "AppInfo":[
                        {
                            "AppArgs":"temp.txt",
                            "AppPath":"/home/test/notepad.exe",
                            "AppName":"notepad"
                        }
                    ]
                }
            }
        ]
    },
    "TotalCount":"1",
    "PageSize":"10",
    "RequestId":"2777461A-E45E-42F8-8E67-0EBF132E93E0",
    "PageNumber":"1"
}

错误码

HttpCode 错误码 错误信息 描述
503 ServiceUnavailable The request has failed due to a temporary failure of the server 请求失败,服务暂时不可用

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