在你开启了云录屏任务后,你可以设定筛选条件,查询符合条件的历史任务。

接口行为

你可以单独或组合使用TaskId、任务状态、时间间隔三个筛选条件查询指定 AppId 下满足条件的任务。

若你组合使用筛选条件,则只会返回满足所有所选筛选条件的任务,若没有则返回空值。

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用OpenAPI。

接口限制

QPS 不得超过 60。

请求方式

使用 GET 方式发起请求。

请求参数
Query
参数名类型必填示例值描述
ActionString是GetWebRecordList接口名称,本接口取值:GetWebRecordList
VersionString是2020-12-01接口版本,本接口取值:2020-12-01
AppIdString是Your_AppId应用的唯一标志
TaskIdString否Your_TaskId要查询的任务 ID
StatusInt否0任务状态。取值为 0,1,2,3,4。
  • 0:所有状态
  • 1:启动中
  • 2:运行中
  • 3:任务失败
  • 4:任务成功
  • 默认值为0。值不合法时,自动调整为默认值。
    CreateTimeBeginInt否1629183877查询起始时间戳, unix 时间,单位为秒。 默认值为0。值不合法时,自动调整为默认值。
    CreateTimeEndInt否1629183880查询结束时间戳,unix 时间, 单位为秒。默认值为当前时间戳。值不合法时,自动调整为默认值。
    PageNumberInt否1 页码,取值范围为 [1,2147483647],默认值为 1。值不合法时,自动调整为默认值。
    PageSizeInt否20 每页任务数,取值范围为 [1,100],默认值为 50。值不合法时,自动调整为默认值。
    请求示例代码
    https://rtc.volcengineapi.com?Action=GetWebRecordList&Version=2020-12-01&AppId=Your_AppId
    
    postscript
    返回调用结果
    返回参数说明

    返回结果参看 BaseResponse。

    其中 Result 的结构如下:

    参数名类型描述
    WebRecordListWebRecordList任务列表信息
    MessageString仅在请求成功时返回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