调用ListAppSessions查询应用会话列表_云渲染(GCS)-阿里云帮助中心

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

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
PlatformSessionIds	array	否	平台会话 ID 列表
	string	否	其中一个 ID	100XXXX
CustomSessionIds	array	否	自定义会话 ID 列表
	string	否	其中一个 ID	1ADE0XXXX
PageSize	integer	否	分页查询时设置的每页行数。最大值 100，默认值 20。	20
PageNumber	integer	否	实例列表的页码。起始值 1，默认值 1。	1
AppId	string	否	应用 ID	13027XXXX
ProjectId	string	否	项目 ID。	d9a8****

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID	46329898-489C-4E63-9BA1-C1DA5C5D0986
AppSessions	object []	会话列表
CustomSessionId	string	自定义会话 ID	1ADE0XXXX
PlatformSessionId	string	平台会话 ID	100XXXX
AppId	string	应用 ID	13027XXXX
AppVersion	string	应用版本 ID	35067XXXX
Status	string	应用会话状态，包括： starting：启动中 running：执行中 stopping：停止中	running
BizInfo	object	业务特定的信息，如会话启动/停止时间。
StartTime	string	会话启动时间	2022-07-20 17:58:51
StopTime	string	会话停止时间	2022-07-20 17:58:57
ProjectId	string	项目 ID。	d9a8****
PageSize	integer	分页大小	20
PageNumber	integer	页码	1
TotalCount	integer	总数	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-23

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更。

2023-05-23

OpenAPI 入参发生变更、OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
入参	OpenAPI 入参发生变更。
	新增入参：ProjectId
出参	OpenAPI 返回结构发生变更。

2022-03-03

新增 OpenAPI

看变更集