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

请求地址：

环境	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。

名称	类型	是否必须	示例值	描述
inst_id	Number	必须	15915	实例id
sso_ticket	String	必须	0a44ee7b1c994bea953ce186cedbb006a3415700	从登录态创建的ssoTicket
app_code	String	必须	1b7d1e7c9cd94274a04e833713a3b575	调用方的buc.app-code，注意区分日常和线上环境

名称	类型	示例值	描述
result	HsfResponse		hsf响应
data CompareResultVO 对比结果VO inst_vo InstVO 实例VO └ inst_id Number 12345 运行实例id └ inst_name String "" 实例名称 └ instance_status String "" 实例状态，FAILED:失败；SUCCESS:成功;UNPASS:不通过;RUNNING:运行中;SUBMITTED:已提交 └ instance_start_ime String "" 执行开始时间 └ instanc_end_time String "" 执行结束时间 └ run_project String "" 执行的odps project └ job_category String "" 同构：HOMO ；异构：HETERO rules RuleVO [] 规则列表 └ rule_id Number 12345 规则id └ project_id Number 12345 项目id └ inst_id Number 12345 实例id └ rule_name String 0 规则名称 └ status String SUCCESS 规则状态 └ flags String 1 规则是否通过 └ rule_name_id String 0 规则名称id └ subjects_src String "" 源表 └ subjects_dst String "" 目标表 └ result_src String "" 源表数据量 └ result_dst String "" 目标表数据量 └ actual_difference String 20 实际差异数 └ difference_rate String 10 实际差异率 └ expect_rate String 10 期望差异率 └ rule_name_src String "" 异构对比场景下源表规则名称 └ rule_name_dst String "" 异构对比场景下目标表规则名称 command_vos RuleVO [] 命令列表 └ command_id Number 12345 命令id └ content String "" 命令sql内容 └ status String SUCCESS 命令状态 └ job_id Number 12345 任务id └ inst_id Number 12345 实例id └ rule_id Number 0 对比规则id └ command_type String ODPS 命令类型 └ command_instance_id String 12345 命令实例id └ log_view_url String "" logview地址 └ running_log String "" 运行日志 └ exploration_rule String "" 探查规则 inst_result_token_vo InstResultTokenVO 实例结果token └ token_for_current_project String “” 当前项目可见的token └ token_for_all String "" 所有人可见的token inst_result_vo InstResultVO 实例结果明细VO fulltext_result InstFulltextResultBO 描述全文对比字段结果 └ rule_id Number 100 子规则id └ project_id Number 1 所属项目 └ job_id Number 2 所属任务 └ inst_id Number 3 所属实例 └ start_time String 2023-07-02 00:00:04 开始时间 └ end_time String 2023-07-02 00:00:36 结束时间 └ rule_name String 100 规则名称 └ subjects_src String wl_rec_test.dwd_dt_moe_one_log_url_access_di 源表名 └ subjects_dst String wl_rec_test.dwd_dt_moe_one_log_url_access_wide_di 目标表名 └ actual_difference String 34,363 实际差异数 └ actual_same_cnt String 4,720 实际相同数 └ difference_rate String 78.45% 实际差异率 └ expect_rate String 2% 期望差异率 └ status String SUCCESS 状态 └ fulltext_col_src String [] 全文对比源表字段列表 └ fulltext_col_dst String [] 全文对比目标表字段列表 └ fulltext_result String [] 全文对比详细数据 full_text_diffs RuleFullTextDiff [] 差异数据统计 └ diff_type String 主键一致，其他列存在差异差异类型 └ diff_total Number 34363 差异总数 └ diff_percent String 100% 差异比例 └ flags String false 对比是否通过 └ diff_summary_same_primary_key String [] 全文对比主键一致，其他列存在差异 └ diff_summary_src_only String [] 主键仅在源表存在 └ diff_summary_dst_only String [] 主键仅在目标表存在 table_result InstTableResultBO 描述表级别结果 └ rule_id Number 0 规则id └ project_id Number 1 项目id └ job_id Number 2 任务id └ inst_id Number 3 实例id └ start_time String 2023-07-02 00:00:04 开始时间 └ end_time String 2023-07-02 00:00:36 结束时间 └ rule_name String 0 规则名称 └ subjects_src String wl_rec_test.dwd_dt_moe_one_log_url_access_di 源表名 └ subjects_dst String wl_rec_test.dwd_dt_moe_one_log_url_access_wide_di 目标表名 └ result_src String 39,083 源表结果 └ result_dst String 4,720 目标表结果 └ actual_difference String 34,363 实际差异数 └ difference_rate String 87.92% 实际差异率 └ expect_rate String 1% 期望差异率 └ status String SUCCESS 状态 └ flags String false 规则是否通过 └ success2 Boolean true 是否成功 └ error_code2 Number 0 错误码 └ cause2 String null 出错原因 └ message2 String null 出错信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaDtOnecompareComparejobResultRequest req = new AlibabaDtOnecompareComparejobResultRequest();
req.setInstId(15915L);
req.setSsoTicket("0a44ee7b1c994bea953ce186cedbb006a3415700");
req.setAppCode("1b7d1e7c9cd94274a04e833713a3b575");
AlibabaDtOnecompareComparejobResultResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaDtOnecompareComparejobResultRequest req = new AlibabaDtOnecompareComparejobResultRequest();
req.InstId = 15915L;
req.SsoTicket = "0a44ee7b1c994bea953ce186cedbb006a3415700";
req.AppCode = "1b7d1e7c9cd94274a04e833713a3b575";
AlibabaDtOnecompareComparejobResultResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaDtOnecompareComparejobResultRequest;
$req->setInstId("15915");
$req->setSsoTicket("0a44ee7b1c994bea953ce186cedbb006a3415700");
$req->setAppCode("1b7d1e7c9cd94274a04e833713a3b575");
$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=alibaba.dt.onecompare.comparejob.result' \
-d 'partner_id=apidoc' \
-d 'sign=9BF57876EFE4F3549421D30D236EBD39' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-21+19%3A57%3A29' \
-d 'v=2.0' \
-d 'app_code=1b7d1e7c9cd94274a04e833713a3b575' \
-d 'inst_id=15915' \
-d 'sso_ticket=0a44ee7b1c994bea953ce186cedbb006a3415700'

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

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

