文档中心 云转码(KET) 点播转码API 任务管理接口说明 查询任务列表接口(GetTaskList)

查询任务列表接口(GetTaskList)

最近更新时间:2024-08-15 10:54:56

功能描述:

根据时间、任务状态、出错码等范围查询已创建的任务列表

注意:可以查询最近30天的任务信息

请求方式:

GET

请求参数:

参数名

类型

是否必须

描述

StartDate

int

否

开始时间,默认为当前月的第一天;格式:20160919

EndDate

int

否

截止时间,默认为开始时间加30天;若大于当前时间,则默认为当前时间;格式:20160930

Marker

int

否

请求起始游标,默认为0

Limit

int

否

单次请求的记录数,默认为100,最大值为100

ErrorCode

string

否

出错码限制,若要查询多个错误码,则用逗号隔开,形如1001,1002

TaskStatus

string

否

任务状态限制(init,exec,succ,fail),若要查询多个状态则用逗号隔开,形如init,exec

StartTime

int

否

查询的起始时间戳,若设置则StartDate失效

EndTime

int

否

查询的截止时间戳,若设置则EndDate失效

返回参数:

参数名

类型

是否必须

描述

ErrNum

int

是

错误码,0:成功;非0:失败

ErrMsg

string

是

描述本次请求错误的原因

StartDate

int

是

开始时间

EndDate

int

是

截止时间

Marker

int

是

请求起始游标,默认为0

Count

int

是

本次返回记录条数

Total

int

是

该时间区间内总记录条数

TaskInfo

json array

是

任务列表

TaskID

string

是

任务ID

IsFlow

int

是

是否为流式任务,1-是,0-否

FlowData

json array

否

流式任务信息

Preset

string

是

模板名

SrcInfo

json array

是

源文件信息

DstBucket

string

是

目标Bucket

DstDir

string

是

目标目录

DstObjectKey

string

是

目标ObjectKey

DstAcl

string

是

目标文件访问类型

IsTop

int

是

是否被置顶

CbUrl

string

是

任务回调地址

CbMethod

string

是

回调方式

ExtParam

string

是

扩展参数

TaskStatus

string

是

单个任务执行状态

ErrorCode

string

是

出错码

ErrorMsg

string

是

出错描述

CreateTime

string

是

任务创建时间

path

string

是

源文件路径(KS3)

index

string

否

任务拼接顺序

type

string

是

文件类型

请求示例:


GET /?Action=GetTaskList

&Version=2017-01-01

&X-Amz-Algorithm=AWS4-HMAC-SHA256

&X-Amz-Date=20170519T085226Z

&X-Amz-Credential=xxxxx

&X-Amz-SignedHeaders=xxxxx

&X-Amz-Signature=xxxxx HTTP/1.1

Host: kvs.cn-beijing-6.api.ksyun.com

Accept: application/json

返回示例:


HTTP/1.1 200 OK

Server: ksyun-open-platform

Date: Fri, 12 May 2017 08:01:06 GMT

Content-Type: application/json;charset=UTF-8

Transfer-Encoding: chunked

{

	"StartDate":"20160815",

	"EndDate":"20160816",

	"Marker":0,

	"Count":2,

	"Total":6,

	"TaskInfo":[

		{

			"TaskID":"65909f7144cfc2de10cf656989cca37520160815",

			"IsFlow":0,

			"Preset":"preset_avop1",

			"SrcInfo":[

				{

					"path":"/wangshuai9/ksyun.flv",

					"index":0,

					"type":"video"

				}

			],

			"DstBucket":"wangshuai9",

			"DstDir":"",

			"DstObjectKey":"ksyun_1.flv",

			"DstAcl":"public-read",

			"IsTop":"0",

			"CbUrl":"http://www.ksyun.com",

			"CbMethod":"callback",

			"ExtParam":"",

			"TaskStatus":"succ",

			"ErrorCode":"0",

			"ErrorMsg":"",

			"CreateTime":"2016-08-15 16:24:12"

		},

		{

			"TaskID":"40d309d3b2bf373cd3f08e5b5e1bddf720160816",

			"IsFlow":1,

			"FlowData":[

				{

					"Preset":"preset_avop2",

					"SrcInfo":[

						{

							"path":"/wangshuai9/ksyun2.flv",

							"index":0,

							"type":"video"

						}

					],

					"DstBucket":"wangshuai9",

					"DstDir":"",

					"DstObjectKey":"ksyun_2.flv",

					"DstAcl":"public-read",

					"ExtParam":""

				},

				{

					"Preset":"preset_avop3",

					"SrcInfo":[

						{

							"path":"/wangshuai9/ksyun3.flv",

							"index":0,

							"type":"video"

						}

					],

					"DstBucket":"wangshuai9",

					"DstDir":"",

					"DstObjectKey":"ksyun_3.flv",

					"DstAcl":"public-read",

					"ExtParam":""

				}

			],		

			"IsTop":"1",

			"CbUrl":"http://www.ksyun.com",

			"CbMethod":"callback",

			"ExtParam":"",

			"TaskStatus":"succ",

			"ErrorCode":"0",

			"ErrorMsg":"",

			"CreateTime":"2016-08-16 11:13:29"

		}

	],

	"ErrNum":0,

	"ErrMsg":"success"

}

上一篇:置顶任务接口(TopTaskByTaskID)
下一篇:查询任务详情接口(GetTaskByTaskID)
以上内容是否对您有帮助?
有帮助
没帮助