在你开启了云录屏任务后,你可以设定筛选条件,查询符合条件的历史任务。
你可以单独或组合使用TaskId、任务状态、时间间隔三个筛选条件查询指定 AppId 下满足条件的任务。
若你组合使用筛选条件,则只会返回满足所有所选筛选条件的任务,若没有则返回空值。
关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用OpenAPI。
使用 GET 方式发起请求。
| 参数名 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | GetWebRecordList | 接口名称,本接口取值:GetWebRecordList |
| Version | String | 是 | 2020-12-01 | 接口版本,本接口取值:2020-12-01 |
| AppId | String | 是 | Your_AppId | 应用的唯一标志 |
| TaskId | String | 否 | Your_TaskId | 要查询的任务 ID |
| Status | Int | 否 | 0 | 任务状态。取值为 0,1,2,3,4。 0。值不合法时,自动调整为默认值。 |
| CreateTimeBegin | Int | 否 | 1629183877 | 查询起始时间戳, unix 时间,单位为秒。 默认值为0。值不合法时,自动调整为默认值。 |
| CreateTimeEnd | Int | 否 | 1629183880 | 查询结束时间戳,unix 时间, 单位为秒。默认值为当前时间戳。值不合法时,自动调整为默认值。 |
| PageNumber | Int | 否 | 1 | 页码,取值范围为 [1,2147483647],默认值为 1。值不合法时,自动调整为默认值。 |
| PageSize | Int | 否 | 20 | 每页任务数,取值范围为 [1,100],默认值为 50。值不合法时,自动调整为默认值。 |
https://rtc.volcengineapi.com?Action=GetWebRecordList&Version=2020-12-01&AppId=Your_AppId
postscript返回结果参看 BaseResponse。
其中 Result 的结构如下:
| 参数名 | 类型 | 描述 |
|---|---|---|
| WebRecordList | WebRecordList | 任务列表信息 |
| Message | String | 仅在请求成功时返回success。 |
返回值 Result 仅在请求成功时返回以上参数,失败时为空
{
"ResponseMetadata": {
"Service": "rtc",
"Action": "GetWebRecordList",
"Version": "2020-12-01",
"Region": "cn-north-1",
"RequestId": "Your_RequestId"
},
"Result": {
"Message": "success",
"WebRecordList": {
"AppId": "Your_AppId",
"PageNumber": 1,
"PageSize": 2,
"TotalCount": 501,
"Tasks": [
{
"TaskId": "Your_TaskId",
"CreateTime": 1629183877,
"FinishTime": 1629183880,
"Status": 3,
"InputURL": "http://www.xxx.xxx/xxx/xxx.html",
"VideoSpace": "Your_videoSpace",
"Vid": "Your_Vid",
"MaxRecordSecond": 240,
"Duration": 120,
"Bucket": "Your_Bucket",
"ObjectKey": "Your_objectKey.mp4"
}
]
}
}
}
json