阿里安全开放平台-阿里聚安全

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

名称	类型	是否必须	示例值	更多限制	描述
task_top_query	TaskTopQuery	必须			请求参数
task_query TaskQuery 必须请求业务参数 └ only_main_task Boolean 可选 false 只查询主任务 └ page_index Number 可选 1 页码 └ main_task_id Number 可选 12 lianfan.huiwa.task.video.submit接口返回的id通过这里传入,会一次返回生成的所有视频 └ page_size Number 可选 20 一页大小 └ task_ids Number [] 可选任务id lianfan.huiwa.task.video.submit接口返回的id通过这里传入,会一次返回生成的所有视频

名称	类型	示例值	描述
pagination	PaginationDTO		分页信息
└ total Number 1 总数 └ page_size Number 10 一页大小 └ current_page Number 1 当前页码
succeed	Boolean	true	是否成功
error_codes	ErrorCodeDTO		错误描述
└ code String error 错误码 └ message String message 错误描述
model	VideoTaskDTO []		查询结果
└ task_id Number 1 任务id └ cover_image_url String https:// 封面图 └ task_type Number 6 任务类型 └ task_biz_type Number 16 业务类型 video_infos VideoInfoDTO [] 视频信息 └ first_frame_url String http:// 首帧图片 └ video_url String http:// 视频链接 └ task_id Number 1 任务id └ duration Number 5 时长 └ pass_through String {} {} task_status ImageTaskStatusDTO 任务状态 └ status_value Number 2 任务状态，2：生成中，4：生成成功，-1：生成失败，-2：图片可能存在风险 └ status_name String 状态描述状态描述 └ remark String 失败原因失败原因 └ main_task_id Number 12 主任务id,一次提交返回的id

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
LianfanHuiwaTaskVideoGetRequest req = new LianfanHuiwaTaskVideoGetRequest();
LianfanHuiwaTaskVideoGetRequest.TaskTopQuery obj1 = new LianfanHuiwaTaskVideoGetRequest.TaskTopQuery();
LianfanHuiwaTaskVideoGetRequest.TaskQuery obj2 = new LianfanHuiwaTaskVideoGetRequest.TaskQuery();
obj2.setOnlyMainTask(false);
obj2.setPageIndex(1L);
obj2.setMainTaskId(12L);
obj2.setPageSize(20L);
obj2.setTaskIds(new Long[] { 任务id };
);
obj1.setTaskQuery(obj2);
req.setTaskTopQuery(obj1);
LianfanHuiwaTaskVideoGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
LianfanHuiwaTaskVideoGetRequest req = new LianfanHuiwaTaskVideoGetRequest();
LianfanHuiwaTaskVideoGetRequest.TaskTopQueryDomain obj1 = new LianfanHuiwaTaskVideoGetRequest.TaskTopQueryDomain();
LianfanHuiwaTaskVideoGetRequest.TaskQueryDomain obj2 = new LianfanHuiwaTaskVideoGetRequest.TaskQueryDomain();
obj2.OnlyMainTask = false;
obj2.PageIndex = 1L;
obj2.MainTaskId = 12L;
obj2.PageSize = 20L;
obj2.TaskIds = new long[] { 任务id };
;
obj1.TaskQuery= obj2;
req.TaskTopQuery_ = obj1;
LianfanHuiwaTaskVideoGetResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new LianfanHuiwaTaskVideoGetRequest;
$task_top_query = new TaskTopQuery;
$task_query = new TaskQuery;
$task_query->only_main_task="false";
$task_query->page_index="1";
$task_query->main_task_id="12";
$task_query->page_size="20";
$task_query->task_ids="任务id";
$task_top_query->task_query = $task_query;
$req->setTaskTopQuery(json_encode($task_top_query));
$resp = $c->execute($req);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=lianfan.huiwa.task.video.get' \
-d 'partner_id=apidoc' \
-d 'sign=A34A8DAA11A9A0298545321AEAD5ECE8' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-12-06+18%3A10%3A25' \
-d 'v=2.0' \
-d 'task_top_query=null'

# -*- coding: utf-8 -*-
import top.api

req=top.api.LianfanHuiwaTaskVideoGetRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.task_top_query="数据结构示例JSON格式"
try:
	resp= req.getResponse()
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"lianfan.huiwa.task.video.get");
add_param(pRequest,"task_top_query","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,NULL);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('lianfan.huiwa.task.video.get', {
	'task_top_query':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<lianfan_huiwa_task_video_get_response>
    <pagination>
        <total>1</total>
        <page_size>10</page_size>
        <current_page>1</current_page>
    </pagination>
    <succeed>true</succeed>
    <error_codes>
        <code>error</code>
        <message>message</message>
    </error_codes>
    <model>
        <video_task_d_t_o>
            <task_id>1</task_id>
            <cover_image_url>https://</cover_image_url>
            <task_type>6</task_type>
            <task_biz_type>16</task_biz_type>
            <video_infos>
                <video_info_d_t_o>
                    <first_frame_url>http://</first_frame_url>
                    <video_url>http://</video_url>
                    <task_id>1</task_id>
                    <duration>5</duration>
                </video_info_d_t_o>
            </video_infos>
            <pass_through>{}</pass_through>
            <task_status>
                <status_value>2</status_value>
                <status_name>状态描述</status_name>
                <remark>失败原因</remark>
            </task_status>
            <main_task_id>12</main_task_id>
        </video_task_d_t_o>
    </model>
</lianfan_huiwa_task_video_get_response>

{
    "lianfan_huiwa_task_video_get_response":{
        "pagination":{
            "total":1,
            "page_size":10,
            "current_page":1
        },
        "succeed":true,
        "error_codes":{
            "code":"error",
            "message":"message"
        },
        "model":{
            "video_task_d_t_o":[
                {
                    "task_id":1,
                    "cover_image_url":"https:\/\/",
                    "task_type":6,
                    "task_biz_type":16,
                    "video_infos":{
                        "video_info_d_t_o":[
                            {
                                "first_frame_url":"http:\/\/",
                                "video_url":"http:\/\/",
                                "task_id":1,
                                "duration":5
                            }
                        ]
                    },
                    "pass_through":"{}",
                    "task_status":{
                        "status_value":2,
                        "status_name":"状态描述",
                        "remark":"失败原因"
                    },
                    "main_task_id":12
                }
            ]
        }
    }
}

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案

API测试工具错误码查询工具 SDK下载

绘蛙API

lianfan.huiwa.task.video.get (查询视频任务详情)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