更新时间:2021-11-25 GMT+08:00
分享

获取渲染任务列表

功能介绍

获取渲染任务列表。

仅支持查询90天内的渲染任务信息。

URI

GET /v2/cvr/render-tasks

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

请求参数

表1 查询参数

参数

是否必选

参数类型

描述

status

String

任务状态。

status的取值范围如下:

  • active:运行中的任务。
  • finish:已经结束运行的任务。
  • initial:正在初始化的任务。
  • clean:正在转储中的任务。

application_id

String

根据应用ID进行精确搜索。

获取指定应用ID下的渲染任务列表。

server_id

String

根据云服务器ID进行精确搜索。

获取指定云服务器上的渲染任务。

device_id

String

根据设备ID进行精确搜索。

获取指定设备的渲染任务列表。

limit

Integer

每页显示的条目数量。

默认为1000,最大值为1000。

offset

Integer

偏移量,表示从此偏移量开始查询。

默认为0,最大值为1000。

响应参数

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

    参数

    参数类型

    描述

    count

    Integer

    符合条件的所有渲染任务的数量。

    render_tasks

    Array of objects

    渲染任务信息列表,详情请参见表3

    表3 render_task字段数据结构说明

    参数

    参数类型

    描述

    task_id

    String

    任务ID。

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

    application_id

    String

    应用ID。

    应用的唯一标识,格式为UUID。

    server_id

    String

    云服务器ID。

    云服务器的唯一标识,格式为UUID。

    session_id

    String

    会话ID,提供音视频流的会话ID。

    • 普通型云服务器该ID为空。
    • 会话型云服务器该ID为会话编号。

    device_id

    String

    设备ID,设备的唯一标识。

    application_user

    String

    应用使用用户标识。

    status

    String

    任务状态。

    status的取值范围如下:

    • active:运行中的任务。
    • finish:已经结束运行的任务。

    start_time

    String

    任务开始时间。

    时间格式例如:2020-05-20T03:30:52Z

    finish_time

    String

    任务结束时间。

    时间格式例如:2020-05-20T03:30:52Z

    finish_reason

    String

    任务结束原因。

    finish_reason的取值范围如下:

    • cancel:主动停止任务。
    • normal:任务正常结束。
    • error:出现故障,任务结束。
    • server_deleted:云服务器删除,任务结束。
    • application_start_failed:启动应用失败,任务结束。
    • device_changed:修改设备,任务结束。
  • 状态码为400时
    表4 响应参数

    参数

    参数类型

    描述

    error_code

    String

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

    error_msg

    String

    错误的英文描述。

请求示例

  • 请求示例
    获取指定应用下所有还在运行的渲染任务。
    GET https://{endpoint}/v2/cvr/render-task?application_id=63b79e6e-7be9-11eb-8817-84a93e805fe6&status=active

响应示例

  • 状态码为200时
    {
        "count": 1,
        "render_tasks": [
            {
                "task_id": "5a229588-7bea-11eb-bb6d-84a93e805fe6", 
                "application_id": "63b79e6e-7be9-11eb-8817-84a93e805fe6", 
                "server_id": "63231434-7bea-11eb-9409-84a93e805fe6", 
                "session_id": "1",
                "device_id": "0FBCA6", 
                "status": "active", 
                "start_time": "2021-03-02T12:55:13Z", 
                "finish_time": "", 
                "finish_reason": "" 
            }
        ]
    }
  • 状态码为400时
    { 
      "error_code" : "string", 
      "error_msg" : "string" 
    }

状态码

请参见状态码

错误码

请参见错误码

分享:

    相关文档

    相关产品