查询 URL 批量上传任务状态--视频点播-火山引擎

文档中心

立即注册

导航

查询 URL 批量上传任务状态

最近更新时间：2024.11.28 11:54:25首次发布时间：2021.02.23 10:42:40

此接口用于查询 URL 批量上传任务状态。

使用说明

您可以通过 UploadMediaByUrl 接口返回的 JobId（任务 ID）查询对应 URL 的上传状态。上传成功将返回 Vid 以及媒资基础信息。

请求说明

请求地址：https://vod.volcengineapi.com?Action=QueryUploadTaskInfo&Version=2020-08-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

参数	类型	是否必选	示例值	描述
Action	String	是	`QueryUploadTaskInfo`	接口名称。当前 API 的名称为 `QueryUploadTaskInfo`。
Version	String	是	`2020-08-01`	接口版本。当前 API 的版本为 `2020-08-01`。
JobIds	String	是	`YourJobIds`	每个 URL 对应的任务 ID。查询多个以 `,` 逗号分隔，最多 20 条。

返回参数

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

参数	类型	示例值	描述
Data	Object	`-`	URL 批量上传状态查询结果。
MediaInfoList	Object[]	`-`	URL 批量上传状态查询返回的 `JobId` 对应的信息。
RequestId	String	`RequestId`	请求唯一标识，可用于日志查询。
JobId	String	`JobId`	任务 ID，可用于查询 URL 上传状态。
SourceUrl	String	`SourceUrl`	用户上传的 URL。
State	String	`State`	上传状态。取值如下： `initial`：初始状态 `processing`：处理中 `success`：上传成功 `failed`：上传失败
Vid	String	`Vid`	视频 ID。
SpaceName	String	`SpaceName`	空间名称。
AccountId	String	`AccountId`	火山引擎账号 ID。
SourceInfo	Object	`-`	视频元信息。
FileId	String	`v02b69g10***ldb8vjafvmg`	文件 ID。
Md5	String	`b9fd116504b***88e59a824878f07a`	文件 MD5 值。
FileType	String	`video`	文件类型。取值如下： `video`：视频。 `audio`：音频。
Codec	String	`h264`	编码格式。
Height	Integer	`270`	视频高度，单位为 px。
Width	Integer	`480`	视频宽度，单位为 px。
Format	String	`MP4`	文件格式。
Duration	Float	`2.944`	视频时长，单位为秒。
Size	Double	`104847`	文件大小，单位为字节。
StoreUri	String	`tos-cn-v-febf3a/daeba******a18e61e1aebfaf39aa.mp4`	对象存储地址。
Definition	String	`unknown`	清晰度。
Bitrate	Integer	`284910`	码率，单位为 bps。
Fps	Float	`25`	帧率，单位为 fps。
CreateTime	String	`2022-12-28T08:57:58Z`	创建时间。
Quality	String	`higher`	音频质量。
DynamicRange	String	`SDR`	动态范围。取值如下： `HDR` `SDR`
TosStorageClass	String	`STANDARD`	视频存储类型。取值如下： `STANDARD`：标准存储。 `ARCHIVE`：归档存储。 `IA`：低频存储。
FileName	String	`088ecee226***29d3e906c6.mp4`	文件路径。
AudioStreamMeta	Object	`-`	音频流元信息。
Codec	String	`aac`	音频编码格式。
Duration	Float	`2.943`	音频时长，单位为秒。
SampleRate	Integer	`44100`	音频采样率，单位为 Hz。
Bitrate	Integer	`127658`	音频码率，单位为 bps。
Quality	String	`higher`	音频质量，取值如下： `medium`：普通音质 `higher`：高音质 `highest`：音乐音质
Channels	Integer	`2`	声道数。
VideoStreamMeta	Object	`-`	视频流元信息。
Codec	String	`h264`	视频编码格式。
Height	Integer	`270`	视频高度，单位为 px。
Width	Integer	`480`	视频宽度，单位为 px。
Duration	Float	`2.944`	视频时长，单位为秒。
Definition	String	`720p`	视频清晰度。
Bitrate	Integer	`284910`	视频码率，单位为 bps。
Fps	Float	`25`	视频帧率，单位为 fps。
CallbackArgs	String	`xxxxxxxxxxxx`	自定义字段，回调时透传返回。
NotExistJobIds	String[]	`-`	URL 批量上传状态查询不存在的 JobId，包括错误的和过期的 JobId。

请求示例

https://vod.volcengineapi.com?Action=QueryUploadTaskInfo&Version=2020-08-01&JobIds=YourJobIds

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20201124165******5107034080031B5",
    "Action": "QueryUploadTaskInfo",
    "Version": "2020-08-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "Data": {
      "MediaInfoList": [
        {
          "RequestId": "RequestId",
          "JobId": "JobId",
          "SourceUrl": "SourceUrl",
          "State": "State",
          "Vid": "Vid",
          "SpaceName": "SpaceName",
          "AccountId": "AccountId",
          "CallbackArgs": "xxxxxxxxxxxx",
          "SourceInfo": {
            "Md5": "Md5",
            "FileType": "FileType",
            "Height": 1,
            "Width": 1,
            "Format": "Format",
            "Duration": 0.1,
            "Size": 0.1,
            "StoreUri": "StoreUri",
            "Bitrate": 1,
            "TosStorageClass": "STANDARD",
            "FileName": "088ecee226***29d3e906c6.mp4"
          }
        }
      ],
      "NotExistJobIds": [
        "NotExistJobIds"
      ]
    }
  }
}

错误码

下表列举了本接口特有的错误码。如需了解更多错误码，详见视频点播公共错误码。

状态码	错误码	错误信息	说明
400	InvalidParameter.UploadParamsError	-	上传参数错误。
400	InvalidParameter.AKMissMatchError	-	请检查您的 AK 和空间。
400	InvalidParameter.JobIdEmptyError	-	任务 ID 是空的。
400	InvalidParameter.SpaceNotExistsError	-	空间不存在。
400	InvalidParameter.UrlTotalError	-	URL 请求数量超过限制。
400	InvalidParameter.JobIdTotalError	-	JobId 请求数量超过限制。
500	InternalError.QueryBodyError	-	按任务 ID 查询错误。
500	InternalError.BodyParseError	-	正文解析错误。
500	InternalError.CreateUploadStateError	-	创建上传状态失败。
500	InternalError.BuildRavenDataError	-	创建消费者数据错误。
500	InternalError.NsqSendError	-	消息队列发送失败。
500	InternalError.GetAccountError	-	获取账号错误。

服务端 SDK

点播 OpenAPI 提供了配套的服务端 SDK，支持多种编程语言，帮助您实现快速开发。建议使用服务端 SDK 来调用 API，此 API 各语言调用的示例代码，请参考如下：