文档

ListAppInstances - 查询交付组内实例详细信息

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
appstreaming:ListAppInstancesRead
  • 全部资源
    acs:appstreaming::{#accountId}:*

请求参数

名称类型必填描述示例值
AppInstanceGroupIdstring

交付组 ID。

aig-4p5f8tj16yb8b****
AppInstanceIdstring

应用实例 ID。

ai-azn3kmwruh1vl****
Statusarray

应用实例状态列表。

string

应用实例状态。

枚举值:
  • INIT初始化
  • STARTING应用启动中
  • CLOSING应用停止中
  • CLOSED应用已关闭
  • RUNNING应用运行中
  • IDLE空闲
  • BOUND已绑定
  • UNAVAILABLE不可用
INIT
AppInstanceIdListarray

应用实例 ID 列表,最大长度为 100。

string

应用实例 ID。

ai-azn3kmwruh1vl****
PageSizeinteger

每页的查询结果数量,不可超过100。默认值为20。建议填写该参数。

20
PageNumberinteger

需展示的查询结果页码。默认值为1。建议填写该参数。

1
IncludeDeletedboolean

是否查询已删除的实例信息。 该参数为 true 时 AppInstanceIdList 的字段必填,否则会报参数错误。

true

返回参数

名称类型描述示例值
object

返回信息集合。

RequestIdstring

请求 ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
TotalCountinteger

查询结果的总数。

18
PageSizeinteger

每页的查询结果数量,不可超过100。建议填写该参数。

10
PageNumberinteger

需展示的查询结果页码。建议填写该参数。

1
AppInstanceModelsobject []

查询的应用实例列表。

AppInstanceIdstring

应用实例 ID。

ai-8dl7dzchklmka****
AppInstanceGroupIdstring

交付组 ID。

aig-dk8p95irqfst9****
Statusstring

应用实例状态。

BOUND
MainEthPublicIpstring

主网卡公网 IP。交付组网络策略(StrategyType)为混合模式(Mixed)时才返回该值,否则为空。

10.13.13.211
GmtCreatestring

创建时间。

2023-03-07T20:29:19.000+08:00
GmtModifiedstring

更新时间。

2023-03-07T20:29:19.000+08:00
SessionStatusstring

会话连接状态。实例状态为应用运行中(RUNNING)时才返回该值,否则为空。

枚举值:
  • disconnect已关闭
  • connect已连接
connect
BindInfoobject

实例与用户绑定相关信息。

EndUserIdstring

实例绑定的最终用户 ID。

app.test
UsageDurationlong

实例使用时长。单位:秒。

2000

示例

正常返回示例

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-09OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:AppInstanceIdList
    新增入参:IncludeDeleted
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)
文档反馈