使用StartRenderingSession API为客户端调度并启动云应用服务实例-视图计算-阿里云-视图计算(VECS)-阿里云帮助中心

为请求端（ClientId）调度一个空闲云应用服务实例，并完成服务启动。如果请求端（ClientId）启动请求发起成功后重复发起启动请求，若已关联会话处于启动暂停（SessionStartSuspended）状态，则重启会话；若会话为其他状态，则直接返回会话信息。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

vs:StartRenderingSession

update

*全部资源

*

无

请求语法

POST / HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
ProjectId	string	是	项目 ID	project-422bc38dfgh5eb44149f135ef76304f63b
ClientId	string	是	终端客户的唯一 ID	04c30850-1d91-4da1-b811-66d0ee94af7d
AppId	string	否	云应用 ID	cap-b06b26edfhytbn b94a75ae1a79efc90eb
ClientParams	object	否	终端客户的参数信息
ClientIp	string	否	终端客户 Ip，将默认用于位置就近实例调度	106.11.43.1
PatchId	string	否	云应用补丁包 ID。默认启动 AppId 稳定版本（未设置稳定 Patch 版本时，默认为原始版本）输入 origin 时，启动原始版本	patch-03fa76e8e13a49b63456b063dgh309b4

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID	BEA5625F-8FCF-48F4-851B-CA63946DA664
SessionId	string	会话 ID	session-i205217481741918129226
Hostname	string	实例 hostname,默认为访问 Eip	cn-xxx.ecr.aliyuncs.com
PortMappings	array<object>	端口映射信息
	object	端口映射信息
ExternalPort	string	外网端口或端口段，如 22。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。	10013/10020
InternalPort	string	内网端口或端口段，端口与外网端口一一对应。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。	49008/49015
StateInfo	object	会话状态信息
State	string	会话状态	SessionStarting
Comment	string	状态描述信息	会话启动中
UpdateTime	string	状态最新更新时间，采用 ISO 8601 标准的 UTC 时间，格式为 YYYY-MM-DDTHH:mmZ。	2021-05-06T06:37Z
Location	object	云应用服务实例位置信息
ProvinceCode	string	云应用服务实例所属省份码	610000
IsRepeatedRequest	boolean	是否是重复请求	false
RenderingInstanceId	string	云应用服务实例 ID	render-9f8c57355d224ad7beaf95e145f22111

示例

正常返回示例

JSON格式

{
  "RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
  "SessionId": "session-i205217481741918129226",
  "Hostname": "cn-xxx.ecr.aliyuncs.com",
  "PortMappings": [
    {
      "ExternalPort": "10013/10020",
      "InternalPort": "49008/49015"
    }
  ],
  "StateInfo": {
    "State": "SessionStarting",
    "Comment": "会话启动中",
    "UpdateTime": "2021-05-06T06:37Z"
  },
  "Location": {
    "ProvinceCode": "610000"
  },
  "IsRepeatedRequest": false,
  "RenderingInstanceId": "render-9f8c57355d224ad7beaf95e145f22111"
}

错误码

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

变更历史

更多信息，参考变更详情。