You need to enable JavaScript to run this app.
导航
调用方式 V2
最近更新时间:2023.10.18 19:54:11首次发布时间:2022.09.28 14:44:44

说明

该服务为异步调用,分为任务提交和任务查询两步骤

调用方式-任务提交

接口简介

对输入视频进行x2超分,有效提升低分辨率视频的质量,改善内容纹理细节、抑制压缩伪像,全面提高视频清晰度与主观质量

限制条件

名称内容

视频要求

1.视频格式:MP4、MOV格式,建议使用MP4格式,其余格式会被拒绝,其余格式能力后续开放。
2.视频时长:时长小于10min,分辨率大于256P小于或等于1080P,建议480P或720P
3.视频大小:不超过500MB

请求说明

名称内容
接口地址https://visual.volcengineapi.com
请求方式POST
Content-Typeapplication/json

请求参数

(1)header请求参数

公共请求参数

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

名称类型是否必填描述
X-DateString使用UTC时间,精确到秒。请使用格式:YYYYMMDD'T'HHMMSS'Z' ,例如:20201103T104027Z

Authorization

String

HMAC-SHA256:签名方法
-Credential为签名凭证,其中:
-AccessKeyId为访问密钥ID,可在 访问密钥(Access Key) 获取;
-ShortDate为请求的短时间,使用UTC时间,精确到日。请使用格式:YYYYMMDD,例如:20180201
-Region为请求地区,国内一般为为cn-north-1
-Service为请求的服务,一般为cv
-SignedHeaders为参与签名计算的头部信息,content-typehost 为必选头部;
-Signature为签名,可在 签名方法 获取。
注:我们提供了SDK及签名示例供您实现服务快速接入,具体可参考 快速接入
例如:HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}

X-Security-TokenString指安全令牌服务(Security Token Service,STS) 颁发的临时安全凭证中的SessionToken,使用长期密钥时无需填写该参数。

(2)Query参数

业务请求参数

参数可选/必选类型说明
Action必选String接口名,取值:VideoOverResolutionSubmitTaskV2
Version必选String版本号,取值:2022-08-31

(3)Body参数

业务请求参数

参数可选/必选类型说明备注
req_key必选String算法名称,取固定值为lens_video_nnsr
vid可选String用于从视频架构侧下载视频的唯一标示和url参数必选其一
url可选String需要超分视频的url和vid参数必选其一, 如果都提供,则优先使用vid参数

输出说明

(1)通用输出参数
请参考通用返回字段及错误码
(2)业务输出参数
data字段

字段类型说明
task_idString任务编号,用于查询任务运行状态和结果

(3)输出示例

{
    "code":10000,
    "data":{
        "task_id":"7148008545607221256"
    },
    "message":"Success",
    "request_id":"2022092718435001021005903904070D74",
    "status":10000,
    "time_elapsed":"74.407672ms"
}

错误码

(1)通用错误码
请参考通用返回字段及错误码

(2)业务错误码

http code错误码错误信息说明
20010000Success成功
调用方式-任务查询

接口简介

视频超分辨率的任务查询。

请求说明

名称内容
接口地址https://visual.volcengineapi.com
请求方式POST
Content-Typeapplication/json

请求参数
(1)header请求参数
公共请求参数

名称类型是否必填示例值描述
X-DateString20201103T104027Z使用UTC标准时间,日期精确到秒,格式:YYYYMMDD'T'HHMMSS'Z'。

Authorization

String

HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request,
SignedHeaders={SignedHeaders}, Signature={Signature}

HMAC-SHA256:签名方法
Credential:签名凭证,其中,
-AccessKeyId是访问密钥ID,可在 访问密钥(Access Key) 获取;
-ShortDate是请求的短时间,使用UTC时间,精确到日。请使用格式:YYYYMMDD,例如:20180201
-Region默认为cn-north-1
-Service默认为cv
SignedHeaders是参与签名计算的头部信息,content-type 和 host 为必选头部
Signature是签名,可在 签名方法 获取。
注:我们提供了SDK及签名示例供您实现服务快速接入,具体可参考 快速接入

X-Security-Token

String

指安全令牌服务(Security Token Service,STS) 颁发的临时安全凭证中的SessionToken:
1.用户 / Service 访问自己的资源则可以使用 AK/SK 直接访问(长期 Token),无需填写该参数。
2.用户 / Service 通过扮演角色去调用接口时需要使用 STS。具体流程:先调用 AssumeRole 获得短期 token, 然后将该 Token 放入该参数去请求目标接口。

(2)Query参数

参数可选/必选类型说明
Action必选String接口名,取值:VideoOverResolutionQueryTaskV2
Version必选String版本号,取值:2022-08-31

(3)Body参数

业务请求参数

参数可选/必选类型说明备注
req_key必选String算法名称,取固定值为lens_video_nnsr
task_id必选String任务ID

输出说明

(1)通用输出参数
请参考通用返回字段及错误码

(2)业务输出参数
data字段

字段类型说明
statusstring任务状态。
not_found:任务无法查询到,此种情况一般为任务已过期
in_queue:已提交队列
generating:已开始生成
done:已完成,注意任务完成并非处理成功,需进一步检查错误码和错误信息
resp_datastring超分后视频的相关信息,包括video_url,超分后的视频链接,链接下载有效期1h

(3)输出示例

{
    "code":10000,
    "data":{
        "binary_data_base64":[

        ],
        "resp_data":"{\"progress\": 100, \"received_at\": 1664332269, \"finished_at\": 1664332344, \"vid\": \"v0383eg10001ccpr4drc77ue2rq914s0\", \"video_url\": \"https://v26-vvecloud.yangyi08.com/d34c92ec54f15288033a89aeacd436be/6333c04a/video/tos/cn/tos-cn-v-07ec30/f61b240f326948xxxxxx610e2c/?a=7073\u0026ch=0\u0026cr=0\u0026dr=4\u0026er=0\u0026lr=unwatermarked\u0026cd=0%7C0%7C0%7C0\u0026br=31125\u0026bt=31125\u0026cs=0\u0026ds=4\u0026ft=Q3AOVNnnrThWH6R~YG-bmo\u0026mime_type=video_mp4\u0026qs=13\u0026rc=Mzc8dWg6Zmd1ZjQzNGg7M0BpMzc8dWg6Zmd1ZjQzNGg7M0BwLm4vcjRvMW1gLS1kMDBzYSNwLm4vcjRvMW1gLS1kMDBzcw%3D%3D\u0026l=202209281031090102100450231734ABCD\"}",
        "status":"done"
    },
    "message":"Success",
    "request_id":"20220928143238010212077037063605CD",
    "status":10000,
    "time_elapsed":"6.494149ms"
}

错误码

(1)通用错误码
请参考通用返回字段及错误码

(2)业务错误码

http code错误码错误信息说明
20010000Success成功