为请求端(ClientId)调度一个空闲云应用服务实例,并完成服务启动。 如果请求端(ClientId)启动请求发起成功后重复发起启动请求,若已关联会话处于启动暂停(SessionStartSuspended)状态,则重启会话;若会话为其他状态,则直接返回会话信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
vs:StartRenderingSession | update | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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。
| patch-03fa76e8e13a49b63456b063dgh309b4 |
返回参数
示例
正常返回示例
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"
}
错误码
访问错误中心查看更多错误码。