有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

接口请求域名: ivld.tencentcloudapi.com 。

将URL指向的媒资视频文件导入系统之中。

请注意,本接口为异步接口。接口返回MediaId仅代表导入视频任务发起,不代表任务完成,您可调用读接口(DescribeMedia/DescribeMedias)接口查询MediaId

URL字段推荐您使用COS地址,其形式为https://${Bucket}-${AppId}.cos.${Region}.myqcloud.com/${ObjectKey},其中${Bucket}为您的COS桶名称,Region为COS桶所在可用区${ObjectKey}为指向存储在COS桶内的待分析的视频的ObjectKey

另外,目前产品也支持使用外部URL地址,但是当传入URL为非COS地址时,需要您指定额外的WriteBackCosPath以供产品回写结果数据。

分析完成后,本产品将在您的${Bucket}桶内创建名为${ObjectKey}_${task-create-time}的目录(task-create-time形式为1970-01-01T08:08:08)并将分析结果将回传回该目录,也即,结构化分析结果(包括图片,JSON等数据)将会写回https://${Bucket}-${AppId}.cos.${Region}.myqcloud.com/${ObjectKey}_${task-create-time}目录

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ImportMedia。
Version String 公共参数,本接口取值:2021-09-03。
Region String 公共参数,详见产品支持的 地域列表
URL String 待分析视频的URL,目前只支持不带签名的COS地址,长度最长1KB
示例值:cos://bucket/object.mp4
MD5 String 待分析视频的MD5,为空时不做校验,否则会做MD5校验,长度必须为32B
示例值:9207adf18198dd5b165aae0bdd8f709d
Name String 待分析视频的名称,指定后可支持筛选,最多64B
示例值:新闻30分
WriteBackCosPath String 当非本人外部视频地址导入时,该字段为转存的cos桶地址且不可为空; 示例:https://${Bucket}-${AppId}.cos.${Region}.myqcloud.com/${PathPrefix}/ (注意,cos路径需要以/分隔符结尾)。
推荐采用本主帐号COS桶,如果使用其他帐号COS桶,请确保COS桶可写,否则可导致分析失败
示例值:https://bucket/path/
Label String 自定义标签,可用于查询
示例值:tag
CallbackURL String 媒资导入完成的回调地址,该设置优先级高于控制台全局的设置;
示例值:http;//xxx
MediaType Integer 媒资文件类型,详细定义参见MediaPreknownInfo.MediaType
默认为2(视频)
示例值:2

3. 输出参数

参数名称 类型 描述
MediaId String 媒资文件在系统中的ID
示例值:"123456"
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 导入图片

输入示例

POST / HTTP/1.1
Host: ivld.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ImportMedia
<公共请求参数>

{
    "URL": "https://ai-media-251202827.cos.ap-guangzhou.myqcloud.com/phye-debug/male.png",
    "Name": "male.png",
    "MediaType": "1"
}

输出示例

{
    "Response": {
        "MediaId": "media-9DfyyCOZ",
        "RequestId": "a642b499-9ebd-4601-a57e-a8cf5c2bee49"
    }
}

示例2 发起导入任务成功

输入示例

POST / HTTP/1.1
Host: ivld.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ImportMedia
<公共请求参数>

{
    "URL": "https://ai-media-1256936300.cos.ap-guangzhou.myqcloud.com/ai-media/test/test-news-6mins.mp4",
    "Name": "demo-video-0"
}

输出示例

