调用GetAppSession获取应用会话详情_云渲染(GCS)-阿里云帮助中心

获取应用会话详情。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
cgcs:GetAppSession	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
PlatformSessionId	string	否	平台会话 ID，在平台中唯一标识一个会话。注意：PlatformSessionId 和 CustomSessionId 必须二选一。如果同时设置了两个参数，以 PlatformSessionId 为准。	100XXXX
CustomSessionId	string	否	自定义会话 ID，用于查询最近一条未结束的应用会话记录。注意：PlatformSessionId 和 CustomSessionId 必须二选一。如果同时设置了两个参数，以 PlatformSessionId 为准。	1ADE0XXXX

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID	46329898-489C-4E63-9BA1-C1DA5C5D0986
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

示例

正常返回示例

JSON格式

{
  "RequestId": "46329898-489C-4E63-9BA1-C1DA5C5D0986",
  "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"
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2022-03-03	新增 OpenAPI	查看变更详情