You need to enable JavaScript to run this app.
导航

查询单个直播录制任务

最近更新时间2024.01.18 14:14:40

首次发布时间2023.11.17 11:30:17

调用 GetPullRecordTask 接口,查询单个直播录制任务信息。

注意事项

  • 请求频率:单用户请求频率限制为 10 次/秒
  • 前提条件:请先调用 ListPullRecordTask 接口,获取待查询的录制任务 ID。

请求说明

  • 请求方式:POST
  • 请求地址:https://live.volcengineapi.com?Action=GetPullRecordTask&Version=2023-01-01

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

Query

参数类型是否必选示例值描述
ActionStringGetPullRecordTask接口名称。当前 API 的名称为 GetPullRecordTask
VersionString2023-01-01接口版本。当前 API 的版本为 2023-01-01

Body

参数类型是否必选示例值描述
TaskIDString5b903f78c7f5ae*******01f6fe2eea直播录制任务的 ID,任务的唯一标识。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构

参数类型示例值描述
TaskIdString5b903f78c7f5ae*******01f6fe2eea直播录制任务的 ID。
StartTimeString2023-10-09T15:16:15+08:00任务开始时间。
EndTimeString2023-10-09T15:18:28+08:00任务结束时间
VhostStringexample.com域名空间
DomainStringpull.example.com推流/拉流域名
AppStringlive应用名称。
StreamStringexample_stream流名称。

Status

String

生效中

任务状态,有以下几种状态:

  • 停用
  • 未开始
  • 生效中
  • 已结束

请求示例

POST https://live.volcengineapi.com?Action=GetPullRecordTask&Version=2023-01-01
{
  "TaskID": "5b903f78c7f5ae*******01f6fe2eea"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202306041104200100100232280022D31",
    "Action": "GetPullRecordTask",
    "Version": "2023-01-01",
    "Service": "live",
    "Region": "cn-north-1"
  },
  "Result": {
    "TaskId": "5b903f78c7f5ae*******01f6fe2eea",
    "StartTime": "2023-10-09T15:16:15+08:00",
    "EndTime": "2023-10-09T15:18:28+08:00",
    "Vhost": "example.com",
    "Domain": "pull.example.com",
    "App": "live",
    "Stream": "example_stream",
    "Status": "生效中"
  }
}

错误码

下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。

状态码错误码错误信息说明
200CommonErr-未分类错误。建议重试,如果仍返回该错误码,请联系技术支持
400InvalidParam-输入的参数无效或不符合要求,请参照请求参数说明进行检查。
400InvalidParam.BindErrorRequest parameter error, please check input data参数未通过校验,请检查参数类型是否正确。
403RequestForbidden-请求被拒绝,当前账号下无请求的资源(域名空间、域名、应用、配置模版、证书)。
403RequestForbidden.AccountIDNotAllowthis AccountID does not have permission to access the corresponding resource, please check the request parameters请求被拒绝,当前账号下无请求的资源(域名空间、域名、应用、配置模版、证书)。
403RequestForbidden.BillingStatusBilling status is not available for the AccountID, please activate the service or recharge.未开通视频直播服务或账号欠费,造成账单不可用,请检查服务开通情况和账号欠费情况。
404ResourceNotFound-未找到资源(域名空间、域名、应用、配置模版、证书)。建议重试,如果仍返回该错误码,请联系技术支持
500InternalErroran internal error occurred, please contact the administrator.出现内部错误,请联系技术支持
502InternalServiceErroran internal error occurred, please contact the administrator.服务间出现错误,请联系技术支持
502InternalServiceError.BadResponsean internal error occurred, please contact the administrator.服务间出现错误,请联系技术支持
504InternalServiceTimeoutInternal Service is timeout. please contact the administrator.内部服务超时,请联系技术支持

服务端 SDK

视频直播提供了配套的开发工具集 SDK,支持多种编程语言,帮助您更方便的调用 API。