查询交付组内会话实例的详细信息，包括实例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 | |
| AppInstanceIdList | array | 否 | 应用实例 ID 列表，最大长度为 100。 | |
| string | 是 | 应用实例 ID。 | ai-azn3kmwruh1vl**** | |
| PageSize | integer | 否 | 每页的查询结果数量，不可超过 | 20 |
| PageNumber | integer | 否 | 需展示的查询结果页码。默认值为 | 1 |
| IncludeDeleted | boolean | 否 | 是否查询已删除的实例信息。 该参数为 true 时 AppInstanceIdList 的字段必填，否则会报参数错误。 枚举值：
| true |
返回参数
示例
正常返回示例
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",
"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
}
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-05-09 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |