ListAppSessions - 查询应用会话列表

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
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>

会话列表

appSessionobject
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 返回结构发生变更查看变更详情
2023-05-23OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2022-03-03新增 OpenAPI查看变更详情