查询应用会话列表,支持批量查询。只支持查询未结束的会话信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
cgcs:ListAppSessions | list | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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**** |
返回参数
示例
正常返回示例
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 返回结构发生变更 | 查看变更详情 |
2023-05-23 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2022-03-03 | 新增 OpenAPI | 查看变更详情 |