首页文档中心 API参考获取任务列表与在线用户列表

获取任务列表与在线用户列表

API名称: task_list
HTTP方法类型: GET
所需HTTP头字段:
- xvs-signature 签名字段
- xvs-timestamp 签名时间戳
URL查询参数:
- service_code 任务相关的服务码

下面是一个请求抓包数据：

GET /api/20140928/task_list?service_code=TESTING HTTP/1.1
Host: c.zhiboyun.com
Connection: keep-alive
Accept: application/json, text/javascript, */*; q=0.01
xvs-timestamp: 1443494296533
User-Agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/45.0.2454.101 Safari/537.36
xvs-signature: c576f321f9ad60c92d85032a99f9856b8c432cdf55f6c275b2c8a27344a5bf14
Accept-Encoding: gzip, deflate, sdch
Accept-Language: zh-CN,zh;q=0.8

上面这个抓包请求中计算xvs-signature的共享密钥是abc

下面是API返回数据示例:

空的：

{
    "ret": 0, 
    "user_list": [ ], 
    "task_list": [ ]
}

有数据的：

{
    "ret": 0,
    "user_list": [
        {
            "vs_id": "aws-cn_north_1-5",
            "service_code": "TESTING",
            "user_name": "001",
            "client_version": "451",
            "device_type": "10"
        }
    ],
    "task_list": [
        {
            "id": "aws-cn_north_1-5-7d4bb08e1ada4741",
            "serial": 29832958,
            "sequence": 1555,
            "progress": 0,
            "vs_id": "aws-cn_north_1-5",
            "service_code": "TESTING",
            "outputs": [
                {
                    "file_name": "aws-cn_north_1-5-7d4bb08e1ada4741.flv",
                    "tag": "tcp_output_live_only",
                    "audio_codec_name": "aac",
                    "video_codec_name": "libx264",
                    "format": "flv",
                    "width": 576,
                    "height": 432,
                    "relative_dir": "TESTING/20151106/02/26/flv/",
                    "http_output_bytes": 0,
                    "http_connections_num": 0,
                    "streams": [
                        {
                            "index": 0,
                            "codec_type": 1,
                            "codec_id": 86018,
                            "copy": 0,
                            "width": 0,
                            "height": 0,
                            "bit_rate": 48000
                        },
                        {
                            "index": 1,
                            "codec_type": 0,
                            "codec_id": 28,
                            "copy": 1,
                            "width": 576,
                            "height": 432,
                            "bit_rate": 0
                        }
                    ],
                    "live_url": "http://xvs-5.zhiboyun.com:80/live/sid/TESTING/aws-cn_north_1-5-7d4bb08e1ada4741.flv"
                },
                {
                    "file_name": "aws-cn_north_1-5-7d4bb08e1ada4741",
                    "tag": "rtmp_push_low_delay",
                    "audio_codec_name": "libvo_aacenc",
                    "video_codec_name": "libx264",
                    "format": "rtmp",
                    "width": 576,
                    "height": 432,
                    "relative_dir": "TESTING/20151106/02/26/rtmp/",
                    "http_output_bytes": 0,
                    "http_connections_num": 0,
                    "streams": [
                        {
                            "index": 2,
                            "codec_type": 0,
                            "codec_id": 28,
                            "copy": 1,
                            "width": 576,
                            "height": 432,
                            "bit_rate": 0
                        },
                        {
                            "index": 3,
                            "codec_type": 1,
                            "codec_id": 86018,
                            "copy": 0,
                            "width": 0,
                            "height": 0,
                            "bit_rate": 128000
                        }
                    ],
                    "live_url": "rtmp://rtmp-out.zhiboyun.com/live/aws-cn_north_1-5-7d4bb08e1ada4741"
                },
                {
                    "file_name": "aws-cn_north_1-5-7d4bb08e1ada4741.m3u8",
                    "tag": "output_m3u8_only",
                    "audio_codec_name": "libvo_aacenc",
                    "video_codec_name": "libx264",
                    "format": "m3u8",
                    "width": 576,
                    "height": 432,
                    "relative_dir": "TESTING/20151106/02/26/m3u8/",
                    "http_output_bytes": 0,
                    "http_connections_num": 0,
                    "streams": [
                        {
                            "index": 4,
                            "codec_type": 1,
                            "codec_id": 86018,
                            "copy": 0,
                            "width": 0,
                            "height": 0,
                            "bit_rate": 128000
                        },
                        {
                            "index": 5,
                            "codec_type": 0,
                            "codec_id": 28,
                            "copy": 1,
                            "width": 576,
                            "height": 432,
                            "bit_rate": 0
                        }
                    ],
                    "live_url": "http://s3.cn-north-1.amazonaws.com.cn/xvs/pub/TESTING/20151106/02/26/m3u8/l_aws-cn_north_1-5-7d4bb08e1ada4741.m3u8"
                }
            ],
            "inputs": [
                {
                    "url": "",
                    "service_code": "TESTING",
                    "user_name": "001",
                    "device_type": 10,
                    "device_version": "451"
                }
            ],
            "http_live_url": "http://xvs-5.zhiboyun.com:80/live/sid/TESTING/",
            "input_bytes": 147585,
            "opaque": "testing%20opaque%20string"
        }
    ]
}

ret api调用返回值，非0代表错误，0表示调用成功。错误代码参考API返回代码表
user_list 用户列表
- id 用户数据id, 注意每次调用返回此值都会变化，不可把此值作为用户永久ID记录
- vs_id 用户所在服务器id
- service_code 用户所属服务码
- client_version 用户终端sdk版本号
- device_type 用户终端设备类型
task_list 任务列表
- id 任务id
- serial 序列号，内部识别，应用无需关心
- sequence 任务在服务器上的序号，应用无需关心
- progress 任务进度，对于实时转码或直播，progress永远为0
- vs_id 任务所在服务器id
- service_code 任务所属服务码
- http_live_url 基于HTTP协议的FLV格式的直播输出的播放地址前缀, 上述例子中，完整的播放地址即为： http://xvs-5.zhiboyun.com:80/live/id/aws-cn_north_1-5-c57f35b6642dfb39.flv 此字段请不要再使用将来可能会被删除，应用可以直接通过live_url字段获取直播播放地址
- input_bytes 任务输入字节数, 此数值实时更新
- opaque 任务透传字串，通过此字段，可以得到应用在创建任务时传入的透传参数。
- inputs 任务输入列表，一般任务都是只有一个输入，但在合屏的任务中，输入可能会有多个。
  - input_bytes 输入总计流量的实时统计数值，单位是byte
  - url 输出源url, 如果是xvs-tcp上传协议，则此属性值为空字符串
  - service_code 用户/输出/输入所属服务码
  - client_version 客户端SDK版本号
  - device_type 客户端类型
- outputs 任务输出列表
  - file_name 任务输出文件名
  - relative_dir 输出相对路径
  - http_output_bytes 输出http直播的字节数(实时更新), 对于hls此值为0
  - http_connections_num 输出http直播并发数，对于hls直播此值为0
  - tag 任务输出格式配置标签
  - audio_codec_name 输出音频编码名称
  - video_codec_name 输出视频编码名称
  - format 输出容器格式
  - width 输出视频画面宽度
  - height 输出视频画面高度
  - streams 某一任务输出格式中音视频流的列表，例如，一个即有声音又有画面的视频输出格式，一般至少包括一个音频流和一个视频流
    - index 流索引
    - codec_type 流编码类型, 0视频、1音频
    - codec_id 流的编码格式id
    - width 视频流画面宽度，音频流此值为0`
    - height 视频流画面高度，音频流此值为0
    - copy 是否启用了copy模式 1 copy模式， 2 非copy模式
  - live_url 直播播放地址，如果输出格式支持直播，则会有此字段，当前支持直播的输出格式有flv, m3u8, rtmp 此字段在2015-10-29后开始提供。

有关任务的说明参考基本概念中有关任务的描述

获取任务列表与在线用户列表

基本描述

示例说明

返回JSON数据属性描述

补充说明