- 请求方式:
get
- 请求路径:
/live/snapshot/query-snapshot
请求参数说明
参数名 | 类型 | 名称 | 是否必填 | 说明 |
---|---|---|---|---|
TaskID | string | 任务ID | 是 | 任务ID,对应任务创建时返回的ID,目前只支持单个任务 |
返回参数说明
参数名 | 类型 | 名称 |
---|---|---|
code | int | 状态码,成功时为100000 |
message | string | 描述信息,成功时为success |
TaskList | list | 任务信息列表,目前只支持返回单个任务信息,详细说明如下 |
TaskList[*].TaskID | string | 任务ID |
TaskList[*].TaskType | string | 任务类型,含义分别为: live-record:直播录制 live-snapshot:直播截图 live-ext-redirect:直播转推 |
TaskList[*].UniqName | string | 客户标识 |
TaskList[*].DomainName | string | 域名 |
TaskList[*].App | string | 频道名 |
TaskList[*].Stream | string | 流名称 |
TaskList[*].Params | object | 转码参数,当taskType等于live-record或live-snapshot时存在 |
TaskList[*].Params.Output | object array | 输出参数 |
TaskList[].Params.Output[].Format | string | 输出图片的封装格式 |
TaskList[].Params.Output[].Interval | string | 截图间隔时长,单位秒 |
TaskList[*].Params.XOSAccessKey | string | XOS存储的访问密钥 |
TaskList[*].Params.XOSSecretKey | string | XOS存储的访问密钥 |
TaskList[*].Params.XOSBucket | string | XOS存储的Bucket名称 |
TaskList[*].Params.XOSRegion | string | XOS存储的Region名称 |
TaskList[*].Params.SnapshotNotifyUrl | string | 截图文件回调通知URL |
TaskList[*].CreateTime | string | 任务创建时间,格式yyyy-MM-dd HH:mm:ss |
TaskList[*].UpdateTime | string | 任务更新时间,格式yyyy-MM-dd HH:mm:ss |
TaskList[*].TaskStatus | string | 任务执行状态,有三种,分别是 “running” :任务运行中 “finished” :任务正常结束 “failed” :任务失败 |
TaskList[*].ErrMsg | string | 任务具体错误信息 |
调用示例
https://cdnapi-global.ctapi.ctyun.cn/live/snapshot/query-snapshot
返回结果:
{
"code":100000,
"TaskList":[
{
"App":"test",
"TaskID":"123",
"DomainName":"ctyun.cn",
"ErrMsg":"Task scheduling exception",
"CreateTime":"2022-02-24 14:57:43",
"Params":{
"OssAccessKey":"test",
"Output":[
{
"Format":"jpg",
"Interval":"10"
}
],
"SnapshotNotifyUrl":"test",
"OssBucket":"test",
"OssSecretKey":"test",
"OssRegion":"test"
},
"TaskStatus":"failed",
"Template":"None",
"Referrer":"open-api",
"UniqName":"123",
"TaskType":"live-snapshot",
"UpdateTime":"2022-02-24 14:57:43",
"Worker":"unknown",
"Stream":"test",
"SrcUrl":"None",
"DstUrl":""
}
],
"message":"success"
}