{
    "Response": {
        "MediaId": "media-a1b2c3d4",
        "RequestId": "50f3df82-beae-4f5f-9b47-23e8302f62ae"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure.InvalidSecretId SecredId失效。
AuthFailure.MFAFailure MFA失败。
AuthFailure.SecretIdNotFound SecretId不存在。
AuthFailure.SignatureExpire 签名已过期。
AuthFailure.SignatureFailure 签名校验失败。
AuthFailure.TaskFinished 任务已完成。
AuthFailure.TokenFailure 令牌失败。
AuthFailure.UserActivated 用户已激活。
AuthFailure.UserInvalidStatus 用户状态异常。
AuthFailure.UserNotFound 用户无权限。
AuthFailure.UserStopArrear 用户已欠费停服。
FailedOperation.AiTemplateNotExist 匹配的模板不存在。
FailedOperation.CategoryExist 自定义人物分类已存在。
FailedOperation.CategoryLevelChanged 自定义类型层级变化。
FailedOperation.CategoryReferred 自定义人物分类被引用,不能删除。
FailedOperation.CustomGroupAlreadyExist 自定义人物库已存在。
FailedOperation.DBConnectionError 内部DB连接失败。
FailedOperation.DownloadFailed 媒资文件下载失败。
FailedOperation.FeatureAlgoFailed 图片特征提取失败。
FailedOperation.GetCAMTokenFailed 获取CAM临时鉴权失败。
FailedOperation.GetTaskListFailed 获取任务列表失败。
FailedOperation.GetVideoMetadataFailed 获取媒资信息失败。
FailedOperation.ImageNumExceeded 图片数量过多。
FailedOperation.MD5Mismatch MD5不匹配。
FailedOperation.MediaAlreadyExist 媒资文件已经存在。
FailedOperation.MediaExpired 媒资文件已经过期。
FailedOperation.MediaInUse 媒资正在使用。
FailedOperation.MediaNotReady 媒体文件未就绪。
FailedOperation.MultipleFacesInImage 图片中包含多张人脸。
FailedOperation.NoFaceInImage 图片中不包含人脸。
FailedOperation.OpenChargeFailed 计费开通失败。
FailedOperation.PersonDuplicated 人脸库中存在相似的人脸: %!s(MISSING)。
FailedOperation.PersonNotMatched 人脸图片不属于已知人物。
FailedOperation.PersonNumExceeded 自定义人物数量过多。
FailedOperation.QualityAlgoFailed 图片质量分检测失败。
FailedOperation.QualityTooLow 图片质量分过低。
FailedOperation.SnapshotDeserializeFailed 结果快照反序列化失败。
FailedOperation.StopFlowFailed 停止AI工作室任务失败。
FailedOperation.TaskAlreadyExist 存在相同的任务。
FailedOperation.TaskNotFinished 视频分析未完成。
FailedOperation.TranscodeFailed 转码失败。
FailedOperation.UploadFailed 上传文件失败。
InternalError.DBConnectionError 内部DB连接失败。
InternalError.DBOperationError 内部DB操作错误。
InternalError.InnerError 内部错误。
InternalError.InternalOverflow 自定义人物请求超过限制。
InvalidParameter.InvalidCategoryId 自定义人物类型ID不合法。
InvalidParameter.InvalidFilePath 文件路径不合法。
InvalidParameter.InvalidImage 图片不合法。
InvalidParameter.InvalidImageId 图片ID不合法。
InvalidParameter.InvalidL1Category 一级自定义类型不合法。
InvalidParameter.InvalidL2Category 二级自定义类型不合法。
InvalidParameter.InvalidMD5 MD5不合法。
InvalidParameter.InvalidMediaId 媒体ID不合法。
InvalidParameter.InvalidMediaLabel MediaLabel无效。
InvalidParameter.InvalidMediaLang MediaLang无效。
InvalidParameter.InvalidMediaName 媒体名称非法。
InvalidParameter.InvalidMediaPreknownInfo MediaPreknownInfo无效。
InvalidParameter.InvalidMediaStatus 媒资状态不合法。
InvalidParameter.InvalidMediaType MediaType无效。
InvalidParameter.InvalidName 名称不合法。
InvalidParameter.InvalidPageNumber 分页序号不合法。
InvalidParameter.InvalidPageSize 分页大小不合法。
InvalidParameter.InvalidParam 输入字段 %!s(MISSING) 不合法。
InvalidParameter.InvalidPersonId 人物ID不合法。
InvalidParameter.InvalidSortBy 排序字段不合法。
InvalidParameter.InvalidSortOrder 排序方式不合法。
InvalidParameter.InvalidTaskId 任务ID不合法。
InvalidParameter.InvalidTaskName 任务名称不合法。
InvalidParameter.InvalidTaskStatus 任务状态不合法。
InvalidParameter.InvalidURL URL不合法。
InvalidParameter.InvalidUin 用户Uin无效。
InvalidParameter.NameTooLong 名称超过长度限制。
InvalidParameter.ParamTooLong 参数超过长度限制。
InvalidParameter.URLNotResolved 输入URL域名无法解析。
InvalidParameter.UnsupportURL 不支持的URL类型。
LimitExceeded.UsageLimitExceeded 使用量超过限制。
RequestLimitExceeded.BatchImportOverflow 批量导入超过限制。
RequestLimitExceeded.ConcurrencyOverflow 同时发起过多任务。
ResourceNotFound.CustomCategoryNotFound 自定义人物类型不存在。
ResourceNotFound.CustomGroupNotFound 自定义人物库不存在。
ResourceNotFound.MediaNotFound 媒资文件不存在。
ResourceNotFound.RecordNotFound 记录不存在。
ResourceNotFound.TaskNotFound 任务不存在。
UnauthorizedOperation.UnauthorizedProduct 用户未激活该产品。
UnsupportedOperation.MediaNotAccessible 媒资文件不可访问。
UnsupportedOperation.TaskNotAccessible 任务不可访问。