调用DescribeGWSInstances查询可视化集群实例信息_弹性高性能计算(E-HPC)-阿里云帮助中心

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
ClusterId	string	是	可视化集群 ID。	gws-rhz99q8rc****
InstanceId	string	否	可视化实例 ID。	i-bp1bzqq1ddeemuddn****
PageNumber	integer	否	当前页码。起始值：1 默认值：1	1
PageSize	integer	否	每页显示的条数。取值范围：1~50 默认值：10	10
UserUid	long	否	列出分配给指定用户 ID 的所有实例。说明如果此参数未指定，则列出所有用户的实例。	1234567890
UserName	string	否	列出分配给指定用户名称的所有实例。说明如果此参数未指定，则列出所有用户的实例。	testuser

返回参数

名称	类型	描述	示例值
	object
PageSize	integer	显示每页条数。	10
RequestId	string	请求 ID。	2777461A-E45E-42F8-8E67-0EBF132E93E0
PageNumber	integer	显示当前页。	1
TotalCount	integer	列表信息总数。	1
Instances	object []	可视化实例信息列表。
Status	string	可视化实例的状态。可能值： Creating：创建中 Starting：启动中 Stopping：停止中 Stopped：已停止 Initializing：初始化 Unregistered：未注册 Registered：已注册 InUse：使用中 Missing：丢失 Cloning：镜像制作中	Creating
WorkMode	string	可视化实例工作模式。可能值： Desktop：桌面模式 Application：应用模式	Desktop
ExpireTime	string	可视化实例到期时间。	2099-12-31T15:59Z
CreateTime	string	可视化实例创建时间。	2020-02-03T14:03Z
InstanceId	string	可视化实例 ID。	i-bp1bzqq1ddeemuddn****
Name	string	可视化实例名称。	c0-i01-1-g6-2c8g
InstanceType	string	可视化实例类型。	ecs.g6.large
UserName	string	可视化实例分配的用户名。说明实例未分配给指定用户时，此值为空。	user-****
ClusterId	string	可视化集群 ID。	gws-rhz99q8rc****
AppList	object []	应用程序列表信息。说明工作模式为桌面模式时，此列表为空。
AppName	string	应用程序名称。	notepad
AppArgs	string	应用运行参数。	temp.txt
AppPath	string	应用程序运行路径。	/home/test/notepad.exe

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParams	The specified parameter %s is invalid.	无效的参数：%s
406	AliyunError	An Alibaba Cloud product error occurred.	阿里云产品错误
407	NotAuthorized	You are not authorized by RAM for this request.	此请求未获得RAM授权
500	UnknownError	An unknown error occurred.	未知错误
503	ServiceUnavailable	The request has failed due to a temporary failure of the server	请求失败，服务暂时不可用

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