调用ListAppInstances查询交付组内应用实例-无影云应用-阿里云-无影云应用(App Streaming)-阿里云帮助中心

查询交付组内会话实例的详细信息，包括实例ID、实例状态、创建时间、更新时间、会话状态、主网卡公网IP等。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

appstreaming:ListAppInstances

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
AppInstanceGroupId	string	是	交付组 ID。	aig-4p5f8tj16yb8b****
AppInstanceId	string	否	应用实例 ID。	ai-azn3kmwruh1vl****
Status	array	否	应用实例状态列表。
	string	是	应用实例状态。枚举值： INIT : 初始化 STARTING : 应用启动中 CLOSING : 应用停止中 CLOSED : 应用已关闭 RUNNING : 应用运行中 IDLE : 空闲 BOUND : 已绑定 UNAVAILABLE : 不可用	INIT
AppInstanceIdList	array	否	应用实例 ID 列表，最大长度为 100。
	string	是	应用实例 ID。	ai-azn3kmwruh1vl****
PageSize	integer	否	每页的查询结果数量，不可超过`100`。默认值为`20`。建议填写该参数。	20
PageNumber	integer	否	需展示的查询结果页码。默认值为`1`。建议填写该参数。	1
IncludeDeleted	boolean	否	是否查询已删除的实例信息。该参数为 true 时 AppInstanceIdList 的字段必填，否则会报参数错误。枚举值： true : 查询 false : 不查询[默认值]	true
UserIdList	array	否	用户 ID 列表，最大长度为 100。
	string	否	用户 ID	Alice

返回参数

名称	类型	描述	示例值
	object	返回信息集合。
RequestId	string	请求 ID。	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
TotalCount	integer	查询结果的总数。	18
PageSize	integer	每页的查询结果数量，不可超过`100`。建议填写该参数。	10
PageNumber	integer	需展示的查询结果页码。建议填写该参数。	1
AppInstanceModels	array<object>	查询的应用实例列表。
	array<object>	查询的应用实例。
AppInstanceId	string	应用实例 ID。	ai-8dl7dzchklmka****
AppInstanceGroupId	string	交付组 ID。	aig-dk8p95irqfst9****
Status	string	应用实例状态。	BOUND
MainEthPublicIp	string	主网卡公网 IP。交付组网络策略（`StrategyType`）为混合模式（`Mixed`）时才返回该值，否则为空。	10.13.13.211
NetworkInterfaceIp	string
GmtCreate	string	创建时间。	2023-03-07T20:29:19.000+08:00
GmtModified	string	更新时间。	2023-03-07T20:29:19.000+08:00
SessionStatus	string	会话连接状态。实例状态为应用运行中（`RUNNING`）时才返回该值，否则为空。枚举值： disconnect : 已关闭 connect : 已连接	connect
BindInfo	object	实例与用户绑定相关信息。
EndUserId	string	实例绑定的最终用户 ID。	app.test
UsageDuration	integer	实例使用时长。单位：秒。	2000
NodeId	string	运行实例的节点 ID。说明只有本实例所属交付组的售卖模式为按资源售卖（ChargeResourceMode=Node）时，才会返回本参数。	i-bp13********
ChargeType	string	实例的付费类型，返回值： PrePaid：包年包月（预付费）。 PostPaid：按量付费（后付费）。说明只有本实例所属交付组的售卖模式为按资源售卖（ChargeResourceMode=Node）时，才会返回本参数。枚举值： PostPaid : 按量付费（后付费） PrePaid : 包年包月（预付费）	PostPaid
NetworkInterfaceId	string

示例

正常返回示例

JSON格式

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "TotalCount": 18,
  "PageSize": 10,
  "PageNumber": 1,
  "AppInstanceModels": [
    {
      "AppInstanceId": "ai-8dl7dzchklmka****",
      "AppInstanceGroupId": "aig-dk8p95irqfst9****",
      "Status": "BOUND",
      "MainEthPublicIp": "10.13.13.211",
      "NetworkInterfaceIp": "",
      "GmtCreate": "2023-03-07T20:29:19.000+08:00",
      "GmtModified": "2023-03-07T20:29:19.000+08:00",
      "SessionStatus": "connect",
      "BindInfo": {
        "EndUserId": "app.test",
        "UsageDuration": 2000
      },
      "NodeId": "i-bp13********",
      "ChargeType": "PostPaid",
      "NetworkInterfaceId": ""
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。