文档首页/ VR云渲游平台 CVR/ API参考/ API/ 渲染任务管理/ 渲染节点调度
更新时间：2024-10-28 GMT+08:00
查看PDF
分享

渲染节点调度

功能介绍

一般由设备调用，用于获取已安装指定应用的GPU云服务器的IP地址、端口等信息。

接口约束

无

URI

POST /v2/cvr/render-tasks

该接口需要使用global终端节点调用。

请求参数

表1 请求参数

参数

是否必选

参数类型

描述

application_id

是

String

设备需要使用的应用ID。

device_id

是

String

设备ID。

  • 长度范围1到40个字符。
  • 只允许输入英文大小写字母、数字及“_”、“-”。

device_brand

否

String

设备品牌。

  • 长度范围1到30个字符。
  • 只允许输入英文大小写字母、数字、空格及“_”、“-”、“.“。

device_type

否

String

设备类型。

device_type的取值范围如下：

  • vr：VR头显
  • pc：台式机或笔记本电脑
  • mobile: 手机或平板
  • ideahub: 智慧屏

VR应用仅支持设备类型为vr，3D应用默认设备类型为pc。

application_launch_args

否

String

应用启动参数。

  • 长度范围1到200个字符。
  • 只允许输入中文字符、英文大小写字母、数字、空格、英文引号及“_”、“-”、“.“、“/”、“:”。

application_user

否

String

应用使用用户标识（该参数仅对3D应用生效）。

  • 长度范围1到40个字符。
  • 只允许输入英文大小写字母、数字及下划线“_”。

protocol_type

否

String

设备与云服务器进行通信时所使用的协议类型。

取值范围如下：

  • udp：集成Android VR SDK的客户端需使用该协议
  • webrtc: 集成Windows SDK或Android 3D SDK的客户端需使用该协议
  • websocket:集成Web SDK的客户端需使用该协议

默认值：udp，VR应用仅支持udp协议类型。

location

否

Array of strings

区域列表或边缘小站列表。

分配指定区域中的空闲云服务器。

  • 最多输入10个区域或边缘小站。
  • 每个区域或边缘小站的长度不超过40个字符。

sandbox_enable

否

Boolean

该参数已废弃。

是否支持多路会话的云服务器（该参数仅对VR应用生效）。

  • true，表示支持多路会话的云服务器。此时，在单路会话和多路会话的云服务器上均可启动渲染任务。
  • false，表示不支持多路会话的云服务器。此时，只能在单路会话的云服务器上启动渲染任务。

默认值：false。

resolution

否

String

GPU云服务器传给设备的画面分辨率（该参数仅对3D应用生效）。

允许输入480p，540p，720p，1080p，2k，4k。

默认值：1080p。

gpu_ip_type

否

String

分配给设备使用的GPU云服务器的IP类型。

  • public：表示响应的gpu_ip的IP地址为公网，适用于使用公网连接设备与云服务器的场景。
  • private: 表示响应的gpu_ip的IP地址为私网，适用于使用专线或者内网等连接设备与云服务器的场景。

默认值：public。

响应参数

  • 状态码为200时
    表2 响应参数

    参数

    参数类型

    描述

    gpu_ip

    String

    分配给设备使用的GPU云服务器的IP地址。

    port

    String

    云服务器端口。

    link_token

    String

    设备用于连接GPU云服务器的认证凭据。

    task_id

    String

    渲染任务的任务ID。

    连接任务的唯一标识，格式为UUID。

    application_id

    String

    应用ID。

    device_id

    String

    设备ID。

    device_brand

    String

    设备品牌。

    device_type

    String

    设备类型。

    application_user

    String

    应用使用用户标识。

    application_launch_args

    String

    应用启动参数。

    protocol_type

    String

    设备与云服务器进行通信时所使用的协议类型。

    location

    Array of strings

    区域列表或边缘小站列表。

    resolution

    String

    GPU云服务器传给设备的画面分辨率。

    gpu_ip_type

    String

    分配给设备使用的GPU云服务器的IP类型。
  • 状态码为400时
    表3 响应参数

    参数

    参数类型

    描述

    error_code

    String

    返回的错误码，如CVR.0001。

    error_msg

    String

    错误的英文描述。

请求示例

  • 请求URL示例 
    POST https://{endpoint}/v2/cvr/render-tasks
  • 请求示例 
    {
    "application_id": "5afa7bb2-53d7-11eb-a5aa-fa1640a9b002",
    "device_id": "477e10fc9938405cb2eceb631a0e6615", 
    "device_brand": "HUAWEI",
    "device_type": "pc",
    "application_user": "user1",
    "protocol_type": "udp",
    "location": ["cn-north-1"],
    "resolution": "480p",   
    "gpu_ip_type": "private"
}

响应示例

  • 状态码为200时

    OK

    { 
    "gpu_ip" : "255.255.255.255", 
    "port":"10001",
    "link_token" : "******", 
    "task_id" : "5afa7bb2-53d7-11eb-a5aa-fa1640a9b003",    
    "application_id": "5afa7bb2-53d7-11eb-a5aa-fa1640a9b002",
    "application_launch_args": "",
    "device_id": "477e10fc9938405cb2eceb631a0e6615", 
    "device_brand": "HUAWEI",
    "device_type": "pc",
    "application_user": "user1",
    "protocol_type": "udp",
    "resolution": "480p",   
    "gpu_ip_type": "private",
    "location": ["cn-north-1"]
}
  • 状态码为400时 
    { 
  "error_code" : "string", 
  "error_msg" : "string" 
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 渲染任务管理

相关文档