req.inst_id=15915
req.sso_ticket="0a44ee7b1c994bea953ce186cedbb006a3415700"
req.app_code="1b7d1e7c9cd94274a04e833713a3b575"
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,"alibaba.dt.onecompare.comparejob.result");
add_param(pRequest,"inst_id","15915");
add_param(pRequest,"sso_ticket","0a44ee7b1c994bea953ce186cedbb006a3415700");
add_param(pRequest,"app_code","1b7d1e7c9cd94274a04e833713a3b575");
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('alibaba.dt.onecompare.comparejob.result', {
	'inst_id':'15915',
	'sso_ticket':'0a44ee7b1c994bea953ce186cedbb006a3415700',
	'app_code':'1b7d1e7c9cd94274a04e833713a3b575'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_dt_onecompare_comparejob_result_response>
    <result>
        <data>
            <inst_vo>
                <inst_id>12345</inst_id>
                <inst_name>&quot;&quot;</inst_name>
                <instance_status>&quot;&quot;</instance_status>
                <instance_start_ime>&quot;&quot;</instance_start_ime>
                <instanc_end_time>&quot;&quot;</instanc_end_time>
                <run_project>&quot;&quot;</run_project>
                <job_category>&quot;&quot;</job_category>
            </inst_vo>
            <rules>
                <rule_v_o>
                    <rule_id>12345</rule_id>
                    <project_id>12345</project_id>
                    <inst_id>12345</inst_id>
                    <rule_name>0</rule_name>
                    <status>SUCCESS</status>
                    <flags>1</flags>
                    <rule_name_id>0</rule_name_id>
                    <subjects_src>&quot;&quot;</subjects_src>
                    <subjects_dst>&quot;&quot;</subjects_dst>
                    <result_src>&quot;&quot;</result_src>
                    <result_dst>&quot;&quot;</result_dst>
                    <actual_difference>20</actual_difference>
                    <difference_rate>10</difference_rate>
                    <expect_rate>10</expect_rate>
                    <rule_name_src>&quot;&quot;</rule_name_src>
                    <rule_name_dst>&quot;&quot;</rule_name_dst>
                </rule_v_o>
            </rules>
            <command_vos>
                <rule_v_o>
                    <command_id>12345</command_id>
                    <content>&quot;&quot;</content>
                    <status>SUCCESS</status>
                    <job_id>12345</job_id>
                    <inst_id>12345</inst_id>
                    <rule_id>0</rule_id>
                    <command_type>ODPS</command_type>
                    <command_instance_id>12345</command_instance_id>
                    <log_view_url>&quot;&quot;</log_view_url>
                    <running_log>&quot;&quot;</running_log>
                    <exploration_rule>&quot;&quot;</exploration_rule>
                </rule_v_o>
            </command_vos>
            <inst_result_token_vo>
                <token_for_current_project>“”</token_for_current_project>
                <token_for_all>&quot;&quot;</token_for_all>
            </inst_result_token_vo>
            <inst_result_vo>
                <fulltext_result>
                    <rule_id>100</rule_id>
                    <project_id>1</project_id>
                    <job_id>2</job_id>
                    <inst_id>3</inst_id>
                    <start_time>2023-07-02 00:00:04</start_time>
                    <end_time>2023-07-02 00:00:36</end_time>
                    <rule_name>100</rule_name>
                    <subjects_src>wl_rec_test.dwd_dt_moe_one_log_url_access_di</subjects_src>
                    <subjects_dst>wl_rec_test.dwd_dt_moe_one_log_url_access_wide_di</subjects_dst>
                    <actual_difference>34,363</actual_difference>
                    <actual_same_cnt>4,720</actual_same_cnt>
                    <difference_rate>78.45%</difference_rate>
                    <expect_rate>2%</expect_rate>
                    <status>SUCCESS</status>
                    <full_text_diffs>
                        <rule_full_text_diff>
                            <diff_type>主键一致，其他列存在差异</diff_type>
                            <diff_total>34363</diff_total>
                            <diff_percent>100%</diff_percent>
                        </rule_full_text_diff>
                    </full_text_diffs>
                    <flags>false</flags>
                </fulltext_result>
                <table_result>
                    <rule_id>0</rule_id>
                    <project_id>1</project_id>
                    <job_id>2</job_id>
                    <inst_id>3</inst_id>
                    <start_time>2023-07-02 00:00:04</start_time>
                    <end_time>2023-07-02 00:00:36</end_time>
                    <rule_name>0</rule_name>
                    <subjects_src>wl_rec_test.dwd_dt_moe_one_log_url_access_di</subjects_src>
                    <subjects_dst>wl_rec_test.dwd_dt_moe_one_log_url_access_wide_di</subjects_dst>
                    <result_src>39,083</result_src>
                    <result_dst>4,720</result_dst>
                    <actual_difference>34,363</actual_difference>
                    <difference_rate>87.92%</difference_rate>
                    <expect_rate>1%</expect_rate>
                    <status>SUCCESS</status>
                    <flags>false</flags>
                </table_result>
            </inst_result_vo>
        </data>
        <success2>true</success2>
        <error_code2>0</error_code2>
        <cause2>null</cause2>
        <message2>null</message2>
    </result>
</alibaba_dt_onecompare_comparejob_result_response>

{
    "alibaba_dt_onecompare_comparejob_result_response":{
        "result":{
            "data":{
                "inst_vo":{
                    "inst_id":12345,
                    "inst_name":"\"\"",
                    "instance_status":"\"\"",
                    "instance_start_ime":"\"\"",
                    "instanc_end_time":"\"\"",
                    "run_project":"\"\"",
                    "job_category":"\"\""
                },
                "rules":{
                    "rule_v_o":[
                        {
                            "rule_id":12345,
                            "project_id":12345,
                            "inst_id":12345,
                            "rule_name":"0",
                            "status":"SUCCESS",
                            "flags":"1",
                            "rule_name_id":"0",
                            "subjects_src":"\"\"",
                            "subjects_dst":"\"\"",
                            "result_src":"\"\"",
                            "result_dst":"\"\"",
                            "actual_difference":"20",
                            "difference_rate":"10",
                            "expect_rate":"10",
                            "rule_name_src":"\"\"",
                            "rule_name_dst":"\"\""
                        }
                    ]
                },
                "command_vos":{
                    "rule_v_o":[
                        {
                            "command_id":12345,
                            "content":"\"\"",
                            "status":"SUCCESS",
                            "job_id":12345,
                            "inst_id":12345,
                            "rule_id":0,
                            "command_type":"ODPS",
                            "command_instance_id":"12345",
                            "log_view_url":"\"\"",
                            "running_log":"\"\"",
                            "exploration_rule":"\"\""
                        }
                    ]
                },
                "inst_result_token_vo":{
                    "token_for_current_project":"“”",
                    "token_for_all":"\"\""
                },
                "inst_result_vo":{
                    "fulltext_result":{
                        "rule_id":100,
                        "project_id":1,
                        "job_id":2,
                        "inst_id":3,
                        "start_time":"2023-07-02 00:00:04",
                        "end_time":"2023-07-02 00:00:36",
                        "rule_name":"100",
                        "subjects_src":"wl_rec_test.dwd_dt_moe_one_log_url_access_di",
                        "subjects_dst":"wl_rec_test.dwd_dt_moe_one_log_url_access_wide_di",
                        "actual_difference":"34,363",
                        "actual_same_cnt":"4,720",
                        "difference_rate":"78.45%",
                        "expect_rate":"2%",
                        "status":"SUCCESS",
                        "full_text_diffs":{
                            "rule_full_text_diff":[
                                {
                                    "diff_type":"主键一致，其他列存在差异",
                                    "diff_total":34363,
                                    "diff_percent":"100%"
                                }
                            ]
                        },
                        "flags":"false"
                    },
                    "table_result":{
                        "rule_id":0,
                        "project_id":1,
                        "job_id":2,
                        "inst_id":3,
                        "start_time":"2023-07-02 00:00:04",
                        "end_time":"2023-07-02 00:00:36",
                        "rule_name":"0",
                        "subjects_src":"wl_rec_test.dwd_dt_moe_one_log_url_access_di",
                        "subjects_dst":"wl_rec_test.dwd_dt_moe_one_log_url_access_wide_di",
                        "result_src":"39,083",
                        "result_dst":"4,720",
                        "actual_difference":"34,363",
                        "difference_rate":"87.92%",
                        "expect_rate":"1%",
                        "status":"SUCCESS",
                        "flags":"false"
                    }
                }
            },
            "success2":true,
            "error_code2":0,
            "cause2":"null",
            "message2":"null"
        }
    }
}

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

alibaba.dt.onecompare.comparejob.result (查看数据对比实例结果)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