接口功能介绍
查询直播拉流配置信息。
使用说明
本接口目前适用于设定拉流。调用本接口查询域名下设定拉流的配置信息。单个用户一分钟限制调用100次。
接口详情
请求方式：POST
请求路径：/live/preload/query-preload
请求参数
| 参数名 | 类型 | 名称 | 是否必填 | 说明 |
|---|---|---|---|---|
| domain | string | 域名 | 否 | - |
| query_start_time | string | 查询起始时间 | 否 | 时间格式："2022-11-28 18:03:48"。对应任务的创建时间 |
| query_end_time | string | 查询结束时间 | 否 | 时间格式："2022-11-28 20:03:48"。结束时间要大于开始时间 |
| status | int | 状态 | 否 | 根据状态过滤。 1：下发成功；2：部署成功；3：执行成功；4：执行停止；-1：下发失败；-2：部署失败；-3: 执行失败 |
| page | int | 页码 | 否 | 默认1 |
| page_size | int | 页长 | 否 | 默认50。最长200 |
| task_id | string | 任务ID | 否 | 当task_id有传时，其他参数不生效。task_id与query_start_time & query_end_time 需要有一个必填。 |
响应参数
| 字段名称 | 类型 | 说明 |
|---|---|---|
| code | int | 标识。当code=100000则提交成功，其他失败 |
| message | string | 当code != 100000则查询成功，显示错误信息 |
| data | list | 查询失败则空数组 |
| data.create_time | string | 创建时间。时间格式："2022-11-28 18:03:48" |
| data.end_time | string | 结束时间。时间格式："2022-11-28 20:03:48" |
| data.start_time | string | 开始时间。时间格式："2022-11-28 18:30:00" |
| data.status | int | 状态。 1：下发成功；2：部署成功；3：执行成功；4：执行停止；-1：下发失败；-2：部署失败；-3: 执行失败 |
| data.task_id | string | 任务id |
| data.url | string | url |
| total | long | 总数 |
示例
请求路径：https://cdnapi-global.ctapi.ctyun.cn/live/preload/query-preload
请求示例
{
"query_start_time": "2023-08-25 10:10:00",
"query_end_time": "2023-08-25 12:00:00"
}
正常响应示例
{
"code": 100000,
"message": "success",
"total": 1,
"data": [
{
"url": "ctyun.cn",
"status": 4,
"start_time": "2023-08-25 11:26:24",
"end_time": "2023-08-25 11:41:24",
"create_time": "2023-08-25 11:26:25",
"task_id": "701406964793126912"
}
]
}
错误码请参考：参数code和message含义
