DescribeRenderingSession - 查询会话信息_视图计算(VECS)-阿里云帮助中心

查询会话的详情信息，包含会话当前状态、网络访问IP/端口、云应用服务实例位置等信息。

调试

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

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
ProjectId	string	是	项目 ID	project-422bc38dfgh5eb44149f135ef76304f63b
SessionId	string	否	会话 ID。SessionId/ClientId 至少必选一项	session-i205217481741918129226
ClientId	string	否	终端客户的唯一 ID。SessionId/ClientId 至少必选一项	d27c89d6-4fe3-4855-a89c-ea721c708b0b

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID	BEA5625F-8FCF-48F4-851B-CA63946DA664
SessionId	string	会话 ID	session-i205217481741918129226
ClientId	string	终端客户端 ID	c91263a0-f9ac-45bd-bbe9-6e293ad32d91
AppId	string	云应用 ID	cap-b06b26edfhytbn b94a75ae1a79efc90eb
StartTime	string	启动时间	2025-05-18T02:20:00Z
Hostname	string	实例 hostname，默认为访问 Eip	111.45.29.96
Isp	string	运营商编码，取值范围： cmcc unicom telecom	telecom
PortMappings	array<object>	端口映射信息
端口映射	object	端口映射信息
ExternalPort	string	外网端口或端口段，如 22。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。	10013/10020
InternalPort	string	内网端口或端口段，端口与外网端口一一对应。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。	49008/49015
StateInfo	object	会话状态信息
State	string	会话状态，取值范围， SessionStarting：会话启动中 SessionStartSuspended：会话启动暂停，重新发起 start 可重试 SessionStarted：会话已启动/使用中 SessionStartFailed：会话启动失败 SessionAbnormal：会话启动成功后，出现状态异常 SessionStopping：会话停止中 SessionStopFailed：会话停止失败	SessionStarted
Comment	string	状态描述信息	已启动
UpdateTime	string	状态最新更新时间	2024-10-15T10:05:20+08:00
Location	object	云应用服务实例位置信息
ProvinceCode	string	云应用服务实例所属省份码	310000
AdditionalIngresses	array<object>	其他可选的入口网络信息
其他可选的入口网络信息	object	可选的入口网络信息
PortMappings	array<object>	端口映射列表
端口映射	object	端口映射信息
ExternalPort	string	外网端口或端口段，如 22。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。	11060/11079
InternalPort	string	内网端口或端口段，端口与外网端口一一对应。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。	11060/11079
Isp	string	运营商编码，取值范围： cmcc unicom telecom	unicom
Hostname	string	云应用服务实例域名/IP	111.45.29.96
RenderingInstanceId	string	云应用服务实例 ID	render-9f8c57355d224ad7beaf95e145f22111
PatchId	string	云应用补丁包 ID。空值表示为原始版本	patch-03fa76e8e13a49b6a966b063d9d309b4

示例

正常返回示例

JSON格式

{
  "RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
  "SessionId": "session-i205217481741918129226",
  "ClientId": "c91263a0-f9ac-45bd-bbe9-6e293ad32d91",
  "AppId": "cap-b06b26edfhytbn b94a75ae1a79efc90eb",
  "StartTime": "2025-05-18T02:20:00Z",
  "Hostname": "111.45.29.96",
  "Isp": "telecom",
  "PortMappings": [
    {
      "ExternalPort": "10013/10020",
      "InternalPort": "49008/49015"
    }
  ],
  "StateInfo": {
    "State": "SessionStarted",
    "Comment": "已启动",
    "UpdateTime": "2024-10-15T10:05:20+08:00"
  },
  "Location": {
    "ProvinceCode": 310000
  },
  "AdditionalIngresses": [
    {
      "PortMappings": [
        {
          "ExternalPort": "11060/11079",
          "InternalPort": "11060/11079"
        }
      ],
      "Isp": "unicom",
      "Hostname": "111.45.29.96"
    }
  ],
  "RenderingInstanceId": "render-9f8c57355d224ad7beaf95e145f22111",
  "PatchId": "patch-03fa76e8e13a49b6a966b063d9d309b4"
}

错误码

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