接口功能介绍
通过本接口可获取存放在云点播存储桶内的音视频文件的元数据信息。由于获取元数据信息需要较长时间拉取文件样本,为保证业务流程运转流畅,本接口被设定为异步调用方式。用户在接口中仅需提供源文件访问地址(必须为云点播产品合法的存储桶地址),后台在接收到请求后,会通过HTTP POST方法将结果(JSON格式)返回。异步回调数据格式可参考以下文档。
接口约束
本接口的单用户QPS限制为20次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。
URI
POST /metadata/task
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
visitUrl | 是 | String | 源文件访问地址 | https://bucketname.gdoss.xstore.ctyun.cn/video.mp4 | |
clientCallbackUrl | 是 | String | 用户自建的回调接收服务地址。 | https://callback.ctyun.cn/Callback |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
code | 是 | Integer | 本次请求的结果码。 | 0 | |
message | 是 | String | 错误文本信息,创建成功时,为空字符串。 | "" | |
data | 是 | Object | 返回数据。 | data |
表data
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
taskId | 是 | String | 获取元数据任务的ID。 | c39c5d5b11b849508f3a9b98a27d1310 |
请求示例
{
"visitUrl": "https://bucketname.gdoss.xstore.ctyun.cn/video.mp4",
"clientCallbackUrl": "https://callback.ctyun.cn/Callback"
}
响应示例
{
"code":"0",
"message":"",
"data": {
"taskId": "c39c5d5b11b849508f3a9b98a27d1310"
}
}
状态码
Http 状态码 | 状态码信息 | 状态码描述 |
---|---|---|
0 | 表示业务成功 | 表示业务成功 |
400 | 请求参数有误 | 请求参数有误 |
403 | 用户鉴权失败,用户无操作权限 | 用户鉴权失败,用户无操作权限 |
404 | 请求的资源不存在,输入错误的URL | 请求的资源不存在,输入错误的URL |
500 | 业务执行异常 | 业务执行异常 |
错误码
OpenAPI错误码请参考 错误码说明。