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

查询 URL 批量上传任务状态

最近更新时间2024.01.18 14:39:29

首次发布时间2021.02.23 10:42:40

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

使用说明

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

注意事项

请求频率:单用户请求频率限制为 10 次/秒

请求说明

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

调试

请求参数

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

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

返回参数

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

参数类型示例值描述
DataObject of Data-URL 批量上传状态查询结果。

Data

参数类型示例值描述
MediaInfoListArray of MediaInfoList-URL 批量上传状态查询返回的 JobId 对应的信息。
NotExistJobIdsArray of String-URL 批量上传状态查询不存在的 JobId,包括错误的和过期的 JobId

MediaInfoList

参数类型示例值描述
RequestIdStringRequestId请求唯一标识,用于日志查询。
JobIdStringJobId用于查询 URL 上传状态。
SourceUrlStringSourceUrl用户上传的 Url。

State

String

State

上传状态。取值如下:

  • init
  • process
  • success
  • fail
VidStringVid视频 ID。
SpaceNameStringSpaceName点播空间名称。
AccountIdStringAccountId用户账号的 ID。
SourceInfoObject of SourceInfo-视频的元信息。
CallbackArgsStringxxxxxxxxxxxx自定义字段,回调时会透传返回。

SourceInfo

参数类型示例值描述
Md5StringMd5Hash 值。

FileType

String

FileType

文件类型。取值如下:

  • video:音频
  • audio:视频
HeightInteger1视频高度,单位为 px。
WidthInteger1视频宽度,单位为 px。
FormatStringFormat文件格式。
DurationFloat0.1视频时长,单位为秒。
SizeDouble0.1文件大小,单位为字节。
StoreUriStringStoreUri存储地址。
BitrateInteger1码率,单位为 bps。

TosStorageClass

String

STANDARD

存储类型。取值如下:

  • STANDARD:标准存储
  • ARCHIVE:归档存储
FileNameString088ecee226***29d3e906c6.mp4文件路径

请求示例

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"
      ]
    }
  }
}

错误码

下表列举了本接口特有的错误码。更多信息请见公共错误码

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

服务端 SDK

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