最近更新时间:2024.03.19 14:39:41
首次发布时间:2021.02.23 10:42:40
此接口用于查询 URL 批量上传任务状态。
您可以通过 UploadMediaByUrl 接口返回的 JobId
查询对应 URL 的上传状态。上传成功将返回 Vid
以及媒资基础信息。
请求频率:单用户请求频率限制为 10 次/秒。
请求地址:https://vod.volcengineapi.com?Action=QueryUploadTaskInfo&Version=2020-08-01
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | QueryUploadTaskInfo | 接口名称。当前 API 的名称为 QueryUploadTaskInfo 。 |
Version | String | 是 | 2020-08-01 | 接口版本。当前 API 的版本为 2020-08-01 。 |
JobIds | String | 是 | YourJobIds | 每个 URL 对应的任务 ID。查询多个以 , 逗号分隔,最多 20 条。 |
下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Data | Object of Data | - | URL 批量上传状态查询结果。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
MediaInfoList | Array of MediaInfoList | - | URL 批量上传状态查询返回的 JobId 对应的信息。 |
NotExistJobIds | Array of String | - | URL 批量上传状态查询不存在的 JobId ,包括错误的和过期的 JobId 。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | RequestId | 请求唯一标识,用于日志查询。 |
JobId | String | JobId | 用于查询 URL 上传状态。 |
SourceUrl | String | SourceUrl | 用户上传的 Url。 |
State | String |
| 上传状态。取值如下:
|
Vid | String | Vid | 视频 ID。 |
SpaceName | String | SpaceName | 点播空间名称。 |
AccountId | String | AccountId | 用户账号的 ID。 |
SourceInfo | Object of SourceInfo | - | 视频的元信息。 |
CallbackArgs | String | xxxxxxxxxxxx | 自定义字段,回调时会透传返回。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Md5 | String | Md5 | Hash 值。 |
FileType | String |
| 文件类型。取值如下:
|
Height | Integer | 1 | 视频高度,单位为 px。 |
Width | Integer | 1 | 视频宽度,单位为 px。 |
Format | String | Format | 文件格式。 |
Duration | Float | 0.1 | 视频时长,单位为秒。 |
Size | Double | 0.1 | 文件大小,单位为字节。 |
StoreUri | String | StoreUri | 存储地址。 |
Bitrate | Integer | 1 | 码率,单位为 bps。 |
TosStorageClass | String |
| 存储类型。取值如下:
|
FileName | String | 088ecee226***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" ] } } }
下表列举了本接口特有的错误码。更多信息请见公共错误码。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
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 | - | 获取账号错误。 |
点播 OpenAPI 提供了配套的服务端 SDK,支持多种编程语言,帮助您实现快速开发。建议使用服务端 SDK 来调用 API,此 API 各语言调用的示例代码,请参考如下: