ListRenderingSessions - 查询会话列表

分页查询指定条件下的云应用服务会话列表。

调试

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

授权信息

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

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

请求参数

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

项目 ID

project-422bc38dfgh5eb44149f135ef76304f63b
SessionIdstring

会话 ID

session-i205217481741918129226
ClientIdstring

终端客户的唯一 ID

ae7990f4-203d-494b-a5ea-e0babe9fa13d
AppIdstring

云应用 ID

cap-b06b26edfhytbn b94a75ae1a79efc90eb
Statestring

会话状态,取值范围,

  1. SessionStarting:会话启动中
  2. SessionStartSuspended:会话启动暂停,重新发起 start 可重试
  3. SessionStarted:会话已启动/使用中
  4. SessionStartFailed:会话启动失败
  5. SessionAbnormal:会话启动成功后,出现状态异常
  6. SessionStopping:会话停止中
  7. SessionStopFailed:会话停止失败
SessionStarting
RenderingInstanceIdstring

云应用服务实例 ID

render-9f8c57355d224ad7beaf95e145f22111
PageNumberinteger

页码,起始值为 1

1
PageSizeinteger

分页查询时设置的每页行数

10
StartTimestring

时间区间筛选参数。按照 ISO8601 标准表示,并需要使用 UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

2025-03-25T02:00:00Z
EndTimestring

时间区间筛选参数。按照 ISO8601 标准表示,并需要使用 UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

2025-03-31T22:20:00Z
PatchIdstring

云应用补丁包 ID。

  1. 输入 origin 时,仅过滤启动了 App 原始版本的会话
patch-03fa76e8e13a49b6a966b063d9d309b4

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID

BEA5625F-8FCF-48F4-851B-CA63946DA664
Sessionsarray<object>

会话列表

会话列表object

会话信息

AppIdstring

云应用 ID

cap-4e1a6a425495458ba78693b8ac6600ea
RenderingInstanceIdstring

云应用服务实例 ID

render-a10722fb84b243f6ba02a89a2e5c838d
StartTimestring

启动时间

2024-07-04T01:23:00Z
ClientIdstring

终端客户端 ID

fd6b2134-7954-4754-8915-5fb8b0469622
PatchIdstring

云应用补丁包 ID。空值表示为原始版本

patch-03fa76e8e13a49b6a966b063d9d309b4
SessionIdstring

会话 ID

session-i205217481741918129226
TotalCountlong

匹配的会话总数

8

示例

正常返回示例

JSON格式

{
  "RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
  "Sessions": [
    {
      "AppId": "cap-4e1a6a425495458ba78693b8ac6600ea",
      "RenderingInstanceId": "render-a10722fb84b243f6ba02a89a2e5c838d",
      "StartTime": "2024-07-04T01:23:00Z",
      "ClientId": "fd6b2134-7954-4754-8915-5fb8b0469622",
      "PatchId": "patch-03fa76e8e13a49b6a966b063d9d309b4",
      "SessionId": "session-i205217481741918129226"
    }
  ],
  "TotalCount": 8
}

错误码

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