首页 云渲染 GCS 开发参考 API参考 API目录 会话管理 ListAppSessions - 查询应用会话列表

ListAppSessions - 查询应用会话列表

更新时间: 2023-05-23 16:57:16

查询应用会话列表,支持批量查询。只支持查询未结束的会话信息。

调试

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

调试

授权信息

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

请求参数

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

平台会话ID列表

string

其中一个ID

100XXXX
CustomSessionIdsarray

自定义会话ID列表

string

其中一个ID

1ADE0XXXX
PageSizeinteger

分页查询时设置的每页行数。最大值100,默认值20。

20
PageNumberinteger

实例列表的页码。起始值1,默认值1。

1
AppIdstring

应用ID

13027XXXX
ProjectIdstring

项目ID。

d9a8****

返回参数

名称类型描述示例值
object
RequestIdstring

请求ID

46329898-489C-4E63-9BA1-C1DA5C5D0986
AppSessionsarray

会话列表

object
CustomSessionIdstring

自定义会话ID

1ADE0XXXX
PlatformSessionIdstring

平台会话ID

100XXXX
AppIdstring

应用ID

13027XXXX
AppVersionstring

应用版本ID

35067XXXX
Statusstring

应用会话状态,包括:

  • starting:启动中
  • running:执行中
  • stopping:停止中
running
BizInfoobject

业务特定的信息,如会话启动/停止时间。

StartTimestring

会话启动时间

2022-07-20 17:58:51
StopTimestring

会话停止时间

2022-07-20 17:58:57
ProjectIdstring

项目ID。

d9a8****
PageSizeinteger

分页大小

20
PageNumberinteger

页码

1
TotalCountinteger

总数

100

示例

正常返回示例

JSON格式

{
  "RequestId": "46329898-489C-4E63-9BA1-C1DA5C5D0986",
  "AppSessions": [
    {
      "CustomSessionId": "1ADE0XXXX",
      "PlatformSessionId": "100XXXX ",
      "AppId": "13027XXXX",
      "AppVersion": "35067XXXX",
      "Status": "running",
      "BizInfo": {
        "StartTime": "2022-07-20 17:58:51",
        "StopTime": "2022-07-20 17:58:57"
      },
      "ProjectId": "d9a8****\n"
    }
  ],
  "PageSize": 20,
  "PageNumber": 1,
  "TotalCount": 100
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-05-23OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-05-23OpenAPI 入参发生变更,OpenAPI 返回结构发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ProjectId
出参OpenAPI 返回结构发生变更
2022-03-03新增 OpenAPI
阿里云首页 云渲染 GCS 相关技术圈